Create a Job Template for an Organization
post
/api/v2/organizations/{id}/job_templates/
Make a POST request to this resource with the following job template fields to create a new job template associated with this organization.
name
: Name of this job template. (string, required)description
: Optional description of this job template. (string, default=""
)job_type
: (choice)run
: Run (default)check
: Check
inventory
: (id, default=``)project
: (id, default=``)playbook
: (string, default=""
)scm_branch
: Branch to use in job run. Project default used if blank. Only allowed if project allow_override field is set to true. (string, default=""
)forks
: (integer, default=0
)limit
: (string, default=""
)verbosity
: (choice)0
: 0 (Normal) (default)1
: 1 (Verbose)2
: 2 (More Verbose)3
: 3 (Debug)4
: 4 (Connection Debug)5
: 5 (WinRM Debug)
extra_vars
: (json, default=``)job_tags
: (string, default=""
)force_handlers
: (boolean, default=False
)skip_tags
: (string, default=""
)start_at_task
: (string, default=""
)timeout
: The amount of time (in seconds) to run before the task is canceled. (integer, default=0
)-
use_fact_cache
: If enabled, Tower will act as an Ansible Fact Cache Plugin; persisting facts at the end of a playbook run to the database and caching facts for use by Ansible. (boolean, default=False
) -
host_config_key
: (string, default=""
) ask_scm_branch_on_launch
: (boolean, default=False
)ask_diff_mode_on_launch
: (boolean, default=False
)ask_variables_on_launch
: (boolean, default=False
)ask_limit_on_launch
: (boolean, default=False
)ask_tags_on_launch
: (boolean, default=False
)ask_skip_tags_on_launch
: (boolean, default=False
)ask_job_type_on_launch
: (boolean, default=False
)ask_verbosity_on_launch
: (boolean, default=False
)ask_inventory_on_launch
: (boolean, default=False
)ask_credential_on_launch
: (boolean, default=False
)survey_enabled
: (boolean, default=False
)become_enabled
: (boolean, default=False
)diff_mode
: If enabled, textual changes made to any templated files on the host are shown in the standard output (boolean, default=False
)allow_simultaneous
: (boolean, default=False
)custom_virtualenv
: Local absolute file path containing a custom Python virtualenv to use (string, default=""
)job_slice_count
: The number of jobs to slice into at runtime. Will cause the Job Template to launch a workflow if value is greater than 1. (integer, default=1
)webhook_service
: Service that webhook requests will be accepted from (choice)""
: ---------github
: GitHubgitlab
: GitLab
webhook_credential
: Personal Access Token for posting back the status to the service API (id, default=``)
Request
Supported Media Types
- application/json
Path Parameters
Root Schema : schema
Type:
Show Source
object
-
allow_simultaneous(optional):
boolean
-
ask_credential_on_launch(optional):
boolean
-
ask_diff_mode_on_launch(optional):
boolean
-
ask_inventory_on_launch(optional):
boolean
-
ask_job_type_on_launch(optional):
boolean
-
ask_limit_on_launch(optional):
boolean
-
ask_scm_branch_on_launch(optional):
boolean
-
ask_skip_tags_on_launch(optional):
boolean
-
ask_tags_on_launch(optional):
boolean
-
ask_variables_on_launch(optional):
boolean
-
ask_verbosity_on_launch(optional):
boolean
-
become_enabled(optional):
boolean
-
custom_virtualenv(optional):
string
Local absolute file path containing a custom Python virtualenv to use
-
description(optional):
string
-
diff_mode(optional):
boolean
If enabled, textual changes made to any templated files on the host are shown in the standard output
-
extra_vars(optional):
string
-
force_handlers(optional):
boolean
-
forks(optional):
integer
-
host_config_key(optional):
string
-
inventory(optional):
integer
-
job_slice_count(optional):
integer
The number of jobs to slice into at runtime. Will cause the Job Template to launch a workflow if value is greater than 1.
-
job_tags(optional):
string
-
job_type(optional):
string
-
limit(optional):
string
-
name:
string
-
playbook(optional):
string
-
project(optional):
string
-
scm_branch(optional):
string
Branch to use in job run. Project default used if blank. Only allowed if project allow_override field is set to true.
-
skip_tags(optional):
string
-
start_at_task(optional):
string
-
survey_enabled(optional):
boolean
-
timeout(optional):
integer
The amount of time (in seconds) to run before the task is canceled.
-
use_fact_cache(optional):
boolean
If enabled, Tower will act as an Ansible Fact Cache Plugin; persisting facts at the end of a playbook run to the database and caching facts for use by Ansible.
-
verbosity(optional):
string
-
webhook_credential(optional):
integer
Personal Access Token for posting back the status to the service API
-
webhook_service(optional):
string
Service that webhook requests will be accepted from