jobs#

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

positional arguments:
  action
    list
    get
    delete
    stdout
    monitor

options:
  -h, --help  show this help message and exit

awx jobs: the following arguments are required: action

jobs list#

usage: awx jobs list [-h] [--all] [--order_by ORDER_BY] [-f {json,yaml,jq,human}] [--filter TEXT] [--conf.color BOOLEAN] [-v] [--type {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}] [--execution_environment ID] [--failed BOOLEAN] [--started STARTED]
                     [--finished FINISHED] [--canceled_on CANCELED_ON] [--elapsed ELAPSED] [--job_explanation TEXT] [--execution_node TEXT] [--controller_node TEXT]
                     [--work_unit_id TEXT] [--job_type {run,check,scan}] [--inventory ID] [--project ID] [--playbook TEXT] [--scm_branch TEXT] [--forks INTEGER]
                     [--limit TEXT] [--verbosity {0,1,2,3,4,5}] [--extra_vars JSON/YAML] [--job_tags TEXT] [--force_handlers BOOLEAN] [--skip_tags TEXT]
                     [--start_at_task TEXT] [--timeout INTEGER] [--use_fact_cache BOOLEAN] [--organization ID] [--job_template ID] [--allow_simultaneous BOOLEAN]
                     [--artifacts JSON/YAML] [--scm_revision TEXT] [--instance_group ID] [--diff_mode BOOLEAN] [--job_slice_number INTEGER]
                     [--job_slice_count INTEGER] [--webhook_service {,gitflic,github,gitlab,bitbucket_dc}] [--webhook_credential ID] [--webhook_guid TEXT]

options:
  -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 {job}          only list jobs with the specified type
  --created CREATED     only list jobs with the specified created
  --modified MODIFIED   only list jobs with the specified modified
  --name TEXT           only list jobs with the specified name
  --description TEXT    only list jobs with the specified description
  --unified_job_template ID
                        only list jobs with the specified unified_job_template
  --launch_type {manual,relaunch,callback,scheduled,dependency,workflow,webhook,sync,scm}
                        only list jobs with the specified launch_type
  --status {new,pending,waiting,running,successful,failed,error,canceled}
                        only list jobs with the specified status
  --execution_environment ID
                        only list jobs with the specified execution_environment
  --failed BOOLEAN      only list jobs with the specified failed
  --started STARTED     only list jobs with the specified started
  --finished FINISHED   only list jobs with the specified finished
  --canceled_on CANCELED_ON
                        only list jobs with the specified canceled_on
  --elapsed ELAPSED     only list jobs with the specified elapsed
  --job_explanation TEXT
                        only list jobs with the specified job_explanation
  --execution_node TEXT
                        only list jobs with the specified execution_node
  --controller_node TEXT
                        only list jobs with the specified controller_node
  --work_unit_id TEXT   only list jobs with the specified work_unit_id
  --job_type {run,check,scan}
                        only list jobs with the specified job_type
  --inventory ID        only list jobs with the specified inventory
  --project ID          only list jobs with the specified project
  --playbook TEXT       only list jobs with the specified playbook
  --scm_branch TEXT     only list jobs with the specified scm_branch
  --forks INTEGER       only list jobs with the specified forks
  --limit TEXT          only list jobs with the specified limit
  --verbosity {0,1,2,3,4,5}
                        only list jobs with the specified verbosity
  --extra_vars JSON/YAML
                        only list jobs with the specified extra_vars
  --job_tags TEXT       only list jobs with the specified job_tags
  --force_handlers BOOLEAN
                        only list jobs with the specified force_handlers
  --skip_tags TEXT      only list jobs with the specified skip_tags
  --start_at_task TEXT  only list jobs with the specified start_at_task
  --timeout INTEGER     only list jobs with the specified timeout
  --use_fact_cache BOOLEAN
                        only list jobs with the specified use_fact_cache
  --organization ID     only list jobs with the specified organization
  --job_template ID     only list jobs with the specified job_template
  --allow_simultaneous BOOLEAN
                        only list jobs with the specified allow_simultaneous
  --artifacts JSON/YAML
                        only list jobs with the specified artifacts
  --scm_revision TEXT   only list jobs with the specified scm_revision
  --instance_group ID   only list jobs with the specified instance_group
  --diff_mode BOOLEAN   only list jobs with the specified diff_mode
  --job_slice_number INTEGER
                        only list jobs with the specified job_slice_number
  --job_slice_count INTEGER
                        only list jobs with the specified job_slice_count
  --webhook_service {,gitflic,github,gitlab,bitbucket_dc}
                        only list jobs with the specified webhook_service
  --webhook_credential ID
                        only list jobs with the specified webhook_credential
  --webhook_guid TEXT   only list 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

jobs get#

usage: awx 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

options:
  -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 jobs get: the following arguments are required: id

jobs delete#

usage: awx jobs delete [-h] id

positional arguments:
  id          the ID (or unique name) of the resource

options:
  -h, --help  show this help message and exit

awx jobs delete: the following arguments are required: id

jobs stdout#

usage: awx jobs stdout [-h] id

positional arguments:
  id

options:
  -h, --help  show this help message and exit

awx jobs stdout: the following arguments are required: id

jobs monitor#

usage: awx jobs monitor [-h] id

positional arguments:
  id

options:
  -h, --help  show this help message and exit

awx jobs monitor: the following arguments are required: id