workflow_job_templates#
usage: awx workflow_job_templates [-h] action ...
positional arguments:
action
create
list
get
modify
delete
launch
associate
disassociate
optional arguments:
-h, --help show this help message and exit
awx workflow_job_templates: the following arguments are required: action
workflow_job_templates create#
usage: awx workflow_job_templates create [-h] --name TEXT [--description TEXT]
[--extra_vars JSON/YAML]
[--organization ID]
[--survey_enabled BOOLEAN]
[--allow_simultaneous BOOLEAN]
[--ask_variables_on_launch BOOLEAN]
[--inventory ID] [--limit TEXT]
[--scm_branch TEXT]
[--ask_inventory_on_launch BOOLEAN]
[--ask_credential_on_launch BOOLEAN]
[--ask_scm_branch_on_launch BOOLEAN]
[--ask_limit_on_launch BOOLEAN]
[--webhook_service {,gitflic,github,gitlab,bitbucket_dc}]
[--webhook_credential ID]
[--ask_labels_on_launch BOOLEAN]
[--ask_skip_tags_on_launch BOOLEAN]
[--ask_tags_on_launch BOOLEAN]
[--skip_tags TEXT] [--job_tags TEXT]
required arguments:
--name TEXT Name of this workflow job template.
optional arguments:
-h, --help show this help message and exit
--description TEXT Optional description of this workflow job template.
--extra_vars JSON/YAML, -e JSON/YAML
a JSON or YAML string. You can optionally specify a
file path e.g., @path/to/file.yml
--organization ID The organization used to determine access to this
template.
--survey_enabled BOOLEAN
--allow_simultaneous BOOLEAN
--ask_variables_on_launch BOOLEAN
--inventory ID Inventory applied as a prompt, assuming job template
prompts for inventory
--limit TEXT
--scm_branch TEXT
--ask_inventory_on_launch BOOLEAN
--ask_credential_on_launch BOOLEAN
--ask_scm_branch_on_launch BOOLEAN
--ask_limit_on_launch BOOLEAN
--webhook_service {,gitflic,github,gitlab,bitbucket_dc}
Service that webhook requests will be accepted from
--webhook_credential ID
Personal Access Token for posting back the status to
the service API
--ask_labels_on_launch BOOLEAN
--ask_skip_tags_on_launch BOOLEAN
--ask_tags_on_launch BOOLEAN
--skip_tags TEXT
--job_tags TEXT
awx workflow_job_templates create: the following arguments are required: --name
workflow_job_templates list#
usage: awx workflow_job_templates list [-h] [--all] [--order_by ORDER_BY]
[-f {json,yaml,jq,human}]
[--filter TEXT] [--conf.color BOOLEAN]
[-v] [--type {workflow_job_template}]
[--created CREATED]
[--modified MODIFIED] [--name TEXT]
[--description TEXT]
[--last_job_run LAST_JOB_RUN]
[--last_job_failed BOOLEAN]
[--next_job_run NEXT_JOB_RUN]
[--status {new,pending,waiting,running,successful,failed,error,canceled,never updated,ok,missing,none,updating}]
[--extra_vars JSON/YAML]
[--organization ID]
[--survey_enabled BOOLEAN]
[--allow_simultaneous BOOLEAN]
[--ask_variables_on_launch BOOLEAN]
[--inventory ID]
[--ask_inventory_on_launch BOOLEAN]
[--ask_credential_on_launch BOOLEAN]
[--ask_scm_branch_on_launch BOOLEAN]
[--ask_limit_on_launch BOOLEAN]
[--webhook_service {,gitflic,github,gitlab,bitbucket_dc}]
[--webhook_credential ID]
[--ask_labels_on_launch BOOLEAN]
[--ask_skip_tags_on_launch BOOLEAN]
[--ask_tags_on_launch BOOLEAN]
optional arguments:
-h, --help show this help message and exit
--all fetch all pages of content from the API when returning
results (instead of just the first page)
--order_by ORDER_BY order results by given field name, prefix the field
name with a dash (-) to sort in reverse eg
--order_by='-name',multiple sorting fields may be
specified by separating the field names with a comma
(,)
--type {workflow_job_template}
only list workflow_job_templates with the specified
type
--created CREATED only list workflow_job_templates with the specified
created
--modified MODIFIED only list workflow_job_templates with the specified
modified
--name TEXT only list workflow_job_templates with the specified
name
--description TEXT only list workflow_job_templates with the specified
description
--last_job_run LAST_JOB_RUN
only list workflow_job_templates with the specified
last_job_run
--last_job_failed BOOLEAN
only list workflow_job_templates with the specified
last_job_failed
--next_job_run NEXT_JOB_RUN
only list workflow_job_templates with the specified
next_job_run
--status {new,pending,waiting,running,successful,failed,error,canceled,never updated,ok,missing,none,updating}
only list workflow_job_templates with the specified
status
--extra_vars JSON/YAML, -e JSON/YAML
only list workflow_job_templates with the specified
extra_vars
--organization ID only list workflow_job_templates with the specified
organization
--survey_enabled BOOLEAN
only list workflow_job_templates with the specified
survey_enabled
--allow_simultaneous BOOLEAN
only list workflow_job_templates with the specified
allow_simultaneous
--ask_variables_on_launch BOOLEAN
only list workflow_job_templates with the specified
ask_variables_on_launch
--inventory ID only list workflow_job_templates with the specified
inventory
--ask_inventory_on_launch BOOLEAN
only list workflow_job_templates with the specified
ask_inventory_on_launch
--ask_credential_on_launch BOOLEAN
only list workflow_job_templates with the specified
ask_credential_on_launch
--ask_scm_branch_on_launch BOOLEAN
only list workflow_job_templates with the specified
ask_scm_branch_on_launch
--ask_limit_on_launch BOOLEAN
only list workflow_job_templates with the specified
ask_limit_on_launch
--webhook_service {,gitflic,github,gitlab,bitbucket_dc}
only list workflow_job_templates with the specified
webhook_service
--webhook_credential ID
only list workflow_job_templates with the specified
webhook_credential
--ask_labels_on_launch BOOLEAN
only list workflow_job_templates with the specified
ask_labels_on_launch
--ask_skip_tags_on_launch BOOLEAN
only list workflow_job_templates with the specified
ask_skip_tags_on_launch
--ask_tags_on_launch BOOLEAN
only list workflow_job_templates with the specified
ask_tags_on_launch
input/output formatting:
-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}
specify a format for the input and output
--filter TEXT specify an output filter (only valid with jq or human
format)
--conf.color BOOLEAN Display colorized output. Defaults to True
-v, --verbose print debug-level logs, including requests made
workflow_job_templates get#
usage: awx workflow_job_templates get [-h] [-f {json,yaml,jq,human}]
[--filter TEXT] [--conf.color BOOLEAN]
[-v]
id
positional arguments:
id the ID (or unique name) of the resource
optional arguments:
-h, --help show this help message and exit
input/output formatting:
-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}
specify a format for the input and output
--filter TEXT specify an output filter (only valid with jq or human
format)
--conf.color BOOLEAN Display colorized output. Defaults to True
-v, --verbose print debug-level logs, including requests made
awx workflow_job_templates get: the following arguments are required: id
workflow_job_templates modify#
usage: awx workflow_job_templates modify [-h] id
positional arguments:
id the ID (or unique name) of the resource
optional arguments:
-h, --help show this help message and exit
awx workflow_job_templates modify: the following arguments are required: id
workflow_job_templates delete#
usage: awx workflow_job_templates delete [-h] id
positional arguments:
id the ID (or unique name) of the resource
optional arguments:
-h, --help show this help message and exit
awx workflow_job_templates delete: the following arguments are required: id
workflow_job_templates launch#
usage: awx workflow_job_templates launch [-h] [--monitor]
[--action-timeout ACTION_TIMEOUT]
[--wait] [--interval INTERVAL]
[--extra_vars JSON/YAML]
[--inventory ID] [--limit TEXT]
[--scm_branch TEXT] [--labels LABELS]
[--credentials [ID, ID, ...]]
[--skip_tags TEXT] [--job_tags TEXT]
id
positional arguments:
id
optional arguments:
-h, --help show this help message and exit
--monitor If set, prints stdout of the launched job until it
finishes.
--action-timeout ACTION_TIMEOUT
If set with --monitor or --wait, time out waiting on
job completion.
--wait If set, waits until the launched job finishes.
--interval INTERVAL If set with --monitor or --wait, amount of time to
wait in seconds between api calls. Minimum value is
2.5 seconds to avoid overwhelming the api
--extra_vars JSON/YAML, -e JSON/YAML
a JSON or YAML string. You can optionally specify a
file path e.g., @path/to/file.yml
--inventory ID the ID of the associated inventory
--limit TEXT
--scm_branch TEXT
--labels LABELS
--credentials [ID, ID, ...]
a list of comma-delimited credentials to associate
(IDs or unique names)
--skip_tags TEXT
--job_tags TEXT
awx workflow_job_templates launch: the following arguments are required: id
workflow_job_templates associate#
usage: awx workflow_job_templates associate [-h]
(--start_notification | --success_notification | --failure_notification | --approval_notification )
id
positional arguments:
id
optional arguments:
-h, --help show this help message and exit
--start_notification
The ID (or name) of the notification_template to
associate
--success_notification
The ID (or name) of the notification_template to
associate
--failure_notification
The ID (or name) of the notification_template to
associate
--approval_notification
The ID (or name) of the notification_template to
associate
awx workflow_job_templates associate: the following arguments are required: id
workflow_job_templates disassociate#
usage: awx workflow_job_templates disassociate [-h]
(--start_notification | --success_notification | --failure_notification | --approval_notification )
id
positional arguments:
id
optional arguments:
-h, --help show this help message and exit
--start_notification
The ID (or name) of the notification_template to
disassociate
--success_notification
The ID (or name) of the notification_template to
disassociate
--failure_notification
The ID (or name) of the notification_template to
disassociate
--approval_notification
The ID (or name) of the notification_template to
disassociate
awx workflow_job_templates disassociate: the following arguments are required: id