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

機械翻訳について

ジョブ・テンプレートの更新

patch

/api/v2/job_templates/{id}/

このリソースに対してPUTまたはPATCHリクエストを行って、このジョブ・テンプレートを更新します。次のフィールドを変更できます。

name: このジョブ・テンプレートの名前。(文字列、必須)
description: このジョブ・テンプレートのオプションの説明。(文字列、デフォルト="")
job_type: (選択)
- run: 実行(デフォルト)
- check: チェック
inventory: (id、デフォルト=``)
project: (id、デフォルト=``)
playbook: (文字列、デフォルト="")
scm_branch: ジョブ実行で使用するブランチ。空白の場合に使用されるプロジェクトのデフォルト。プロジェクトのallow_overrideフィールドがtrueに設定されている場合にのみ許可されます。(文字列、デフォルト="")
forks: (整数、デフォルト=0)
limit: (文字列、デフォルト="")
verbosity: (選択)
- 0: 0 (標準) (デフォルト)
- 1: 1 (詳細)
- 2: 2 (より詳細)
- 3: 3 (デバッグ)
- 4: 4 (接続デバッグ)
- 5: 5 (WinRMデバッグ)
extra_vars: (json、デフォルト=``)
job_tags: (文字列、デフォルト="")
force_handlers: (ブール、デフォルト=False)
skip_tags: (文字列、デフォルト="")
start_at_task: (文字列、デフォルト="")
timeout: タスクが取り消されるまでの実行時間(秒)。(整数、デフォルト=0)
use_fact_cache: 有効にすると、TowerはAnsibleファクト・キャッシュ・プラグインとして機能します。プレイブック実行の終了時にファクトをデータベースに永続化し、Ansibleで使用できるようにファクトをキャッシュします。(ブール、デフォルト=False)
host_config_key: (文字列、デフォルト="")
ask_scm_branch_on_launch: (ブール、デフォルト=False)
ask_diff_mode_on_launch: (ブール、デフォルト=False)
ask_variables_on_launch: (ブール、デフォルト=False)
ask_limit_on_launch: (ブール、デフォルト=False)
ask_tags_on_launch: (ブール、デフォルト=False)
ask_skip_tags_on_launch: (ブール、デフォルト=False)
ask_job_type_on_launch: (ブール、デフォルト=False)
ask_verbosity_on_launch: (ブール、デフォルト=False)
ask_inventory_on_launch: (ブール、デフォルト=False)
ask_credential_on_launch: (ブール、デフォルト=False)
survey_enabled: (ブール、デフォルト=False)
become_enabled: (ブール、デフォルト=False)
diff_mode: 有効にすると、ホスト上のテンプレート化されたファイルに加えられたテキストの変更が標準出力に表示されます(ブール、デフォルト=False)
allow_simultaneous: (ブール、デフォルト=False)
custom_virtualenv: 使用するカスタムPython virtualenvを含むローカルの絶対ファイル・パス(文字列、デフォルト="")
job_slice_count: 実行時にスライスするジョブの数。値が1より大きい場合は、ジョブ・テンプレートによってワークフローが起動されます。(整数、デフォルト=1)
webhook_service: Webフック・リクエストを受け入れるサービス(選択)
- "": ---------
- github: GitHub
- gitlab: GitLab
webhook_credential: サービスAPIにステータスをポスト・バックするための個人アクセス・トークン(id、デフォルト=``)

PATCHリクエストの場合は、変更中のフィールドのみを含めます。

リクエスト

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

application/json

パス・パラメータ

id: 文字列

問合せパラメータ

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

検索条件。

ルート・スキーマ : schema

例:

{
    "allow_simultaneous":false,
    "ask_credential_on_launch":false,
    "ask_diff_mode_on_launch":false,
    "ask_inventory_on_launch":true,
    "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,
    "become_enabled":false,
    "created":"2018-02-01T08:00:00.000000Z",
    "custom_virtualenv":null,
    "description":"",
    "diff_mode":false,
    "extra_vars":"",
    "force_handlers":false,
    "forks":0,
    "host_config_key":"",
    "id":3,
    "inventory":null,
    "job_slice_count":1,
    "job_tags":"",
    "job_type":"run",
    "last_job_failed":false,
    "last_job_run":null,
    "limit":"",
    "modified":"2018-02-01T08:00:00.000000Z",
    "name":"fooo",
    "next_job_run":null,
    "organization":1,
    "playbook":"helloworld.yml",
    "project":2,
    "related":{
        "access_list":"/api/v2/job_templates/3/access_list/",
        "activity_stream":"/api/v2/job_templates/3/activity_stream/",
        "copy":"/api/v2/job_templates/3/copy/",
        "credentials":"/api/v2/job_templates/3/credentials/",
        "instance_groups":"/api/v2/job_templates/3/instance_groups/",
        "jobs":"/api/v2/job_templates/3/jobs/",
        "labels":"/api/v2/job_templates/3/labels/",
        "launch":"/api/v2/job_templates/3/launch/",
        "notification_templates_error":"/api/v2/job_templates/3/notification_templates_error/",
        "notification_templates_started":"/api/v2/job_templates/3/notification_templates_started/",
        "notification_templates_success":"/api/v2/job_templates/3/notification_templates_success/",
        "object_roles":"/api/v2/job_templates/3/object_roles/",
        "organization":"/api/v2/organizations/1/",
        "project":"/api/v2/projects/1/",
        "schedules":"/api/v2/job_templates/3/schedules/",
        "slice_workflow_jobs":"/api/v2/job_templates/3/slice_workflow_jobs/",
        "survey_spec":"/api/v2/job_templates/3/survey_spec/",
        "webhook_key":"/api/v2/job_templates/3/webhook_key/",
        "webhook_receiver":""
    },
    "scm_branch":"",
    "skip_tags":"",
    "start_at_task":"",
    "status":"never updated",
    "summary_fields":{
        "credentials":[
        ],
        "labels":{
            "count":0,
            "results":[
            ]
        },
        "object_roles":{
            "admin_role":{
                "description":"Can manage all aspects of the job template",
                "id":35,
                "name":"Admin"
            },
            "execute_role":{
                "description":"May run the job template",
                "id":36,
                "name":"Execute"
            },
            "read_role":{
                "description":"May view settings for the job template",
                "id":37,
                "name":"Read"
            }
        },
        "organization":{
            "description":"",
            "id":1,
            "name":"foo1"
        },
        "project":{
            "description":"",
            "id":1,
            "name":"proj1",
            "scm_type":"git",
            "status":"pending"
        },
        "recent_jobs":[
        ],
        "user_capabilities":{
            "copy":true,
            "delete":true,
            "edit":true,
            "schedule":true,
            "start":true
        }
    },
    "survey_enabled":false,
    "timeout":0,
    "type":"job_template",
    "url":"/api/v2/job_templates/3/",
    "use_fact_cache":false,
    "verbosity":0,
    "webhook_credential":null,
    "webhook_service":""
}

先頭に戻る

レスポンス

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

application/json

200レスポンス

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

{
    "allow_simultaneous":false,
    "ask_credential_on_launch":false,
    "ask_diff_mode_on_launch":false,
    "ask_inventory_on_launch":true,
    "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,
    "become_enabled":false,
    "created":"2018-02-01T08:00:00.000000Z",
    "custom_virtualenv":null,
    "description":"",
    "diff_mode":false,
    "extra_vars":"",
    "force_handlers":false,
    "forks":0,
    "host_config_key":"",
    "id":3,
    "inventory":null,
    "job_slice_count":1,
    "job_tags":"",
    "job_type":"run",
    "last_job_failed":false,
    "last_job_run":null,
    "limit":"",
    "modified":"2018-02-01T08:00:00.000000Z",
    "name":"fooo",
    "next_job_run":null,
    "organization":2,
    "playbook":"helloworld.yml",
    "project":2,
    "related":{
        "access_list":"/api/v2/job_templates/3/access_list/",
        "activity_stream":"/api/v2/job_templates/3/activity_stream/",
        "copy":"/api/v2/job_templates/3/copy/",
        "credentials":"/api/v2/job_templates/3/credentials/",
        "instance_groups":"/api/v2/job_templates/3/instance_groups/",
        "jobs":"/api/v2/job_templates/3/jobs/",
        "labels":"/api/v2/job_templates/3/labels/",
        "launch":"/api/v2/job_templates/3/launch/",
        "notification_templates_error":"/api/v2/job_templates/3/notification_templates_error/",
        "notification_templates_started":"/api/v2/job_templates/3/notification_templates_started/",
        "notification_templates_success":"/api/v2/job_templates/3/notification_templates_success/",
        "object_roles":"/api/v2/job_templates/3/object_roles/",
        "organization":"/api/v2/organizations/2/",
        "project":"/api/v2/projects/2/",
        "schedules":"/api/v2/job_templates/3/schedules/",
        "slice_workflow_jobs":"/api/v2/job_templates/3/slice_workflow_jobs/",
        "survey_spec":"/api/v2/job_templates/3/survey_spec/",
        "webhook_key":"/api/v2/job_templates/3/webhook_key/",
        "webhook_receiver":""
    },
    "scm_branch":"",
    "skip_tags":"",
    "start_at_task":"",
    "status":"never updated",
    "summary_fields":{
        "credentials":[
        ],
        "labels":{
            "count":0,
            "results":[
            ]
        },
        "object_roles":{
            "admin_role":{
                "description":"Can manage all aspects of the job template",
                "id":35,
                "name":"Admin"
            },
            "execute_role":{
                "description":"May run the job template",
                "id":36,
                "name":"Execute"
            },
            "read_role":{
                "description":"May view settings for the job template",
                "id":37,
                "name":"Read"
            }
        },
        "organization":{
            "description":"",
            "id":2,
            "name":"foo2"
        },
        "project":{
            "description":"",
            "id":2,
            "name":"proj2",
            "scm_type":"git",
            "status":"pending"
        },
        "recent_jobs":[
        ],
        "user_capabilities":{
            "copy":true,
            "delete":true,
            "edit":true,
            "schedule":true,
            "start":true
        }
    },
    "survey_enabled":false,
    "timeout":0,
    "type":"job_template",
    "url":"/api/v2/job_templates/3/",
    "use_fact_cache":false,
    "verbosity":0,
    "webhook_credential":null,
    "webhook_service":""
}

400レスポンス

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

{
    "webhook_credential":[
        "Must match the selected webhook service."
    ]
}

403レスポンス

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

{
    "detail":"You do not have permission to perform this action."
}

先頭に戻る