コマンドボタン定義ファイル(cmdbtn.conf)
形式
DESC_VERSION=ファイルバージョン # コメント行 def [usr 対象ユーザー名 対象ユーザー名 …] btn [コマンド]ボタン名 [cmt [コマンド]ボタンのコメント] [cmdtype agent|client] [inev true|false] [hst 実行ホスト名] cmd コマンドライン [var 環境変数ファイル名] [qui true|false] [preview true|false] end-btn : : end-def : :
ファイル
cmdbtn.conf
格納先ディレクトリ
- Windowsの場合
-
- 物理ホストのとき
-
Consoleパス\conf\console\rmtcmd\
- 論理ホストのとき
-
共有フォルダ\jp1cons\conf\console\rmtcmd\
- UNIXの場合
-
- 物理ホストのとき
-
/etc/opt/jp1cons/conf/console/rmtcmd/
- 論理ホストのとき
-
共有ディレクトリ/jp1cons/conf/console/rmtcmd/
ファイルの権限
- Windowsの場合
-
AdministratorsグループおよびSYSTEMユーザー
- UNIXの場合
-
root権限を持つユーザー
説明
[コマンド実行]画面に表示する[コマンド]ボタンを定義するファイルです。コマンドボタン定義ファイルの最大ファイルサイズは,10メガバイトです。なお,使用できるコマンドボタン定義が複数ある場合は,コマンドボタン定義ファイルの先頭に近い定義内容が表示されます。
定義の反映時期
[コマンド]ボタン定義の内容は,jcoimdefコマンドを実行して[コマンド]ボタンが有効な場合に,[コマンド実行]画面を表示するときに反映されます。
なお,JP1/IM - Viewを起動中に[コマンド]ボタン定義の内容を変更した場合は,JP1/IM - Viewの再起動が必要です。
記述内容
- DESC_VERSION=ファイルバージョン
-
コマンドボタン定義ファイルの形式のバージョンを指定します。指定する値は1または2です。クライアントアプリケーションまたはイベント情報の引き継ぎ機能を使用する場合は,2を指定します。2を指定すると,次のパラメーターを指定できます。
-
cmdtype
-
inev
-
preview
ファイルバージョンを省略した場合や1または2以外の数値を指定した場合は,1が仮定されます。
-
- #コメント行
-
#で始まる行は,コメント扱いとなります。
- def〜end-def(定義ブロック)
-
コマンドボタン定義の開始と終了のパラメーターです。64個まで指定できます。
- [usr 対象ユーザー名 対象ユーザー名 …]
-
[コマンド]ボタンを使用するJP1ユーザー名を指定します。対象ユーザー名に指定できる文字数は,1〜31バイトです。半角英数字だけを使用できます。英字は大文字・小文字を区別しません。複数指定する場合は,一つ以上の連続した半角スペースまたはタブを対象ユーザー名と対象ユーザー名の間に挿入して区切ります。複数指定では,100個まで指定できます。101個目以降の対象ユーザー名は無視されます。省略した場合,すべてのJP1ユーザーを対象ユーザーとします。def〜end-defの間に1個指定できます。btn〜end-btnの間には指定できません。
- btn [コマンド]ボタン名〜end-btn
-
[コマンド]ボタンの開始と終了パラメーターです。[コマンド]ボタン名は,[コマンド]ボタンの名称として[コマンド実行]画面の上に表示されます。一つの[コマンド]ボタン名に対して,8文字まで指定できます。指定できる文字は,制御文字(0x00〜0x1F,0x7F〜0x9F)以外の文字列です。大文字・小文字は区別します。[コマンド]ボタンは,定義ブロックの中に16個まで定義できます。重複した[コマンド]ボタン名は指定できません。[コマンド]ボタン名が最大文字数を超える場合,または[コマンド]ボタン名が重複している場合,その[コマンド]ボタン名は読み込めません。
- [cmt [コマンド]ボタンのコメント]
-
[コマンド]ボタンの説明を記述します。コメントは,ツールチップとして表示されます。このパラメーターは省略できます。コメントは40文字まで指定できます。41文字以降の文字は無視されます。指定できる文字は,すべての文字です。
- [cmdtype agent|client]
-
[コマンド]ボタンで実行するコマンドの種類を指定します。管理対象ホストのコマンド,またはクライアントアプリケーションのどちらのコマンドなのかを選択します。クライアントアプリケーションは,クライアントアプリケーション実行機能で実行されます。このパラメーターを指定する場合は,DESC_VERSIONに2を指定してください。
エージェントまたはマネージャーホストでコマンドを実行する場合,agentパラメーターを指定します。クライアントアプリケーションを実行する場合,clientを指定します。
cmdtypeにclientを指定した場合は,hstおよびvarパラメーターを指定できません。
agentまたはclientは,大文字・小文字を区別しません。
- [inev true|false]
-
[コマンド]ボタンを使用してイベント情報を引き継ぐかどうかを指定します。このパラメーターを指定する場合は,DESC_VERSIONに2を指定してください。
[コマンド]ボタンをクリックしたときに指定したイベント情報を引き継いでコマンドを実行させる場合はtrue,実行させない場合はfalseを指定します。省略した場合,falseが指定されます。
trueまたはfalseは,大文字・小文字を区別しません。
- [hst 実行ホスト名]
-
コマンドを実行するホスト名を指定します。実行ホスト名には,ホスト名,ホストグループ名,業務グループ名,および監視グループ名を指定できます。
ホスト名,ホストグループ名には,最大255バイトの文字列を指定できます。業務グループ名,監視グループ名には,最大2,048バイトの文字列を指定できます。このパラメーターは省略できます。
統合監視DBおよびIM構成管理DBが有効な場合に,パス表記で業務グループ名を指定できます。
統合監視DBおよびIM構成管理DBが無効な場合,パス表記で業務グループ名を指定しても,ホスト名またはホストグループ名として扱われます。
イベント引き継ぎ情報は,変数で指定します。指定できるイベント引き継ぎ情報については,マニュアル「JP1/Integrated Management - Manager 導入・設計ガイド」の「3.16.5(1) 指定できるイベント引き継ぎ情報」を参照してください。イベント引き継ぎ情報を指定する場合は,inevパラメーターにtrueを指定してください。イベント引き継ぎ情報を指定する場合は,変数をJP1イベントの情報に置き換えたあとの文字列の長さが,実行ホスト名の最大バイト数以下になるように指定してください。置き換えたあとの文字列の長さが実行ホスト名の最大バイト数を超える場合は,最大バイト数に収まるように切り捨てられた文字列が実行ホスト名に指定されます。
- cmd コマンドライン
-
実行するコマンドを指定します。コマンドラインは4,096バイトまで指定できます。このパラメーターは省略できません。
イベント引き継ぎ情報は,変数で指定します。イベント引き継ぎ情報を指定する場合は,inevパラメーターにtrueを指定してください。イベント引き継ぎ情報を指定する場合は,変数をJP1イベントの情報に置き換えたあとの文字列の長さが,コマンドラインの最大バイト数以下になるように指定してください。置き換えたあとの文字列の長さがコマンドラインの最大バイト数を超える場合は,最大バイト数に収まるように切り捨てられた文字列が環境変数ファイルに指定されます。
- [var 環境変数ファイル名]
-
実行するコマンドの環境変数を指定した環境変数ファイルのファイル名を指定します。このパラメーターは省略できます。環境変数ファイルの形式については,「環境変数ファイル」(2. 定義ファイル)を参照してください。環境変数ファイル名は255バイト以内の文字列で指定します。環境変数ファイル名が最大バイト数を超える場合は,コマンドボタンを読み込みません。
イベント引き継ぎ情報は,変数で指定します。イベント引き継ぎ情報を指定する場合は,inevパラメーターにtrueを指定してください。イベント引き継ぎ情報を指定する場合は,変数をJP1イベントの情報に置き換えたあとの文字列の長さが,環境変数ファイルの最大バイト数以下になるように指定してください。置き換えたあとの文字列の長さが環境変数ファイルの最大バイト数を超える場合は,最大バイト数に収まるように切り捨てられた文字列が環境変数ファイルに指定されます。
- [qui true|false]
-
[コマンド]ボタンを使用してコマンドを実行する前に,コマンドを実行してもよいか確認するメッセージを表示させるかどうかを指定します。確認するメッセージを表示させないと,[コマンド]ボタンをクリックすると同時にコマンドが実行されます。
確認するメッセージを表示させない場合はtrue,表示させる場合はfalseを指定します。省略した場合,falseが指定されます。ただし,previewパラメーターにtrueを指定した場合は,[コマンド実行内容プレビュー]画面が表示されます。
trueまたはfalseは,大文字・小文字を区別しません。
- [preview true|false]
-
[コマンド]ボタンを使用してイベント情報を引き継ぐ場合,引き継ぎ後のコマンド実行内容をプレビューで確認するかどうかを設定するパラメーターです。このパラメーターを指定する場合は,DESC_VERSIONに2を指定してください。
プレビューを表示させる場合はtrue,表示させない場合はfalseを指定します。省略した場合,trueが指定されます。
trueまたはfalseは,大文字・小文字を区別しません。
このパラメーターは,inevパラメーターがfalseの場合は無視されます。
previewパラメーターにfalse,quiパラメーターにtrueを指定した場合は,コマンドボタンをクリックすると同時にコマンドが実行されます。[コマンド実行内容プレビュー]画面およびコマンド実行の確認メッセージは表示されません。
定義例
DESC_VERSION=2 def # ビューアーホストでコマンドを実行する。 # 実行コマンドにイベント引継ぎ情報を指定する。 # 実行前にプレビュー画面を表示する。 btn App1 cmt App1を実行します。 cmdtype client inev true cmd C:\kansi\app1.exe $EVIDBASE $EVSEQNO "$EVMSG" end-btn # ビューアーホストでコマンドを実行する。 # 実行コマンドにイベント引継ぎ情報を指定する。 # 実行前に確認ダイアログを表示する。プレビュー画面は表示しない。 btn App2 cmt App2を実行します。 cmdtype client inev true cmd C:\kansi\app2.exe $EVIDBASE $EVSEQNO "$EVMSG" preview false end-btn # ビューアーホストでコマンドを実行する。 # 実行コマンドにイベント引継ぎ情報を指定する。 # 実行前に確認ダイアログもプレビュー画面も表示しない。 btn App3 cmt App3を実行します。 cmdtype client inev true cmd C:\kansi\app3.exe $EVIDBASE $EVSEQNO "$EVMSG" qui true preview false end-btn # エージェントまたはマネージャーホストでコマンドを実行する。 # 実行コマンドにイベント引継ぎ情報を指定する。 # 実行前にプレビュー画面を表示する。 btn Cmd1 cmt cmd1を実行します。 cmdtype agent inev true hst $EVHOST cmd /kansi/cmd1 $EVIDBASE $EVSEQNO '$EVMSG' end-btn # エージェントまたはマネージャーホストでコマンドを実行する。 # 実行コマンドにイベント引継ぎ情報は指定しない。 # 実行前に確認ダイアログを表示する。 btn Cmd2 cmt cmd2を実行します。 hst agent2 cmd /kansi/cmd2 end-btn end-def