ヘルス・ポリシーを作成、削除、および管理するには、以下の管理用タスクを使用できます。
createHealthPolicy コマンド
createHealthPolicy コマンドは、新規のヘルス・ポリシーを作成します。
表 1. createHealthPolicy コマンドの引数
引数 |
説明 |
name (必須) |
セル内で固有の名前をヘルス・ポリシーに指定します。
|
説明 |
ヘルス・ポリシーの説明を指定します。 |
reactionMode |
ヘルス・ポリシーでのアクションを実行する前にランタイム・タスクを作成するか、アクションを自動化するかを指定します。
指定可能な値は SUPERVISE または AUTOMATIC です。 |
表 2. addCondition ステップの引数
引数 |
説明 |
type (必須) |
条件のタイプを指定します。指定可能な値は、CUSTOM、AGE、WORKLOAD、MEMORY_LEAK、EXCESSIVE_MEMORY、EXCESSIVE_RESPONSE_TIME、EXCESSIVE_REQUEST_TIMEOUT、または STORM_DRAIN です。
各値には、指定が必要なさまざまなパラメーターがあります。 |
式 (expression) |
カスタム条件を使用している場合は、評価する副次式を指定します。 |
params |
- AGE
- maxAge: 最大経過時間を指定します。
- ageUnits: AGE パラメーターの単位のタイプを指定します。指定可能な値は、HOURS または MINUTES です。
デフォルトは HOURS です。
- WORKLOAD
- totalRequests: メンバーを再始動する前に処理する要求の合計を指定します。
この数は 1000 以上にする必要があります。
- MEMORY_LEAK
- level: メモリー・リークの検出レベルを指定します。
指定可能な値は、FAST、NORMAL、または CONSERVATIVE です。
デフォルトは FAST です。
- EXCESSIVE_MEMORY
- timeOverThreshold: メモリー使用量超過条件に問題の期間を指定します。
- timeUnits: timeOverThreshold 値の単位を指定します。指定可能な値は MINUTES または SECONDS です。デフォルトは MINUTES です。
- memoryUsed: JVM プロセスに使用する、Java™ 仮想マシン (JVM) の最大ヒープ・サイズ表すパーセンテージを指定します。この値の範囲は、1 から 99 です。
- EXCESSIVE_RESPONSE_TIME
- responseTime: 長過ぎると見なされる平均応答時間を指定します。平均がこの値に達すると、メンバーが再始動します。
- responseTimeUnits: 応答時間の時間単位を指定します。指定可能な値は、MINUTES、SECONDS、または MILLISECONDS です。
- EXCESSIVE_REQUEST_TIMEOUT
- timeoutPercent: 条件違反の原因となるタイムアウトした要求のパーセンテージに、しきい値を指定します。
この値の範囲は、1 から 99 です。
- STORM_DRAIN
- level: 検出レベルを指定します。指定可能な値は NORMAL または CONSERVATIVE です。
NORMAL の精度は若干劣りますが、ストーム・ドレーン条件を素早く検出できます。
CONSERVATIVE は最も正確ですが、ストーム・ドレーン条件の検出に比較的時間を要します。
|
表 3. addAction ステップの引数.
addAction ステップの引数はテーブル形式で使用します。テーブル形式では、パラメーター名を指定せずに、順次パラメーターを指定します。
引数 |
説明 |
type (必須) |
アクション・タイプを指定します。指定可能な値は、CUSTOM、HEAPDUMP、THREADDUMP、RESTART_SERVER、SET_MAINT_MODE、MAINT_MODE_BREAK、または MAINT_MODE_STOP です。 |
stepNum (必須) |
アクションを実行する順序を指定します。ステップ 1 から開始して、以降順次に完了してゆきます。 |
action |
カスタム・アクションの名前を指定します。 カスタム・アクションの作成には、createHealthAction コマンドを使用します。 |
node |
アクションを実行するノードを指定します。 |
サーバー |
アクションを実行するサーバーを指定します。 |
表 4. addMember ステップの引数.
addMember ステップの引数はテーブル形式で使用します。テーブル形式では、パラメーター名を指定せずに、順次パラメーターを指定します。
引数 |
説明 |
type (必須) |
メンバーのタイプを指定します。指定できる値は、CELL、CLUSTER、DYNAMIC_CLUSTER、SERVER、または ODR です。 |
name (必須) |
メンバーの名前を指定します。 |
node |
ノードの名前を指定します。
SERVER タイプを選択した場合、ノード名は必須です。 |
例
対話モードの使用例:
バッチ・モードの使用例:
以下のコマンドは、事前定義されたヘルス条件の 1 つを使用してヘルス・ポリシーを作成します。
$AdminTask createHealthPolicy { -name myHealthPolicy -description "My Health Policy" -reactionMode SUPERVISE
-addCondition { -type AGE -params {{maxAge 12} {ageUnits HOURS}} } -addAction {{HEAPDUMP 1}{CUSTOM 2 myAction
myNode myServer} } -addMember {SERVER myServer myNode} }
以下のコマンドは、カスタム条件を使用してヘルス・ポリシーを作成します。
$AdminTask createHealthPolicy { -name myHealthPolicy -description "My Health Policy" -reactionMode SUPERVISE
-addCondition { -type CUSTOM -expression "ODRServerMetric_FromServerStart$errors > 100L" }
-addAction {{HEAPDUMP 1}{CUSTOM 2 myAction myNode myServer} } -addMember {SERVER myServer myNode} }
カスタム条件の式は引用符で囲みます。
modifyHealthPolicy コマンド
modifyHealthPolicy コマンドは、既存のヘルス・ポリシーを変更します。
表 5. 初期引数
引数 |
説明 |
name (必須) |
変更するヘルス・ポリシーの名前を指定します。 |
reactionMode |
ヘルス・ポリシーでのアクションを実行する前にランタイム・タスクを作成するか、アクションを自動化するかを指定します。
指定可能な値は SUPERVISE または AUTOMATIC です。 |
表 6. modifyCondition ステップの引数
引数 |
説明 |
型 (type) |
条件のタイプを指定します。指定可能な値は、CUSTOM、AGE、WORKLOAD、MEMORY_LEAK、EXCESSIVE_MEMORY、EXCESSIVE_RESPONSE_TIME、EXCESSIVE_REQUEST_TIMEOUT、または STORM_DRAIN です。
各値には、指定が必要なさまざまなパラメーターがあります。 |
式 (expression) |
カスタム条件を使用している場合は、評価する副次式を指定します。 |
params |
- AGE
- maxAge: 最大経過時間を指定します。
- ageUnits: AGE パラメーターの単位のタイプを指定します。指定可能な値は、HOURS または MINUTES です。
デフォルトは HOURS です。
- WORKLOAD
- totalRequests: メンバーを再始動する前に処理する要求の合計を指定します。
この数は 1000 以上にする必要があります。
- MEMORY_LEAK
- level: メモリー・リークの検出レベルを指定します。
指定可能な値は、FAST、NORMAL、または CONSERVATIVE です。
デフォルトは FAST です。
- EXCESSIVE_MEMORY
- timeOverThreshold: メモリー使用量超過条件に問題の期間を指定します。
- timeUnits: timeOverThreshold 値の単位を指定します。指定可能な値は MINUTES または SECONDS です。デフォルトは MINUTES です。
- memoryUsed: JVM プロセスに使用する、Java 仮想マシン (JVM) の最大ヒープ・サイズ表すパーセンテージを指定します。この値の範囲は、1 から 99 です。
- EXCESSIVE_RESPONSE_TIME
- responseTime: 長過ぎると見なされる平均応答時間を指定します。平均がこの値に達すると、メンバーが再始動します。
- responseTimeUnits: 応答時間の時間単位を指定します。指定可能な値は、MINUTES、SECONDS、または MILLISECONDS です。
- EXCESSIVE_REQUEST_TIMEOUT
- timeoutPercent: 条件違反の原因となるタイムアウトした要求のパーセンテージに、しきい値を指定します。
この値の範囲は、1 から 99 です。
- STORM_DRAIN
- level: 検出レベルを指定します。指定可能な値は NORMAL または CONSERVATIVE です。
NORMAL の精度は若干劣りますが、ストーム・ドレーン条件を素早く検出できます。
CONSERVATIVE は最も正確ですが、ストーム・ドレーン条件の検出に比較的時間を要します。
|
表 7. removeAction ステップの引数
引数 |
説明 |
name |
削除するヘルス・アクションの名前を指定します。name パラメーターはカスタム・アクションにのみ使用します。 |
type (必須) |
アクション・タイプを指定します。指定可能な値は、CUSTOM、HEAPDUMP、THREADDUMP、RESTART_SERVER、SET_MAINT_MODE、MAINT_MODE_BREAK、または MAINT_MODE_STOP です。 |
表 8. addAction ステップの引数
引数 |
説明 |
type (必須) |
アクション・タイプを指定します。指定可能な値は、CUSTOM、HEAPDUMP、THREADDUMP、RESTART_SERVER、SET_MAINT_MODE、MAINT_MODE_BREAK、または MAINT_MODE_STOP です。 |
name |
ヘルス・アクションの名前を指定します。name パラメーターはカスタム・アクションにのみ使用します。 |
node |
アクションを実行するノードを指定します。 |
サーバー |
アクションを実行するサーバーを指定します。 |
stepNum (必須) |
アクションを実行する順序を指定します。ステップ 1 から開始して、以降順次に完了してゆきます。 |
表 9. orderAction ステップの引数
引数 |
説明 |
name |
ヘルス・アクションの名前を指定します。name パラメーターはカスタム・アクションにのみ使用します。 |
型 (type) |
アクション・タイプを指定します。指定可能な値は、CUSTOM、HEAPDUMP、THREADDUMP、RESTART_SERVER、SET_MAINT_MODE、MAINT_MODE_BREAK、または MAINT_MODE_STOP です。 |
stepNum (必須) |
アクションを実行する順序を指定します。ステップ 1 から開始して、以降順次に完了してゆきます。 |
表 10. addMember ステップの引数
引数 |
説明 |
type (必須) |
メンバーのタイプを指定します。指定できる値は、CELL、CLUSTER、DYNAMIC_CLUSTER、SERVER、または ODR です。 |
name (必須) |
メンバーの名前を指定します。 |
node |
ノードの名前を指定します。
SERVER タイプを選択した場合、ノード名は必須です。 |
例
対話モードの使用例:
バッチ・モードの使用例:$AdminTask modifyHealthPolicy { -name myHealthPolicy -removeAction { -type HEAPDUMP } }
deleteHealthPolicy コマンド
deleteHealthPolicy コマンドは、指定されたヘルス・ポリシーを削除します。
表 11. deleteHealthPolicy コマンドの引数
引数 |
説明 |
name (必須) |
削除するヘルス・ポリシー名を指定します。 |
例
バッチ・モードの使用例:
対話モードの使用例:
listHealthPolicies コマンド
listHealthPolicies コマンドはセル内の各構成済みヘルス・ポリシーをリストします。
createHealthAction コマンド
createHealthAction コマンドは、ヘルス・ポリシーの定義時に使用可能な新規のヘルス・アクションを作成します。
表 12. createHealthAction コマンドの引数
引数 |
説明 |
name (必須) |
ヘルス・アクションの名前を指定します。 |
Java アクション、またはそれ以外の任意のタイプの実行可能ファイルであるアクションを作成できます。
表 13. 非 Java ステップの引数
引数 |
説明 |
executable |
実行可能ファイルのパスを指定します。 非 Java ステップの引数を指定する場合、この引数は必須です。 |
executableArgs |
実行可能ファイルに渡す引数のストリング配列を指定します。 |
osNames |
コンマで区切られた、オペレーティング・システムのリストを指定します。
各オペレーティング・システムにアクションを適用する場合は null を指定します。
有効なオペレーティング・システム名は、windows、unix、および zos です。 |
workingDir |
ファイル・システム内の、コマンドの呼び出し元ロケーションを指定します。 非 Java ステップの引数を指定する場合、この引数は必須です。 |
usernameVar |
ユーザー名に変数を指定します。 |
userNameVal |
ユーザー名変数の値を指定します。 |
passwordVar |
パスワードに変数を指定します。 |
passwordVal |
パスワード変数の値を指定します。 |
表 14. Java ステップの引数
引数 |
説明 |
javaDir |
Java 実行可能ファイルのロケーション (例えば ${JAVA_HOME}) を指定します。変数またはパスを指定できます。 |
executableTargetType |
Java 実行可能ファイルに使用しているファイル・タイプを指定します。指定可能な値は EXECUTABLE_JAR または JAVA_CLASS です。 |
executable |
実行可能ファイルのパスを指定します。Java ステップの引数を指定する場合、この引数は必須です。 |
exectuableArgs |
実行可能ファイルに渡す引数のストリング配列を指定します。 |
osNames |
コンマで区切られた、オペレーティング・システムのリストを指定します。
各オペレーティング・システムにアクションを適用する場合は null を指定します。
有効なオペレーティング・システム名は、windows、unix、および zos です。 |
pidVarName |
Java プロセス ID 変数名を指定します。 |
workingDir |
ファイル・システム内の、コマンドの呼び出し元ロケーションを指定します。 Java ステップの引数を指定する場合、この引数は必須です。 |
usernameVar |
ユーザー名に変数を指定します。 |
usernameVal |
ユーザー名変数の値を指定します。 |
passwordVar |
パスワードに変数を指定します。 |
passwordVal |
パスワード変数の値を指定します。 |
例
バッチ・モードの使用例:
対話モードの使用例:
modifyHealthAction コマンド
既存のヘルス・アクションを変更する場合は、modifyHealthAction コマンドを使用します。
表 15. modifyHealthAction コマンドの引数
引数 |
説明 |
name (必須) |
変更するヘルス・アクションの名前を指定します。 |
表 16. 非 Java ステップの引数
引数 |
説明 |
executable |
実行可能ファイルのパスを指定します。 |
executableArgs |
実行可能ファイルに渡す引数のストリング配列を指定します。 |
workingDir |
ファイル・システム内の、コマンドの呼び出し元ロケーションを指定します。 |
usernameVar |
ユーザー名に変数を指定します。 |
usernameVal |
ユーザー名変数の値を指定します。 |
passwordVar |
パスワードに変数を指定します。 |
passwordVal |
パスワード変数の値を指定します。 |
表 17. Java ステップの引数
引数 |
説明 |
javaDir |
Java 実行可能ファイルのロケーション (例えば ${JAVA_HOME}) を指定します。変数またはパスを指定できます。 |
executableTargetType |
Java 実行可能ファイルに使用しているファイル・タイプを指定します。指定可能な値は EXECUTABLE_JAR または JAVA_CLASS です。 |
executable |
実行可能ファイルのパスを指定します。 |
executableArgs |
実行可能ファイルに渡す引数のストリング配列を指定します。 |
pidVarName |
Java プロセス ID 変数名を指定します。 |
usernameVar |
ユーザー名に変数を指定します。 |
usernameVal |
ユーザー名変数の値を指定します。 |
passwordVar |
パスワードに変数を指定します。 |
passwordVal |
パスワード変数の値を指定します。 |
workingDir |
ファイル・システム内の、コマンドの呼び出し元ロケーションを指定します。 |
例
バッチ・モードの使用例:
$AdminTask modifyHealthAction { -name myAction -java { -javaDir c:¥java¥bin -executableTargetType EXECUTABLE_JAR
-executable test.jar -executableArgs "{arg1}{arg2a arg2b}" -pidVarName pvn -workingDir c:¥workingDir } }
対話モードの使用例:
deleteHealthAction コマンド
deleteHealthAction コマンドは、ヘルス・アクションを削除します。
表 18. deleteHealthAction コマンドの引数
引数 |
説明 |
name (必須) |
ヘルス・アクションの名前を指定します。 |
listHealthActions コマンド
listHealthActions コマンドは、セル内の定義済みの各ヘルス・アクションをリストします。
executeHealthAction コマンド
executeHealthAction コマンドは、指定されたヘルス・アクションを実行します。
表 19. executeHealthAction コマンドの引数
引数 |
説明 |
name (必須) |
実行するヘルス・アクションの名前を指定します。 |
node (必須) |
アクションを実行するノードを指定します。 |
server (必須) |
アクションを実行するサーバーを指定します。 |
セル (cell) |
ヘルス・アクションを実行するセルを指定します。 |
timeout |
ヘルス・アクションの実行に関するタイムアウト値を指定します。 |
variables |
変数の java.util.Properties 値を指定します。 |
例
バッチ・モードの使用例:
対話モードの使用例: