6.1.1 Ops I提供部品

Workflow定義では、アクティビティで何を実行するかをTask model内のactionにて定義します。その際に使用可能なOps I提供部品について、以下に詳細を示します。

（表）actionのリスト（Ops I提供部品）

Action 説明
oi.fetch_access_token Ops Iアクセストークンを取得する。
oi.insert_into_custom_table カスタムテーブルに指定したレコードを挿入する。
oi_user.サブフローとして呼び出すワークフロー名 サブフローとして呼び出すワークフロー名を指定する。
awx.run_job_template 自動化のジョブテンプレートを実行する。
awx.get_job_result 自動化のジョブの結果を取得する。

JP1/AJS3のジョブを実行するためのOps I提供部品について以下に示します。JP1/AJS3の連携テンプレートとして提供されるWorkflowのYAML定義の中で使用します。JP1/AJS3の連携テンプレートの詳細は「JP1/AJS3」を参照してください。

（表）actionのリスト（JP1/AJS3連携用Ops I提供部品）

Action Playbook name JP1/AJS3
Command
英語 日本語
ajs.cancel_exec_schedule ジョブネット実行中止 cancel_exec_schedule.yaml ajsplan
ajs.change_hold ジョブネット保留属性変更 change_hold.yaml ajsplan
ajs.change_start_time ジョブスケジュール変更 change_start_time.yaml ajsplan
ajs.interrupt ジョブネット中断 interrupt.yaml ajsintrpt
ajs.kill ジョブネット強制終了 kill.yaml ajskill
ajs.register_fixed_exec ジョブネット確定実行登録 register_fixed_exec.yaml ajsentry
ajs.register_immediate_exec ジョブネット即時実行登録 register_immediate_exec.yaml ajsentry
ajs.register_planned_exec ジョブネット計画実行登録 register_planned_exec.yaml ajsentry
ajs.rerun ジョブネット再実行 rerun.yaml ajsrerun
ajs.show ジョブネット実行情報取得 show.yaml ajsshow

JP1/IMに対するジョブを実行するためのOps I提供部品について以下に示します。JP1/IMの連携テンプレートとして提供されるWorkflowのYAML定義の中で使用します。JP1/IMの連携テンプレートの詳細は「監視抑止」を参照してください。

（表）actionのリスト（JP1/IM連携用Ops I提供部品）

Action Playbook name JP1/IM
Command
英語 日本語
im.apply_common_exclusion_conditions_file 共通除外条件拡張定義ファイル適用 apply_common_exclusion_conditions_file.yaml jcochfilter -ef
im.get_common_exclusion_conditions_file 共通除外条件拡張定義ファイル取得 get_common_exclusion_conditions_file.yaml -
im.set_common_exclusion_conditions_valid 共通除外条件定義の有効/無効を切り替え set_common_exclusion_conditions_valid.yaml jcochfilter -on/-off

Ops I提供部品の詳細を以下に示します。

（1）oi.fetch_access_token

Ops Iアクセストークンを取得します。このOps Iアクセストークンは、ワークフロー内からOps IのREST APIを実行する際に利用します。

oi.fetch_access_tokenを使用する場合は、以下のパラメータを設定する必要があります。

（表）oi.fetch_access_tokenのパラメータ

パラメータ 必須 型 説明
opsi_user_secret_mount_point Yes String Ops Iアクセストークンを取得するユーザーのシークレット情報が格納されているSecrets Enginesのパス
opsi_user_secret_path Yes String Ops Iアクセストークンを取得するユーザーのシークレット情報が格納されているパス
opsi_user_secret_kv_version Yes Number シークレットのSecrets Enginesのバージョン
1：レガシーなSecrets Engines
2：新しいSecrets Engines
opsi_user_secret_version No String 格納されているシークレット情報のバージョン

パラメータで指定した場所には以下のシークレット情報が格納されている必要があります。
シークレット情報については「Secretの作成」を参照してください。

  • username： Ops Iアクセストークンを取得するユーザー名
  • password： Ops Iアクセストークンを取得するユーザーのパスワード
  • domain： Ops IのFQDN（例："テナント名.ops-integration.com"）

oi.fetch_access_tokenの戻り値は以下の通りです。

（表）oi.fetch_access_tokenの戻り値

パラメータ 説明
output.access_token Ops Iアクセストークン
output.origin Ops IのURL


（2）oi.insert_into_custom_table

カスタムテーブルに指定したレコードを挿入します。

oi.insert_into_custom_tableを使用する場合は、以下のパラメータを設定する必要があります。

（表）oi.insert_into_custom_tableのパラメータ

パラメータ 必須 型 説明
parent_execution_id Yes String ワークフローのexecution_id※1。ワークフローのアクションとして実行した別のワークフローの中で使用する場合でも、元のワークフローのexecution_idを指定する必要がある。
graphql_user_object_type Yes String レコードを挿入するカスタムテーブルの名前。Datamodelのmanifest.yamlで定義したテーブル名に「u_」を連結したもの。
例）"u_my_custom_table"
graphql_user_object_data Yes Object 挿入するレコードをdataフィールドに格納したオブジェクト
auth_Type No String Ops Iへのログインに用いる認証タイプ。以下から指定する。
  • password_grant
  • opsi_token
デフォルトは"password_grant"。
opsi_user_secret_mount_point No String auth_typeで"password_grant"を指定した場合、Ops Iアクセストークンを取得するユーザーのシークレット情報が格納されているSecrets Enginesのパスを指定する。
opsi_user_secret_path No String auth_typeで"password_grant"を指定した場合、Ops Iアクセストークンを取得するユーザーのシークレット情報が格納されているパスを指定する。
opsi_user_secret_kv_version No Number auth_typeで"password_grant"を指定した場合、Ops Iアクセストークンを取得するユーザーのシークレット情報を取得するときのSecrets Enginesのバージョンを指定する。
1：レガシーなSecrets Engines
2：新しいSecrets Engines
opsi_user_secret_version No String auth_typeで"password_grant"を指定した場合、Ops Iアクセストークンを取得するユーザーのシークレット情報のバージョンを指定する。指定を省略した場合は最新バージョンを仮定する。
opsi_secret_mount_point No String シークレット情報が格納されているSecrets Enginesのパスを指定する。
auth_typeで"password_grant"を指定した場合でopsi_user_secret_mount_pointを設定している場合は、opsi_user_secret_mount_pointが優先される。
opsi_secret_path No String Ops Iトークンが格納されているシークレットのパスを指定する。
auth_typeで"password_grant"を指定した場合でopsi_user_secret_pathを設定している場合は、opsi_user_secret_pathが優先される。
opsi_secret_kv_version No Number シークレット情報を取得するときのSecrets Enginesのバージョンを指定する。
auth_typeで"password_grant"を指定した場合でopsi_user_secret_kv_versionを設定している場合は、opsi_user_secret_kv_versionが優先される。
1：レガシーなSecrets Engines
2：新しいSecrets Engines
opsi_secret_version No String シークレット情報のバージョンを指定する。指定を省略した場合は最新バージョンを仮定する。
auth_typeで"password_grant"を指定した場合でopsi_user_secret_versionを設定している場合は、opsi_user_secret_versionが優先される。
※1：<% ctx().st2.action_execution_id %>で取得します。詳細についてはStackStorm公式ページを参照してください。
https://docs.stackstorm.com/3.7/orquesta/stackstorm.html#stackstorm-context

パラメータで指定した場所には以下のシークレット情報が格納されている必要があります。
シークレット情報については「Secretの作成」を参照してください。

  • username： Ops Iアクセストークンを取得するユーザー名※2
  • password： Ops Iアクセストークンを取得するユーザーのパスワード※2
  • domain： Ops IのFQDN（例："テナント名.ops-integration.com"）
  • opsi_token： Ops Iトークン※3
※2：auth_typeが"password_grant"の場合必要です。
※3：auth_typeが"opsi_token"の場合必要です。

oi.insert_into_custom_tableの戻り値はありません。



（3）awx.run_job_template

自動化のジョブテンプレートを実行します。

awx.run_job_templateを使用する場合は、以下のパラメータを設定する必要があります。

（表）awx.run_job_templateのパラメータ

パラメータ 必須 型 説明
name※ "object_id"を指定しない場合は必須 String 実行するジョブテンプレートの名前
organization※ "object_id"を指定しない場合は必須 String 対象のジョブテンプレートが属する組織の名前
object_id※ No Number 対象のジョブテンプレートのID
auth_type No String 自動化へのログインに用いる認証タイプ。以下から指定する。
  • saml
  • saml_with_vault_kv2
  • pat
デフォルトは"saml"。
vault_backend_name No String auth_typeで"saml_with_vault_kv2"または"pat"を指定した場合、自動化のクレデンシャル情報が保存されているシークレットバックエンドの名前を指定する。
vault_secret_path No String auth_typeで"saml_with_vault_kv2"または"pat"を指定した場合、自動化のクレデンシャル情報が保存されているシークレットのパスを指定する。
vault_user_key No String auth_typeで"saml_with_vault_kv2"を指定した場合、自動化のユーザー名のキーを指定する。
デフォルトは"user_name"。
vault_pw_key No String auth_typeで"saml_with_vault_kv2"を指定した場合、自動化のパスワードのキーを指定する。
デフォルトは"password"。
user_name No String auth_typeで"saml"を指定した場合、自動化のユーザー名を指定する。
vault_pat_key No String auth_typeで"pat"を指定した場合、自動化のPATのキーを指定する。
デフォルトは"pat"。
password No String auth_typeで"saml"を指定した場合、自動化のユーザーのパスワードを指定する。
payload Yes String 自動化APIへのリクエストボディを指定する。
リクエストボティの形式については、内部で実行されている自動化のAPI（POST /api/v2/job_templates/{id}/launch/）のリファレンス参照。
https://docs.ansible.com/automation-controller/4.5/html/controllerapi/api_ref.html#/Job_Templates
※実行するジョブテンプレートの指定方法は、nameとorganizationを用いる方法と、object_idを用いる方法があります。両方の方法を用いた場合はobject_idが優先されます。

awx.run_job_templateの戻り値は以下の通りです。

（表）awx.run_job_templateの戻り値

パラメータ 説明
result 実行したジョブのID。awx.get_job_resultで使用する。


（4）awx.get_job_result

自動化のジョブの結果を取得します。

awx.get_job_resultを使用する場合は、以下のパラメータを設定する必要があります。

（表）awx.get_job_resultのパラメータ

パラメータ 必須 型 説明
id Yes Number ジョブのID。awx.run_job_templateアクションの戻り値を使用する。
format No String 結果のフォーマット。以下から指定する。
  • "txt"
  • "api"
  • "html"
  • "ansi"
  • "json"
  • "txt_download"
  • "ansi_download"
デフォルトは"txt"。
詳細は、内部で実行している自動化のAPI（/api/v2/jobs/{id}/stdout/?format={format}）のリファレンス参照。https://docs.ansible.com/automation-controller/4.5/html/controllerapi/api_ref.html#/Jobs/Jobs_jobs_stdout_read
auth_type No String 自動化へのログインに用いる認証タイプ。以下から指定する。
  • saml
  • saml_with_vault_kv2
  • pat
デフォルトは"saml"。
vault_backend_name No String auth_typeで"saml_with_vault_kv2"または"pat"を指定した場合、自動化のクレデンシャル情報が保存されているシークレットバックエンドの名前を指定する。
vault_secret_path No String auth_typeで"saml_with_vault_kv2"または"pat"を指定した場合、自動化のクレデンシャル情報が保存されているシークレットのパスを指定する。
vault_user_key No String auth_typeで"saml_with_vault_kv2"を指定した場合、自動化のユーザー名のキーを指定する。
デフォルトは"user_name"。
vault_pw_key No String auth_typeで"saml_with_vault_kv2"を指定した場合、自動化のパスワードのキーを指定する。
デフォルトは"password"。
vault_pat_key No String auth_typeで"pat"を指定した場合、自動化のPATのキーを指定する。
デフォルトは"pat"。
user_name No String auth_typeで"saml"を指定した場合、自動化のユーザー名を指定する。
password No String auth_typeで"saml"を指定した場合、自動化のユーザーのパスワードを指定する。

awx.get_job_resultの戻り値は以下の通りです。

（表）awx.get_job_resultの戻り値

パラメータ 説明
result.id ジョブのID
result.name ジョブの名前
result.status ジョブのステータス。戻り値は以下から返される。
  • new：新規
  • pending：保留中
  • waiting：待機中
  • running：実行中
  • successful：成功
  • failed：失敗
  • error：エラー
本パラメータは、内部で実行されている自動化のAPI（GET /api/v2/jobs/{id}）のレスポンスのstatusパラメータを返します。最新の情報は、以下を参照してください。
https://docs.ansible.com/automation-controller/4.5/html/controllerapi/api_ref.html#/Jobs
result.log ジョブ実行結果。formatで指定した形式になっている。


（5）ajs.cancel_exec_schedule

この部品は、JP1/AJS3に登録済みのジョブネットまたはジョブの次回実行予定を取り消します。

ajs.cancel_exec_scheduleを使用する場合は、以下に示す「（表）JP1/AJS3およびJP1/IM共通パラメータ」、「（表）JP1/AJS3共通パラメータ」、および「（表）ajs.cancel_exec_scheduleの固有パラメータ」を設定する必要があります。

（表）JP1/AJS3およびJP1/IM共通パラメータ

パラメータ 必須 型 説明
job_template_name※ "job_template_object_id"を指定しない場合は必須 String 実行するジョブテンプレートの名前
job_template_organization※ "job_template_object_id"を指定しない場合は必須 String 対象のジョブテンプレートが属する組織の名前
job_template_object_id※ No Number 対象のジョブテンプレートのID
awx_auth_type No String 自動化へのログインに用いる認証タイプ。以下から指定する。
  • saml
  • saml_with_vault_kv2
  • pat
デフォルトは"saml"。
awx_vault_backend_name No String awx_auth_typeで"saml_with_vault_kv2"または"pat"を指定した場合、自動化のクレデンシャル情報が保存されているシークレットバックエンドの名前を指定する。
awx_vault_secret_path No String awx_auth_typeで"saml_with_vault_kv2"または"pat"を指定した場合、自動化のクレデンシャル情報が保存されているシークレットのパスを指定する。
awx_vault_user_key No String awx_auth_typeで"saml_with_vault_kv2"を指定した場合、自動化のユーザー名のキーを指定する。
デフォルトは"user_name"。
awx_vault_pw_key No String awx_auth_typeで"saml_with_vault_kv2"を指定した場合、自動化のパスワードのキーを指定する。
デフォルトは"password"。
awx_vault_pat_key No String awx_auth_typeで"pat"を指定した場合、自動化のPATのキーを指定する。
デフォルトは"pat"。
awx_user_name No String awx_auth_typeで"saml"を指定した場合、自動化のユーザー名を指定する。
awx_password No String awx_auth_typeで"saml"を指定した場合、自動化のユーザーのパスワードを指定する。
※実行するジョブテンプレートの指定方法は、job_template_nameとjob_template_organizationを用いる方法と、job_template_object_idを用いる方法があります。両方の方法を用いた場合はjob_template_object_idが優先されます。

（表）JP1/AJS3共通パラメータ

パラメータ 必須 型 説明
ajs_unit_name Yes String 要求対象ユニットのユニット完全名を、1〜930バイトの文字列で指定する。
例）"/jobgroup/jobnet"
ajs_vault_backend_name Yes String JP1/AJS3のシークレット情報が保存されるシークレットバックエンドの名前を指定する。
ajs_vault_secret_path Yes String JP1/AJS3のシークレット情報が保存されるシークレットへのパスを指定する。
ajs_credential_organization No String JP1/AJS3のシークレット情報を登録したAWXの組織を指定する。
ajs_service_name No String スケジューラーサービス名を、1から30バイトの文字列で指定する。
例）"AJSROOT1"

（表）ajs.cancel_exec_scheduleの固有パラメータ

パラメータ 必須 型 説明
ajs_exec_registration_number No String 次回実行予定を取り消すジョブネットまたはジョブの実行登録番号をYYYYMMDDNNN形式で指定する。

ajs.cancel_exec_scheduleの戻り値は以下の通りです。

（表）ajs.cancel_exec_scheduleの戻り値

パラメータ 説明
result.id 自動化のジョブのID
result.name 自動化のジョブの名前
result.status 自動化のジョブのステータス。戻り値は以下から返される。
  • new：新規
  • pending：保留中
  • waiting：待機中
  • running：実行中
  • successful：成功
  • failed：失敗
  • error：エラー
本パラメータは、内部で実行されている自動化のAPI（GET /api/v2/jobs/{id}）のレスポンスのstatusパラメータを返します。最新の情報は、以下を参照してください。
https://docs.ansible.com/automation-controller/4.5/html/controllerapi/api_ref.html#/Jobs
result.log 自動化のジョブ実行結果
result.output 自動化のジョブ出力結果


（6）ajs.change_hold

この部品は、JP1/AJS3に登録済みのジョブネットまたはジョブの一時的な保留または保留解除をします。

ajs.change_holdを使用する場合は、「（表）JP1/AJS3およびJP1/IM共通パラメータ」、「（表）JP1/AJS3共通パラメータ」、および「（表）ajs.change_holdの固有パラメータ」を設定する必要があります。

（表）ajs.change_holdの固有パラメータ

パラメータ 必須 型 説明
ajs_new_hold_attribute Yes String ジョブネットまたはジョブの実行を一時的に保留する場合は"hold"を、保留解除する場合は"release"を指定する。
ajs_exec_registration_number No String 保留属性を一時的に変更するジョブネットまたはジョブの実行登録番号をYYYYMMDDNNN形式で指定する。

ajs.change_holdの戻り値は「（表）ajs.cancel_exec_scheduleの戻り値」と同様です。

（7）ajs.change_start_time

この部品は、JP1/AJS3に登録済みのジョブネットの実行開始日時を一時的に変更、またはジョブネットを即時実行します。

ajs.change_start_timeを使用する場合は、「（表）JP1/AJS3およびJP1/IM共通パラメータ」、「（表）JP1/AJS3共通パラメータ」、および以下に示す「（表）ajs.change_start_timeの固有パラメータ」を設定する必要があります。

（表）ajs.change_start_timeの固有パラメータ

パラメータ 必須 型 説明
ajs_schedule_change_operation Yes String ジョブネットの実行開始日時を変更するには"ChangeTime"を、ジョブネットを即時実行するには"ExecuteImmediately"を指定する。
ajs_exec_registration_number No String 実行スケジュールを一時的に変更するジョブネットの実行登録番号をYYYYMMDDNNN形式で指定する。
ajs_next_execution_date No String "ajs_schedule_change_operation"で"ChangeTime"を指定した場合は、一時的に変更する次回の実行日を指定する。実行日は以下のいずれかの形式で指定する。
  • [[year/]month/]day※
  • [[year-]month-]day※
yearまたは、year/monthを省略した場合、実行日には次の値が仮定される。
  • year：部品が実行された年
  • year/month：部品が実行された年と月
ajs.next_execution_time No String "ajs_schedule_change_operation"に"ChangeTime"を指定した場合は、一時的に変更する次回の実行開始時刻をhh[:mm]※の形式で指定する。mmを省略した場合、0が仮定される。
ajs_cancel_next_execution No String 次回の実行スケジュールを前倒しに変更した場合、"true"を指定すると変更前の次回実行スケジュールはキャンセルされる。"true"を指定しない場合、変更前の次回実行スケジュールはキャンセルされず、処理が続行される。
ajs_change_lower_jobnets No String 指定したジョブネット中のジョブネットに対して、実行開始時刻を相対的に変更する場合は、"true"を指定する。"true"を指定しない場合、指定されたジョブネットの実行開始時刻のみが変更される。
※[ ]で囲まれている項目は、任意に指定できます（省略できます）。

ajs.change_start_timeの戻り値は「（表）ajs.cancel_exec_scheduleの戻り値」と同様です。

（8）ajs.interrupt

この部品は、JP1/AJS3で現在実行中のジョブが終了し後、ジョブネットの実行を中断します。

ajs.interruptを使用する場合は、「（表）JP1/AJS3およびJP1/IM共通パラメータ」、「（表）JP1/AJS3共通パラメータ」、および以下に示す「（表）ajs.interruptの固有パラメータ」を設定する必要があります。

（表）ajs.interruptの固有パラメータ

パラメータ 必須 型 説明
ajs_exec_registration_number No String 実行を中断したいジョブネットの実行登録番号をYYYYMMDDNNN形式で指定する。

ajs.interruptの戻り値は「（表）ajs.cancel_exec_scheduleの戻り値」と同様です。

（9）ajs.kill

この部品は、JP1/AJS3で実行中のジョブまたはジョブネットの実行を強制終了します。

ajs.killを使用する場合は、「（表）JP1/AJS3およびJP1/IM共通パラメータ」、「（表）JP1/AJS3共通パラメータ」、および以下に示す「（表）ajs.killの固有パラメータ」を設定する必要があります。

（表）ajs.killの固有パラメータ

パラメータ 必須 型 説明
ajs_exec_registration_number No String 強制終了するジョブネットまたはジョブの実行登録番号をYYYYMMDDNNN形式で指定する。

ajs.killの戻り値は「（表）ajs.cancel_exec_scheduleの戻り値」と同様です。

（10）ajs.register_fixed_exec

この部品は、JP1/AJS3に登録済みのジョブネットを確定実行登録します。

ajs.register_fixed_execを使用する場合は、「（表）JP1/AJS3およびJP1/IM共通パラメータ」、「（表）JP1/AJS3共通パラメータ」、および以下に示す「（表）ajs.register_fixed_execの固有パラメータ」を設定する必要があります。

（表）ajs.register_fixed_execの固有パラメータ

パラメータ 必須 型 説明
ajs_execute_prior Yes String スケジューラーサービスの停止中に実行予定日を過ぎた場合、実行のタイミングを以下で指定する。
  • true：スケジューラーサービス起動時
  • false：次回のスケジュール実行時
ajs_macro_parameter No String JP1/AJS3のマクロ変数名と引き継ぎ情報の組み合わせをname:value形式で指定する。","で区切ることで同時に32個まで指定できる。
例）AJS2AA:5,AJS2BB:test
ajs_execute_date No String ジョブネットを確定実行登録する確定実行日を、YYYY-MM-DDまたはYYYY/MM/DDの形式で指定する。
ajs_execute_time No String ジョブネットを確定実行登録する確定実行時刻を、hh[:mm]※の形式で指定する。mmを省略した場合、0が仮定される。
ajs_execute_generation No String ジョブネットを確定実行登録する場合、次回以降の実行予定世代数を指定する。
ajs_execute_start_date No String ジョブネットを確定実行登録する実行期間の開始日を、YYYY-MM-DDまたはYYYY/MM/DDの形式で指定する。
ajs_execute_end_date No String ジョブネットを確定実行登録する実行期間の終了日を、YYYY-MM-DDまたはYYYY/MM/DDの形式で指定する。
※[ ]で囲まれている項目は、任意に指定できます（省略できます）。

ajs.register_fixed_execの戻り値は「（表）ajs.cancel_exec_scheduleの戻り値」と同様です。

（11）ajs.register_immediate_exec

この部品は、JP1/AJS3に登録済みのジョブネットを即時実行登録します。

ajs.register_immediate_execを使用する場合は、「（表）JP1/AJS3およびJP1/IM共通パラメータ」、「（表）JP1/AJS3共通パラメータ」、および以下に示す「（表）ajs.register_immediate_execの固有パラメータ」を設定する必要があります。

（表）ajs.register_immediate_execの固有パラメータ

パラメータ 必須 型 説明
ajs_macro_parameter No String JP1/AJS3のマクロ変数名と引き継ぎ情報の組み合わせをname:value形式で指定する。","で区切ることで同時に32個まで指定できる。
例）AJS2AA:5,AJS2BB:test

ajs.register_immediate_execの戻り値は「（表）ajs.cancel_exec_scheduleの戻り値」と同様です。

（12）ajs.register_planned_exec

この部品は、JP1/AJS3に登録済みのジョブネットを計画実行登録します。

ajs.register_planned_execを使用する場合は、「（表）JP1/AJS3およびJP1/IM共通パラメータ」、「（表）JP1/AJS3共通パラメータ」、および以下に示す「（表）ajs.register_planned_execの固有パラメータ」を設定する必要があります。

（表）ajs.register_planned_execの固有パラメータ

パラメータ 必須 型 説明
ajs_execute_prior Yes String スケジューラーサービスの停止中に実行予定日を過ぎた場合、実行のタイミングを以下で指定する。
  • true：スケジューラーサービス起動時
  • false：次回のスケジュール実行時
ajs_macro_parameter No String JP1/AJS3のマクロ変数名と引き継ぎ情報の組み合わせをname:value形式で指定する。","で区切ることで同時に32個まで指定できる。
例）AJS2AA:5,AJS2BB:test

ajs.register_planned_execの戻り値は「（表）ajs.cancel_exec_scheduleの戻り値」と同様です。

（13）ajs.rerun

この部品は、JP1/AJS3に登録済みのジョブネットまたはジョブを再実行します。

ajs.rerunを使用する場合は、「（表）JP1/AJS3およびJP1/IM共通パラメータ」、「（表）JP1/AJS3共通パラメータ」、および以下に示す「（表）ajs.rerunの固有パラメータ」を設定する必要があります。

（表）ajs.rerunの固有パラメータ

パラメータ 必須 型 説明
ajs_exec_registration_number No String 再実行するジョブネットまたはジョブの実行登録番号をYYYYMMDDNNN形式で指定する。
ajs_rerun_method No String ジョブネットまたはジョブの再実行方法を以下から指定する。
  • FromTop：ジョブネットを先頭から再実行する場合
  • FromAbnormallyJobnet：異常終了したジョブが含まれるジョブネットを先頭から再実行する場合
  • FromAfterAbnormallyJob：異常終了したジョブの次のジョブから再実行する場合
  • FromAbnormallyJob：異常終了したジョブから再実行する場合
  • OnlyWarningJob：警告検出終了しているジョブを再実行する場合
  • FromSpecifiedUnit：指定したジョブネット，またはジョブから再実行する場合
  • OnlySpecifiedUnit：指定したジョブネット，またはジョブを再実行する場合
  • FromAfterSpecifiedUnit：指定したジョブネット，またはジョブの次から再実行する場合
デフォルトは"FromAbnormallyJob"。
ajs_rerun_with_hold No String 再実行するジョブネットまたはジョブを中断するには、"true"を指定する。"true"を指定しない場合、処理は中断されずに続行される。
ajs.set_skipped_jobs_to_warning No String "true"を指定すると、先行するジョブネットまたはジョブの終了状況を警告検出に変更して異常状態で終了する。"true"を指定しない場合、処理は警告検出によって終了せず、続行される。

ajs.rerunの戻り値は「（表）ajs.cancel_exec_scheduleの戻り値」と同様です。

（14）ajs.show

この部品は、JP1/AJS3で登録済みのジョブネットまたはジョブの実行情報を取得します。

ajs.showを使用する場合は、「（表）JP1/AJS3およびJP1/IM共通パラメータ」および「（表）JP1/AJS3共通パラメータ」を設定する必要があります。

ajs.showの戻り値は「（表）ajs.cancel_exec_scheduleの戻り値」と同様です。

（15）im.apply_common_exclusion_conditions_file

この部品は、パラメータに指定した共通除外条件拡張定義ファイルを、JP1/IMに適用し監視抑止/抑止解除を行います。共通除外条件拡張定義ファイルは、Ops I提供部品のim.get_common_exclusion_conditions_fileで取得したファイルを利用できます。

im.apply_common_exclusion_conditions_fileを使用する場合は、「（表）JP1/AJS3およびJP1/IM共通パラメータ」と以下の「（表）JP1/IM共通パラメータ」を設定する必要があります。

（表）JP1/IM共通パラメータ

パラメータ 必須 型 説明
opsi_git_group_path Yes String 共通除外条件拡張定義ファイルの格納先のGitグループパスを指定する。
例） "ops-i-system-engineers"
opsi_git_repository_name Yes String 共通除外条件拡張定義ファイルの格納先のリポジトリ名を指定する。
opsi_container_name Yes String 共通除外条件拡張定義ファイルの格納先のコンテナ名を指定する。
opsi_container_item_name Yes String 共通除外条件拡張定義ファイルの格納先のコンテナアイテムフォルダ名を指定する。
opsi_directory_path Yes String 共通除外条件拡張定義ファイルの格納先のコンテナアイテムフォルダ内のディレクトリパスを指定する。なお、末尾の"/"の指定有無は問わない。
例） "jp1im_A/"
opsi_vault_backend_name Yes String キーに"opsi_token"または"opsi_domain"を設定したシークレットが登録されたSecrets Engines名を指定する。
opsi_vault_secret_path Yes String キーに"opsi_token"または"opsi_domain"を設定したシークレットが登録されたシークレットパスを指定する。
im_vault_backend_name Yes String JP1/IMのシークレット情報が保存されているシークレットバックエンドの名前を指定する。
im_vault_secret_path Yes String JP1/IMのシークレット情報が保存されているシークレットへのパスを指定する。
opsi_credential_organization No String Ops Iクレデンシャルを登録したAWXの組織を指定する。
im_credential_organization No String JP1/IMのシークレット情報を登録したAWXの組織を指定する。

im.apply_common_exclusion_conditions_fileの戻り値は「（表）ajs.cancel_exec_scheduleの戻り値」と同様です。

（16）im.get_common_exclusion_conditions_file

この部品は、JP1/IMに登録済みの共通除外条件拡張定義ファイルを取得します。

im.get_common_exclusion_conditions_fileを使用する場合は、「（表）JP1/AJS3およびJP1/IM共通パラメータ」、「（表）JP1/IM共通パラメータ」を設定する必要があります。

im.get_common_exclusion_conditions_fileの戻り値は「（表）ajs.cancel_exec_scheduleの戻り値」と同様です。

（17）im.set_common_exclusion_conditions_valid

この部品は、JP1/IMに登録済みの共通除外条件拡張定義の有効/無効を切り替えます。

im.set_common_exclusion_conditions_validを使用する場合は、「（表）JP1/AJS3およびJP1/IM共通パラメータ」、「（表）JP1/IM共通パラメータ」、および「（表）im.set_common_exclusion_conditions_validの固有パラメータ」を設定する必要があります

（表）im.set_common_exclusion_conditions_validの固有パラメータ

パラメータ 必須 型 説明
im_valid_operation Yes String 共通除外条件群を有効化する場合に"on"、無効化する場合に"off"を指定する。
im_common_exclusion_conditions_ids Yes Object "ids"キーに対して、有効化または無効化する共通除外条件群のIDを配列で指定する。
指定できる共通除外条件群のIDの範囲は0～1023です。
指定例：
im_common_exclusion_conditions_ids: { "ids": [1,2,3] }

im.set_common_exclusion_conditions_validの戻り値は「（表）ajs.cancel_exec_scheduleの戻り値」と同様です。