system_jobs

system_jobs#

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

positional arguments:
  action
    list
    get
    delete

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

awx system_jobs: the following arguments are required: action

system_jobs list#

usage: awx system_jobs list [-h] [--all] [--order_by ORDER_BY]
                            [-f {json,yaml,jq,human}] [--filter TEXT]
                            [--conf.color BOOLEAN] [-v] [--type {system_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]
                            [--work_unit_id TEXT] [--system_job_template ID]
                            [--job_type {,cleanup_jobs,cleanup_activitystream,cleanup_sessions,cleanup_tokens}]
                            [--extra_vars 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 {system_job}   only list system_jobs with the specified type
  --created CREATED     only list system_jobs with the specified created
  --modified MODIFIED   only list system_jobs with the specified modified
  --name TEXT           only list system_jobs with the specified name
  --description TEXT    only list system_jobs with the specified description
  --unified_job_template ID
                        only list system_jobs with the specified
                        unified_job_template
  --launch_type {manual,relaunch,callback,scheduled,dependency,workflow,webhook,sync,scm}
                        only list system_jobs with the specified launch_type
  --status {new,pending,waiting,running,successful,failed,error,canceled}
                        only list system_jobs with the specified status
  --execution_environment ID
                        only list system_jobs with the specified
                        execution_environment
  --failed BOOLEAN      only list system_jobs with the specified failed
  --started STARTED     only list system_jobs with the specified started
  --finished FINISHED   only list system_jobs with the specified finished
  --canceled_on CANCELED_ON
                        only list system_jobs with the specified canceled_on
  --elapsed ELAPSED     only list system_jobs with the specified elapsed
  --job_explanation TEXT
                        only list system_jobs with the specified
                        job_explanation
  --execution_node TEXT
                        only list system_jobs with the specified
                        execution_node
  --work_unit_id TEXT   only list system_jobs with the specified work_unit_id
  --system_job_template ID
                        only list system_jobs with the specified
                        system_job_template
  --job_type {,cleanup_jobs,cleanup_activitystream,cleanup_sessions,cleanup_tokens}
                        only list system_jobs with the specified job_type
  --extra_vars TEXT     only list system_jobs with the specified extra_vars

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

system_jobs get#

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

system_jobs delete#

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