Oracle Linux Automation Manager CLIおよびAPIリファレンス・ガイド

ジョブ・テンプレートの起動

get

/api/v2/job_templates/{id}/launch/

このリソースに対してGETリクエストを行って、job_templateを起動できるかどうか、およびjob_templateを起動するためにパスワードが必要かどうかを判断します。レスポンスには次のフィールドが含まれます。

ask_variables_on_launch: 起動時に変数の指定を求めるようにjob_templateが構成されているかどうかを示すフラグ(ブール、読取り専用)
ask_tags_on_launch: 起動時にタグの指定を求めるようにjob_templateが構成されているかどうかを示すフラグ(ブール、読取り専用)
ask_skip_tags_on_launch: 起動時にskip_tagsの指定を求めるようにjob_templateが構成されているかどうかを示すフラグ(ブール、読取り専用)
ask_job_type_on_launch: 起動時にjob_typeの指定を求めるようにjob_templateが構成されているかどうかを示すフラグ(ブール、読取り専用)
ask_limit_on_launch: 起動時に制限の指定を求めるようにjob_templateが構成されているかどうかを示すフラグ(ブール、読取り専用)
ask_inventory_on_launch: 起動時にインベントリの指定を求めるようにjob_templateが構成されているかどうかを示すフラグ(ブール、読取り専用)
ask_credential_on_launch: 起動時に資格証明の指定を求めるようにjob_templateが構成されているかどうかを示すフラグ(ブール、読取り専用)
can_start_without_user_input: ユーザー入力なしでjob_templateを起動できるかどうかを示すフラグ(ブール、読取り専用)
passwords_needed_to_start: job_templateを起動するために必要なパスワード名(配列、読取り専用)
variables_needed_to_start: job_templateを起動するために必要な必須変数名(配列、読取り専用)
survey_enabled: 有効なサーベイがjob_templateにあるかどうかを示すフラグ(ブール、読取り専用)
inventory_needed_to_start: ジョブ・テンプレートに関連付けられたインベントリが存在することを示すフラグ。ない場合は、ジョブの起動時に指定する必要があります(ブール、読取り専用)

job_templateを起動するには、このリソースに対してPOSTリクエストを行います。パスワード、インベントリまたは追加変数(extra_vars)が必要な場合は、extra_varsをYAMLまたはJSON文字列として指定し、カッコをエスケープして、POSTデータで渡す必要があります。 inventory_needed_to_startがTrueの場合は、inventoryが必要です。

成功した場合、レスポンス・ステータス・コードは201になります。必要なパスワードが指定されていない場合は、400ステータス・コードが返されます。ジョブを起動できない場合は、405ステータス・コードが返されます。指定された資格証明またはインベントリの使用をユーザーが許可されていない場合は、403ステータス・コードが返されます。

リクエスト

サポートされているメディア・タイプ

application/json

パス・パラメータ

id: 文字列

問合せパラメータ

search(オプション): 文字列

検索条件。

先頭に戻る

レスポンス

サポートされているメディア・タイプ

application/json

200レスポンス

レスポンスの例(application/json)

{
    "ask_credential_on_launch":false,
    "ask_diff_mode_on_launch":false,
    "ask_inventory_on_launch":false,
    "ask_job_type_on_launch":false,
    "ask_limit_on_launch":false,
    "ask_scm_branch_on_launch":false,
    "ask_skip_tags_on_launch":false,
    "ask_tags_on_launch":false,
    "ask_variables_on_launch":false,
    "ask_verbosity_on_launch":false,
    "can_start_without_user_input":false,
    "credential_needed_to_start":false,
    "defaults":{
        "credentials":[
            {
                "credential_type":2,
                "id":4,
                "name":"Vault #1",
                "passwords_needed":[
                    "vault_password.abc"
                ],
                "vault_id":"abc"
            },
            {
                "credential_type":2,
                "id":5,
                "name":"Vault #2",
                "passwords_needed":[
                    "vault_password.xyz"
                ],
                "vault_id":"xyz"
            },
            {
                "credential_type":3,
                "id":3,
                "name":"test-cred",
                "passwords_needed":[
                ]
            }
        ],
        "diff_mode":false,
        "extra_vars":"",
        "inventory":{
            "id":1,
            "name":"test-inv"
        },
        "job_tags":"",
        "job_type":"run",
        "limit":"",
        "scm_branch":"",
        "skip_tags":"",
        "verbosity":0
    },
    "inventory_needed_to_start":false,
    "job_template_data":{
        "description":"",
        "id":2,
        "name":"deploy-job-template"
    },
    "passwords_needed_to_start":[
        "vault_password.abc",
        "vault_password.xyz"
    ],
    "survey_enabled":false,
    "variables_needed_to_start":[
    ]
}

先頭に戻る