projects#
usage: awx projects [-h] action ...
positional arguments:
action
create
list
get
modify
delete
update
associate
disassociate
optional arguments:
-h, --help show this help message and exit
awx projects: the following arguments are required: action
projects create#
usage: awx projects create [-h] [--monitor] [--wait] --name TEXT
[--description TEXT] [--local_path TEXT]
[--scm_type {,git,svn,insights,archive}]
[--scm_url TEXT] [--scm_branch TEXT]
[--scm_refspec TEXT] [--scm_clean BOOLEAN]
[--scm_track_submodules BOOLEAN]
[--scm_delete_on_update BOOLEAN] [--credential ID]
[--timeout INTEGER] [--organization ID]
[--scm_update_on_launch BOOLEAN]
[--scm_update_cache_timeout INTEGER]
[--allow_override BOOLEAN]
[--default_environment ID]
[--signature_validation_credential ID]
required arguments:
--name TEXT Name of this project.
optional arguments:
-h, --help show this help message and exit
--monitor If set, prints stdout of the project update until it
finishes.
--wait If set, waits until the new project has updated.
--description TEXT Optional description of this project.
--local_path TEXT Local path (relative to PROJECTS_ROOT) containing
playbooks and related files for this project.
--scm_type {,git,svn,insights,archive}
Specifies the source control system used to store the
project.
--scm_url TEXT The location where the project is stored.
--scm_branch TEXT Specific branch, tag or commit to checkout.
--scm_refspec TEXT For git projects, an additional refspec to fetch.
--scm_clean BOOLEAN Discard any local changes before syncing the project.
--scm_track_submodules BOOLEAN
Track submodules latest commits on defined branch.
--scm_delete_on_update BOOLEAN
Delete the project before syncing.
--credential ID the ID of the associated credential
--timeout INTEGER The amount of time (in seconds) to run before the task
is canceled.
--organization ID The organization used to determine access to this
template.
--scm_update_on_launch BOOLEAN
Update the project when a job is launched that uses
the project.
--scm_update_cache_timeout INTEGER
The number of seconds after the last project update
ran that a new project update will be launched as a
job dependency.
--allow_override BOOLEAN
Allow changing the SCM branch or revision in a job
template that uses this project.
--default_environment ID
The default execution environment for jobs run using
this project.
--signature_validation_credential ID
An optional credential used for validating files in
the project against unexpected changes.
awx projects create: the following arguments are required: --name
projects list#
usage: awx projects list [-h] [--all] [--order_by ORDER_BY]
[-f {json,yaml,jq,human}] [--filter TEXT]
[--conf.color BOOLEAN] [-v] [--type {project}]
[--created CREATED] [--modified MODIFIED]
[--name TEXT] [--description TEXT]
[--local_path TEXT]
[--scm_type {,git,svn,insights,archive}]
[--scm_url TEXT] [--scm_branch TEXT]
[--scm_refspec TEXT] [--scm_clean BOOLEAN]
[--scm_track_submodules BOOLEAN]
[--scm_delete_on_update BOOLEAN] [--credential ID]
[--timeout INTEGER] [--scm_revision 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}]
[--organization ID] [--scm_update_on_launch BOOLEAN]
[--scm_update_cache_timeout INTEGER]
[--allow_override BOOLEAN] [--custom_virtualenv TEXT]
[--default_environment ID]
[--signature_validation_credential ID]
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 {project} only list projects with the specified type
--created CREATED only list projects with the specified created
--modified MODIFIED only list projects with the specified modified
--name TEXT only list projects with the specified name
--description TEXT only list projects with the specified description
--local_path TEXT only list projects with the specified local_path
--scm_type {,git,svn,insights,archive}
only list projects with the specified scm_type
--scm_url TEXT only list projects with the specified scm_url
--scm_branch TEXT only list projects with the specified scm_branch
--scm_refspec TEXT only list projects with the specified scm_refspec
--scm_clean BOOLEAN only list projects with the specified scm_clean
--scm_track_submodules BOOLEAN
only list projects with the specified
scm_track_submodules
--scm_delete_on_update BOOLEAN
only list projects with the specified
scm_delete_on_update
--credential ID only list projects with the specified credential
--timeout INTEGER only list projects with the specified timeout
--scm_revision TEXT only list projects with the specified scm_revision
--last_job_run LAST_JOB_RUN
only list projects with the specified last_job_run
--last_job_failed BOOLEAN
only list projects with the specified last_job_failed
--next_job_run NEXT_JOB_RUN
only list projects with the specified next_job_run
--status {new,pending,waiting,running,successful,failed,error,canceled,never updated,ok,missing}
only list projects with the specified status
--organization ID only list projects with the specified organization
--scm_update_on_launch BOOLEAN
only list projects with the specified
scm_update_on_launch
--scm_update_cache_timeout INTEGER
only list projects with the specified
scm_update_cache_timeout
--allow_override BOOLEAN
only list projects with the specified allow_override
--custom_virtualenv TEXT
only list projects with the specified
custom_virtualenv
--default_environment ID
only list projects with the specified
default_environment
--signature_validation_credential ID
only list projects with the specified
signature_validation_credential
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
projects get#
usage: awx projects 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 projects get: the following arguments are required: id
projects modify#
usage: awx projects 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 projects modify: the following arguments are required: id
projects delete#
usage: awx projects 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 projects delete: the following arguments are required: id
projects update#
usage: awx projects update [-h] [--monitor] [--action-timeout ACTION_TIMEOUT]
[--wait] [--interval INTERVAL]
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
awx projects update: the following arguments are required: id
projects associate#
usage: awx projects associate [-h]
(--start_notification | --success_notification | --failure_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
awx projects associate: the following arguments are required: id
projects disassociate#
usage: awx projects disassociate [-h]
(--start_notification | --success_notification | --failure_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
awx projects disassociate: the following arguments are required: id