8.1.2 新規作成
実行エージェントを新規に作成できます。
実行エージェント一覧画面から,[新規作成]ボタンをクリックして起動する以下のダイアログに必要な情報を入力し,[実行]ボタンをクリックして作成します。
すでに存在する同種同名の実行エージェントを複数作成することはできません。また,マネージャー種別が「ジョブ管理(V01-12以前はジョブスケジューラー)」以外の場合,[新規作成]ボタンが非活性となり,操作できません。
- 注意事項
-
-
作成する実行エージェントの実行ホスト名は,作成時点で正しく名前解決できている必要があります。
-
V02-30以降でコマンド文を生成して一括登録する場合,閉域の環境(AWS Transit Gatewayなどによりサービスと接続されているネットワーク)から接続して操作を行ってください。インターネット経由での一括操作はできませんのでご注意ください。
-
|
項目 |
説明 |
指定要否 |
|---|---|---|
|
種類 |
実行エージェントの種類を選択します。
|
必須 |
|
エージェント名 |
実行エージェントまたは実行エージェントグループとして登録したいエージェント名を入力します。 1〜255バイトの任意文字列(以下,使用禁止文字を除く)を指定可能です。 アンダーバー(_)2つの「__」で始まる名称は,サービス用に予約されているため,指定できません。
|
必須 |
|
ジョブの受付配信制限の状態 |
実行エージェントまたは実行エージェントグループのジョブの受付配信制限の状態を選択します。
「有効」または「無効」を選択した場合,実行エージェントの状態(接続状態)は「未確認」に設定されます。「保留」または「閉塞」を選択した場合,実行エージェントの状態(接続状態)は「使用不可」に設定されます。 |
必須 |
|
実行ホスト名 |
ジョブの実行先ホスト名を入力します。 1〜255バイトの任意文字列(以下,使用禁止文字を除く)を指定可能です。 マネージャーホスト名は指定できません。
|
エージェントのみ指定(必須) |
|
ジョブ実行多重度 |
ジョブ実行多重度を設定する時間帯と,その時間帯のジョブ実行多重度を以下の形式で入力します。 なお,タイムゾーンはJSTになります。 ジョブ実行多重度により,この実行エージェントで同時に実行できるジョブ数を制限できます。同時実行数が制限されるジョブは,UNIXジョブ,PCジョブ,フレキシブルジョブ,HTTP接続ジョブ,アクションジョブ,カスタムジョブ,および引き継ぎ情報設定ジョブです。同時に実行しようとしたジョブ数が,ジョブ実行多重度に達した場合,それを超えた分のジョブは,実行中のジョブが終了するまでキューイング(実行待ち)の状態になります。
|
エージェントのみ指定(必須) |
|
属するエージェントと優先順位 |
実行エージェントグループに関連づける実行エージェント名とそのグループ内での優先順位を以下の形式で入力します。
|
グループのみ指定(必須) |
|
説明 |
実行エージェントまたは実行エージェントグループに対するコメントを入力します。 1〜80バイトの任意文字列(以下,使用禁止文字を除く)を指定可能です。
|
任意 |
|
一括登録(V02-30以降) |
複数の実行エージェントを一括で登録するコマンド文を生成できます。 [コマンド文生成]ボタンをクリックして起動するダイアログで必要な情報を入力(コマンド実行先ホストのOSをLinuxかWindowsから選択)し,[生成とJSONファイルのダウンロード]ボタンをクリックすると,一括登録用コマンド文の生成と,リクエストボディとなるJSONファイルのテンプレートをダウンロードできます。 生成されたコマンド文をコピーしてリクエストボディ(JSONファイル)※1を編集し,クライアント端末からJSONファイルを指定してコマンドを実行することで一括登録の操作ができます。コマンド文を実行すると,サービスポータルに対してREST APIでの通信が発生するため,通信ができるように事前にポートの許可設定などを実施してください。 なお,生成されたコマンド文の有効期限は60分になるため,あらかじめテンプレートからリクエストボディとなるJSONファイルを作成しておき,コマンド文に入力データとして指定することもご検討ください。 システム負荷の軽減のため,複数の一括操作コマンドを同時に実行しないでください。 リクエストボディの例を以下に示します。 {"agents":[{"type":"A","name":"sampleAgent","status":"Ef","host":"samplehost","con_exe_def":"00:00-00:00=10","link_agent":"","description":"サンプルです。","targethost_id":"ajs-mgr99.99.jp1-cld.local"}]}レスポンスで返却する主なステータスコードを※4に示します。 |
− |
- 注※1
-
リクエストボディの形式を以下に示します。
|
項目 |
説明 |
|---|---|
|
{ |
− |
|
"agents" : [ { |
− |
|
"type" :種類, |
実行エージェントの種類(文字列)を指定します。※2 |
|
"name" : エージェント名, |
実行エージェント名または実行エージェントグループ名(文字列)を指定します。 |
|
"status" : ジョブの受付配信制限の状態, |
ジョブの受付配信制限の状態(文字列)を指定します。※3 |
|
"host" : 実行ホスト名, |
実行ホスト名(文字列)を指定します。 |
|
"con_exe_def" : ジョブ実行多重度, |
ジョブ実行多重度(文字列)を指定します。 |
|
"link_agent" : 属するエージェントと優先順位, |
属する実行エージェント名と優先順位(文字列)を指定します。 |
|
"description" : 説明, |
説明(文字列)を指定します。 |
|
"targethost_id" : 操作対象マネージャーホスト名 |
操作対象のマネージャーホスト名(文字列)を指定します。このマネージャーホストに紐づく実行エージェントに対して操作が行われます。 |
|
}, ... ] |
要求エージェント分だけ繰り返して指定してください。 |
|
} |
− |
- 注※2
-
実行エージェントの種類(文字列)を以下に示します。
|
識別子(値) |
意味 |
|---|---|
|
A |
エージェント |
|
G |
グループ |
- 注※3
-
ジョブの受付配信制限の状態(文字列)を以下に示します。
|
識別子(値) |
意味 |
|---|---|
|
Ef |
有効 |
|
In |
無効 |
|
Hd |
保留 |
|
Bl |
閉塞 |
- 注※4
-
レスポンスで返却する主なステータスコードを以下に示します。
|
ステータスコード |
説明 |
|---|---|
|
202 |
成功しました。タスクIDを返却します。 |
|
400 |
リクエスト内容が不正です(KBDC10028-E,KBDC10101-E,KBDC10301-E,KBDC10318-E)。 |
|
401 |
認証情報が無効です(KBDC20102-E,KBDC10104-E)。 |
|
403 |
権限がありません(KBDC10028-E,KBDC10020-E)。 |
|
409 |
操作中です(KBDC10501-W,KBDC10502-W)。 |
|
412 |
エージェント名が重複しています(KBDC10732-E,KBDC13004-E)。 |
|
503 |
メンテナンス中です(KBDC13016-E,KBDC13017-E)。 |