schedules#
usage: awx schedules [-h] action ...
positional arguments:
action
list
create
get
modify
delete
optional arguments:
-h, --help show this help message and exit
awx schedules: the following arguments are required: action
schedules list#
usage: awx schedules list [-h] [--all] [--order_by ORDER_BY]
[-f {json,yaml,jq,human}] [--filter TEXT]
[--conf.color BOOLEAN] [-v] [--rrule TEXT]
[--type {schedule}] [--created CREATED]
[--modified MODIFIED] [--name TEXT]
[--description TEXT] [--extra_data JSON/YAML]
[--inventory ID] [--execution_environment ID]
[--unified_job_template ID] [--enabled BOOLEAN]
[--dtstart DTSTART] [--dtend DTEND]
[--next_run NEXT_RUN]
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
(,)
--rrule TEXT only list schedules with the specified rrule
--type {schedule} only list schedules with the specified type
--created CREATED only list schedules with the specified created
--modified MODIFIED only list schedules with the specified modified
--name TEXT only list schedules with the specified name
--description TEXT only list schedules with the specified description
--extra_data JSON/YAML
only list schedules with the specified extra_data
--inventory ID only list schedules with the specified inventory
--execution_environment ID
only list schedules with the specified
execution_environment
--unified_job_template ID
only list schedules with the specified
unified_job_template
--enabled BOOLEAN only list schedules with the specified enabled
--dtstart DTSTART only list schedules with the specified dtstart
--dtend DTEND only list schedules with the specified dtend
--next_run NEXT_RUN only list schedules with the specified next_run
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
schedules create#
usage: awx schedules create [-h] --rrule TEXT --name TEXT [--description TEXT]
[--extra_data JSON/YAML] [--inventory ID]
[--scm_branch TEXT] [--job_type {None,,run,check}]
[--job_tags TEXT] [--skip_tags TEXT]
[--limit TEXT] [--diff_mode BOOLEAN]
[--verbosity {None,0,1,2,3,4,5}]
[--execution_environment ID] [--forks INTEGER]
[--job_slice_count INTEGER] [--timeout INTEGER]
--unified_job_template ID [--enabled BOOLEAN]
required arguments:
--rrule TEXT A value representing the schedules iCal recurrence
rule.
--name TEXT Name of this schedule.
--unified_job_template ID
the ID of the associated unified_job_template
optional arguments:
-h, --help show this help message and exit
--description TEXT Optional description of this schedule.
--extra_data JSON/YAML
a JSON or YAML string. You can optionally specify a
file path e.g., @path/to/file.yml
--inventory ID Inventory applied as a prompt, assuming job template
prompts for inventory
--scm_branch TEXT
--job_type {None,,run,check}
--job_tags TEXT
--skip_tags TEXT
--limit TEXT
--diff_mode BOOLEAN
--verbosity {None,0,1,2,3,4,5}
--execution_environment ID
The container image to be used for execution.
--forks INTEGER
--job_slice_count INTEGER
--timeout INTEGER
--enabled BOOLEAN Enables processing of this schedule.
awx schedules create: the following arguments are required: --rrule, --name, --unified_job_template
schedules get#
usage: awx schedules 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 schedules get: the following arguments are required: id
schedules modify#
usage: awx schedules 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 schedules modify: the following arguments are required: id
schedules delete#
usage: awx schedules 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 schedules delete: the following arguments are required: id