workflow_jobs#

usage: awx workflow_jobs [-h] action ...

positional arguments:
  action
    list
    get
    delete
    monitor

optional arguments:
  -h, --help  show this help message and exit

awx workflow_jobs: the following arguments are required: action

workflow_jobs list#

usage: awx workflow_jobs list [-h] [--all] [--order_by ORDER_BY]
                              [-f {json,yaml,jq,human}] [--filter TEXT]
                              [--conf.color BOOLEAN] [-v]
                              [--type {workflow_job}] [--created CREATED]
                              [--modified MODIFIED] [--name TEXT]
                              [--description TEXT] [--unified_job_template ID]
                              [--launch_type {manual,relaunch,callback,scheduled,dependency,workflow,webhook,sync,scm}]
                              [--status {new,pending,waiting,running,successful,failed,error,canceled}]
                              [--failed BOOLEAN] [--started STARTED]
                              [--finished FINISHED]
                              [--canceled_on CANCELED_ON] [--elapsed ELAPSED]
                              [--job_explanation TEXT] [--work_unit_id TEXT]
                              [--workflow_job_template ID]
                              [--extra_vars JSON/YAML]
                              [--allow_simultaneous BOOLEAN]
                              [--job_template ID] [--is_sliced_job BOOLEAN]
                              [--inventory ID]
                              [--webhook_service {,github,gitlab,bitbucket_dc}]
                              [--webhook_credential ID] [--webhook_guid TEXT]

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}
                        only list workflow_jobs with the specified type
  --created CREATED     only list workflow_jobs with the specified created
  --modified MODIFIED   only list workflow_jobs with the specified modified
  --name TEXT           only list workflow_jobs with the specified name
  --description TEXT    only list workflow_jobs with the specified description
  --unified_job_template ID
                        only list workflow_jobs with the specified
                        unified_job_template
  --launch_type {manual,relaunch,callback,scheduled,dependency,workflow,webhook,sync,scm}
                        only list workflow_jobs with the specified launch_type
  --status {new,pending,waiting,running,successful,failed,error,canceled}
                        only list workflow_jobs with the specified status
  --failed BOOLEAN      only list workflow_jobs with the specified failed
  --started STARTED     only list workflow_jobs with the specified started
  --finished FINISHED   only list workflow_jobs with the specified finished
  --canceled_on CANCELED_ON
                        only list workflow_jobs with the specified canceled_on
  --elapsed ELAPSED     only list workflow_jobs with the specified elapsed
  --job_explanation TEXT
                        only list workflow_jobs with the specified
                        job_explanation
  --work_unit_id TEXT   only list workflow_jobs with the specified
                        work_unit_id
  --workflow_job_template ID
                        only list workflow_jobs with the specified
                        workflow_job_template
  --extra_vars JSON/YAML
                        only list workflow_jobs with the specified extra_vars
  --allow_simultaneous BOOLEAN
                        only list workflow_jobs with the specified
                        allow_simultaneous
  --job_template ID     only list workflow_jobs with the specified
                        job_template
  --is_sliced_job BOOLEAN
                        only list workflow_jobs with the specified
                        is_sliced_job
  --inventory ID        only list workflow_jobs with the specified inventory
  --webhook_service {,github,gitlab,bitbucket_dc}
                        only list workflow_jobs with the specified
                        webhook_service
  --webhook_credential ID
                        only list workflow_jobs with the specified
                        webhook_credential
  --webhook_guid TEXT   only list workflow_jobs with the specified
                        webhook_guid

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_jobs get#

usage: awx workflow_jobs 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_jobs get: the following arguments are required: id

workflow_jobs delete#

usage: awx workflow_jobs 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_jobs delete: the following arguments are required: id

workflow_jobs monitor#

usage: awx workflow_jobs monitor [-h] id

positional arguments:
  id

optional arguments:
  -h, --help  show this help message and exit

awx workflow_jobs monitor: the following arguments are required: id