wsadmin スクリプトを使用する AdminTask オブジェクトの AdministrativeJobs コマンド・グループ
Jython スクリプト言語を使用すると、wsadmin ツールで管理ジョブを構成および管理できます。
deleteJob
deleteJob コマンドは、ジョブ・マネージャーから既存のジョブを削除します。コマンドを呼び出した時にジョブが実行中である場合は、ジョブが削除されているかどうかのジョブ結果が戻されます。
ターゲット・オブジェクト
なし。
必須パラメーター
- -jobToken
- 削除するジョブの固有 ID を指定します。(ストリング、必須)
戻り値
このコマンドは出力を返しません。
バッチ・モードの使用例
- Jython ストリングを使用:
AdminTask.deleteJob('-jobToken myToken')
- Jython リストを使用:
AdminTask.deleteJob('-jobToken', 'myToken')
対話モードの使用例
- Jython を使用:
AdminTask.deleteJob('-interactive')
getJobTargets
getJobTargets コマンドが、対象のジョブのターゲットを表示します。コマンドが戻すジョブのターゲットは、未登録か、削除された可能性があります。
ターゲット・オブジェクト
なし。
必須パラメーター
- -jobToken
- 対象のジョブの固有 ID を指定します。(ストリング、必須)
戻り値
このコマンドは、対象のジョブのターゲットのノード名を戻します。
バッチ・モードの使用例
- Jython ストリングを使用:
AdminTask.getJobTargets('-jobToken myToken')
- Jython リストを使用:
AdminTask.getJobTargets('-jobToken', 'myToken')
対話モードの使用例
- Jython を使用:
AdminTask.getJobTargets('-interactive')
getJobTargetStatus
getJobTargetStatus コマンドは、対象のジョブの、最新のジョブ・ターゲット状況を表示します。
ターゲット・オブジェクト
なし。
必須パラメーター
- -jobToken
- 対象のジョブの固有 ID を指定します。(ストリング、必須)
オプション・パラメーター
- -targetList
- ターゲット・ノード名のリストを指定します。 (String[]、オプション)
戻り値
コマンドは、ターゲットの最新ジョブ状況を戻します。状況には、NOT_ATTEMPTED、DISTRIBUTED、ASYNC_IN_PROGRESS、SUCCEEDED、PARTIALLY_SUCCEEDED、FAILED、DELAYED、または REJECTED があります。
バッチ・モードの使用例
- Jython ストリングを使用:
AdminTask.getJobTargetStatus('-jobToken myToken')
- Jython リストを使用:
AdminTask.getJobTargetStatus('-jobToken', 'myToken')
対話モードの使用例
- Jython を使用:
AdminTask.getJobTargetStatus('-interactive')
getJobTargetHistory
getJobTargetHistory コマンドは、対象のジョブのジョブ・ターゲット履歴を表示します。
ターゲット・オブジェクト
なし。
必須パラメーター
- -jobToken
- 対象のジョブの固有 ID を指定します。(ストリング、必須)
- -target
- 対象のターゲットのノード名を指定します。 (ストリング、必須)
- -maxReturn
- 戻す結果の最大数を指定します。(整数、必須)
オプション・パラメーター
- -startingTime
- コマンドがジョブ・ターゲット履歴のリターンを開始する時刻を指定します。 (ストリング、オプション)
- -endingTime
- コマンドがジョブ・ターゲット履歴のリターンを停止する時刻を指定します。 (ストリング、オプション)
- -ascending
- 結果を昇順で戻すか降順で戻すかを指定します。 結果を昇順で表示する場合は true を、降順で表示する場合は false を指定します。(ブール値、オプション)
戻り値
このコマンドは、最初の属性が一致数を指定し、2 番目の属性がターゲットのジョブの履歴を指定する、属性のリストを戻します。各リストには、タイム・スタンプ、状況、メッセージ、および結果属性が含まれます。
バッチ・モードの使用例
- Jython ストリングを使用:
AdminTask.getJobTargetHistory('-jobToken 2846493472984754 -target 3820J37H3017N294 -maxReturn 20')
- Jython リストを使用:
AdminTask.getJobTargetHistory('-jobToken', '2846493472984754', '-target', '3820J37H3017N294', '-maxReturn', '20')
対話モードの使用例
- Jython を使用:
AdminTask.getJobTargetHistory('-interactive')
getJobTypes
getJobTypes コマンドは、対象のエンドポイント用のサポートされたジョブ・タイプを表示します。
ターゲット・オブジェクト
なし。
オプション・パラメーター
- -targetList
- ターゲットのノード名のリストを指定します。 (String[]、オプション)
- -group
- ターゲットのグループの名前を指定します。(ストリング、オプション)
戻り値
このコマンドは、指定された各ターゲットがサポートするジョブ・タイプのリストを戻します。
バッチ・モードの使用例
- Jython ストリングを使用:
AdminTask.getJobTypes('-target myProfileKey')
- Jython リストを使用:
AdminTask.getJobTypes('-target', 'myProfileKey')
対話モードの使用例
- Jython を使用:
AdminTask.getJobTypes('-interactive')
getJobTypeMetadata
getJobTypeMetadata コマンドが、特定ジョブ・タイプに関連するメタデータを表示します。
ターゲット・オブジェクト
なし。
必須パラメーター
- -jobTypeList
- 対象のジョブ・タイプのリストを指定します。 (String[]、オプション)
戻り値
コマンドが、name、label、description、job-properties、および job-parameters 属性などの属性のリストを戻します。
バッチ・モードの使用例
- Jython ストリングを使用:
AdminTask.getJobTypeMetadata('-jobTypeList inventory')
- Jython リストを使用:
AdminTask.getJobTypeMetadata('-jobTypeList', 'inventory')
対話モードの使用例
- Jython を使用:
AdminTask.getJobTypeMetadata('-interactive')
getOverallJobStatus
getOverallJobStatus コマンドは、特定のジョブ、または対象のジョブのリストの、全体的なジョブ状況を表示します。
ターゲット・オブジェクト
なし。
オプション・パラメーター
- -jobTokenList
- 対象のジョブの 1 つ以上の固有 ID を指定します。 (String[]、オプション)
戻り値
- STATE 属性は、ジョブの現在の状態を指定します。
- TOTAL_RESULTS 属性は、ジョブの総数を指定します。
- DISTRIBUTED 属性は、分散ジョブの数を指定します。
- ASYNC_IN_PROGRESS 属性は、進行中の非同期ジョブの数を指定します。
- SUCCEEDED 属性は、実行に成功したジョブの数を指定します。
- PARTIALLY_SUCCEEDED 属性は、部分的に終了したジョブの数を指定します。例えば、ノードが複数のサーバーを表していて、そのノードのいくつかのサーバーのみでジョブが正常に完了した場合には、部分的な成功になります。
- FAILED 属性は、実行に失敗したジョブの数を指定します。
- NOT_ATTEMPTED 属性は、システムが試行しなかったジョブの数を指定します。
バッチ・モードの使用例
- Jython ストリングを使用:
AdminTask.getOverallJobStatus('-jobTokenList myJobToken')
- Jython リストを使用:
AdminTask.getOverallJobStatus('-jobTokenList', 'myJobToken')
対話モードの使用例
- Jython を使用:
AdminTask.getOverallJobStatus('-interactive')
queryJobs
queryJobs コマンドは、サブミットされた各ジョブについてジョブ・マネージャーに照会します。
ターゲット・オブジェクト
なし。
必須パラメーター
- -query
- ジョブの照会に使用する検索式を指定します。(ストリング、必須)ジョブ照会を作成する場合は、以下のガイドラインを使用してください。
- 照会は、キー、演算子、値、または値のリストで構成されます。 単一値、またはコンマで区切られた値のリストを指定することができます。
- 複数の式をスペースと AND 演算子で分離します。
- 以下の大/小文字を区別するキーがサポートされます。
- jobToken
- 照会する特定ジョブのジョブ・トークンを指定します。
- group
- 照会するノード・グループ名を指定します。
- description
- 照会するジョブの説明を指定します。説明に複数の単語が含まれる場合は、単一引用符または二重引用符を使用して、説明のフォーマットを設定します (例えば、description = "job description")。
- activationDateTime
- システムがジョブをアクティブにする日時 (例えば、2006-05-03T10:30:45-0000) を指定します。 activationDateTime キー値の -0000 のセクションは、RFC 822 フォーマットを表しています。Z をグリニッジ標準時 (GMT) の簡略形として指定することができます (例えば、2006-05-03T10:30:45Z)。時間帯を指定しない場合、システムはサーバーの時間帯を使用します。
- expirationDateTime
- ジョブの有効期限が切れる日時 (例えば、2006-05-03T10:30:45-0000) を指定します。 activationDateTime キー値の -0000 のセクションは、RFC 822 フォーマットを表しています。Z をグリニッジ標準時 (GMT) の簡略形として指定することができます (例えば、2006-05-03T10:30:45Z)。時間帯を指定しない場合、システムはサーバーの時間帯を使用します。
- state
- ジョブの状態を指定します。有効な値には、ASYNC_IN_PROGRESS、SUCCEEDED、PARTIALLY_SUCCEEDED、FAILED、DELAYED、REJECTED、および NOT_ATTEMPTED があります。
- ターゲット (target)
- ジョブのターゲット・ノードを指定します。 特定ノードのジョブを戻すには、このキーを使用します。 コマンドは、特定ノードおよびその特定ノードが属するノード・グループのジョブを戻します。 照会ごとに、targetID を 1 つだけ指定することができます。
- 以下の演算子がサポートされています。
表 1. queryJobs -query 演算子. 照会で演算子を使用します。 Character 値 = 等しい。値が NULL の場合、= NULL と指定します。 != 等しくない。値が NULL ではない場合、!= NULL と指定します。 > より大きい < より小さい >= より大か等しい <= より小か等しい
- -maxReturn
- 戻す一致の最大数を指定します。 (整数、必須)
戻り値
[ [result [{activationDateTime=2008-03-11T11:56:48-0500,
expirationDateTime=2008-05-10T11:56:48-0500, jobToken=120525460839085191,
description=testSubmitJobToValidBaseTargetList}{activationDateTime=2008-03-11T14:05:33-0500,
expirationDateTime=2008-05-10T14:05:33-0500, jobToken=120526233387582472,
description=testSubmitJobToValidBaseTargetList}]] [size 2] ]
バッチ・モードの使用例
- Jython ストリングを使用:
print AdminTask.queryJobs('-query activationDateTime>= "2006-01-01" activationDateTime<= "2007-01-01" -maxReturn 20')
print AdminTask.queryJobs('[-query "target = node3" -maxReturn 2]')
- Jython リストを使用:
AdminTask.queryJobs('-query', 'activationDateTime>= "2006-01-01" activationDateTime<= "2007-01-01"', '-maxReturn', '20')
print AdminTask.queryJobs(['-query', '"target = node3"', '-maxReturn', '2'])
対話モードの使用例
- Jython ストリングを使用:
AdminTask.queryJobs('-interactive')
resumeJob
resumeJob コマンドは、以前に開始されたか、中断されたジョブを再開します。
ターゲット・オブジェクト
なし。
必須パラメーター
- -jobToken
- 対象のジョブの固有 ID を指定します。(ストリング、必須)
戻り値
このコマンドは出力を返しません。
バッチ・モードの使用例
- Jython ストリングを使用:
AdminTask.resumeJob('-jobToken myToken')
- Jython リストを使用:
AdminTask.resumeJob('-jobToken', 'myToken')
対話モードの使用例
- Jython を使用:
AdminTask.resumeJob('-interactive')
submitJob
submitJob コマンドは、新規の管理ジョブをジョブ・マネージャーにサブミットします。
ターゲット・オブジェクト
なし。
必須パラメーター
- -jobType
- サブミットするジョブのタイプを指定します。(ストリング、必須)
オプション・パラメーター
- -group
- ターゲットのグループの名前を指定します。(ストリング、オプション)
- -targetList
- ターゲットにするノードのリストを指定します。 (String[]、オプション)
- -jobParams
- サブミットするジョブに必要なパラメーターを指定します。(プロパティー、オプション)
- -username
- セキュリティーが有効な場合に、ジョブのサブミット時に使用するユーザー名を指定します。(ストリング、オプション)
- -password
- セキュリティーが有効な場合に、ジョブのサブミット時に使用するユーザー名のパスワードを指定します。 (ストリング、オプション)
- -description
- ジョブの説明を指定します。(ストリング、オプション)
- -activationDateTime
- ジョブを活動化する日時を、「2006-05-03T10:30:45-0000」のフォーマットで指定します。activationDateTime パラメーター値の「-0000」のセクションは、RFC 822 フォーマットを表します。「2006-05-03T10:30:45Z」のように、グリニッジ標準時 (GMT) を簡略化して「Z」と指定することができます。時間帯を指定しない場合、システムはサーバーの時間帯を使用します。(ストリング、オプション)
- -expirationDateTime
- ジョブの有効期限を指定します。(ストリング、オプション)
- -executionWindow
- ジョブの繰り返し間隔を指定します。(ストリング、オプション)
- -executionWindowUnit
- executionWindow パラメーターによって設定される値の繰り返し間隔計測単位を指定します。ジョブを日ごとに実行する場合は DAILY、週ごとに実行する場合は WEEKLY、月ごとに実行する場合は MONTHLY、年ごとに実行する場合は YEARLY を指定します。 また、CONNECTION を指定して、ノードがジョブ・マネージャーに接続してジョブのポーリングを行うたびにジョブを実行するよう設定することもできます。 CONNECTION を指定する場合は、executionWindow パラメーターを設定しないでください。 (ストリング、オプション)
- システムがジョブ通知を送信する E メール・アドレスを指定します。(ストリング、オプション)
戻り値
このコマンドは、新規にサブミットされたジョブのジョブ・トークンを戻します。
バッチ・モードの使用例
- Jython ストリングを使用:
AdminTask.submitJob('[-jobType createApplicationServer -target profileKey -jobParams "[serverName myServer]" ]')
- Jython リストを使用:
AdminTask.submitJob(['-jobType', 'createApplicationServer', '-target', 'profileKey', '-jobParams', '"[serverName myServer]"'])
対話モードの使用例
- Jython を使用:
AdminTask.submitJob('-interactive')
suspendJob
suspendJob コマンドは、既にサブミットされたジョブを中断します。
ターゲット・オブジェクト
なし。
必須パラメーター
- -jobToken
- 中断するジョブの固有 ID を指定します。(ストリング、必須)
戻り値
このコマンドは出力を返しません。
バッチ・モードの使用例
- Jython ストリングを使用:
AdminTask.suspendJob('-jobToken myToken')
- Jython リストを使用:
AdminTask.suspendJob('-jobToken', 'myToken')
対話モードの使用例
- Jython を使用:
AdminTask.suspendJob('-interactive')