4.7.2 JP1/Baseイベントサービスの状態取得
機能
この部品は,WindowsまたはUNIXの実行対象サーバで,JP1/Baseのイベントサービスの状態を取得します。
また,JP1/Baseのイベントサービスが特定の状態になるまで部品の完了を待たせることができます。
この部品が前提とするサーバを次に示します。
・実行対象サーバ
この部品を実行する対象となるサーバです。
この部品内のスクリプトでは次に示す処理を行います。
・次のコマンドを実行します。
jevstat ["イベントサーバ名(JP1Base.eventServerNameプロパティ)の値"]
[-t "時間オプション(JP1.timeOptionプロパティ)の値"]
・待ち状態の戻り値(JP1.waitStatusReturnCodeプロパティ)を指定した場合,指定した状態になるか,待ち状態の確認リトライ回数(JP1.waitStatusRetryCountプロパティ)を超過するまで,待ち状態の確認リトライ間隔(JP1.waitStatusRetryIntervalプロパティ)ごとにjevstatコマンドの実行を繰り返します。
JP1/Baseのjevstatコマンドの詳細については,JP1/Baseマニュアルの同コマンドを参照してください。
利用場面
JP1/Baseの設定変更後,変更を反映するためにJP1/Baseのイベントサービスを再起動する場合に使用します。
前提条件
【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については,リリースノートを参照してください。
【システム内前提製品】
(1)JP1/Automatic Operation 11-00以降
【実行対象サーバ内前提製品】
(1)JP1/Base 09-00以降
【実行対象サーバ内前提製品の稼働OS】
(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter
(2) Windows Server 2012 Standard/Datacenter,Windows Server 2012 R2 Standard/Datacenter
(3) Windows Server 2016 Standard/Datacenter
(4) Red Hat Enterprise Linux Server 6 (32-bit x86),Red Hat Enterprise Linux Server 6 (64-bit x86_64)
(5) Red Hat Enterprise Linux Server 7 (64-bit x86_64)
【実行対象サーバ内前提製品の使用条件】
なし。
注意事項
(1) この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。
(2) その他の注意事項については,JP1/Baseマニュアルの同コマンドの注意事項を参照してください。
実行権限
Windowsの場合:Administrator権限
UNIXの場合:root権限
バージョン
02.02.00
部品のタグ
Gather JP1 information,Base,Windows,Linux
タスクログに表示される部品の名称
jp1baseEventGetStatus
戻り値
戻り値 |
説明 |
---|---|
0 |
正常 |
12 |
異常(ユーザーミス) プロパティ不正 |
21 |
異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知) |
27 |
異常(エラー内容はタスクログで確認) |
プロパティ一覧
プロパティ一覧を次の表に示します。
プロパティキー |
プロパティ名 |
説明 |
デフォルト値 |
入出力種別 |
必須区分 |
---|---|---|---|---|---|
plugin.destinationHost |
実行対象サーバのホスト名 |
この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。 |
− |
入力 |
○ |
JP1Base.eventServerName |
イベントサーバ名 |
イベントサーバ名を指定します。 |
− |
入力 |
△ |
JP1.timeOption |
時間(t)オプション |
実行するコマンドに時間(t)オプションを設定する場合に時間を指定します。省略した場合は時間(t)オプションを設定しません。 |
− |
入力 |
△ |
JP1.waitStatusReturnCode |
待ち状態の戻り値 |
状態取得コマンドの戻り値が指定した値になるまで繰り返し状態確認コマンドを実行します。省略した場合は繰り返し処理を行いません。 |
− |
入力 |
△ |
JP1.waitStatusRetryCount |
待ち状態の確認リトライ回数 |
状態取得コマンドを実行するリトライ回数を指定します。 |
60 |
入力 |
△ |
JP1.waitStatusRetryInterval |
待ち状態の確認リトライ間隔 |
状態取得コマンドを実行するリトライ間隔を秒単位で指定します。 |
10 |
入力 |
△ |
common.returnValue |
部品の戻り値 |
この部品の戻り値が格納されます。 |
− |
出力 |
△ |
common.commandExitCode |
実行コマンドの戻り値 |
実行コマンドの戻り値が格納されます。 |
− |
出力 |
△ |
common.commandOutput |
実行コマンドの出力情報 |
実行コマンドの標準出力と標準エラー出力が格納されます。 |
− |
出力 |
△ |