Created
August 27, 2018 18:58
-
-
Save ssato/695ebd402d892f45a35dbbdfa6177afb to your computer and use it in GitHub Desktop.
The log of 'collect_tower-cli_help_texts.sh' run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| ssato@localhost% time bash -x ./autoinstall.d/data/awx/3/collect_tower-cli_help_texts.sh | tee /tmp/collect_tower-cli_help_texts.sh.txt | |
| # tower-cli --help | |
| Usage: tower-cli [OPTIONS] COMMAND [ARGS]... | |
| Options: | |
| --version Display tower-cli version. | |
| --help Show this message and exit. | |
| Commands: | |
| config Read or write tower-cli configuration. | |
| empty Empties assets from Tower. | |
| login Retrieves and stores an OAuth2 personal auth... | |
| logout Removes an OAuth2 personal auth token from... | |
| receive Export assets from Tower. | |
| send Import assets into Tower. | |
| version Display full version information. | |
| Resources: | |
| activity_stream Activity on server. | |
| ad_hoc Launch commands based on playbook given at... | |
| application Manage OAuth2 applications. | |
| credential Manage credentials within Ansible Tower. | |
| credential_type Manage credential types within Ansible Tower. | |
| group Manage groups belonging to an inventory. | |
| host Manage hosts belonging to a group within an... | |
| instance Check instances within Ansible Tower. | |
| instance_group Check instance groups within Ansible Tower. | |
| inventory Manage inventory within Ansible Tower. | |
| inventory_script Manage inventory scripts within Ansible... | |
| inventory_source Manage inventory sources within Ansible... | |
| inventory_update Launch or monitor inventory source updates. | |
| job Launch or monitor jobs. | |
| job_template Manage job templates. | |
| label Manage labels within Ansible Tower. | |
| node Manage nodes inside of a workflow job... | |
| notification_template Manage notification templates within Ansible... | |
| organization Manage organizations within Ansible Tower. | |
| project Manage projects within Ansible Tower. | |
| project_update Launch or monitor project updates. | |
| role Add and remove users/teams from roles. | |
| schedule Manage schedules within Ansible Tower. | |
| setting Manage settings within Ansible Tower. | |
| team Manage teams within Ansible Tower. | |
| user Manage users within Ansible Tower. | |
| workflow Manage workflow job templates. | |
| workflow_job Launch or monitor workflow jobs. | |
| # tower-cli config --help | |
| Usage: tower-cli config [OPTIONS] [KEY] [VALUE] | |
| Read or write tower-cli configuration. | |
| `tower config` saves the given setting to the appropriate Tower CLI; | |
| either the user's ~/.tower_cli.cfg file, or the /etc/tower/tower_cli.cfg | |
| file if --global is used. | |
| Writing to /etc/tower/tower_cli.cfg is likely to require heightened | |
| permissions (in other words, sudo). | |
| Options: | |
| --global Write this config option to the global | |
| configuration. Probably will require sudo. | |
| Deprecated: Use `--scope=global` instead. | |
| --scope [local|user|global] The config file to write. "local" writes to a | |
| config file in the local directory; "user" | |
| writes to the home directory, and "global" to a | |
| system-wide directory (probably requires sudo). | |
| --unset Remove reference to this configuration option | |
| from the config file. | |
| --help Show this message and exit. | |
| # tower-cli empty --help | |
| Usage: tower-cli empty [OPTIONS] | |
| Empties assets from Tower. | |
| 'tower empty' removes all assets from Tower | |
| Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| --organization TEXT | |
| --user TEXT | |
| --team TEXT | |
| --credential_type TEXT | |
| --credential TEXT | |
| --notification_template TEXT | |
| --inventory_script TEXT | |
| --inventory TEXT | |
| --project TEXT | |
| --job_template TEXT | |
| --workflow TEXT | |
| --all | |
| --no-color Disable color output | |
| --help Show this message and exit. | |
| # tower-cli login --help | |
| Usage: tower-cli login [OPTIONS] USERNAME | |
| Retrieves and stores an OAuth2 personal auth token. | |
| Options: | |
| --password TEXT [required] | |
| --client-id TEXT | |
| --client-secret TEXT | |
| --scope [read|write] | |
| -v, --verbose Show information about requests being made. | |
| --help Show this message and exit. | |
| # tower-cli logout --help | |
| Usage: tower-cli logout [OPTIONS] | |
| Removes an OAuth2 personal auth token from config. | |
| Options: | |
| --help Show this message and exit. | |
| # tower-cli receive --help | |
| Usage: tower-cli receive [OPTIONS] | |
| Export assets from Tower. | |
| 'tower receive' exports one or more assets from a Tower instance | |
| For all of the possible assets types the TEXT can either be the assets | |
| name (or username for the case of a user) or the keyword all. Specifying | |
| all will export all of the assets of that type. | |
| Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| --organization TEXT | |
| --user TEXT | |
| --team TEXT | |
| --credential_type TEXT | |
| --credential TEXT | |
| --notification_template TEXT | |
| --inventory_script TEXT | |
| --inventory TEXT | |
| --project TEXT | |
| --job_template TEXT | |
| --workflow TEXT | |
| --all | |
| --help Show this message and exit. | |
| # tower-cli send --help | |
| Usage: tower-cli send [OPTIONS] [SOURCE]... | |
| Import assets into Tower. | |
| 'tower send' imports one or more assets into a Tower instance | |
| The import can take either JSON or YAML. Data can be sent on stdin (i.e. | |
| from tower-cli receive pipe) and/or from files or directories passed as | |
| parameters. | |
| If a directory is specified only files that end in .json, .yaml or .yml | |
| will be imported. Other files will be ignored. | |
| Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| --prevent TEXT Prevents import of a specific asset type. | |
| Multiple prevent options can be passed. | |
| --secret_management [default|prompt|random] | |
| What to do with secrets for new items. | |
| default - use "password", "token" or | |
| "secret" depending on the fieldprompt - | |
| prompt for the secret to userandom - | |
| generate a random string for the secret | |
| --no-color Disable color output | |
| --help Show this message and exit. | |
| # tower-cli version --help | |
| Usage: tower-cli version [OPTIONS] | |
| Display full version information. | |
| Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| --help Show this message and exit. | |
| # tower-cli activity_stream --help | |
| Usage: tower-cli activity_stream [OPTIONS] COMMAND [ARGS]... | |
| Activity on server. | |
| Options: | |
| --help Show this message and exit. | |
| Commands: | |
| get Return one and exactly one activity stream. | |
| list Return a list of activity streams. | |
| # tower-cli activity_stream get --help | |
| Usage: tower-cli activity_stream get [OPTIONS] [ID] | |
| Return one and exactly one activity stream. | |
| Lookups may be through a primary key, specified as a positional argument, | |
| and/or through filters specified through options. | |
| If the number of results does not equal one, abort with an error. | |
| Field Options: | |
| --operation TEXT [REQUIRED] The operation field. | |
| --timestamp TEXT [REQUIRED] The timestamp field. | |
| --changes TEXT [REQUIRED] The changes field. | |
| --object1 TEXT [REQUIRED] The object1 field. | |
| --object2 TEXT [REQUIRED] The object2 field. | |
| --actor USER [REQUIRED] The actor field. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli activity_stream list --help | |
| Usage: tower-cli activity_stream list [OPTIONS] | |
| Return a list of activity streams. | |
| If one or more filters are provided through options, filter the results | |
| accordingly. | |
| If no filters are provided, return all results. | |
| Field Options: | |
| --operation TEXT [REQUIRED] The operation field. | |
| --timestamp TEXT [REQUIRED] The timestamp field. | |
| --changes TEXT [REQUIRED] The changes field. | |
| --object1 TEXT [REQUIRED] The object1 field. | |
| --object2 TEXT [REQUIRED] The object2 field. | |
| --actor USER [REQUIRED] The actor field. | |
| Local Options: | |
| -a, --all-pages If set, collate all pages of content from the API when | |
| returning results. [default: False] | |
| --page INTEGER The page to show. Ignored if --all-pages is sent. | |
| [default: 1] | |
| --page-size INTEGER Number of records to show. Ignored if --all-pages. | |
| -Q, --query TEXT... A key and value to be passed as an HTTP query string | |
| key and value to the Tower API. Will be run through | |
| HTTP escaping. This argument may be sent multiple | |
| times. | |
| Example: `--query foo bar` would be passed to | |
| Tower as ?foo=bar | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli ad_hoc --help | |
| Usage: tower-cli ad_hoc [OPTIONS] COMMAND [ARGS]... | |
| Launch commands based on playbook given at runtime. | |
| Options: | |
| --help Show this message and exit. | |
| Commands: | |
| cancel Cancel a currently running job. | |
| delete Remove the given ad hoc. | |
| get Return one and exactly one ad hoc. | |
| launch Launch a new ad-hoc command. | |
| list Return a list of ad hocs. | |
| monitor Stream the standard output from a job,... | |
| relaunch Relaunch a stopped job. | |
| status Print the current job status. | |
| stdout Print out the standard out of a unified job... | |
| wait Wait for a running job to finish. | |
| # tower-cli ad_hoc cancel --help | |
| Usage: tower-cli ad_hoc cancel [OPTIONS] [ID] | |
| Cancel a currently running job. | |
| Fails with a non-zero exit status if the job cannot be canceled. You must | |
| provide either a pk or parameters in the job's identity. | |
| Field Options: | |
| --job-explanation TEXT The job_explanation field. | |
| --created TEXT The created field. | |
| --status TEXT The status field. | |
| --elapsed TEXT The elapsed field. | |
| --job-type [run|check] [REQUIRED] The job_type field. [default: | |
| run] | |
| -i, --inventory INVENTORY [REQUIRED] The inventory field. | |
| --limit TEXT The limit field. | |
| --credential CREDENTIAL [REQUIRED] The credential field. | |
| --module-name TEXT The module_name field. [default: command] | |
| --module-args TEXT The module_args field. | |
| --forks INTEGER The forks field. | |
| --verbosity [default|verbose|more_verbose|debug|connection|winrm] | |
| The verbosity field. | |
| --become-enabled BOOLEAN The become_enabled field. | |
| --diff-mode BOOLEAN The diff_mode field. | |
| Local Options: | |
| --fail-if-not-running Fail loudly if the job is not currently running. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli ad_hoc delete --help | |
| Usage: tower-cli ad_hoc delete [OPTIONS] [ID] | |
| Remove the given ad hoc. | |
| If --fail-on-missing is True, then the ad hoc's not being found is | |
| considered a failure; otherwise, a success with no change is reported. | |
| Field Options: | |
| --job-explanation TEXT The job_explanation field. | |
| --created TEXT The created field. | |
| --status TEXT The status field. | |
| --elapsed TEXT The elapsed field. | |
| --job-type [run|check] [REQUIRED] The job_type field. [default: | |
| run] | |
| -i, --inventory INVENTORY [REQUIRED] The inventory field. | |
| --limit TEXT The limit field. | |
| --credential CREDENTIAL [REQUIRED] The credential field. | |
| --module-name TEXT The module_name field. [default: command] | |
| --module-args TEXT The module_args field. | |
| --forks INTEGER The forks field. | |
| --verbosity [default|verbose|more_verbose|debug|connection|winrm] | |
| The verbosity field. | |
| --become-enabled BOOLEAN The become_enabled field. | |
| --diff-mode BOOLEAN The diff_mode field. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli ad_hoc get --help | |
| Usage: tower-cli ad_hoc get [OPTIONS] [ID] | |
| Return one and exactly one ad hoc. | |
| Lookups may be through a primary key, specified as a positional argument, | |
| and/or through filters specified through options. | |
| If the number of results does not equal one, abort with an error. | |
| Field Options: | |
| --job-explanation TEXT The job_explanation field. | |
| --created TEXT The created field. | |
| --status TEXT The status field. | |
| --elapsed TEXT The elapsed field. | |
| --job-type [run|check] [REQUIRED] The job_type field. | |
| -i, --inventory INVENTORY [REQUIRED] The inventory field. | |
| --limit TEXT The limit field. | |
| --credential CREDENTIAL [REQUIRED] The credential field. | |
| --module-name TEXT The module_name field. | |
| --module-args TEXT The module_args field. | |
| --forks INTEGER The forks field. | |
| --verbosity [default|verbose|more_verbose|debug|connection|winrm] | |
| The verbosity field. | |
| --become-enabled BOOLEAN The become_enabled field. | |
| --diff-mode BOOLEAN The diff_mode field. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli ad_hoc launch --help | |
| Usage: tower-cli ad_hoc launch [OPTIONS] | |
| Launch a new ad-hoc command. | |
| Runs a user-defined command from Ansible Tower, immediately starts it, and | |
| returns back an ID in order for its status to be monitored. | |
| Field Options: | |
| --job-explanation TEXT The job_explanation field. | |
| --job-type [run|check] [REQUIRED] The job_type field. [default: | |
| run] | |
| -i, --inventory INVENTORY [REQUIRED] The inventory field. | |
| --limit TEXT The limit field. | |
| --credential CREDENTIAL [REQUIRED] The credential field. | |
| --module-name TEXT The module_name field. [default: command] | |
| --module-args TEXT The module_args field. | |
| --forks INTEGER The forks field. | |
| --verbosity [default|verbose|more_verbose|debug|connection|winrm] | |
| The verbosity field. | |
| --become-enabled BOOLEAN The become_enabled field. | |
| --diff-mode BOOLEAN The diff_mode field. | |
| Local Options: | |
| --monitor If sent, immediately calls `monitor` on the newly | |
| launched command rather than exiting with a success. | |
| --wait Monitor the status of the job, but do not print while job | |
| is in progress. | |
| --timeout INTEGER If provided with --monitor, this attempt will time out | |
| after the given number of seconds. Does nothing if | |
| --monitor is not sent. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli ad_hoc list --help | |
| Usage: tower-cli ad_hoc list [OPTIONS] | |
| Return a list of ad hocs. | |
| If one or more filters are provided through options, filter the results | |
| accordingly. | |
| If no filters are provided, return all results. | |
| Field Options: | |
| --job-explanation TEXT The job_explanation field. | |
| --created TEXT The created field. | |
| --status TEXT The status field. | |
| --elapsed TEXT The elapsed field. | |
| --job-type [run|check] [REQUIRED] The job_type field. | |
| -i, --inventory INVENTORY [REQUIRED] The inventory field. | |
| --limit TEXT The limit field. | |
| --credential CREDENTIAL [REQUIRED] The credential field. | |
| --module-name TEXT The module_name field. | |
| --module-args TEXT The module_args field. | |
| --forks INTEGER The forks field. | |
| --verbosity [default|verbose|more_verbose|debug|connection|winrm] | |
| The verbosity field. | |
| --become-enabled BOOLEAN The become_enabled field. | |
| --diff-mode BOOLEAN The diff_mode field. | |
| Local Options: | |
| -a, --all-pages If set, collate all pages of content from the API when | |
| returning results. [default: False] | |
| --page INTEGER The page to show. Ignored if --all-pages is sent. | |
| [default: 1] | |
| --page-size INTEGER Number of records to show. Ignored if --all-pages. | |
| -Q, --query TEXT... A key and value to be passed as an HTTP query string | |
| key and value to the Tower API. Will be run through | |
| HTTP escaping. This argument may be sent multiple | |
| times. | |
| Example: `--query foo bar` would be passed to | |
| Tower as ?foo=bar | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli ad_hoc monitor --help | |
| Usage: tower-cli ad_hoc monitor [OPTIONS] [ID] | |
| Stream the standard output from a job, project update, or inventory | |
| udpate. | |
| Field Options: | |
| --job-explanation TEXT The job_explanation field. | |
| --created TEXT The created field. | |
| --status TEXT The status field. | |
| --elapsed TEXT The elapsed field. | |
| --job-type [run|check] [REQUIRED] The job_type field. [default: | |
| run] | |
| -i, --inventory INVENTORY [REQUIRED] The inventory field. | |
| --limit TEXT The limit field. | |
| --credential CREDENTIAL [REQUIRED] The credential field. | |
| --module-name TEXT The module_name field. [default: command] | |
| --module-args TEXT The module_args field. | |
| --forks INTEGER The forks field. | |
| --verbosity [default|verbose|more_verbose|debug|connection|winrm] | |
| The verbosity field. | |
| --become-enabled BOOLEAN The become_enabled field. | |
| --diff-mode BOOLEAN The diff_mode field. | |
| Local Options: | |
| --interval FLOAT Polling interval to refresh content from Tower. | |
| --timeout INTEGER If provided, this command (not the job) will time out | |
| after the given number of seconds. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli ad_hoc relaunch --help | |
| Usage: tower-cli ad_hoc relaunch [OPTIONS] [ID] | |
| Relaunch a stopped job. | |
| Fails with a non-zero exit status if the job cannot be relaunched. You | |
| must provide either a pk or parameters in the job's identity. | |
| Field Options: | |
| --job-explanation TEXT The job_explanation field. | |
| --created TEXT The created field. | |
| --status TEXT The status field. | |
| --elapsed TEXT The elapsed field. | |
| --job-type [run|check] [REQUIRED] The job_type field. [default: | |
| run] | |
| -i, --inventory INVENTORY [REQUIRED] The inventory field. | |
| --limit TEXT The limit field. | |
| --credential CREDENTIAL [REQUIRED] The credential field. | |
| --module-name TEXT The module_name field. [default: command] | |
| --module-args TEXT The module_args field. | |
| --forks INTEGER The forks field. | |
| --verbosity [default|verbose|more_verbose|debug|connection|winrm] | |
| The verbosity field. | |
| --become-enabled BOOLEAN The become_enabled field. | |
| --diff-mode BOOLEAN The diff_mode field. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli ad_hoc status --help | |
| Usage: tower-cli ad_hoc status [OPTIONS] [ID] | |
| Print the current job status. This is used to check a running job. You can | |
| look up the job with the same parameters used for a get request. | |
| Field Options: | |
| --job-explanation TEXT The job_explanation field. | |
| --created TEXT The created field. | |
| --status TEXT The status field. | |
| --elapsed TEXT The elapsed field. | |
| --job-type [run|check] [REQUIRED] The job_type field. [default: | |
| run] | |
| -i, --inventory INVENTORY [REQUIRED] The inventory field. | |
| --limit TEXT The limit field. | |
| --credential CREDENTIAL [REQUIRED] The credential field. | |
| --module-name TEXT The module_name field. [default: command] | |
| --module-args TEXT The module_args field. | |
| --forks INTEGER The forks field. | |
| --verbosity [default|verbose|more_verbose|debug|connection|winrm] | |
| The verbosity field. | |
| --become-enabled BOOLEAN The become_enabled field. | |
| --diff-mode BOOLEAN The diff_mode field. | |
| Local Options: | |
| --detail Print more detail. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli ad_hoc stdout --help | |
| Usage: tower-cli ad_hoc stdout [OPTIONS] [ID] | |
| Print out the standard out of a unified job to the command line. For | |
| Projects, print the standard out of most recent update. For Inventory | |
| Sources, print standard out of most recent sync. For Jobs, print the job's | |
| standard out. For Workflow Jobs, print a status table of its jobs. | |
| Field Options: | |
| --job-explanation TEXT The job_explanation field. | |
| --created TEXT The created field. | |
| --status TEXT The status field. | |
| --elapsed TEXT The elapsed field. | |
| --job-type [run|check] [REQUIRED] The job_type field. [default: | |
| run] | |
| -i, --inventory INVENTORY [REQUIRED] The inventory field. | |
| --limit TEXT The limit field. | |
| --credential CREDENTIAL [REQUIRED] The credential field. | |
| --module-name TEXT The module_name field. [default: command] | |
| --module-args TEXT The module_args field. | |
| --forks INTEGER The forks field. | |
| --verbosity [default|verbose|more_verbose|debug|connection|winrm] | |
| The verbosity field. | |
| --become-enabled BOOLEAN The become_enabled field. | |
| --diff-mode BOOLEAN The diff_mode field. | |
| Local Options: | |
| --start-line INTEGER Line at which to start printing the standard out. | |
| --end-line INTEGER Line at which to end printing the standard out. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli ad_hoc wait --help | |
| Usage: tower-cli ad_hoc wait [OPTIONS] [ID] | |
| Wait for a running job to finish. Blocks further input until the job | |
| completes (whether successfully or unsuccessfully) and a final status can | |
| be given. | |
| Field Options: | |
| --job-explanation TEXT The job_explanation field. | |
| --created TEXT The created field. | |
| --status TEXT The status field. | |
| --elapsed TEXT The elapsed field. | |
| --job-type [run|check] [REQUIRED] The job_type field. [default: | |
| run] | |
| -i, --inventory INVENTORY [REQUIRED] The inventory field. | |
| --limit TEXT The limit field. | |
| --credential CREDENTIAL [REQUIRED] The credential field. | |
| --module-name TEXT The module_name field. [default: command] | |
| --module-args TEXT The module_args field. | |
| --forks INTEGER The forks field. | |
| --verbosity [default|verbose|more_verbose|debug|connection|winrm] | |
| The verbosity field. | |
| --become-enabled BOOLEAN The become_enabled field. | |
| --diff-mode BOOLEAN The diff_mode field. | |
| Local Options: | |
| --min-interval INTEGER The minimum interval to request an update from | |
| Tower. | |
| --max-interval INTEGER The maximum interval to request an update from | |
| Tower. | |
| --timeout INTEGER If provided, this command (not the job) will time | |
| out after the given number of seconds. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli application --help | |
| Usage: tower-cli application [OPTIONS] COMMAND [ARGS]... | |
| Manage OAuth2 applications. | |
| Options: | |
| --help Show this message and exit. | |
| Commands: | |
| copy Copy an application. | |
| create Create an application. | |
| delete Remove the given application. | |
| get Return one and exactly one application. | |
| list Return a list of applications. | |
| modify Modify an already existing application. | |
| # tower-cli application copy --help | |
| Usage: tower-cli application copy [OPTIONS] [ID] | |
| Copy an application. | |
| Only the ID is used for the lookup. All provided fields are used to | |
| override the old data from the copied resource. | |
| Field Options: | |
| --user USER [REQUIRED] The user field. | |
| -n, --name TEXT [REQUIRED] The name field. | |
| --client-type TEXT [REQUIRED] The client_type field. | |
| --redirect-uris TEXT The redirect_uris field. | |
| --authorization-grant-type TEXT | |
| [REQUIRED] The authorization_grant_type | |
| field. | |
| --skip-authorization TEXT The skip_authorization field. | |
| Local Options: | |
| --new-name TEXT The name to give the new resource, if used, will deep copy | |
| in the backend. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli application create --help | |
| Usage: tower-cli application create [OPTIONS] | |
| Create an application. | |
| Fields in the resource's --identity tuple are used for a lookup; if a | |
| match is found, then no-op (unless --force-on-exists is set) but do not | |
| fail (unless --fail-on-found is set). | |
| Field Options: | |
| --user USER [REQUIRED] The user field. | |
| -n, --name TEXT [REQUIRED] The name field. | |
| --client-type TEXT [REQUIRED] The client_type field. | |
| --redirect-uris TEXT The redirect_uris field. | |
| --authorization-grant-type TEXT | |
| [REQUIRED] The authorization_grant_type | |
| field. | |
| --skip-authorization TEXT The skip_authorization field. | |
| Local Options: | |
| --fail-on-found If used, return an error if a matching record already | |
| exists. [default: False] | |
| --force-on-exists If used, if a match is found on unique fields, other | |
| fields will be updated to the provided values. If False, | |
| a match causes the request to be a no-op. [default: | |
| False] | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli application delete --help | |
| Usage: tower-cli application delete [OPTIONS] [ID] | |
| Remove the given application. | |
| If --fail-on-missing is True, then the application's not being found is | |
| considered a failure; otherwise, a success with no change is reported. | |
| Field Options: | |
| --user USER [REQUIRED] The user field. | |
| -n, --name TEXT [REQUIRED] The name field. | |
| --client-type TEXT [REQUIRED] The client_type field. | |
| --redirect-uris TEXT The redirect_uris field. | |
| --authorization-grant-type TEXT | |
| [REQUIRED] The authorization_grant_type | |
| field. | |
| --skip-authorization TEXT The skip_authorization field. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli application get --help | |
| Usage: tower-cli application get [OPTIONS] [ID] | |
| Return one and exactly one application. | |
| Lookups may be through a primary key, specified as a positional argument, | |
| and/or through filters specified through options. | |
| If the number of results does not equal one, abort with an error. | |
| Field Options: | |
| --user USER [REQUIRED] The user field. | |
| -n, --name TEXT [REQUIRED] The name field. | |
| --client-type TEXT [REQUIRED] The client_type field. | |
| --redirect-uris TEXT The redirect_uris field. | |
| --authorization-grant-type TEXT | |
| [REQUIRED] The authorization_grant_type | |
| field. | |
| --skip-authorization TEXT The skip_authorization field. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli application list --help | |
| Usage: tower-cli application list [OPTIONS] | |
| Return a list of applications. | |
| If one or more filters are provided through options, filter the results | |
| accordingly. | |
| If no filters are provided, return all results. | |
| Field Options: | |
| --user USER [REQUIRED] The user field. | |
| -n, --name TEXT [REQUIRED] The name field. | |
| --client-type TEXT [REQUIRED] The client_type field. | |
| --redirect-uris TEXT The redirect_uris field. | |
| --authorization-grant-type TEXT | |
| [REQUIRED] The authorization_grant_type | |
| field. | |
| --skip-authorization TEXT The skip_authorization field. | |
| Local Options: | |
| -a, --all-pages If set, collate all pages of content from the API when | |
| returning results. [default: False] | |
| --page INTEGER The page to show. Ignored if --all-pages is sent. | |
| [default: 1] | |
| --page-size INTEGER Number of records to show. Ignored if --all-pages. | |
| -Q, --query TEXT... A key and value to be passed as an HTTP query string | |
| key and value to the Tower API. Will be run through | |
| HTTP escaping. This argument may be sent multiple | |
| times. | |
| Example: `--query foo bar` would be passed to | |
| Tower as ?foo=bar | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli application modify --help | |
| Usage: tower-cli application modify [OPTIONS] [ID] | |
| Modify an already existing application. | |
| Fields in the resource's --identity tuple can be used in lieu of a primary | |
| key for a lookup; in such a case, only other fields are written. | |
| To modify unique fields, you must use the primary key for the lookup. | |
| Field Options: | |
| --user USER [REQUIRED] The user field. | |
| -n, --name TEXT [REQUIRED] The name field. | |
| --client-type TEXT [REQUIRED] The client_type field. | |
| --redirect-uris TEXT The redirect_uris field. | |
| --authorization-grant-type TEXT | |
| [REQUIRED] The authorization_grant_type | |
| field. | |
| --skip-authorization TEXT The skip_authorization field. | |
| Local Options: | |
| --create-on-missing If used, and if options rather than a primary key are | |
| used to attempt to match a record, will create the | |
| record if it does not exist. This is an alias to | |
| `create --force-on-exists`. [default: False] | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli credential --help | |
| Usage: tower-cli credential [OPTIONS] COMMAND [ARGS]... | |
| Manage credentials within Ansible Tower. | |
| Options: | |
| --help Show this message and exit. | |
| Commands: | |
| copy Copy a credential. | |
| create Create a credential. | |
| delete Remove the given credential. | |
| get Return one and exactly one credential. | |
| list Return a list of credentials. | |
| modify Modify an already existing credential. | |
| # tower-cli credential copy --help | |
| Usage: tower-cli credential copy [OPTIONS] [ID] | |
| Copy a credential. | |
| Only the ID is used for the lookup. All provided fields are used to | |
| override the old data from the copied resource. | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| -d, --description TEXT The description field. | |
| --user USER The user field. | |
| --team TEAM The team field. | |
| --organization ORGANIZATION The organization field. | |
| --credential-type CREDENTIAL_TYPE | |
| [REQUIRED] The credential_type field. | |
| --inputs STRUCTURED_INPUT The inputs field. Use @ to get JSON or YAML | |
| from a file. | |
| Local Options: | |
| --new-name TEXT The name to give the new resource, if used, will deep copy | |
| in the backend. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli credential create --help | |
| Usage: tower-cli credential create [OPTIONS] | |
| Create a credential. | |
| Fields in the resource's --identity tuple are used for a lookup; if a | |
| match is found, then no-op (unless --force-on-exists is set) but do not | |
| fail (unless --fail-on-found is set). | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| -d, --description TEXT The description field. | |
| --user USER The user field. | |
| --team TEAM The team field. | |
| --organization ORGANIZATION The organization field. | |
| --credential-type CREDENTIAL_TYPE | |
| [REQUIRED] The credential_type field. | |
| --inputs STRUCTURED_INPUT The inputs field. Use @ to get JSON or YAML | |
| from a file. | |
| Local Options: | |
| --fail-on-found If used, return an error if a matching record already | |
| exists. [default: False] | |
| --force-on-exists If used, if a match is found on unique fields, other | |
| fields will be updated to the provided values. If False, | |
| a match causes the request to be a no-op. [default: | |
| False] | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli credential delete --help | |
| Usage: tower-cli credential delete [OPTIONS] [ID] | |
| Remove the given credential. | |
| If --fail-on-missing is True, then the credential's not being found is | |
| considered a failure; otherwise, a success with no change is reported. | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| -d, --description TEXT The description field. | |
| --user USER The user field. | |
| --team TEAM The team field. | |
| --organization ORGANIZATION The organization field. | |
| --credential-type CREDENTIAL_TYPE | |
| [REQUIRED] The credential_type field. | |
| --inputs STRUCTURED_INPUT The inputs field. Use @ to get JSON or YAML | |
| from a file. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli credential get --help | |
| Usage: tower-cli credential get [OPTIONS] [ID] | |
| Return one and exactly one credential. | |
| Lookups may be through a primary key, specified as a positional argument, | |
| and/or through filters specified through options. | |
| If the number of results does not equal one, abort with an error. | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| -d, --description TEXT The description field. | |
| --user USER The user field. | |
| --team TEAM The team field. | |
| --organization ORGANIZATION The organization field. | |
| --credential-type CREDENTIAL_TYPE | |
| [REQUIRED] The credential_type field. | |
| --inputs STRUCTURED_INPUT The inputs field. Use @ to get JSON or YAML | |
| from a file. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli credential list --help | |
| Usage: tower-cli credential list [OPTIONS] | |
| Return a list of credentials. | |
| If one or more filters are provided through options, filter the results | |
| accordingly. | |
| If no filters are provided, return all results. | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| -d, --description TEXT The description field. | |
| --user USER The user field. | |
| --team TEAM The team field. | |
| --organization ORGANIZATION The organization field. | |
| --credential-type CREDENTIAL_TYPE | |
| [REQUIRED] The credential_type field. | |
| --inputs STRUCTURED_INPUT The inputs field. Use @ to get JSON or YAML | |
| from a file. | |
| Local Options: | |
| -a, --all-pages If set, collate all pages of content from the API when | |
| returning results. [default: False] | |
| --page INTEGER The page to show. Ignored if --all-pages is sent. | |
| [default: 1] | |
| --page-size INTEGER Number of records to show. Ignored if --all-pages. | |
| -Q, --query TEXT... A key and value to be passed as an HTTP query string | |
| key and value to the Tower API. Will be run through | |
| HTTP escaping. This argument may be sent multiple | |
| times. | |
| Example: `--query foo bar` would be passed to | |
| Tower as ?foo=bar | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli credential modify --help | |
| Usage: tower-cli credential modify [OPTIONS] [ID] | |
| Modify an already existing credential. | |
| Fields in the resource's --identity tuple can be used in lieu of a primary | |
| key for a lookup; in such a case, only other fields are written. | |
| To modify unique fields, you must use the primary key for the lookup. | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| -d, --description TEXT The description field. | |
| --user USER The user field. | |
| --team TEAM The team field. | |
| --organization ORGANIZATION The organization field. | |
| --credential-type CREDENTIAL_TYPE | |
| [REQUIRED] The credential_type field. | |
| --inputs STRUCTURED_INPUT The inputs field. Use @ to get JSON or YAML | |
| from a file. | |
| Local Options: | |
| --create-on-missing If used, and if options rather than a primary key are | |
| used to attempt to match a record, will create the | |
| record if it does not exist. This is an alias to | |
| `create --force-on-exists`. [default: False] | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli credential_type --help | |
| Usage: tower-cli credential_type [OPTIONS] COMMAND [ARGS]... | |
| Manage credential types within Ansible Tower. | |
| Options: | |
| --help Show this message and exit. | |
| Commands: | |
| copy Copy a credential type. | |
| create Create a credential type. | |
| delete Remove the given credential type. | |
| get Return one and exactly one credential type. | |
| list Return a list of credential types. | |
| modify Modify an already existing credential type. | |
| # tower-cli credential_type copy --help | |
| Usage: tower-cli credential_type copy [OPTIONS] [ID] | |
| Copy a credential type. | |
| Only the ID is used for the lookup. All provided fields are used to | |
| override the old data from the copied resource. | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| -d, --description TEXT The description field. | |
| --kind [ssh|vault|net|scm|cloud|insights] | |
| [REQUIRED] The type of credential type being | |
| added. Valid options are: ssh, vault, net, | |
| scm, cloud and insights. Note only cloud and | |
| net can be used for creating credential | |
| types. | |
| --managed-by-tower BOOLEAN [READ ONLY] Indicating if the credential | |
| type is a tower built-in type. | |
| --inputs STRUCTURED_INPUT The inputs field. Use @ to get JSON or YAML | |
| from a file. | |
| --injectors STRUCTURED_INPUT The injectors field. Use @ to get JSON or | |
| YAML from a file. | |
| Local Options: | |
| --new-name TEXT The name to give the new resource, if used, will deep copy | |
| in the backend. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli credential_type create --help | |
| Usage: tower-cli credential_type create [OPTIONS] | |
| Create a credential type. | |
| Fields in the resource's --identity tuple are used for a lookup; if a | |
| match is found, then no-op (unless --force-on-exists is set) but do not | |
| fail (unless --fail-on-found is set). | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| -d, --description TEXT The description field. | |
| --kind [ssh|vault|net|scm|cloud|insights] | |
| [REQUIRED] The type of credential type being | |
| added. Valid options are: ssh, vault, net, | |
| scm, cloud and insights. Note only cloud and | |
| net can be used for creating credential | |
| types. | |
| --managed-by-tower BOOLEAN [READ ONLY] Indicating if the credential | |
| type is a tower built-in type. | |
| --inputs STRUCTURED_INPUT The inputs field. Use @ to get JSON or YAML | |
| from a file. | |
| --injectors STRUCTURED_INPUT The injectors field. Use @ to get JSON or | |
| YAML from a file. | |
| Local Options: | |
| --fail-on-found If used, return an error if a matching record already | |
| exists. [default: False] | |
| --force-on-exists If used, if a match is found on unique fields, other | |
| fields will be updated to the provided values. If False, | |
| a match causes the request to be a no-op. [default: | |
| False] | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli credential_type delete --help | |
| Usage: tower-cli credential_type delete [OPTIONS] [ID] | |
| Remove the given credential type. | |
| If --fail-on-missing is True, then the credential type's not being found | |
| is considered a failure; otherwise, a success with no change is reported. | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| -d, --description TEXT The description field. | |
| --kind [ssh|vault|net|scm|cloud|insights] | |
| [REQUIRED] The type of credential type being | |
| added. Valid options are: ssh, vault, net, | |
| scm, cloud and insights. Note only cloud and | |
| net can be used for creating credential | |
| types. | |
| --managed-by-tower BOOLEAN [READ ONLY] Indicating if the credential | |
| type is a tower built-in type. | |
| --inputs STRUCTURED_INPUT The inputs field. Use @ to get JSON or YAML | |
| from a file. | |
| --injectors STRUCTURED_INPUT The injectors field. Use @ to get JSON or | |
| YAML from a file. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli credential_type get --help | |
| Usage: tower-cli credential_type get [OPTIONS] [ID] | |
| Return one and exactly one credential type. | |
| Lookups may be through a primary key, specified as a positional argument, | |
| and/or through filters specified through options. | |
| If the number of results does not equal one, abort with an error. | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| -d, --description TEXT The description field. | |
| --kind [ssh|vault|net|scm|cloud|insights] | |
| [REQUIRED] The type of credential type being | |
| added. Valid options are: ssh, vault, net, | |
| scm, cloud and insights. Note only cloud and | |
| net can be used for creating credential | |
| types. | |
| --managed-by-tower BOOLEAN [READ ONLY] Indicating if the credential | |
| type is a tower built-in type. | |
| --inputs STRUCTURED_INPUT The inputs field. Use @ to get JSON or YAML | |
| from a file. | |
| --injectors STRUCTURED_INPUT The injectors field. Use @ to get JSON or | |
| YAML from a file. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli credential_type list --help | |
| Usage: tower-cli credential_type list [OPTIONS] | |
| Return a list of credential types. | |
| If one or more filters are provided through options, filter the results | |
| accordingly. | |
| If no filters are provided, return all results. | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| -d, --description TEXT The description field. | |
| --kind [ssh|vault|net|scm|cloud|insights] | |
| [REQUIRED] The type of credential type being | |
| added. Valid options are: ssh, vault, net, | |
| scm, cloud and insights. Note only cloud and | |
| net can be used for creating credential | |
| types. | |
| --managed-by-tower BOOLEAN [READ ONLY] Indicating if the credential | |
| type is a tower built-in type. | |
| --inputs STRUCTURED_INPUT The inputs field. Use @ to get JSON or YAML | |
| from a file. | |
| --injectors STRUCTURED_INPUT The injectors field. Use @ to get JSON or | |
| YAML from a file. | |
| Local Options: | |
| -a, --all-pages If set, collate all pages of content from the API when | |
| returning results. [default: False] | |
| --page INTEGER The page to show. Ignored if --all-pages is sent. | |
| [default: 1] | |
| --page-size INTEGER Number of records to show. Ignored if --all-pages. | |
| -Q, --query TEXT... A key and value to be passed as an HTTP query string | |
| key and value to the Tower API. Will be run through | |
| HTTP escaping. This argument may be sent multiple | |
| times. | |
| Example: `--query foo bar` would be passed to | |
| Tower as ?foo=bar | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli credential_type modify --help | |
| Usage: tower-cli credential_type modify [OPTIONS] [ID] | |
| Modify an already existing credential type. | |
| Fields in the resource's --identity tuple can be used in lieu of a primary | |
| key for a lookup; in such a case, only other fields are written. | |
| To modify unique fields, you must use the primary key for the lookup. | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| -d, --description TEXT The description field. | |
| --kind [ssh|vault|net|scm|cloud|insights] | |
| [REQUIRED] The type of credential type being | |
| added. Valid options are: ssh, vault, net, | |
| scm, cloud and insights. Note only cloud and | |
| net can be used for creating credential | |
| types. | |
| --managed-by-tower BOOLEAN [READ ONLY] Indicating if the credential | |
| type is a tower built-in type. | |
| --inputs STRUCTURED_INPUT The inputs field. Use @ to get JSON or YAML | |
| from a file. | |
| --injectors STRUCTURED_INPUT The injectors field. Use @ to get JSON or | |
| YAML from a file. | |
| Local Options: | |
| --create-on-missing If used, and if options rather than a primary key are | |
| used to attempt to match a record, will create the | |
| record if it does not exist. This is an alias to | |
| `create --force-on-exists`. [default: False] | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli group --help | |
| Usage: tower-cli group [OPTIONS] COMMAND [ARGS]... | |
| Manage groups belonging to an inventory. | |
| Options: | |
| --help Show this message and exit. | |
| Commands: | |
| associate Associate this group with the specified... | |
| copy Copy a group. | |
| create Create a group. | |
| delete Remove the given group. | |
| disassociate Disassociate this group from the specified... | |
| get Return one and exactly one group. | |
| list Return a list of groups. | |
| modify Modify an already existing group. | |
| # tower-cli group associate --help | |
| Usage: tower-cli group associate [OPTIONS] | |
| Associate this group with the specified group. | |
| Local Options: | |
| --group TEXT The group to move. | |
| --parent TEXT Destination group to move into. | |
| --inventory INVENTORY | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli group copy --help | |
| Usage: tower-cli group copy [OPTIONS] [ID] | |
| Copy a group. | |
| Only the ID is used for the lookup. All provided fields are used to | |
| override the old data from the copied resource. | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| -d, --description TEXT The description field. | |
| -i, --inventory INVENTORY [REQUIRED] The inventory field. | |
| --variables VARIABLES Group variables, use "@" to get from file. | |
| Local Options: | |
| --new-name TEXT The name to give the new resource, if used, will deep copy | |
| in the backend. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli group create --help | |
| Usage: tower-cli group create [OPTIONS] | |
| Create a group. | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| -d, --description TEXT The description field. | |
| -i, --inventory INVENTORY [REQUIRED] The inventory field. | |
| --variables VARIABLES Group variables, use "@" to get from file. | |
| Local Options: | |
| --fail-on-found If used, return an error if a matching record already | |
| exists. [default: False] | |
| --force-on-exists If used, if a match is found on unique fields, other | |
| fields will be updated to the provided values. If False, | |
| a match causes the request to be a no-op. [default: | |
| False] | |
| --parent TEXT Parent group to nest this one inside of. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli group delete --help | |
| Usage: tower-cli group delete [OPTIONS] [ID] | |
| Remove the given group. | |
| If --fail-on-missing is True, then the group's not being found is | |
| considered a failure; otherwise, a success with no change is reported. | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| -d, --description TEXT The description field. | |
| -i, --inventory INVENTORY [REQUIRED] The inventory field. | |
| --variables VARIABLES Group variables, use "@" to get from file. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli group disassociate --help | |
| Usage: tower-cli group disassociate [OPTIONS] | |
| Disassociate this group from the specified group. | |
| Local Options: | |
| --group TEXT The group to move. | |
| --parent TEXT Destination group to move into. | |
| --inventory INVENTORY | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli group get --help | |
| Usage: tower-cli group get [OPTIONS] [ID] | |
| Return one and exactly one group. | |
| Lookups may be through a primary key, specified as a positional argument, | |
| and/or through filters specified through options. | |
| If the number of results does not equal one, abort with an error. | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| -d, --description TEXT The description field. | |
| -i, --inventory INVENTORY [REQUIRED] The inventory field. | |
| --variables VARIABLES Group variables, use "@" to get from file. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli group list --help | |
| Usage: tower-cli group list [OPTIONS] | |
| Return a list of groups. | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| -d, --description TEXT The description field. | |
| -i, --inventory INVENTORY [REQUIRED] The inventory field. | |
| --variables VARIABLES Group variables, use "@" to get from file. | |
| Local Options: | |
| -a, --all-pages If set, collate all pages of content from the API when | |
| returning results. [default: False] | |
| --page INTEGER The page to show. Ignored if --all-pages is sent. | |
| [default: 1] | |
| --page-size INTEGER Number of records to show. Ignored if --all-pages. | |
| -Q, --query TEXT... A key and value to be passed as an HTTP query string | |
| key and value to the Tower API. Will be run through | |
| HTTP escaping. This argument may be sent multiple | |
| times. | |
| Example: `--query foo bar` would be passed to | |
| Tower as ?foo=bar | |
| --root Show only root groups (groups with no parent groups) | |
| within the given inventory. | |
| --parent TEXT Parent group to nest this one inside of. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli group modify --help | |
| Usage: tower-cli group modify [OPTIONS] [ID] | |
| Modify an already existing group. | |
| Fields in the resource's --identity tuple can be used in lieu of a primary | |
| key for a lookup; in such a case, only other fields are written. | |
| To modify unique fields, you must use the primary key for the lookup. | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| -d, --description TEXT The description field. | |
| -i, --inventory INVENTORY [REQUIRED] The inventory field. | |
| --variables VARIABLES Group variables, use "@" to get from file. | |
| Local Options: | |
| --create-on-missing If used, and if options rather than a primary key are | |
| used to attempt to match a record, will create the | |
| record if it does not exist. This is an alias to | |
| `create --force-on-exists`. [default: False] | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli host --help | |
| Usage: tower-cli host [OPTIONS] COMMAND [ARGS]... | |
| Manage hosts belonging to a group within an inventory. | |
| Options: | |
| --help Show this message and exit. | |
| Commands: | |
| associate Associate a group with this host. | |
| copy Copy a host. | |
| create Create a host. | |
| delete Remove the given host. | |
| disassociate Disassociate a group with this host. | |
| get Return one and exactly one host. | |
| insights Return a JSON host of host insights. | |
| list Return a list of hosts. | |
| list_facts Return a JSON host of all available facts of... | |
| modify Modify an already existing host. | |
| # tower-cli host associate --help | |
| Usage: tower-cli host associate [OPTIONS] | |
| Associate a group with this host. | |
| Local Options: | |
| --host HOST [required] | |
| --group GROUP [required] | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli host copy --help | |
| Usage: tower-cli host copy [OPTIONS] [ID] | |
| Copy a host. | |
| Only the ID is used for the lookup. All provided fields are used to | |
| override the old data from the copied resource. | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| -d, --description TEXT The description field. | |
| -i, --inventory INVENTORY [REQUIRED] The inventory field. | |
| --enabled BOOLEAN The enabled field. | |
| --variables VARIABLES Host variables, use "@" to get from file. | |
| --insights-system-id TEXT The insights_system_id field. | |
| Local Options: | |
| --new-name TEXT The name to give the new resource, if used, will deep copy | |
| in the backend. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli host create --help | |
| Usage: tower-cli host create [OPTIONS] | |
| Create a host. | |
| Fields in the resource's --identity tuple are used for a lookup; if a | |
| match is found, then no-op (unless --force-on-exists is set) but do not | |
| fail (unless --fail-on-found is set). | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| -d, --description TEXT The description field. | |
| -i, --inventory INVENTORY [REQUIRED] The inventory field. | |
| --enabled BOOLEAN The enabled field. | |
| --variables VARIABLES Host variables, use "@" to get from file. | |
| --insights-system-id TEXT The insights_system_id field. | |
| Local Options: | |
| --fail-on-found If used, return an error if a matching record already | |
| exists. [default: False] | |
| --force-on-exists If used, if a match is found on unique fields, other | |
| fields will be updated to the provided values. If False, | |
| a match causes the request to be a no-op. [default: | |
| False] | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli host delete --help | |
| Usage: tower-cli host delete [OPTIONS] [ID] | |
| Remove the given host. | |
| If --fail-on-missing is True, then the host's not being found is | |
| considered a failure; otherwise, a success with no change is reported. | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| -d, --description TEXT The description field. | |
| -i, --inventory INVENTORY [REQUIRED] The inventory field. | |
| --enabled BOOLEAN The enabled field. | |
| --variables VARIABLES Host variables, use "@" to get from file. | |
| --insights-system-id TEXT The insights_system_id field. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli host disassociate --help | |
| Usage: tower-cli host disassociate [OPTIONS] | |
| Disassociate a group with this host. | |
| Local Options: | |
| --host HOST [required] | |
| --group GROUP [required] | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli host get --help | |
| Usage: tower-cli host get [OPTIONS] [ID] | |
| Return one and exactly one host. | |
| Lookups may be through a primary key, specified as a positional argument, | |
| and/or through filters specified through options. | |
| If the number of results does not equal one, abort with an error. | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| -d, --description TEXT The description field. | |
| -i, --inventory INVENTORY [REQUIRED] The inventory field. | |
| --enabled BOOLEAN The enabled field. | |
| --variables VARIABLES Host variables, use "@" to get from file. | |
| --insights-system-id TEXT The insights_system_id field. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli host insights --help | |
| Usage: tower-cli host insights [OPTIONS] [ID] | |
| Return a JSON host of host insights. | |
| Note global option --format is not available here, as the output would | |
| always be JSON-formatted. | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| -d, --description TEXT The description field. | |
| -i, --inventory INVENTORY [REQUIRED] The inventory field. | |
| --enabled BOOLEAN The enabled field. | |
| --variables VARIABLES Host variables, use "@" to get from file. | |
| --insights-system-id TEXT The insights_system_id field. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli host list --help | |
| Usage: tower-cli host list [OPTIONS] | |
| Return a list of hosts. | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| -d, --description TEXT The description field. | |
| -i, --inventory INVENTORY [REQUIRED] The inventory field. | |
| --enabled BOOLEAN The enabled field. | |
| --variables VARIABLES Host variables, use "@" to get from file. | |
| --insights-system-id TEXT The insights_system_id field. | |
| Local Options: | |
| -a, --all-pages If set, collate all pages of content from the API when | |
| returning results. [default: False] | |
| --page INTEGER The page to show. Ignored if --all-pages is sent. | |
| [default: 1] | |
| --page-size INTEGER Number of records to show. Ignored if --all-pages. | |
| -Q, --query TEXT... A key and value to be passed as an HTTP query string | |
| key and value to the Tower API. Will be run through | |
| HTTP escaping. This argument may be sent multiple | |
| times. | |
| Example: `--query foo bar` would be passed to | |
| Tower as ?foo=bar | |
| --group GROUP List hosts that are children of this group. | |
| --host-filter TEXT List hosts filtered by this fact search query string. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli host list_facts --help | |
| Usage: tower-cli host list_facts [OPTIONS] [ID] | |
| Return a JSON host of all available facts of the given host. | |
| Note global option --format is not available here, as the output would | |
| always be JSON-formatted. | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| -d, --description TEXT The description field. | |
| -i, --inventory INVENTORY [REQUIRED] The inventory field. | |
| --enabled BOOLEAN The enabled field. | |
| --variables VARIABLES Host variables, use "@" to get from file. | |
| --insights-system-id TEXT The insights_system_id field. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli host modify --help | |
| Usage: tower-cli host modify [OPTIONS] [ID] | |
| Modify an already existing host. | |
| Fields in the resource's --identity tuple can be used in lieu of a primary | |
| key for a lookup; in such a case, only other fields are written. | |
| To modify unique fields, you must use the primary key for the lookup. | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| -d, --description TEXT The description field. | |
| -i, --inventory INVENTORY [REQUIRED] The inventory field. | |
| --enabled BOOLEAN The enabled field. | |
| --variables VARIABLES Host variables, use "@" to get from file. | |
| --insights-system-id TEXT The insights_system_id field. | |
| Local Options: | |
| --create-on-missing If used, and if options rather than a primary key are | |
| used to attempt to match a record, will create the | |
| record if it does not exist. This is an alias to | |
| `create --force-on-exists`. [default: False] | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli instance --help | |
| Usage: tower-cli instance [OPTIONS] COMMAND [ARGS]... | |
| Check instances within Ansible Tower. | |
| Options: | |
| --help Show this message and exit. | |
| Commands: | |
| get Return one and exactly one instance. | |
| list Return a list of instances. | |
| # tower-cli instance get --help | |
| Usage: tower-cli instance get [OPTIONS] [ID] | |
| Return one and exactly one instance. | |
| Lookups may be through a primary key, specified as a positional argument, | |
| and/or through filters specified through options. | |
| If the number of results does not equal one, abort with an error. | |
| Field Options: | |
| --uuid TEXT The uuid field. | |
| --hostname TEXT The hostname field. | |
| --version TEXT The version field. | |
| --capacity INTEGER The capacity field. | |
| --consumed-capacity INTEGER The consumed_capacity field. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli instance list --help | |
| Usage: tower-cli instance list [OPTIONS] | |
| Return a list of instances. | |
| If one or more filters are provided through options, filter the results | |
| accordingly. | |
| If no filters are provided, return all results. | |
| Field Options: | |
| --uuid TEXT The uuid field. | |
| --hostname TEXT The hostname field. | |
| --version TEXT The version field. | |
| --capacity INTEGER The capacity field. | |
| --consumed-capacity INTEGER The consumed_capacity field. | |
| Local Options: | |
| -a, --all-pages If set, collate all pages of content from the API when | |
| returning results. [default: False] | |
| --page INTEGER The page to show. Ignored if --all-pages is sent. | |
| [default: 1] | |
| --page-size INTEGER Number of records to show. Ignored if --all-pages. | |
| -Q, --query TEXT... A key and value to be passed as an HTTP query string | |
| key and value to the Tower API. Will be run through | |
| HTTP escaping. This argument may be sent multiple | |
| times. | |
| Example: `--query foo bar` would be passed to | |
| Tower as ?foo=bar | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli instance_group --help | |
| Usage: tower-cli instance_group [OPTIONS] COMMAND [ARGS]... | |
| Check instance groups within Ansible Tower. | |
| Options: | |
| --help Show this message and exit. | |
| Commands: | |
| get Return one and exactly one instance group. | |
| list Return a list of instance groups. | |
| # tower-cli instance_group get --help | |
| Usage: tower-cli instance_group get [OPTIONS] [ID] | |
| Return one and exactly one instance group. | |
| Lookups may be through a primary key, specified as a positional argument, | |
| and/or through filters specified through options. | |
| If the number of results does not equal one, abort with an error. | |
| Field Options: | |
| -n, --name TEXT The name field. | |
| --capacity INTEGER The capacity field. | |
| --consumed-capacity INTEGER The consumed_capacity field. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli instance_group list --help | |
| Usage: tower-cli instance_group list [OPTIONS] | |
| Return a list of instance groups. | |
| If one or more filters are provided through options, filter the results | |
| accordingly. | |
| If no filters are provided, return all results. | |
| Field Options: | |
| -n, --name TEXT The name field. | |
| --capacity INTEGER The capacity field. | |
| --consumed-capacity INTEGER The consumed_capacity field. | |
| Local Options: | |
| -a, --all-pages If set, collate all pages of content from the API when | |
| returning results. [default: False] | |
| --page INTEGER The page to show. Ignored if --all-pages is sent. | |
| [default: 1] | |
| --page-size INTEGER Number of records to show. Ignored if --all-pages. | |
| -Q, --query TEXT... A key and value to be passed as an HTTP query string | |
| key and value to the Tower API. Will be run through | |
| HTTP escaping. This argument may be sent multiple | |
| times. | |
| Example: `--query foo bar` would be passed to | |
| Tower as ?foo=bar | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli inventory --help | |
| Usage: tower-cli inventory [OPTIONS] COMMAND [ARGS]... | |
| Manage inventory within Ansible Tower. | |
| Options: | |
| --help Show this message and exit. | |
| Commands: | |
| associate_ig Associate an ig with this inventory. | |
| batch_update Update all related inventory sources of the... | |
| copy Copy an inventory. | |
| create Create an inventory. | |
| delete Remove the given inventory. | |
| disassociate_ig Disassociate an ig with this inventory. | |
| get Return one and exactly one inventory. | |
| list Return a list of inventories. | |
| modify Modify an already existing inventory. | |
| # tower-cli inventory associate_ig --help | |
| Usage: tower-cli inventory associate_ig [OPTIONS] | |
| Associate an ig with this inventory. | |
| Local Options: | |
| --inventory INVENTORY [required] | |
| --instance_group INSTANCE_GROUP | |
| [required] | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli inventory batch_update --help | |
| Usage: tower-cli inventory batch_update [OPTIONS] [ID] | |
| Update all related inventory sources of the given inventory. | |
| Note global option --format is not available here, as the output would | |
| always be JSON-formatted. | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| -d, --description TEXT The description field. | |
| --organization ORGANIZATION [REQUIRED] The organization field. | |
| --variables VARIABLES Inventory variables, use "@" to get from | |
| file. | |
| --kind [|smart] The kind field. Cannot be modified after | |
| created. | |
| --host-filter TEXT The host_filter field. Only useful when | |
| kind=smart. | |
| --insights-credential CREDENTIAL | |
| The insights_credential field. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli inventory copy --help | |
| Usage: tower-cli inventory copy [OPTIONS] [ID] | |
| Copy an inventory. | |
| Only the ID is used for the lookup. All provided fields are used to | |
| override the old data from the copied resource. | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| -d, --description TEXT The description field. | |
| --organization ORGANIZATION [REQUIRED] The organization field. | |
| --variables VARIABLES Inventory variables, use "@" to get from | |
| file. | |
| --kind [|smart] The kind field. Cannot be modified after | |
| created. | |
| --host-filter TEXT The host_filter field. Only useful when | |
| kind=smart. | |
| --insights-credential CREDENTIAL | |
| The insights_credential field. | |
| Local Options: | |
| --new-name TEXT The name to give the new resource, if used, will deep copy | |
| in the backend. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli inventory create --help | |
| Usage: tower-cli inventory create [OPTIONS] | |
| Create an inventory. | |
| Fields in the resource's --identity tuple are used for a lookup; if a | |
| match is found, then no-op (unless --force-on-exists is set) but do not | |
| fail (unless --fail-on-found is set). | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| -d, --description TEXT The description field. | |
| --organization ORGANIZATION [REQUIRED] The organization field. | |
| --variables VARIABLES Inventory variables, use "@" to get from | |
| file. | |
| --kind [|smart] The kind field. Cannot be modified after | |
| created. | |
| --host-filter TEXT The host_filter field. Only useful when | |
| kind=smart. | |
| --insights-credential CREDENTIAL | |
| The insights_credential field. | |
| Local Options: | |
| --fail-on-found If used, return an error if a matching record already | |
| exists. [default: False] | |
| --force-on-exists If used, if a match is found on unique fields, other | |
| fields will be updated to the provided values. If False, | |
| a match causes the request to be a no-op. [default: | |
| False] | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli inventory delete --help | |
| Usage: tower-cli inventory delete [OPTIONS] [ID] | |
| Remove the given inventory. | |
| If --fail-on-missing is True, then the inventory's not being found is | |
| considered a failure; otherwise, a success with no change is reported. | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| -d, --description TEXT The description field. | |
| --organization ORGANIZATION [REQUIRED] The organization field. | |
| --variables VARIABLES Inventory variables, use "@" to get from | |
| file. | |
| --kind [|smart] The kind field. Cannot be modified after | |
| created. | |
| --host-filter TEXT The host_filter field. Only useful when | |
| kind=smart. | |
| --insights-credential CREDENTIAL | |
| The insights_credential field. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli inventory disassociate_ig --help | |
| Usage: tower-cli inventory disassociate_ig [OPTIONS] | |
| Disassociate an ig with this inventory. | |
| Local Options: | |
| --inventory INVENTORY [required] | |
| --instance_group INSTANCE_GROUP | |
| [required] | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli inventory get --help | |
| Usage: tower-cli inventory get [OPTIONS] [ID] | |
| Return one and exactly one inventory. | |
| Lookups may be through a primary key, specified as a positional argument, | |
| and/or through filters specified through options. | |
| If the number of results does not equal one, abort with an error. | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| -d, --description TEXT The description field. | |
| --organization ORGANIZATION [REQUIRED] The organization field. | |
| --variables VARIABLES Inventory variables, use "@" to get from | |
| file. | |
| --kind [|smart] The kind field. Cannot be modified after | |
| created. | |
| --host-filter TEXT The host_filter field. Only useful when | |
| kind=smart. | |
| --insights-credential CREDENTIAL | |
| The insights_credential field. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli inventory list --help | |
| Usage: tower-cli inventory list [OPTIONS] | |
| Return a list of inventories. | |
| If one or more filters are provided through options, filter the results | |
| accordingly. | |
| If no filters are provided, return all results. | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| -d, --description TEXT The description field. | |
| --organization ORGANIZATION [REQUIRED] The organization field. | |
| --variables VARIABLES Inventory variables, use "@" to get from | |
| file. | |
| --kind [|smart] The kind field. Cannot be modified after | |
| created. | |
| --host-filter TEXT The host_filter field. Only useful when | |
| kind=smart. | |
| --insights-credential CREDENTIAL | |
| The insights_credential field. | |
| Local Options: | |
| -a, --all-pages If set, collate all pages of content from the API when | |
| returning results. [default: False] | |
| --page INTEGER The page to show. Ignored if --all-pages is sent. | |
| [default: 1] | |
| --page-size INTEGER Number of records to show. Ignored if --all-pages. | |
| -Q, --query TEXT... A key and value to be passed as an HTTP query string | |
| key and value to the Tower API. Will be run through | |
| HTTP escaping. This argument may be sent multiple | |
| times. | |
| Example: `--query foo bar` would be passed to | |
| Tower as ?foo=bar | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli inventory modify --help | |
| Usage: tower-cli inventory modify [OPTIONS] [ID] | |
| Modify an already existing inventory. | |
| Fields in the resource's --identity tuple can be used in lieu of a primary | |
| key for a lookup; in such a case, only other fields are written. | |
| To modify unique fields, you must use the primary key for the lookup. | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| -d, --description TEXT The description field. | |
| --organization ORGANIZATION [REQUIRED] The organization field. | |
| --variables VARIABLES Inventory variables, use "@" to get from | |
| file. | |
| --kind [|smart] The kind field. Cannot be modified after | |
| created. | |
| --host-filter TEXT The host_filter field. Only useful when | |
| kind=smart. | |
| --insights-credential CREDENTIAL | |
| The insights_credential field. | |
| Local Options: | |
| --create-on-missing If used, and if options rather than a primary key are | |
| used to attempt to match a record, will create the | |
| record if it does not exist. This is an alias to | |
| `create --force-on-exists`. [default: False] | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli inventory_script --help | |
| Usage: tower-cli inventory_script [OPTIONS] COMMAND [ARGS]... | |
| Manage inventory scripts within Ansible Tower. | |
| Options: | |
| --help Show this message and exit. | |
| Commands: | |
| copy Copy an inventory script. | |
| create Create an inventory script. | |
| delete Remove the given inventory script. | |
| get Return one and exactly one inventory script. | |
| list Return a list of inventory scripts. | |
| modify Modify an already existing inventory script. | |
| # tower-cli inventory_script copy --help | |
| Usage: tower-cli inventory_script copy [OPTIONS] [ID] | |
| Copy an inventory script. | |
| Only the ID is used for the lookup. All provided fields are used to | |
| override the old data from the copied resource. | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| -d, --description TEXT The description field. | |
| --script VARIABLES [REQUIRED] Script code to fetch inventory, | |
| prefix with "@" to use contents of file for | |
| this field. | |
| --organization ORGANIZATION [REQUIRED] The organization field. | |
| Local Options: | |
| --new-name TEXT The name to give the new resource, if used, will deep copy | |
| in the backend. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli inventory_script create --help | |
| Usage: tower-cli inventory_script create [OPTIONS] | |
| Create an inventory script. | |
| Fields in the resource's --identity tuple are used for a lookup; if a | |
| match is found, then no-op (unless --force-on-exists is set) but do not | |
| fail (unless --fail-on-found is set). | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| -d, --description TEXT The description field. | |
| --script VARIABLES [REQUIRED] Script code to fetch inventory, | |
| prefix with "@" to use contents of file for | |
| this field. | |
| --organization ORGANIZATION [REQUIRED] The organization field. | |
| Local Options: | |
| --fail-on-found If used, return an error if a matching record already | |
| exists. [default: False] | |
| --force-on-exists If used, if a match is found on unique fields, other | |
| fields will be updated to the provided values. If False, | |
| a match causes the request to be a no-op. [default: | |
| False] | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli inventory_script delete --help | |
| Usage: tower-cli inventory_script delete [OPTIONS] [ID] | |
| Remove the given inventory script. | |
| If --fail-on-missing is True, then the inventory script's not being found | |
| is considered a failure; otherwise, a success with no change is reported. | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| -d, --description TEXT The description field. | |
| --script VARIABLES [REQUIRED] Script code to fetch inventory, | |
| prefix with "@" to use contents of file for | |
| this field. | |
| --organization ORGANIZATION [REQUIRED] The organization field. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli inventory_script get --help | |
| Usage: tower-cli inventory_script get [OPTIONS] [ID] | |
| Return one and exactly one inventory script. | |
| Lookups may be through a primary key, specified as a positional argument, | |
| and/or through filters specified through options. | |
| If the number of results does not equal one, abort with an error. | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| -d, --description TEXT The description field. | |
| --script VARIABLES [REQUIRED] Script code to fetch inventory, | |
| prefix with "@" to use contents of file for | |
| this field. | |
| --organization ORGANIZATION [REQUIRED] The organization field. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli inventory_script list --help | |
| Usage: tower-cli inventory_script list [OPTIONS] | |
| Return a list of inventory scripts. | |
| If one or more filters are provided through options, filter the results | |
| accordingly. | |
| If no filters are provided, return all results. | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| -d, --description TEXT The description field. | |
| --script VARIABLES [REQUIRED] Script code to fetch inventory, | |
| prefix with "@" to use contents of file for | |
| this field. | |
| --organization ORGANIZATION [REQUIRED] The organization field. | |
| Local Options: | |
| -a, --all-pages If set, collate all pages of content from the API when | |
| returning results. [default: False] | |
| --page INTEGER The page to show. Ignored if --all-pages is sent. | |
| [default: 1] | |
| --page-size INTEGER Number of records to show. Ignored if --all-pages. | |
| -Q, --query TEXT... A key and value to be passed as an HTTP query string | |
| key and value to the Tower API. Will be run through | |
| HTTP escaping. This argument may be sent multiple | |
| times. | |
| Example: `--query foo bar` would be passed to | |
| Tower as ?foo=bar | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli inventory_script modify --help | |
| Usage: tower-cli inventory_script modify [OPTIONS] [ID] | |
| Modify an already existing inventory script. | |
| Fields in the resource's --identity tuple can be used in lieu of a primary | |
| key for a lookup; in such a case, only other fields are written. | |
| To modify unique fields, you must use the primary key for the lookup. | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| -d, --description TEXT The description field. | |
| --script VARIABLES [REQUIRED] Script code to fetch inventory, | |
| prefix with "@" to use contents of file for | |
| this field. | |
| --organization ORGANIZATION [REQUIRED] The organization field. | |
| Local Options: | |
| --create-on-missing If used, and if options rather than a primary key are | |
| used to attempt to match a record, will create the | |
| record if it does not exist. This is an alias to | |
| `create --force-on-exists`. [default: False] | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli inventory_source --help | |
| Usage: tower-cli inventory_source [OPTIONS] COMMAND [ARGS]... | |
| Manage inventory sources within Ansible Tower. | |
| Options: | |
| --help Show this message and exit. | |
| Commands: | |
| copy Copy an inventory source. | |
| create Create an inventory source. | |
| delete Remove the given inventory source. | |
| get Return one and exactly one inventory source. | |
| list Return a list of inventory sources. | |
| modify Modify an already existing inventory source. | |
| monitor Stream the standard output from a job,... | |
| status Print the status of the most recent sync. | |
| stdout Print out the standard out of a unified job... | |
| update Update the given inventory source. | |
| wait Wait for a running job to finish. | |
| # tower-cli inventory_source copy --help | |
| Usage: tower-cli inventory_source copy [OPTIONS] [ID] | |
| Copy an inventory source. | |
| Only the ID is used for the lookup. All provided fields are used to | |
| override the old data from the copied resource. | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| -d, --description TEXT The description field. | |
| -i, --inventory INVENTORY [REQUIRED] The inventory field. | |
| --source [|file|scm|ec2|vmware|gce|azure|azure_rm|openstack|satellite6|cloudforms|custom] | |
| [REQUIRED] The type of inventory source in | |
| use. | |
| --credential CREDENTIAL The credential field. | |
| --source-vars TEXT The source_vars field. | |
| --timeout INTEGER The timeout field (in seconds). | |
| --source-project PROJECT Use project files as source for inventory. | |
| --source-path TEXT File in SCM Project to use as source. | |
| --update-on-project-update BOOLEAN | |
| The update_on_project_update field. | |
| --source-regions TEXT The source_regions field. | |
| --instance-filters TEXT The instance_filters field. | |
| --group-by TEXT The group_by field. | |
| --source-script INVENTORY_SCRIPT | |
| The source_script field. | |
| --overwrite BOOLEAN The overwrite field. | |
| --overwrite-vars BOOLEAN The overwrite_vars field. | |
| --update-on-launch BOOLEAN The update_on_launch field. | |
| --update-cache-timeout INTEGER The update_cache_timeout field. | |
| Local Options: | |
| --new-name TEXT The name to give the new resource, if used, will deep copy | |
| in the backend. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli inventory_source create --help | |
| Usage: tower-cli inventory_source create [OPTIONS] | |
| Create an inventory source. | |
| Fields in the resource's --identity tuple are used for a lookup; if a | |
| match is found, then no-op (unless --force-on-exists is set) but do not | |
| fail (unless --fail-on-found is set). | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| -d, --description TEXT The description field. | |
| -i, --inventory INVENTORY [REQUIRED] The inventory field. | |
| --source [|file|scm|ec2|vmware|gce|azure|azure_rm|openstack|satellite6|cloudforms|custom] | |
| [REQUIRED] The type of inventory source in | |
| use. | |
| --credential CREDENTIAL The credential field. | |
| --source-vars TEXT The source_vars field. | |
| --timeout INTEGER The timeout field (in seconds). | |
| --source-project PROJECT Use project files as source for inventory. | |
| --source-path TEXT File in SCM Project to use as source. | |
| --update-on-project-update BOOLEAN | |
| The update_on_project_update field. | |
| --source-regions TEXT The source_regions field. | |
| --instance-filters TEXT The instance_filters field. | |
| --group-by TEXT The group_by field. | |
| --source-script INVENTORY_SCRIPT | |
| The source_script field. | |
| --overwrite BOOLEAN The overwrite field. | |
| --overwrite-vars BOOLEAN The overwrite_vars field. | |
| --update-on-launch BOOLEAN The update_on_launch field. | |
| --update-cache-timeout INTEGER The update_cache_timeout field. | |
| Local Options: | |
| --fail-on-found If used, return an error if a matching record already | |
| exists. [default: False] | |
| --force-on-exists If used, if a match is found on unique fields, other | |
| fields will be updated to the provided values. If False, | |
| a match causes the request to be a no-op. [default: | |
| False] | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli inventory_source delete --help | |
| Usage: tower-cli inventory_source delete [OPTIONS] [ID] | |
| Remove the given inventory source. | |
| If --fail-on-missing is True, then the inventory source's not being found | |
| is considered a failure; otherwise, a success with no change is reported. | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| -d, --description TEXT The description field. | |
| -i, --inventory INVENTORY [REQUIRED] The inventory field. | |
| --source [|file|scm|ec2|vmware|gce|azure|azure_rm|openstack|satellite6|cloudforms|custom] | |
| [REQUIRED] The type of inventory source in | |
| use. | |
| --credential CREDENTIAL The credential field. | |
| --source-vars TEXT The source_vars field. | |
| --timeout INTEGER The timeout field (in seconds). | |
| --source-project PROJECT Use project files as source for inventory. | |
| --source-path TEXT File in SCM Project to use as source. | |
| --update-on-project-update BOOLEAN | |
| The update_on_project_update field. | |
| --source-regions TEXT The source_regions field. | |
| --instance-filters TEXT The instance_filters field. | |
| --group-by TEXT The group_by field. | |
| --source-script INVENTORY_SCRIPT | |
| The source_script field. | |
| --overwrite BOOLEAN The overwrite field. | |
| --overwrite-vars BOOLEAN The overwrite_vars field. | |
| --update-on-launch BOOLEAN The update_on_launch field. | |
| --update-cache-timeout INTEGER The update_cache_timeout field. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli inventory_source get --help | |
| Usage: tower-cli inventory_source get [OPTIONS] [ID] | |
| Return one and exactly one inventory source. | |
| Lookups may be through a primary key, specified as a positional argument, | |
| and/or through filters specified through options. | |
| If the number of results does not equal one, abort with an error. | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| -d, --description TEXT The description field. | |
| -i, --inventory INVENTORY [REQUIRED] The inventory field. | |
| --source [|file|scm|ec2|vmware|gce|azure|azure_rm|openstack|satellite6|cloudforms|custom] | |
| [REQUIRED] The type of inventory source in | |
| use. | |
| --credential CREDENTIAL The credential field. | |
| --source-vars TEXT The source_vars field. | |
| --timeout INTEGER The timeout field (in seconds). | |
| --source-project PROJECT Use project files as source for inventory. | |
| --source-path TEXT File in SCM Project to use as source. | |
| --update-on-project-update BOOLEAN | |
| The update_on_project_update field. | |
| --source-regions TEXT The source_regions field. | |
| --instance-filters TEXT The instance_filters field. | |
| --group-by TEXT The group_by field. | |
| --source-script INVENTORY_SCRIPT | |
| The source_script field. | |
| --overwrite BOOLEAN The overwrite field. | |
| --overwrite-vars BOOLEAN The overwrite_vars field. | |
| --update-on-launch BOOLEAN The update_on_launch field. | |
| --update-cache-timeout INTEGER The update_cache_timeout field. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli inventory_source list --help | |
| Usage: tower-cli inventory_source list [OPTIONS] | |
| Return a list of inventory sources. | |
| If one or more filters are provided through options, filter the results | |
| accordingly. | |
| If no filters are provided, return all results. | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| -d, --description TEXT The description field. | |
| -i, --inventory INVENTORY [REQUIRED] The inventory field. | |
| --source [|file|scm|ec2|vmware|gce|azure|azure_rm|openstack|satellite6|cloudforms|custom] | |
| [REQUIRED] The type of inventory source in | |
| use. | |
| --credential CREDENTIAL The credential field. | |
| --source-vars TEXT The source_vars field. | |
| --timeout INTEGER The timeout field (in seconds). | |
| --source-project PROJECT Use project files as source for inventory. | |
| --source-path TEXT File in SCM Project to use as source. | |
| --update-on-project-update BOOLEAN | |
| The update_on_project_update field. | |
| --source-regions TEXT The source_regions field. | |
| --instance-filters TEXT The instance_filters field. | |
| --group-by TEXT The group_by field. | |
| --source-script INVENTORY_SCRIPT | |
| The source_script field. | |
| --overwrite BOOLEAN The overwrite field. | |
| --overwrite-vars BOOLEAN The overwrite_vars field. | |
| --update-on-launch BOOLEAN The update_on_launch field. | |
| --update-cache-timeout INTEGER The update_cache_timeout field. | |
| Local Options: | |
| -a, --all-pages If set, collate all pages of content from the API when | |
| returning results. [default: False] | |
| --page INTEGER The page to show. Ignored if --all-pages is sent. | |
| [default: 1] | |
| --page-size INTEGER Number of records to show. Ignored if --all-pages. | |
| -Q, --query TEXT... A key and value to be passed as an HTTP query string | |
| key and value to the Tower API. Will be run through | |
| HTTP escaping. This argument may be sent multiple | |
| times. | |
| Example: `--query foo bar` would be passed to | |
| Tower as ?foo=bar | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli inventory_source modify --help | |
| Usage: tower-cli inventory_source modify [OPTIONS] [ID] | |
| Modify an already existing inventory source. | |
| Fields in the resource's --identity tuple can be used in lieu of a primary | |
| key for a lookup; in such a case, only other fields are written. | |
| To modify unique fields, you must use the primary key for the lookup. | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| -d, --description TEXT The description field. | |
| -i, --inventory INVENTORY [REQUIRED] The inventory field. | |
| --source [|file|scm|ec2|vmware|gce|azure|azure_rm|openstack|satellite6|cloudforms|custom] | |
| [REQUIRED] The type of inventory source in | |
| use. | |
| --credential CREDENTIAL The credential field. | |
| --source-vars TEXT The source_vars field. | |
| --timeout INTEGER The timeout field (in seconds). | |
| --source-project PROJECT Use project files as source for inventory. | |
| --source-path TEXT File in SCM Project to use as source. | |
| --update-on-project-update BOOLEAN | |
| The update_on_project_update field. | |
| --source-regions TEXT The source_regions field. | |
| --instance-filters TEXT The instance_filters field. | |
| --group-by TEXT The group_by field. | |
| --source-script INVENTORY_SCRIPT | |
| The source_script field. | |
| --overwrite BOOLEAN The overwrite field. | |
| --overwrite-vars BOOLEAN The overwrite_vars field. | |
| --update-on-launch BOOLEAN The update_on_launch field. | |
| --update-cache-timeout INTEGER The update_cache_timeout field. | |
| Local Options: | |
| --create-on-missing If used, and if options rather than a primary key are | |
| used to attempt to match a record, will create the | |
| record if it does not exist. This is an alias to | |
| `create --force-on-exists`. [default: False] | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli inventory_source monitor --help | |
| Usage: tower-cli inventory_source monitor [OPTIONS] [ID] | |
| Stream the standard output from a job, project update, or inventory | |
| udpate. | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| -d, --description TEXT The description field. | |
| -i, --inventory INVENTORY [REQUIRED] The inventory field. | |
| --source [|file|scm|ec2|vmware|gce|azure|azure_rm|openstack|satellite6|cloudforms|custom] | |
| [REQUIRED] The type of inventory source in | |
| use. | |
| --credential CREDENTIAL The credential field. | |
| --source-vars TEXT The source_vars field. | |
| --timeout INTEGER The timeout field (in seconds). | |
| --source-project PROJECT Use project files as source for inventory. | |
| --source-path TEXT File in SCM Project to use as source. | |
| --update-on-project-update BOOLEAN | |
| The update_on_project_update field. | |
| --source-regions TEXT The source_regions field. | |
| --instance-filters TEXT The instance_filters field. | |
| --group-by TEXT The group_by field. | |
| --source-script INVENTORY_SCRIPT | |
| The source_script field. | |
| --overwrite BOOLEAN The overwrite field. | |
| --overwrite-vars BOOLEAN The overwrite_vars field. | |
| --update-on-launch BOOLEAN The update_on_launch field. | |
| --update-cache-timeout INTEGER The update_cache_timeout field. | |
| Local Options: | |
| --interval FLOAT Polling interval to refresh content from Tower. | |
| --timeout INTEGER If provided, this command (not the job) will time out | |
| after the given number of seconds. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli inventory_source status --help | |
| Usage: tower-cli inventory_source status [OPTIONS] [ID] | |
| Print the status of the most recent sync. | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| -d, --description TEXT The description field. | |
| -i, --inventory INVENTORY [REQUIRED] The inventory field. | |
| --source [|file|scm|ec2|vmware|gce|azure|azure_rm|openstack|satellite6|cloudforms|custom] | |
| [REQUIRED] The type of inventory source in | |
| use. | |
| --credential CREDENTIAL The credential field. | |
| --source-vars TEXT The source_vars field. | |
| --timeout INTEGER The timeout field (in seconds). | |
| --source-project PROJECT Use project files as source for inventory. | |
| --source-path TEXT File in SCM Project to use as source. | |
| --update-on-project-update BOOLEAN | |
| The update_on_project_update field. | |
| --source-regions TEXT The source_regions field. | |
| --instance-filters TEXT The instance_filters field. | |
| --group-by TEXT The group_by field. | |
| --source-script INVENTORY_SCRIPT | |
| The source_script field. | |
| --overwrite BOOLEAN The overwrite field. | |
| --overwrite-vars BOOLEAN The overwrite_vars field. | |
| --update-on-launch BOOLEAN The update_on_launch field. | |
| --update-cache-timeout INTEGER The update_cache_timeout field. | |
| Local Options: | |
| --detail Print more detail. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli inventory_source stdout --help | |
| Usage: tower-cli inventory_source stdout [OPTIONS] [ID] | |
| Print out the standard out of a unified job to the command line. For | |
| Projects, print the standard out of most recent update. For Inventory | |
| Sources, print standard out of most recent sync. For Jobs, print the job's | |
| standard out. For Workflow Jobs, print a status table of its jobs. | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| -d, --description TEXT The description field. | |
| -i, --inventory INVENTORY [REQUIRED] The inventory field. | |
| --source [|file|scm|ec2|vmware|gce|azure|azure_rm|openstack|satellite6|cloudforms|custom] | |
| [REQUIRED] The type of inventory source in | |
| use. | |
| --credential CREDENTIAL The credential field. | |
| --source-vars TEXT The source_vars field. | |
| --timeout INTEGER The timeout field (in seconds). | |
| --source-project PROJECT Use project files as source for inventory. | |
| --source-path TEXT File in SCM Project to use as source. | |
| --update-on-project-update BOOLEAN | |
| The update_on_project_update field. | |
| --source-regions TEXT The source_regions field. | |
| --instance-filters TEXT The instance_filters field. | |
| --group-by TEXT The group_by field. | |
| --source-script INVENTORY_SCRIPT | |
| The source_script field. | |
| --overwrite BOOLEAN The overwrite field. | |
| --overwrite-vars BOOLEAN The overwrite_vars field. | |
| --update-on-launch BOOLEAN The update_on_launch field. | |
| --update-cache-timeout INTEGER The update_cache_timeout field. | |
| Local Options: | |
| --start-line INTEGER Line at which to start printing the standard out. | |
| --end-line INTEGER Line at which to end printing the standard out. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli inventory_source update --help | |
| Usage: tower-cli inventory_source update [OPTIONS] INVENTORY_SOURCE | |
| Update the given inventory source. | |
| Local Options: | |
| --monitor If sent, immediately calls `monitor` on the newly | |
| launched job rather than exiting with a success. | |
| --wait Polls server for status, exists when finished. | |
| --timeout INTEGER If provided with --monitor, this command (not the job) | |
| will time out after the given number of seconds. Does | |
| nothing if --monitor is not sent. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli inventory_source wait --help | |
| Usage: tower-cli inventory_source wait [OPTIONS] [ID] | |
| Wait for a running job to finish. Blocks further input until the job | |
| completes (whether successfully or unsuccessfully) and a final status can | |
| be given. | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| -d, --description TEXT The description field. | |
| -i, --inventory INVENTORY [REQUIRED] The inventory field. | |
| --source [|file|scm|ec2|vmware|gce|azure|azure_rm|openstack|satellite6|cloudforms|custom] | |
| [REQUIRED] The type of inventory source in | |
| use. | |
| --credential CREDENTIAL The credential field. | |
| --source-vars TEXT The source_vars field. | |
| --timeout INTEGER The timeout field (in seconds). | |
| --source-project PROJECT Use project files as source for inventory. | |
| --source-path TEXT File in SCM Project to use as source. | |
| --update-on-project-update BOOLEAN | |
| The update_on_project_update field. | |
| --source-regions TEXT The source_regions field. | |
| --instance-filters TEXT The instance_filters field. | |
| --group-by TEXT The group_by field. | |
| --source-script INVENTORY_SCRIPT | |
| The source_script field. | |
| --overwrite BOOLEAN The overwrite field. | |
| --overwrite-vars BOOLEAN The overwrite_vars field. | |
| --update-on-launch BOOLEAN The update_on_launch field. | |
| --update-cache-timeout INTEGER The update_cache_timeout field. | |
| Local Options: | |
| --min-interval INTEGER The minimum interval to request an update from | |
| Tower. | |
| --max-interval INTEGER The maximum interval to request an update from | |
| Tower. | |
| --timeout INTEGER If provided, this command (not the job) will time | |
| out after the given number of seconds. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli inventory_update --help | |
| Usage: tower-cli inventory_update [OPTIONS] COMMAND [ARGS]... | |
| Launch or monitor inventory source updates. | |
| Options: | |
| --help Show this message and exit. | |
| Commands: | |
| cancel Cancel a currently running job. | |
| delete Remove the given inventory update. | |
| get Return one and exactly one inventory update. | |
| list Return a list of inventory updates. | |
| monitor Stream the standard output from a job,... | |
| relaunch Relaunch a stopped job. | |
| status Print the current job status. | |
| stdout Print out the standard out of a unified job... | |
| wait Wait for a running job to finish. | |
| # tower-cli inventory_update cancel --help | |
| Usage: tower-cli inventory_update cancel [OPTIONS] [ID] | |
| Cancel a currently running job. | |
| Fails with a non-zero exit status if the job cannot be canceled. You must | |
| provide either a pk or parameters in the job's identity. | |
| Field Options: | |
| -I, --inventory-source INVENTORY_SOURCE | |
| [REQUIRED] The inventory_source field. | |
| -n, --name TEXT [READ ONLY] The name field. | |
| --launch-type [manual|relaunch|relaunch|callback|scheduled|dependency|workflow|sync|scm] | |
| [REQUIRED] The launch_type field. | |
| --status [new|pending|waiting|running|successful|failed|error|canceled] | |
| [REQUIRED] The status field. | |
| --job-explanation TEXT [READ ONLY] The job_explanation field. | |
| --created TEXT [READ ONLY] The created field. | |
| --elapsed TEXT [READ ONLY] The elapsed field. | |
| --source [|file|scm|ec2|vmware|gce|azure|azure_rm|openstack|satellite6|cloudforms|custom] | |
| [REQUIRED] The source field. | |
| Local Options: | |
| --fail-if-not-running Fail loudly if the job is not currently running. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli inventory_update delete --help | |
| Usage: tower-cli inventory_update delete [OPTIONS] [ID] | |
| Remove the given inventory update. | |
| If --fail-on-missing is True, then the inventory update's not being found | |
| is considered a failure; otherwise, a success with no change is reported. | |
| Field Options: | |
| -I, --inventory-source INVENTORY_SOURCE | |
| [REQUIRED] The inventory_source field. | |
| -n, --name TEXT [READ ONLY] The name field. | |
| --launch-type [manual|relaunch|relaunch|callback|scheduled|dependency|workflow|sync|scm] | |
| [REQUIRED] The launch_type field. | |
| --status [new|pending|waiting|running|successful|failed|error|canceled] | |
| [REQUIRED] The status field. | |
| --job-explanation TEXT [READ ONLY] The job_explanation field. | |
| --created TEXT [READ ONLY] The created field. | |
| --elapsed TEXT [READ ONLY] The elapsed field. | |
| --source [|file|scm|ec2|vmware|gce|azure|azure_rm|openstack|satellite6|cloudforms|custom] | |
| [REQUIRED] The source field. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli inventory_update get --help | |
| Usage: tower-cli inventory_update get [OPTIONS] [ID] | |
| Return one and exactly one inventory update. | |
| Lookups may be through a primary key, specified as a positional argument, | |
| and/or through filters specified through options. | |
| If the number of results does not equal one, abort with an error. | |
| Field Options: | |
| -I, --inventory-source INVENTORY_SOURCE | |
| [REQUIRED] The inventory_source field. | |
| -n, --name TEXT [READ ONLY] The name field. | |
| --launch-type [manual|relaunch|relaunch|callback|scheduled|dependency|workflow|sync|scm] | |
| [REQUIRED] The launch_type field. | |
| --status [new|pending|waiting|running|successful|failed|error|canceled] | |
| [REQUIRED] The status field. | |
| --job-explanation TEXT [READ ONLY] The job_explanation field. | |
| --created TEXT [READ ONLY] The created field. | |
| --elapsed TEXT [READ ONLY] The elapsed field. | |
| --source [|file|scm|ec2|vmware|gce|azure|azure_rm|openstack|satellite6|cloudforms|custom] | |
| [REQUIRED] The source field. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli inventory_update list --help | |
| Usage: tower-cli inventory_update list [OPTIONS] | |
| Return a list of inventory updates. | |
| If one or more filters are provided through options, filter the results | |
| accordingly. | |
| If no filters are provided, return all results. | |
| Field Options: | |
| -I, --inventory-source INVENTORY_SOURCE | |
| [REQUIRED] The inventory_source field. | |
| -n, --name TEXT [READ ONLY] The name field. | |
| --launch-type [manual|relaunch|relaunch|callback|scheduled|dependency|workflow|sync|scm] | |
| [REQUIRED] The launch_type field. | |
| --status [new|pending|waiting|running|successful|failed|error|canceled] | |
| [REQUIRED] The status field. | |
| --job-explanation TEXT [READ ONLY] The job_explanation field. | |
| --created TEXT [READ ONLY] The created field. | |
| --elapsed TEXT [READ ONLY] The elapsed field. | |
| --source [|file|scm|ec2|vmware|gce|azure|azure_rm|openstack|satellite6|cloudforms|custom] | |
| [REQUIRED] The source field. | |
| Local Options: | |
| -a, --all-pages If set, collate all pages of content from the API when | |
| returning results. [default: False] | |
| --page INTEGER The page to show. Ignored if --all-pages is sent. | |
| [default: 1] | |
| --page-size INTEGER Number of records to show. Ignored if --all-pages. | |
| -Q, --query TEXT... A key and value to be passed as an HTTP query string | |
| key and value to the Tower API. Will be run through | |
| HTTP escaping. This argument may be sent multiple | |
| times. | |
| Example: `--query foo bar` would be passed to | |
| Tower as ?foo=bar | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli inventory_update monitor --help | |
| Usage: tower-cli inventory_update monitor [OPTIONS] [ID] | |
| Stream the standard output from a job, project update, or inventory | |
| udpate. | |
| Field Options: | |
| -I, --inventory-source INVENTORY_SOURCE | |
| [REQUIRED] The inventory_source field. | |
| -n, --name TEXT [READ ONLY] The name field. | |
| --launch-type [manual|relaunch|relaunch|callback|scheduled|dependency|workflow|sync|scm] | |
| [REQUIRED] The launch_type field. | |
| --status [new|pending|waiting|running|successful|failed|error|canceled] | |
| [REQUIRED] The status field. | |
| --job-explanation TEXT [READ ONLY] The job_explanation field. | |
| --created TEXT [READ ONLY] The created field. | |
| --elapsed TEXT [READ ONLY] The elapsed field. | |
| --source [|file|scm|ec2|vmware|gce|azure|azure_rm|openstack|satellite6|cloudforms|custom] | |
| [REQUIRED] The source field. | |
| Local Options: | |
| --interval FLOAT Polling interval to refresh content from Tower. | |
| --timeout INTEGER If provided, this command (not the job) will time out | |
| after the given number of seconds. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli inventory_update relaunch --help | |
| Usage: tower-cli inventory_update relaunch [OPTIONS] [ID] | |
| Relaunch a stopped job. | |
| Fails with a non-zero exit status if the job cannot be relaunched. You | |
| must provide either a pk or parameters in the job's identity. | |
| Field Options: | |
| -I, --inventory-source INVENTORY_SOURCE | |
| [REQUIRED] The inventory_source field. | |
| -n, --name TEXT [READ ONLY] The name field. | |
| --launch-type [manual|relaunch|relaunch|callback|scheduled|dependency|workflow|sync|scm] | |
| [REQUIRED] The launch_type field. | |
| --status [new|pending|waiting|running|successful|failed|error|canceled] | |
| [REQUIRED] The status field. | |
| --job-explanation TEXT [READ ONLY] The job_explanation field. | |
| --created TEXT [READ ONLY] The created field. | |
| --elapsed TEXT [READ ONLY] The elapsed field. | |
| --source [|file|scm|ec2|vmware|gce|azure|azure_rm|openstack|satellite6|cloudforms|custom] | |
| [REQUIRED] The source field. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli inventory_update status --help | |
| Usage: tower-cli inventory_update status [OPTIONS] [ID] | |
| Print the current job status. This is used to check a running job. You can | |
| look up the job with the same parameters used for a get request. | |
| Field Options: | |
| -I, --inventory-source INVENTORY_SOURCE | |
| [REQUIRED] The inventory_source field. | |
| -n, --name TEXT [READ ONLY] The name field. | |
| --launch-type [manual|relaunch|relaunch|callback|scheduled|dependency|workflow|sync|scm] | |
| [REQUIRED] The launch_type field. | |
| --status [new|pending|waiting|running|successful|failed|error|canceled] | |
| [REQUIRED] The status field. | |
| --job-explanation TEXT [READ ONLY] The job_explanation field. | |
| --created TEXT [READ ONLY] The created field. | |
| --elapsed TEXT [READ ONLY] The elapsed field. | |
| --source [|file|scm|ec2|vmware|gce|azure|azure_rm|openstack|satellite6|cloudforms|custom] | |
| [REQUIRED] The source field. | |
| Local Options: | |
| --detail Print more detail. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli inventory_update stdout --help | |
| Usage: tower-cli inventory_update stdout [OPTIONS] [ID] | |
| Print out the standard out of a unified job to the command line. For | |
| Projects, print the standard out of most recent update. For Inventory | |
| Sources, print standard out of most recent sync. For Jobs, print the job's | |
| standard out. For Workflow Jobs, print a status table of its jobs. | |
| Field Options: | |
| -I, --inventory-source INVENTORY_SOURCE | |
| [REQUIRED] The inventory_source field. | |
| -n, --name TEXT [READ ONLY] The name field. | |
| --launch-type [manual|relaunch|relaunch|callback|scheduled|dependency|workflow|sync|scm] | |
| [REQUIRED] The launch_type field. | |
| --status [new|pending|waiting|running|successful|failed|error|canceled] | |
| [REQUIRED] The status field. | |
| --job-explanation TEXT [READ ONLY] The job_explanation field. | |
| --created TEXT [READ ONLY] The created field. | |
| --elapsed TEXT [READ ONLY] The elapsed field. | |
| --source [|file|scm|ec2|vmware|gce|azure|azure_rm|openstack|satellite6|cloudforms|custom] | |
| [REQUIRED] The source field. | |
| Local Options: | |
| --start-line INTEGER Line at which to start printing the standard out. | |
| --end-line INTEGER Line at which to end printing the standard out. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli inventory_update wait --help | |
| Usage: tower-cli inventory_update wait [OPTIONS] [ID] | |
| Wait for a running job to finish. Blocks further input until the job | |
| completes (whether successfully or unsuccessfully) and a final status can | |
| be given. | |
| Field Options: | |
| -I, --inventory-source INVENTORY_SOURCE | |
| [REQUIRED] The inventory_source field. | |
| -n, --name TEXT [READ ONLY] The name field. | |
| --launch-type [manual|relaunch|relaunch|callback|scheduled|dependency|workflow|sync|scm] | |
| [REQUIRED] The launch_type field. | |
| --status [new|pending|waiting|running|successful|failed|error|canceled] | |
| [REQUIRED] The status field. | |
| --job-explanation TEXT [READ ONLY] The job_explanation field. | |
| --created TEXT [READ ONLY] The created field. | |
| --elapsed TEXT [READ ONLY] The elapsed field. | |
| --source [|file|scm|ec2|vmware|gce|azure|azure_rm|openstack|satellite6|cloudforms|custom] | |
| [REQUIRED] The source field. | |
| Local Options: | |
| --min-interval INTEGER The minimum interval to request an update from | |
| Tower. | |
| --max-interval INTEGER The maximum interval to request an update from | |
| Tower. | |
| --timeout INTEGER If provided, this command (not the job) will time | |
| out after the given number of seconds. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli job --help | |
| Usage: tower-cli job [OPTIONS] COMMAND [ARGS]... | |
| Launch or monitor jobs. | |
| Options: | |
| --help Show this message and exit. | |
| Commands: | |
| cancel Cancel a currently running job. | |
| delete Remove the given job. | |
| get Return one and exactly one job. | |
| launch Launch a new job based on a job template. | |
| list Return a list of jobs. | |
| monitor Stream the standard output from a job,... | |
| relaunch Relaunch a stopped job. | |
| status Print the current job status. | |
| stdout Print out the standard out of a unified job... | |
| wait Wait for a running job to finish. | |
| # tower-cli job cancel --help | |
| Usage: tower-cli job cancel [OPTIONS] [ID] | |
| Cancel a currently running job. | |
| Fails with a non-zero exit status if the job cannot be canceled. You must | |
| provide either a pk or parameters in the job's identity. | |
| Field Options: | |
| -J, --job-template JOB_TEMPLATE | |
| The job_template field. | |
| --job-explanation TEXT [READ ONLY] The job_explanation field. | |
| --created TEXT The created field. | |
| --status TEXT The status field. | |
| --elapsed TEXT The elapsed field. | |
| Local Options: | |
| --fail-if-not-running Fail loudly if the job is not currently running. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli job delete --help | |
| Usage: tower-cli job delete [OPTIONS] [ID] | |
| Remove the given job. | |
| If --fail-on-missing is True, then the job's not being found is considered | |
| a failure; otherwise, a success with no change is reported. | |
| Field Options: | |
| -J, --job-template JOB_TEMPLATE | |
| The job_template field. | |
| --job-explanation TEXT [READ ONLY] The job_explanation field. | |
| --created TEXT The created field. | |
| --status TEXT The status field. | |
| --elapsed TEXT The elapsed field. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli job get --help | |
| Usage: tower-cli job get [OPTIONS] [ID] | |
| Return one and exactly one job. | |
| Lookups may be through a primary key, specified as a positional argument, | |
| and/or through filters specified through options. | |
| If the number of results does not equal one, abort with an error. | |
| Field Options: | |
| -J, --job-template JOB_TEMPLATE | |
| The job_template field. | |
| --job-explanation TEXT [READ ONLY] The job_explanation field. | |
| --created TEXT The created field. | |
| --status TEXT The status field. | |
| --elapsed TEXT The elapsed field. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli job launch --help | |
| Usage: tower-cli job launch [OPTIONS] | |
| Launch a new job based on a job template. | |
| Creates a new job in Ansible Tower, immediately starts it, and returns | |
| back an ID in order for its status to be monitored. | |
| Field Options: | |
| -J, --job-template JOB_TEMPLATE | |
| The job_template field. | |
| Local Options: | |
| --monitor If sent, immediately calls `job monitor` on the | |
| newly launched job rather than exiting with a | |
| success. | |
| --wait Monitor the status of the job, but do not print | |
| while job is in progress. | |
| --timeout INTEGER If provided with --monitor, this command (not the | |
| job) will time out after the given number of | |
| seconds. Does nothing if --monitor is not sent. | |
| --no-input Suppress any requests for input. | |
| -e, --extra-vars TEXT yaml format text that contains extra variables to | |
| pass on. Use @ to get these from a file. | |
| --diff-mode BOOLEAN Specify diff mode for job template to run. | |
| --limit TEXT Specify host limit for job template to run. | |
| --tags TEXT Specify tagged actions in the playbook to run. | |
| --skip-tags TEXT Specify tagged actions in the playbook to omit. | |
| --job-type [run|check] Specify job type for job template to run. | |
| --verbosity INTEGER Specify verbosity of the playbook run. | |
| --inventory INVENTORY Specify inventory for job template to run. | |
| --credential CREDENTIAL Specify machine credential for job template to run. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli job list --help | |
| Usage: tower-cli job list [OPTIONS] | |
| Return a list of jobs. | |
| If one or more filters are provided through options, filter the results | |
| accordingly. | |
| If no filters are provided, return all results. | |
| Field Options: | |
| -J, --job-template JOB_TEMPLATE | |
| The job_template field. | |
| --job-explanation TEXT [READ ONLY] The job_explanation field. | |
| --created TEXT The created field. | |
| --status TEXT The status field. | |
| --elapsed TEXT The elapsed field. | |
| Local Options: | |
| -a, --all-pages If set, collate all pages of content from the API when | |
| returning results. [default: False] | |
| --page INTEGER The page to show. Ignored if --all-pages is sent. | |
| [default: 1] | |
| --page-size INTEGER Number of records to show. Ignored if --all-pages. | |
| -Q, --query TEXT... A key and value to be passed as an HTTP query string | |
| key and value to the Tower API. Will be run through | |
| HTTP escaping. This argument may be sent multiple | |
| times. | |
| Example: `--query foo bar` would be passed to | |
| Tower as ?foo=bar | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli job monitor --help | |
| Usage: tower-cli job monitor [OPTIONS] [ID] | |
| Stream the standard output from a job, project update, or inventory | |
| udpate. | |
| Field Options: | |
| -J, --job-template JOB_TEMPLATE | |
| The job_template field. | |
| --job-explanation TEXT [READ ONLY] The job_explanation field. | |
| --created TEXT The created field. | |
| --status TEXT The status field. | |
| --elapsed TEXT The elapsed field. | |
| Local Options: | |
| --interval FLOAT Polling interval to refresh content from Tower. | |
| --timeout INTEGER If provided, this command (not the job) will time out | |
| after the given number of seconds. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli job relaunch --help | |
| Usage: tower-cli job relaunch [OPTIONS] [ID] | |
| Relaunch a stopped job. | |
| Fails with a non-zero exit status if the job cannot be relaunched. You | |
| must provide either a pk or parameters in the job's identity. | |
| Field Options: | |
| -J, --job-template JOB_TEMPLATE | |
| The job_template field. | |
| --job-explanation TEXT [READ ONLY] The job_explanation field. | |
| --created TEXT The created field. | |
| --status TEXT The status field. | |
| --elapsed TEXT The elapsed field. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli job status --help | |
| Usage: tower-cli job status [OPTIONS] [ID] | |
| Print the current job status. This is used to check a running job. You can | |
| look up the job with the same parameters used for a get request. | |
| Field Options: | |
| -J, --job-template JOB_TEMPLATE | |
| The job_template field. | |
| --job-explanation TEXT [READ ONLY] The job_explanation field. | |
| --created TEXT The created field. | |
| --status TEXT The status field. | |
| --elapsed TEXT The elapsed field. | |
| Local Options: | |
| --detail Print more detail. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli job stdout --help | |
| Usage: tower-cli job stdout [OPTIONS] [ID] | |
| Print out the standard out of a unified job to the command line. For | |
| Projects, print the standard out of most recent update. For Inventory | |
| Sources, print standard out of most recent sync. For Jobs, print the job's | |
| standard out. For Workflow Jobs, print a status table of its jobs. | |
| Field Options: | |
| -J, --job-template JOB_TEMPLATE | |
| The job_template field. | |
| --job-explanation TEXT [READ ONLY] The job_explanation field. | |
| --created TEXT The created field. | |
| --status TEXT The status field. | |
| --elapsed TEXT The elapsed field. | |
| Local Options: | |
| --start-line INTEGER Line at which to start printing the standard out. | |
| --end-line INTEGER Line at which to end printing the standard out. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli job wait --help | |
| Usage: tower-cli job wait [OPTIONS] [ID] | |
| Wait for a running job to finish. Blocks further input until the job | |
| completes (whether successfully or unsuccessfully) and a final status can | |
| be given. | |
| Field Options: | |
| -J, --job-template JOB_TEMPLATE | |
| The job_template field. | |
| --job-explanation TEXT [READ ONLY] The job_explanation field. | |
| --created TEXT The created field. | |
| --status TEXT The status field. | |
| --elapsed TEXT The elapsed field. | |
| Local Options: | |
| --min-interval INTEGER The minimum interval to request an update from | |
| Tower. | |
| --max-interval INTEGER The maximum interval to request an update from | |
| Tower. | |
| --timeout INTEGER If provided, this command (not the job) will time | |
| out after the given number of seconds. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli job_template --help | |
| Usage: tower-cli job_template [OPTIONS] COMMAND [ARGS]... | |
| Manage job templates. | |
| Options: | |
| --help Show this message and exit. | |
| Commands: | |
| associate_credential Associate a credential with this job... | |
| associate_ig Associate an ig with this job_template. | |
| associate_label Associate a label with this job_template. | |
| associate_notification_template | |
| Associate a notification template from | |
| this... | |
| callback Contact Tower and request a configuration... | |
| copy Copy a job template. | |
| create Create a job template. | |
| delete Remove the given job template. | |
| disassociate_credential Disassociate a credential with this job... | |
| disassociate_ig Disassociate an ig with this job_template. | |
| disassociate_label Disassociate a label with this job_template. | |
| disassociate_notification_template | |
| Disassociate a notification template from... | |
| get Return one and exactly one job template. | |
| list Return a list of job templates. | |
| modify Modify an already existing job template. | |
| survey Get the survey_spec for the job template. | |
| # tower-cli job_template associate_credential --help | |
| Usage: tower-cli job_template associate_credential [OPTIONS] | |
| Associate a credential with this job template. | |
| Local Options: | |
| --job-template JOB_TEMPLATE | |
| --credential CREDENTIAL | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli job_template associate_ig --help | |
| Usage: tower-cli job_template associate_ig [OPTIONS] | |
| Associate an ig with this job_template. | |
| Local Options: | |
| --job_template JOB_TEMPLATE [required] | |
| --instance_group INSTANCE_GROUP | |
| [required] | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli job_template associate_label --help | |
| Usage: tower-cli job_template associate_label [OPTIONS] | |
| Associate a label with this job_template. | |
| Local Options: | |
| --job_template JOB_TEMPLATE [required] | |
| --label LABEL [required] | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli job_template associate_notification_template --help | |
| Usage: tower-cli job_template associate_notification_template | |
| [OPTIONS] | |
| Associate a notification template from this job template. | |
| Local Options: | |
| --job-template JOB_TEMPLATE | |
| --notification-template NOTIFICATION_TEMPLATE | |
| --status [any|error|success] Specify job run status of job template to | |
| relate to. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli job_template callback --help | |
| Usage: tower-cli job_template callback [OPTIONS] [ID] | |
| Contact Tower and request a configuration update using this job template. | |
| Field Options: | |
| -e, --extra-vars VARIABLES Extra variables used by Ansible in YAML or | |
| key=value format. Use @ to get YAML from a file. | |
| Local Options: | |
| --host-config-key TEXT Job-template-specific string used to authenticate | |
| host during provisioning callback. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli job_template copy --help | |
| Usage: tower-cli job_template copy [OPTIONS] [ID] | |
| Copy a job template. | |
| Only the ID is used for the lookup. All provided fields are used to | |
| override the old data from the copied resource. | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| -d, --description TEXT The description field. | |
| --job-type [run|check] The job_type field. | |
| -i, --inventory INVENTORY The inventory field. | |
| --project PROJECT [REQUIRED] The project field. | |
| --playbook TEXT [REQUIRED] The playbook field. | |
| --credential CREDENTIAL The credential field. | |
| --vault-credential CREDENTIAL The vault_credential field. | |
| --forks INTEGER The forks field. | |
| --limit TEXT The limit field. | |
| --verbosity [default|verbose|more_verbose|debug|connection|winrm] | |
| The verbosity field. | |
| -e, --extra-vars VARIABLES Extra variables used by Ansible in YAML or | |
| key=value format. Use @ to get YAML from a | |
| file. | |
| --job-tags TEXT The job_tags field. | |
| --force-handlers BOOLEAN The force_handlers field. | |
| --skip-tags TEXT The skip_tags field. | |
| --start-at-task TEXT The start_at_task field. | |
| --timeout INTEGER The amount of time (in seconds) to run | |
| before the task is canceled. | |
| --use-fact-cache BOOLEAN If enabled, Tower will act as an Ansible | |
| Fact Cache Plugin; persisting facts at the | |
| end of a playbook run to the database and | |
| caching facts for use by Ansible. | |
| --host-config-key TEXT Allow Provisioning Callbacks using this host | |
| config key | |
| --ask-diff-mode-on-launch BOOLEAN | |
| Ask diff mode on launch. | |
| --ask-variables-on-launch BOOLEAN | |
| Prompt user for extra_vars on launch. | |
| --ask-limit-on-launch BOOLEAN Prompt user for host limits on launch. | |
| --ask-tags-on-launch BOOLEAN Prompt user for job tags on launch. | |
| --ask-skip-tags-on-launch BOOLEAN | |
| Prompt user for tags to skip on launch. | |
| --ask-job-type-on-launch BOOLEAN | |
| Prompt user for job type on launch. | |
| --ask-verbosity-on-launch BOOLEAN | |
| Prompt user for verbosity on launch. | |
| --ask-inventory-on-launch BOOLEAN | |
| Prompt user for inventory on launch. | |
| --ask-credential-on-launch BOOLEAN | |
| Prompt user for machine credential on | |
| launch. | |
| --survey-enabled BOOLEAN Prompt user for job type on launch. | |
| --become-enabled BOOLEAN The become_enabled field. | |
| --diff-mode BOOLEAN If enabled, textual changes made to any | |
| templated files on the host are shown in the | |
| standard output. | |
| --allow-simultaneous BOOLEAN The allow_simultaneous field. | |
| --survey-spec VARIABLES On write commands, perform extra POST to the | |
| survey_spec endpoint. | |
| Local Options: | |
| --new-name TEXT The name to give the new resource, if used, will deep copy | |
| in the backend. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli job_template create --help | |
| Usage: tower-cli job_template create [OPTIONS] | |
| Create a job template. | |
| Fields in the resource's --identity tuple are used for a lookup; if a | |
| match is found, then no-op (unless --force-on-exists is set) but do not | |
| fail (unless --fail-on-found is set). | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| -d, --description TEXT The description field. | |
| --job-type [run|check] The job_type field. | |
| -i, --inventory INVENTORY The inventory field. | |
| --project PROJECT [REQUIRED] The project field. | |
| --playbook TEXT [REQUIRED] The playbook field. | |
| --credential CREDENTIAL The credential field. | |
| --vault-credential CREDENTIAL The vault_credential field. | |
| --forks INTEGER The forks field. | |
| --limit TEXT The limit field. | |
| --verbosity [default|verbose|more_verbose|debug|connection|winrm] | |
| The verbosity field. | |
| -e, --extra-vars VARIABLES Extra variables used by Ansible in YAML or | |
| key=value format. Use @ to get YAML from a | |
| file. | |
| --job-tags TEXT The job_tags field. | |
| --force-handlers BOOLEAN The force_handlers field. | |
| --skip-tags TEXT The skip_tags field. | |
| --start-at-task TEXT The start_at_task field. | |
| --timeout INTEGER The amount of time (in seconds) to run | |
| before the task is canceled. | |
| --use-fact-cache BOOLEAN If enabled, Tower will act as an Ansible | |
| Fact Cache Plugin; persisting facts at the | |
| end of a playbook run to the database and | |
| caching facts for use by Ansible. | |
| --host-config-key TEXT Allow Provisioning Callbacks using this host | |
| config key | |
| --ask-diff-mode-on-launch BOOLEAN | |
| Ask diff mode on launch. | |
| --ask-variables-on-launch BOOLEAN | |
| Prompt user for extra_vars on launch. | |
| --ask-limit-on-launch BOOLEAN Prompt user for host limits on launch. | |
| --ask-tags-on-launch BOOLEAN Prompt user for job tags on launch. | |
| --ask-skip-tags-on-launch BOOLEAN | |
| Prompt user for tags to skip on launch. | |
| --ask-job-type-on-launch BOOLEAN | |
| Prompt user for job type on launch. | |
| --ask-verbosity-on-launch BOOLEAN | |
| Prompt user for verbosity on launch. | |
| --ask-inventory-on-launch BOOLEAN | |
| Prompt user for inventory on launch. | |
| --ask-credential-on-launch BOOLEAN | |
| Prompt user for machine credential on | |
| launch. | |
| --survey-enabled BOOLEAN Prompt user for job type on launch. | |
| --become-enabled BOOLEAN The become_enabled field. | |
| --diff-mode BOOLEAN If enabled, textual changes made to any | |
| templated files on the host are shown in the | |
| standard output. | |
| --allow-simultaneous BOOLEAN The allow_simultaneous field. | |
| --survey-spec VARIABLES On write commands, perform extra POST to the | |
| survey_spec endpoint. | |
| Local Options: | |
| --fail-on-found If used, return an error if a matching record already | |
| exists. [default: False] | |
| --force-on-exists If used, if a match is found on unique fields, other | |
| fields will be updated to the provided values. If False, | |
| a match causes the request to be a no-op. [default: | |
| False] | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli job_template delete --help | |
| Usage: tower-cli job_template delete [OPTIONS] [ID] | |
| Remove the given job template. | |
| If --fail-on-missing is True, then the job template's not being found is | |
| considered a failure; otherwise, a success with no change is reported. | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| -d, --description TEXT The description field. | |
| --job-type [run|check] The job_type field. | |
| -i, --inventory INVENTORY The inventory field. | |
| --project PROJECT [REQUIRED] The project field. | |
| --playbook TEXT [REQUIRED] The playbook field. | |
| --credential CREDENTIAL The credential field. | |
| --vault-credential CREDENTIAL The vault_credential field. | |
| --forks INTEGER The forks field. | |
| --limit TEXT The limit field. | |
| --verbosity [default|verbose|more_verbose|debug|connection|winrm] | |
| The verbosity field. | |
| -e, --extra-vars VARIABLES Extra variables used by Ansible in YAML or | |
| key=value format. Use @ to get YAML from a | |
| file. | |
| --job-tags TEXT The job_tags field. | |
| --force-handlers BOOLEAN The force_handlers field. | |
| --skip-tags TEXT The skip_tags field. | |
| --start-at-task TEXT The start_at_task field. | |
| --timeout INTEGER The amount of time (in seconds) to run | |
| before the task is canceled. | |
| --use-fact-cache BOOLEAN If enabled, Tower will act as an Ansible | |
| Fact Cache Plugin; persisting facts at the | |
| end of a playbook run to the database and | |
| caching facts for use by Ansible. | |
| --host-config-key TEXT Allow Provisioning Callbacks using this host | |
| config key | |
| --ask-diff-mode-on-launch BOOLEAN | |
| Ask diff mode on launch. | |
| --ask-variables-on-launch BOOLEAN | |
| Prompt user for extra_vars on launch. | |
| --ask-limit-on-launch BOOLEAN Prompt user for host limits on launch. | |
| --ask-tags-on-launch BOOLEAN Prompt user for job tags on launch. | |
| --ask-skip-tags-on-launch BOOLEAN | |
| Prompt user for tags to skip on launch. | |
| --ask-job-type-on-launch BOOLEAN | |
| Prompt user for job type on launch. | |
| --ask-verbosity-on-launch BOOLEAN | |
| Prompt user for verbosity on launch. | |
| --ask-inventory-on-launch BOOLEAN | |
| Prompt user for inventory on launch. | |
| --ask-credential-on-launch BOOLEAN | |
| Prompt user for machine credential on | |
| launch. | |
| --survey-enabled BOOLEAN Prompt user for job type on launch. | |
| --become-enabled BOOLEAN The become_enabled field. | |
| --diff-mode BOOLEAN If enabled, textual changes made to any | |
| templated files on the host are shown in the | |
| standard output. | |
| --allow-simultaneous BOOLEAN The allow_simultaneous field. | |
| --survey-spec VARIABLES On write commands, perform extra POST to the | |
| survey_spec endpoint. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli job_template disassociate_credential --help | |
| Usage: tower-cli job_template disassociate_credential [OPTIONS] | |
| Disassociate a credential with this job template. | |
| Local Options: | |
| --job-template JOB_TEMPLATE | |
| --credential CREDENTIAL | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli job_template disassociate_ig --help | |
| Usage: tower-cli job_template disassociate_ig [OPTIONS] | |
| Disassociate an ig with this job_template. | |
| Local Options: | |
| --job_template JOB_TEMPLATE [required] | |
| --instance_group INSTANCE_GROUP | |
| [required] | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli job_template disassociate_label --help | |
| Usage: tower-cli job_template disassociate_label [OPTIONS] | |
| Disassociate a label with this job_template. | |
| Local Options: | |
| --job_template JOB_TEMPLATE [required] | |
| --label LABEL [required] | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli job_template disassociate_notification_template --help | |
| Usage: tower-cli job_template disassociate_notification_template | |
| [OPTIONS] | |
| Disassociate a notification template from this job template. | |
| Local Options: | |
| --job-template JOB_TEMPLATE | |
| --notification-template NOTIFICATION_TEMPLATE | |
| --status [any|error|success] Specify job run status of job template to | |
| relate to. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli job_template get --help | |
| Usage: tower-cli job_template get [OPTIONS] [ID] | |
| Return one and exactly one job template. | |
| Lookups may be through a primary key, specified as a positional argument, | |
| and/or through filters specified through options. | |
| If the number of results does not equal one, abort with an error. | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| -d, --description TEXT The description field. | |
| --job-type [run|check] The job_type field. | |
| -i, --inventory INVENTORY The inventory field. | |
| --project PROJECT [REQUIRED] The project field. | |
| --playbook TEXT [REQUIRED] The playbook field. | |
| --credential CREDENTIAL The credential field. | |
| --vault-credential CREDENTIAL The vault_credential field. | |
| --forks INTEGER The forks field. | |
| --limit TEXT The limit field. | |
| --verbosity [default|verbose|more_verbose|debug|connection|winrm] | |
| The verbosity field. | |
| -e, --extra-vars VARIABLES Extra variables used by Ansible in YAML or | |
| key=value format. Use @ to get YAML from a | |
| file. | |
| --job-tags TEXT The job_tags field. | |
| --force-handlers BOOLEAN The force_handlers field. | |
| --skip-tags TEXT The skip_tags field. | |
| --start-at-task TEXT The start_at_task field. | |
| --timeout INTEGER The amount of time (in seconds) to run | |
| before the task is canceled. | |
| --use-fact-cache BOOLEAN If enabled, Tower will act as an Ansible | |
| Fact Cache Plugin; persisting facts at the | |
| end of a playbook run to the database and | |
| caching facts for use by Ansible. | |
| --host-config-key TEXT Allow Provisioning Callbacks using this host | |
| config key | |
| --ask-diff-mode-on-launch BOOLEAN | |
| Ask diff mode on launch. | |
| --ask-variables-on-launch BOOLEAN | |
| Prompt user for extra_vars on launch. | |
| --ask-limit-on-launch BOOLEAN Prompt user for host limits on launch. | |
| --ask-tags-on-launch BOOLEAN Prompt user for job tags on launch. | |
| --ask-skip-tags-on-launch BOOLEAN | |
| Prompt user for tags to skip on launch. | |
| --ask-job-type-on-launch BOOLEAN | |
| Prompt user for job type on launch. | |
| --ask-verbosity-on-launch BOOLEAN | |
| Prompt user for verbosity on launch. | |
| --ask-inventory-on-launch BOOLEAN | |
| Prompt user for inventory on launch. | |
| --ask-credential-on-launch BOOLEAN | |
| Prompt user for machine credential on | |
| launch. | |
| --survey-enabled BOOLEAN Prompt user for job type on launch. | |
| --become-enabled BOOLEAN The become_enabled field. | |
| --diff-mode BOOLEAN If enabled, textual changes made to any | |
| templated files on the host are shown in the | |
| standard output. | |
| --allow-simultaneous BOOLEAN The allow_simultaneous field. | |
| --survey-spec VARIABLES On write commands, perform extra POST to the | |
| survey_spec endpoint. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli job_template list --help | |
| Usage: tower-cli job_template list [OPTIONS] | |
| Return a list of job templates. | |
| If one or more filters are provided through options, filter the results | |
| accordingly. | |
| If no filters are provided, return all results. | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| -d, --description TEXT The description field. | |
| --job-type [run|check] The job_type field. | |
| -i, --inventory INVENTORY The inventory field. | |
| --project PROJECT [REQUIRED] The project field. | |
| --playbook TEXT [REQUIRED] The playbook field. | |
| --credential CREDENTIAL The credential field. | |
| --vault-credential CREDENTIAL The vault_credential field. | |
| --forks INTEGER The forks field. | |
| --limit TEXT The limit field. | |
| --verbosity [default|verbose|more_verbose|debug|connection|winrm] | |
| The verbosity field. | |
| -e, --extra-vars VARIABLES Extra variables used by Ansible in YAML or | |
| key=value format. Use @ to get YAML from a | |
| file. | |
| --job-tags TEXT The job_tags field. | |
| --force-handlers BOOLEAN The force_handlers field. | |
| --skip-tags TEXT The skip_tags field. | |
| --start-at-task TEXT The start_at_task field. | |
| --timeout INTEGER The amount of time (in seconds) to run | |
| before the task is canceled. | |
| --use-fact-cache BOOLEAN If enabled, Tower will act as an Ansible | |
| Fact Cache Plugin; persisting facts at the | |
| end of a playbook run to the database and | |
| caching facts for use by Ansible. | |
| --host-config-key TEXT Allow Provisioning Callbacks using this host | |
| config key | |
| --ask-diff-mode-on-launch BOOLEAN | |
| Ask diff mode on launch. | |
| --ask-variables-on-launch BOOLEAN | |
| Prompt user for extra_vars on launch. | |
| --ask-limit-on-launch BOOLEAN Prompt user for host limits on launch. | |
| --ask-tags-on-launch BOOLEAN Prompt user for job tags on launch. | |
| --ask-skip-tags-on-launch BOOLEAN | |
| Prompt user for tags to skip on launch. | |
| --ask-job-type-on-launch BOOLEAN | |
| Prompt user for job type on launch. | |
| --ask-verbosity-on-launch BOOLEAN | |
| Prompt user for verbosity on launch. | |
| --ask-inventory-on-launch BOOLEAN | |
| Prompt user for inventory on launch. | |
| --ask-credential-on-launch BOOLEAN | |
| Prompt user for machine credential on | |
| launch. | |
| --survey-enabled BOOLEAN Prompt user for job type on launch. | |
| --become-enabled BOOLEAN The become_enabled field. | |
| --diff-mode BOOLEAN If enabled, textual changes made to any | |
| templated files on the host are shown in the | |
| standard output. | |
| --allow-simultaneous BOOLEAN The allow_simultaneous field. | |
| --survey-spec VARIABLES On write commands, perform extra POST to the | |
| survey_spec endpoint. | |
| Local Options: | |
| -a, --all-pages If set, collate all pages of content from the API when | |
| returning results. [default: False] | |
| --page INTEGER The page to show. Ignored if --all-pages is sent. | |
| [default: 1] | |
| --page-size INTEGER Number of records to show. Ignored if --all-pages. | |
| -Q, --query TEXT... A key and value to be passed as an HTTP query string | |
| key and value to the Tower API. Will be run through | |
| HTTP escaping. This argument may be sent multiple | |
| times. | |
| Example: `--query foo bar` would be passed to | |
| Tower as ?foo=bar | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli job_template modify --help | |
| Usage: tower-cli job_template modify [OPTIONS] [ID] | |
| Modify an already existing job template. | |
| Fields in the resource's --identity tuple can be used in lieu of a primary | |
| key for a lookup; in such a case, only other fields are written. | |
| To modify unique fields, you must use the primary key for the lookup. | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| -d, --description TEXT The description field. | |
| --job-type [run|check] The job_type field. | |
| -i, --inventory INVENTORY The inventory field. | |
| --project PROJECT [REQUIRED] The project field. | |
| --playbook TEXT [REQUIRED] The playbook field. | |
| --credential CREDENTIAL The credential field. | |
| --vault-credential CREDENTIAL The vault_credential field. | |
| --forks INTEGER The forks field. | |
| --limit TEXT The limit field. | |
| --verbosity [default|verbose|more_verbose|debug|connection|winrm] | |
| The verbosity field. | |
| -e, --extra-vars VARIABLES Extra variables used by Ansible in YAML or | |
| key=value format. Use @ to get YAML from a | |
| file. | |
| --job-tags TEXT The job_tags field. | |
| --force-handlers BOOLEAN The force_handlers field. | |
| --skip-tags TEXT The skip_tags field. | |
| --start-at-task TEXT The start_at_task field. | |
| --timeout INTEGER The amount of time (in seconds) to run | |
| before the task is canceled. | |
| --use-fact-cache BOOLEAN If enabled, Tower will act as an Ansible | |
| Fact Cache Plugin; persisting facts at the | |
| end of a playbook run to the database and | |
| caching facts for use by Ansible. | |
| --host-config-key TEXT Allow Provisioning Callbacks using this host | |
| config key | |
| --ask-diff-mode-on-launch BOOLEAN | |
| Ask diff mode on launch. | |
| --ask-variables-on-launch BOOLEAN | |
| Prompt user for extra_vars on launch. | |
| --ask-limit-on-launch BOOLEAN Prompt user for host limits on launch. | |
| --ask-tags-on-launch BOOLEAN Prompt user for job tags on launch. | |
| --ask-skip-tags-on-launch BOOLEAN | |
| Prompt user for tags to skip on launch. | |
| --ask-job-type-on-launch BOOLEAN | |
| Prompt user for job type on launch. | |
| --ask-verbosity-on-launch BOOLEAN | |
| Prompt user for verbosity on launch. | |
| --ask-inventory-on-launch BOOLEAN | |
| Prompt user for inventory on launch. | |
| --ask-credential-on-launch BOOLEAN | |
| Prompt user for machine credential on | |
| launch. | |
| --survey-enabled BOOLEAN Prompt user for job type on launch. | |
| --become-enabled BOOLEAN The become_enabled field. | |
| --diff-mode BOOLEAN If enabled, textual changes made to any | |
| templated files on the host are shown in the | |
| standard output. | |
| --allow-simultaneous BOOLEAN The allow_simultaneous field. | |
| --survey-spec VARIABLES On write commands, perform extra POST to the | |
| survey_spec endpoint. | |
| Local Options: | |
| --create-on-missing If used, and if options rather than a primary key are | |
| used to attempt to match a record, will create the | |
| record if it does not exist. This is an alias to | |
| `create --force-on-exists`. [default: False] | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli job_template survey --help | |
| Usage: tower-cli job_template survey [OPTIONS] [ID] | |
| Get the survey_spec for the job template. To write a survey, use the | |
| modify command with the --survey-spec parameter. | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| -d, --description TEXT The description field. | |
| --job-type [run|check] The job_type field. | |
| -i, --inventory INVENTORY The inventory field. | |
| --project PROJECT [REQUIRED] The project field. | |
| --playbook TEXT [REQUIRED] The playbook field. | |
| --credential CREDENTIAL The credential field. | |
| --vault-credential CREDENTIAL The vault_credential field. | |
| --forks INTEGER The forks field. | |
| --limit TEXT The limit field. | |
| --verbosity [default|verbose|more_verbose|debug|connection|winrm] | |
| The verbosity field. | |
| -e, --extra-vars VARIABLES Extra variables used by Ansible in YAML or | |
| key=value format. Use @ to get YAML from a | |
| file. | |
| --job-tags TEXT The job_tags field. | |
| --force-handlers BOOLEAN The force_handlers field. | |
| --skip-tags TEXT The skip_tags field. | |
| --start-at-task TEXT The start_at_task field. | |
| --timeout INTEGER The amount of time (in seconds) to run | |
| before the task is canceled. | |
| --use-fact-cache BOOLEAN If enabled, Tower will act as an Ansible | |
| Fact Cache Plugin; persisting facts at the | |
| end of a playbook run to the database and | |
| caching facts for use by Ansible. | |
| --host-config-key TEXT Allow Provisioning Callbacks using this host | |
| config key | |
| --ask-diff-mode-on-launch BOOLEAN | |
| Ask diff mode on launch. | |
| --ask-variables-on-launch BOOLEAN | |
| Prompt user for extra_vars on launch. | |
| --ask-limit-on-launch BOOLEAN Prompt user for host limits on launch. | |
| --ask-tags-on-launch BOOLEAN Prompt user for job tags on launch. | |
| --ask-skip-tags-on-launch BOOLEAN | |
| Prompt user for tags to skip on launch. | |
| --ask-job-type-on-launch BOOLEAN | |
| Prompt user for job type on launch. | |
| --ask-verbosity-on-launch BOOLEAN | |
| Prompt user for verbosity on launch. | |
| --ask-inventory-on-launch BOOLEAN | |
| Prompt user for inventory on launch. | |
| --ask-credential-on-launch BOOLEAN | |
| Prompt user for machine credential on | |
| launch. | |
| --survey-enabled BOOLEAN Prompt user for job type on launch. | |
| --become-enabled BOOLEAN The become_enabled field. | |
| --diff-mode BOOLEAN If enabled, textual changes made to any | |
| templated files on the host are shown in the | |
| standard output. | |
| --allow-simultaneous BOOLEAN The allow_simultaneous field. | |
| --survey-spec VARIABLES On write commands, perform extra POST to the | |
| survey_spec endpoint. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli label --help | |
| Usage: tower-cli label [OPTIONS] COMMAND [ARGS]... | |
| Manage labels within Ansible Tower. | |
| Options: | |
| --help Show this message and exit. | |
| Commands: | |
| copy Copy a label. | |
| create Create a new label. | |
| get Return one and exactly one label. | |
| list Return a list of labels. | |
| modify Modify an already existing label. | |
| # tower-cli label copy --help | |
| Usage: tower-cli label copy [OPTIONS] [ID] | |
| Copy a label. | |
| Only the ID is used for the lookup. All provided fields are used to | |
| override the old data from the copied resource. | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| --organization ORGANIZATION [REQUIRED] The organization field. | |
| Local Options: | |
| --new-name TEXT The name to give the new resource, if used, will deep copy | |
| in the backend. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli label create --help | |
| Usage: tower-cli label create [OPTIONS] | |
| Create a new label. | |
| There are two types of label creation: isolatedly creating a new label and | |
| creating a new label under a job template. Here the two types are | |
| discriminated by whether to provide --job-template option. | |
| Fields in the resource's --identity tuple are used for a lookup; if a | |
| match is found, then no-op (unless --force-on-exists is set) but do not | |
| fail (unless --fail-on-found is set). | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| --organization ORGANIZATION [REQUIRED] The organization field. | |
| Local Options: | |
| --fail-on-found If used, return an error if a matching record | |
| already exists. [default: False] | |
| --force-on-exists If used, if a match is found on unique fields, | |
| other fields will be updated to the provided | |
| values. If False, a match causes the request to | |
| be a no-op. [default: False] | |
| --job-template JOB_TEMPLATE The job template to relate to. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli label get --help | |
| Usage: tower-cli label get [OPTIONS] [ID] | |
| Return one and exactly one label. | |
| Lookups may be through a primary key, specified as a positional argument, | |
| and/or through filters specified through options. | |
| If the number of results does not equal one, abort with an error. | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| --organization ORGANIZATION [REQUIRED] The organization field. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli label list --help | |
| Usage: tower-cli label list [OPTIONS] | |
| Return a list of labels. | |
| If one or more filters are provided through options, filter the results | |
| accordingly. | |
| If no filters are provided, return all results. | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| --organization ORGANIZATION [REQUIRED] The organization field. | |
| Local Options: | |
| -a, --all-pages If set, collate all pages of content from the API when | |
| returning results. [default: False] | |
| --page INTEGER The page to show. Ignored if --all-pages is sent. | |
| [default: 1] | |
| --page-size INTEGER Number of records to show. Ignored if --all-pages. | |
| -Q, --query TEXT... A key and value to be passed as an HTTP query string | |
| key and value to the Tower API. Will be run through | |
| HTTP escaping. This argument may be sent multiple | |
| times. | |
| Example: `--query foo bar` would be passed to | |
| Tower as ?foo=bar | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli label modify --help | |
| Usage: tower-cli label modify [OPTIONS] [ID] | |
| Modify an already existing label. | |
| Fields in the resource's --identity tuple can be used in lieu of a primary | |
| key for a lookup; in such a case, only other fields are written. | |
| To modify unique fields, you must use the primary key for the lookup. | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| --organization ORGANIZATION [REQUIRED] The organization field. | |
| Local Options: | |
| --create-on-missing If used, and if options rather than a primary key are | |
| used to attempt to match a record, will create the | |
| record if it does not exist. This is an alias to | |
| `create --force-on-exists`. [default: False] | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli node --help | |
| Usage: tower-cli node [OPTIONS] COMMAND [ARGS]... | |
| Manage nodes inside of a workflow job template. | |
| Options: | |
| --help Show this message and exit. | |
| Commands: | |
| associate_always_node Add a node to always run after the parent is... | |
| associate_credential Associate a credential with this... | |
| associate_failure_node Add a node to run on failure. | |
| associate_success_node Add a node to run on success. | |
| copy Copy a node. | |
| create Create a node. | |
| delete Remove the given node. | |
| disassociate_always_node Remove an always node link. | |
| disassociate_credential Disassociate a credential with this... | |
| disassociate_failure_node Remove a failure node link. | |
| disassociate_success_node Remove success node. | |
| get Return one and exactly one node. | |
| list Return a list of nodes. | |
| modify Modify an already existing node. | |
| # tower-cli node associate_always_node --help | |
| Usage: tower-cli node associate_always_node [OPTIONS] PARENT [CHILD] | |
| Add a node to always run after the parent is finished. | |
| Field Options: | |
| -W, --workflow-job-template WORKFLOW | |
| [REQUIRED] The workflow_job_template field. | |
| --unified-job-template TEXT The unified_job_template field. | |
| --extra-data VARIABLES Extra data for schedule rules in the form of | |
| a .json file. | |
| -i, --inventory INVENTORY The inventory field. | |
| --credential CREDENTIAL The credential field. | |
| --job-type TEXT The job_type field. | |
| --job-tags TEXT The job_tags field. | |
| --skip-tags TEXT The skip_tags field. | |
| --limit TEXT The limit field. | |
| --diff-mode BOOLEAN The diff_mode field. | |
| --verbosity [default|verbose|more_verbose|debug|connection|winrm] | |
| The verbosity field. | |
| Local Options: | |
| --inventory-source INVENTORY_SOURCE | |
| Use this inventory source as | |
| unified_job_template field | |
| --project PROJECT Use this project as unified_job_template | |
| field | |
| --job-template JOB_TEMPLATE Use this job template as | |
| unified_job_template field | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli node associate_credential --help | |
| Usage: tower-cli node associate_credential [OPTIONS] | |
| Associate a credential with this workflow_job_template_node. | |
| Local Options: | |
| --workflow_job_template_node WORKFLOW_JOB_TEMPLATE_NODE | |
| [required] | |
| --credential CREDENTIAL [required] | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli node associate_failure_node --help | |
| Usage: tower-cli node associate_failure_node [OPTIONS] PARENT [CHILD] | |
| Add a node to run on failure. | |
| Field Options: | |
| -W, --workflow-job-template WORKFLOW | |
| [REQUIRED] The workflow_job_template field. | |
| --unified-job-template TEXT The unified_job_template field. | |
| --extra-data VARIABLES Extra data for schedule rules in the form of | |
| a .json file. | |
| -i, --inventory INVENTORY The inventory field. | |
| --credential CREDENTIAL The credential field. | |
| --job-type TEXT The job_type field. | |
| --job-tags TEXT The job_tags field. | |
| --skip-tags TEXT The skip_tags field. | |
| --limit TEXT The limit field. | |
| --diff-mode BOOLEAN The diff_mode field. | |
| --verbosity [default|verbose|more_verbose|debug|connection|winrm] | |
| The verbosity field. | |
| Local Options: | |
| --inventory-source INVENTORY_SOURCE | |
| Use this inventory source as | |
| unified_job_template field | |
| --project PROJECT Use this project as unified_job_template | |
| field | |
| --job-template JOB_TEMPLATE Use this job template as | |
| unified_job_template field | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli node associate_success_node --help | |
| Usage: tower-cli node associate_success_node [OPTIONS] PARENT [CHILD] | |
| Add a node to run on success. | |
| Field Options: | |
| -W, --workflow-job-template WORKFLOW | |
| [REQUIRED] The workflow_job_template field. | |
| --unified-job-template TEXT The unified_job_template field. | |
| --extra-data VARIABLES Extra data for schedule rules in the form of | |
| a .json file. | |
| -i, --inventory INVENTORY The inventory field. | |
| --credential CREDENTIAL The credential field. | |
| --job-type TEXT The job_type field. | |
| --job-tags TEXT The job_tags field. | |
| --skip-tags TEXT The skip_tags field. | |
| --limit TEXT The limit field. | |
| --diff-mode BOOLEAN The diff_mode field. | |
| --verbosity [default|verbose|more_verbose|debug|connection|winrm] | |
| The verbosity field. | |
| Local Options: | |
| --inventory-source INVENTORY_SOURCE | |
| Use this inventory source as | |
| unified_job_template field | |
| --project PROJECT Use this project as unified_job_template | |
| field | |
| --job-template JOB_TEMPLATE Use this job template as | |
| unified_job_template field | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli node copy --help | |
| Usage: tower-cli node copy [OPTIONS] [ID] | |
| Copy a node. | |
| Only the ID is used for the lookup. All provided fields are used to | |
| override the old data from the copied resource. | |
| Field Options: | |
| -W, --workflow-job-template WORKFLOW | |
| [REQUIRED] The workflow_job_template field. | |
| --unified-job-template TEXT The unified_job_template field. | |
| --extra-data VARIABLES Extra data for schedule rules in the form of | |
| a .json file. | |
| -i, --inventory INVENTORY The inventory field. | |
| --credential CREDENTIAL The credential field. | |
| --job-type TEXT The job_type field. | |
| --job-tags TEXT The job_tags field. | |
| --skip-tags TEXT The skip_tags field. | |
| --limit TEXT The limit field. | |
| --diff-mode BOOLEAN The diff_mode field. | |
| --verbosity [default|verbose|more_verbose|debug|connection|winrm] | |
| The verbosity field. | |
| Local Options: | |
| --new-name TEXT The name to give the new resource, if used, will deep copy | |
| in the backend. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli node create --help | |
| Usage: tower-cli node create [OPTIONS] | |
| Create a node. | |
| Fields in the resource's --identity tuple are used for a lookup; if a | |
| match is found, then no-op (unless --force-on-exists is set) but do not | |
| fail (unless --fail-on-found is set). | |
| Field Options: | |
| -W, --workflow-job-template WORKFLOW | |
| [REQUIRED] The workflow_job_template field. | |
| --unified-job-template TEXT The unified_job_template field. | |
| --extra-data VARIABLES Extra data for schedule rules in the form of | |
| a .json file. | |
| -i, --inventory INVENTORY The inventory field. | |
| --credential CREDENTIAL The credential field. | |
| --job-type TEXT The job_type field. | |
| --job-tags TEXT The job_tags field. | |
| --skip-tags TEXT The skip_tags field. | |
| --limit TEXT The limit field. | |
| --diff-mode BOOLEAN The diff_mode field. | |
| --verbosity [default|verbose|more_verbose|debug|connection|winrm] | |
| The verbosity field. | |
| Local Options: | |
| --inventory-source INVENTORY_SOURCE | |
| Use this inventory source as | |
| unified_job_template field | |
| --project PROJECT Use this project as unified_job_template | |
| field | |
| --job-template JOB_TEMPLATE Use this job template as | |
| unified_job_template field | |
| --fail-on-found If used, return an error if a matching | |
| record already exists. [default: False] | |
| --force-on-exists If used, if a match is found on unique | |
| fields, other fields will be updated to the | |
| provided values. If False, a match causes | |
| the request to be a no-op. [default: False] | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli node delete --help | |
| Usage: tower-cli node delete [OPTIONS] [ID] | |
| Remove the given node. | |
| If --fail-on-missing is True, then the node's not being found is | |
| considered a failure; otherwise, a success with no change is reported. | |
| Field Options: | |
| -W, --workflow-job-template WORKFLOW | |
| [REQUIRED] The workflow_job_template field. | |
| --unified-job-template TEXT The unified_job_template field. | |
| --extra-data VARIABLES Extra data for schedule rules in the form of | |
| a .json file. | |
| -i, --inventory INVENTORY The inventory field. | |
| --credential CREDENTIAL The credential field. | |
| --job-type TEXT The job_type field. | |
| --job-tags TEXT The job_tags field. | |
| --skip-tags TEXT The skip_tags field. | |
| --limit TEXT The limit field. | |
| --diff-mode BOOLEAN The diff_mode field. | |
| --verbosity [default|verbose|more_verbose|debug|connection|winrm] | |
| The verbosity field. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli node disassociate_always_node --help | |
| Usage: tower-cli node disassociate_always_node [OPTIONS] PARENT CHILD | |
| Remove an always node link. The resultant 2 nodes will both become root | |
| nodes. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli node disassociate_credential --help | |
| Usage: tower-cli node disassociate_credential [OPTIONS] | |
| Disassociate a credential with this workflow_job_template_node. | |
| Local Options: | |
| --workflow_job_template_node WORKFLOW_JOB_TEMPLATE_NODE | |
| [required] | |
| --credential CREDENTIAL [required] | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli node disassociate_failure_node --help | |
| Usage: tower-cli node disassociate_failure_node [OPTIONS] PARENT CHILD | |
| Remove a failure node link. The resulatant 2 nodes will both become root | |
| nodes. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli node disassociate_success_node --help | |
| Usage: tower-cli node disassociate_success_node [OPTIONS] PARENT CHILD | |
| Remove success node. The resulatant 2 nodes will both become root nodes. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli node get --help | |
| Usage: tower-cli node get [OPTIONS] [ID] | |
| Return one and exactly one node. | |
| Lookups may be through a primary key, specified as a positional argument, | |
| and/or through filters specified through options. | |
| If the number of results does not equal one, abort with an error. | |
| Field Options: | |
| -W, --workflow-job-template WORKFLOW | |
| [REQUIRED] The workflow_job_template field. | |
| --unified-job-template TEXT The unified_job_template field. | |
| --extra-data VARIABLES Extra data for schedule rules in the form of | |
| a .json file. | |
| -i, --inventory INVENTORY The inventory field. | |
| --credential CREDENTIAL The credential field. | |
| --job-type TEXT The job_type field. | |
| --job-tags TEXT The job_tags field. | |
| --skip-tags TEXT The skip_tags field. | |
| --limit TEXT The limit field. | |
| --diff-mode BOOLEAN The diff_mode field. | |
| --verbosity [default|verbose|more_verbose|debug|connection|winrm] | |
| The verbosity field. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli node list --help | |
| Usage: tower-cli node list [OPTIONS] | |
| Return a list of nodes. | |
| If one or more filters are provided through options, filter the results | |
| accordingly. | |
| If no filters are provided, return all results. | |
| Field Options: | |
| -W, --workflow-job-template WORKFLOW | |
| [REQUIRED] The workflow_job_template field. | |
| --unified-job-template TEXT The unified_job_template field. | |
| --extra-data VARIABLES Extra data for schedule rules in the form of | |
| a .json file. | |
| -i, --inventory INVENTORY The inventory field. | |
| --credential CREDENTIAL The credential field. | |
| --job-type TEXT The job_type field. | |
| --job-tags TEXT The job_tags field. | |
| --skip-tags TEXT The skip_tags field. | |
| --limit TEXT The limit field. | |
| --diff-mode BOOLEAN The diff_mode field. | |
| --verbosity [default|verbose|more_verbose|debug|connection|winrm] | |
| The verbosity field. | |
| Local Options: | |
| --inventory-source INVENTORY_SOURCE | |
| Use this inventory source as | |
| unified_job_template field | |
| --project PROJECT Use this project as unified_job_template | |
| field | |
| --job-template JOB_TEMPLATE Use this job template as | |
| unified_job_template field | |
| -a, --all-pages If set, collate all pages of content from | |
| the API when returning results. [default: | |
| False] | |
| --page INTEGER The page to show. Ignored if --all-pages is | |
| sent. [default: 1] | |
| --page-size INTEGER Number of records to show. Ignored if --all- | |
| pages. | |
| -Q, --query TEXT... A key and value to be passed as an HTTP | |
| query string key and value to the Tower API. | |
| Will be run through HTTP escaping. This | |
| argument may be sent multiple times. | |
| Example: `--query foo bar` would be passed | |
| to Tower as ?foo=bar | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli node modify --help | |
| Usage: tower-cli node modify [OPTIONS] | |
| Modify an already existing node. | |
| Fields in the resource's --identity tuple can be used in lieu of a primary | |
| key for a lookup; in such a case, only other fields are written. | |
| To modify unique fields, you must use the primary key for the lookup. | |
| Field Options: | |
| -W, --workflow-job-template WORKFLOW | |
| [REQUIRED] The workflow_job_template field. | |
| --unified-job-template TEXT The unified_job_template field. | |
| --extra-data VARIABLES Extra data for schedule rules in the form of | |
| a .json file. | |
| -i, --inventory INVENTORY The inventory field. | |
| --credential CREDENTIAL The credential field. | |
| --job-type TEXT The job_type field. | |
| --job-tags TEXT The job_tags field. | |
| --skip-tags TEXT The skip_tags field. | |
| --limit TEXT The limit field. | |
| --diff-mode BOOLEAN The diff_mode field. | |
| --verbosity [default|verbose|more_verbose|debug|connection|winrm] | |
| The verbosity field. | |
| Local Options: | |
| --inventory-source INVENTORY_SOURCE | |
| Use this inventory source as | |
| unified_job_template field | |
| --project PROJECT Use this project as unified_job_template | |
| field | |
| --job-template JOB_TEMPLATE Use this job template as | |
| unified_job_template field | |
| --create-on-missing If used, and if options rather than a | |
| primary key are used to attempt to match a | |
| record, will create the record if it does | |
| not exist. This is an alias to `create | |
| --force-on-exists`. [default: False] | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli notification_template --help | |
| Usage: tower-cli notification_template [OPTIONS] COMMAND [ARGS]... | |
| Manage notification templates within Ansible Tower. | |
| Options: | |
| --help Show this message and exit. | |
| Commands: | |
| copy Copy a notification template. | |
| create Create a notification template. | |
| delete Remove the given notification template. | |
| get Return one and exactly one notification... | |
| list Return a list of notification templates. | |
| modify Modify an existing notification template. | |
| # tower-cli notification_template copy --help | |
| Usage: tower-cli notification_template copy [OPTIONS] [ID] | |
| Copy a notification template. | |
| Only the ID is used for the lookup. All provided fields are used to | |
| override the old data from the copied resource. | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| -d, --description TEXT The description field. | |
| --organization ORGANIZATION The organization field. | |
| --notification-type [email|slack|twilio|pagerduty|hipchat|webhook|irc] | |
| [REQUIRED] The notification_type field. | |
| --notification-configuration FILENAME | |
| The notification configuration field. Note | |
| providing this field would disable all | |
| notification-configuration-related fields. | |
| --username TEXT [email]The username. | |
| --sender TEXT [email]The sender. | |
| --recipients TEXT [email]The recipients. | |
| --use-tls BOOLEAN [email]The tls trigger. | |
| --host TEXT [email]The host. | |
| --use-ssl BOOLEAN [email/irc]The ssl trigger. | |
| --password TEXT [email/irc]The password. | |
| --port INTEGER [email/irc]The email port. | |
| --channels TEXT [slack]The channel. | |
| --token TEXT [slack/pagerduty/hipchat]The token. | |
| --account-token TEXT [twilio]The account token. | |
| --from-number TEXT [twilio]The source phone number. | |
| --to-numbers TEXT [twilio]The destination SMS numbers. | |
| --account-sid TEXT [twilioThe account sid. | |
| --subdomain TEXT [pagerduty]The subdomain. | |
| --service-key TEXT [pagerduty]The API service/integration key. | |
| --client-name TEXT [pagerduty]The client identifier. | |
| --message-from TEXT [hipchat]The label to be shown with | |
| notification. | |
| --api-url TEXT [hipchat]The api url. | |
| --color [yellow|green|red|purple|gray|random] | |
| [hipchat]The notification color. | |
| --rooms TEXT [hipchat]Rooms to send notification to. Use | |
| multiple flags to send to multiple rooms, ex | |
| --rooms=A --rooms=B | |
| --notify TEXT [hipchat]The notify channel trigger. | |
| --url TEXT [webhook]The target URL. | |
| --headers FILENAME [webhook]The http headers. | |
| --server TEXT [irc]Server address. | |
| --nickname TEXT [irc]The irc nick. | |
| --target TEXT [irc]The distination channels or users. | |
| Local Options: | |
| --new-name TEXT The name to give the new resource, if used, will deep copy | |
| in the backend. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli notification_template create --help | |
| Usage: tower-cli notification_template create [OPTIONS] | |
| Create a notification template. | |
| All required configuration-related fields (required according to | |
| notification_type) must be provided. | |
| There are two types of notification template creation: isolatedly creating | |
| a new notification template and creating a new notification template under | |
| a job template. Here the two types are discriminated by whether to provide | |
| --job-template option. --status option controls more specific, job-run- | |
| status-related association. | |
| Fields in the resource's --identity tuple are used for a lookup; if a | |
| match is found, then no-op (unless --force-on-exists is set) but do not | |
| fail (unless --fail-on-found is set). | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| -d, --description TEXT The description field. | |
| --organization ORGANIZATION The organization field. | |
| --notification-type [email|slack|twilio|pagerduty|hipchat|webhook|irc] | |
| [REQUIRED] The notification_type field. | |
| --notification-configuration FILENAME | |
| The notification configuration field. Note | |
| providing this field would disable all | |
| notification-configuration-related fields. | |
| --username TEXT [email]The username. | |
| --sender TEXT [email]The sender. | |
| --recipients TEXT [email]The recipients. | |
| --use-tls BOOLEAN [email]The tls trigger. | |
| --host TEXT [email]The host. | |
| --use-ssl BOOLEAN [email/irc]The ssl trigger. | |
| --password TEXT [email/irc]The password. | |
| --port INTEGER [email/irc]The email port. | |
| --channels TEXT [slack]The channel. | |
| --token TEXT [slack/pagerduty/hipchat]The token. | |
| --account-token TEXT [twilio]The account token. | |
| --from-number TEXT [twilio]The source phone number. | |
| --to-numbers TEXT [twilio]The destination SMS numbers. | |
| --account-sid TEXT [twilioThe account sid. | |
| --subdomain TEXT [pagerduty]The subdomain. | |
| --service-key TEXT [pagerduty]The API service/integration key. | |
| --client-name TEXT [pagerduty]The client identifier. | |
| --message-from TEXT [hipchat]The label to be shown with | |
| notification. | |
| --api-url TEXT [hipchat]The api url. | |
| --color [yellow|green|red|purple|gray|random] | |
| [hipchat]The notification color. | |
| --rooms TEXT [hipchat]Rooms to send notification to. Use | |
| multiple flags to send to multiple rooms, ex | |
| --rooms=A --rooms=B | |
| --notify TEXT [hipchat]The notify channel trigger. | |
| --url TEXT [webhook]The target URL. | |
| --headers FILENAME [webhook]The http headers. | |
| --server TEXT [irc]Server address. | |
| --nickname TEXT [irc]The irc nick. | |
| --target TEXT [irc]The distination channels or users. | |
| Local Options: | |
| --fail-on-found If used, return an error if a matching record | |
| already exists. [default: False] | |
| --force-on-exists If used, if a match is found on unique fields, | |
| other fields will be updated to the provided | |
| values. If False, a match causes the request to | |
| be a no-op. [default: False] | |
| --job-template JOB_TEMPLATE The job template to relate to. | |
| --status [error|success] Specify job run status of job template to | |
| relate to. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli notification_template delete --help | |
| Usage: tower-cli notification_template delete [OPTIONS] [ID] | |
| Remove the given notification template. | |
| Note here configuration-related fields like 'notification_configuration' | |
| and 'channels' will not be used even provided. | |
| If --fail-on-missing is True, then the notification template's not being | |
| found is considered a failure; otherwise, a success with no change is | |
| reported. | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| -d, --description TEXT The description field. | |
| --organization ORGANIZATION The organization field. | |
| --notification-type [email|slack|twilio|pagerduty|hipchat|webhook|irc] | |
| [REQUIRED] The notification_type field. | |
| --notification-configuration FILENAME | |
| The notification configuration field. Note | |
| providing this field would disable all | |
| notification-configuration-related fields. | |
| --username TEXT [email]The username. | |
| --sender TEXT [email]The sender. | |
| --recipients TEXT [email]The recipients. | |
| --use-tls BOOLEAN [email]The tls trigger. | |
| --host TEXT [email]The host. | |
| --use-ssl BOOLEAN [email/irc]The ssl trigger. | |
| --password TEXT [email/irc]The password. | |
| --port INTEGER [email/irc]The email port. | |
| --channels TEXT [slack]The channel. | |
| --token TEXT [slack/pagerduty/hipchat]The token. | |
| --account-token TEXT [twilio]The account token. | |
| --from-number TEXT [twilio]The source phone number. | |
| --to-numbers TEXT [twilio]The destination SMS numbers. | |
| --account-sid TEXT [twilioThe account sid. | |
| --subdomain TEXT [pagerduty]The subdomain. | |
| --service-key TEXT [pagerduty]The API service/integration key. | |
| --client-name TEXT [pagerduty]The client identifier. | |
| --message-from TEXT [hipchat]The label to be shown with | |
| notification. | |
| --api-url TEXT [hipchat]The api url. | |
| --color [yellow|green|red|purple|gray|random] | |
| [hipchat]The notification color. | |
| --rooms TEXT [hipchat]Rooms to send notification to. Use | |
| multiple flags to send to multiple rooms, ex | |
| --rooms=A --rooms=B | |
| --notify TEXT [hipchat]The notify channel trigger. | |
| --url TEXT [webhook]The target URL. | |
| --headers FILENAME [webhook]The http headers. | |
| --server TEXT [irc]Server address. | |
| --nickname TEXT [irc]The irc nick. | |
| --target TEXT [irc]The distination channels or users. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli notification_template get --help | |
| Usage: tower-cli notification_template get [OPTIONS] [ID] | |
| Return one and exactly one notification template. | |
| Note here configuration-related fields like 'notification_configuration' | |
| and 'channels' will not be used even provided. | |
| Lookups may be through a primary key, specified as a positional argument, | |
| and/or through filters specified through options. | |
| If the number of results does not equal one, abort with an error. | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| -d, --description TEXT The description field. | |
| --organization ORGANIZATION The organization field. | |
| --notification-type [email|slack|twilio|pagerduty|hipchat|webhook|irc] | |
| [REQUIRED] The notification_type field. | |
| --notification-configuration FILENAME | |
| The notification configuration field. Note | |
| providing this field would disable all | |
| notification-configuration-related fields. | |
| --username TEXT [email]The username. | |
| --sender TEXT [email]The sender. | |
| --recipients TEXT [email]The recipients. | |
| --use-tls BOOLEAN [email]The tls trigger. | |
| --host TEXT [email]The host. | |
| --use-ssl BOOLEAN [email/irc]The ssl trigger. | |
| --password TEXT [email/irc]The password. | |
| --port INTEGER [email/irc]The email port. | |
| --channels TEXT [slack]The channel. | |
| --token TEXT [slack/pagerduty/hipchat]The token. | |
| --account-token TEXT [twilio]The account token. | |
| --from-number TEXT [twilio]The source phone number. | |
| --to-numbers TEXT [twilio]The destination SMS numbers. | |
| --account-sid TEXT [twilioThe account sid. | |
| --subdomain TEXT [pagerduty]The subdomain. | |
| --service-key TEXT [pagerduty]The API service/integration key. | |
| --client-name TEXT [pagerduty]The client identifier. | |
| --message-from TEXT [hipchat]The label to be shown with | |
| notification. | |
| --api-url TEXT [hipchat]The api url. | |
| --color [yellow|green|red|purple|gray|random] | |
| [hipchat]The notification color. | |
| --rooms TEXT [hipchat]Rooms to send notification to. Use | |
| multiple flags to send to multiple rooms, ex | |
| --rooms=A --rooms=B | |
| --notify TEXT [hipchat]The notify channel trigger. | |
| --url TEXT [webhook]The target URL. | |
| --headers FILENAME [webhook]The http headers. | |
| --server TEXT [irc]Server address. | |
| --nickname TEXT [irc]The irc nick. | |
| --target TEXT [irc]The distination channels or users. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli notification_template list --help | |
| Usage: tower-cli notification_template list [OPTIONS] | |
| Return a list of notification templates. | |
| Note here configuration-related fields like 'notification_configuration' | |
| and 'channels' will not be used even provided. | |
| If one or more filters are provided through options, filter the results | |
| accordingly. | |
| If no filters are provided, return all results. | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| -d, --description TEXT The description field. | |
| --organization ORGANIZATION The organization field. | |
| --notification-type [email|slack|twilio|pagerduty|hipchat|webhook|irc] | |
| [REQUIRED] The notification_type field. | |
| --notification-configuration FILENAME | |
| The notification configuration field. Note | |
| providing this field would disable all | |
| notification-configuration-related fields. | |
| --username TEXT [email]The username. | |
| --sender TEXT [email]The sender. | |
| --recipients TEXT [email]The recipients. | |
| --use-tls BOOLEAN [email]The tls trigger. | |
| --host TEXT [email]The host. | |
| --use-ssl BOOLEAN [email/irc]The ssl trigger. | |
| --password TEXT [email/irc]The password. | |
| --port INTEGER [email/irc]The email port. | |
| --channels TEXT [slack]The channel. | |
| --token TEXT [slack/pagerduty/hipchat]The token. | |
| --account-token TEXT [twilio]The account token. | |
| --from-number TEXT [twilio]The source phone number. | |
| --to-numbers TEXT [twilio]The destination SMS numbers. | |
| --account-sid TEXT [twilioThe account sid. | |
| --subdomain TEXT [pagerduty]The subdomain. | |
| --service-key TEXT [pagerduty]The API service/integration key. | |
| --client-name TEXT [pagerduty]The client identifier. | |
| --message-from TEXT [hipchat]The label to be shown with | |
| notification. | |
| --api-url TEXT [hipchat]The api url. | |
| --color [yellow|green|red|purple|gray|random] | |
| [hipchat]The notification color. | |
| --rooms TEXT [hipchat]Rooms to send notification to. Use | |
| multiple flags to send to multiple rooms, ex | |
| --rooms=A --rooms=B | |
| --notify TEXT [hipchat]The notify channel trigger. | |
| --url TEXT [webhook]The target URL. | |
| --headers FILENAME [webhook]The http headers. | |
| --server TEXT [irc]Server address. | |
| --nickname TEXT [irc]The irc nick. | |
| --target TEXT [irc]The distination channels or users. | |
| Local Options: | |
| -a, --all-pages If set, collate all pages of content from the API when | |
| returning results. [default: False] | |
| --page INTEGER The page to show. Ignored if --all-pages is sent. | |
| [default: 1] | |
| --page-size INTEGER Number of records to show. Ignored if --all-pages. | |
| -Q, --query TEXT... A key and value to be passed as an HTTP query string | |
| key and value to the Tower API. Will be run through | |
| HTTP escaping. This argument may be sent multiple | |
| times. | |
| Example: `--query foo bar` would be passed to | |
| Tower as ?foo=bar | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli notification_template modify --help | |
| Usage: tower-cli notification_template modify [OPTIONS] [ID] | |
| Modify an existing notification template. | |
| Not all required configuration-related fields (required according to | |
| notification_type) should be provided. | |
| Fields in the resource's --identity tuple can be used in lieu of a primary | |
| key for a lookup; in such a case, only other fields are written. | |
| To modify unique fields, you must use the primary key for the lookup. | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| -d, --description TEXT The description field. | |
| --organization ORGANIZATION The organization field. | |
| --notification-type [email|slack|twilio|pagerduty|hipchat|webhook|irc] | |
| [REQUIRED] The notification_type field. | |
| --notification-configuration FILENAME | |
| The notification configuration field. Note | |
| providing this field would disable all | |
| notification-configuration-related fields. | |
| --username TEXT [email]The username. | |
| --sender TEXT [email]The sender. | |
| --recipients TEXT [email]The recipients. | |
| --use-tls BOOLEAN [email]The tls trigger. | |
| --host TEXT [email]The host. | |
| --use-ssl BOOLEAN [email/irc]The ssl trigger. | |
| --password TEXT [email/irc]The password. | |
| --port INTEGER [email/irc]The email port. | |
| --channels TEXT [slack]The channel. | |
| --token TEXT [slack/pagerduty/hipchat]The token. | |
| --account-token TEXT [twilio]The account token. | |
| --from-number TEXT [twilio]The source phone number. | |
| --to-numbers TEXT [twilio]The destination SMS numbers. | |
| --account-sid TEXT [twilioThe account sid. | |
| --subdomain TEXT [pagerduty]The subdomain. | |
| --service-key TEXT [pagerduty]The API service/integration key. | |
| --client-name TEXT [pagerduty]The client identifier. | |
| --message-from TEXT [hipchat]The label to be shown with | |
| notification. | |
| --api-url TEXT [hipchat]The api url. | |
| --color [yellow|green|red|purple|gray|random] | |
| [hipchat]The notification color. | |
| --rooms TEXT [hipchat]Rooms to send notification to. Use | |
| multiple flags to send to multiple rooms, ex | |
| --rooms=A --rooms=B | |
| --notify TEXT [hipchat]The notify channel trigger. | |
| --url TEXT [webhook]The target URL. | |
| --headers FILENAME [webhook]The http headers. | |
| --server TEXT [irc]Server address. | |
| --nickname TEXT [irc]The irc nick. | |
| --target TEXT [irc]The distination channels or users. | |
| Local Options: | |
| --create-on-missing If used, and if options rather than a primary key are | |
| used to attempt to match a record, will create the | |
| record if it does not exist. This is an alias to | |
| `create --force-on-exists`. [default: False] | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli organization --help | |
| Usage: tower-cli organization [OPTIONS] COMMAND [ARGS]... | |
| Manage organizations within Ansible Tower. | |
| Options: | |
| --help Show this message and exit. | |
| Commands: | |
| associate Associate a user with this organization. | |
| associate_admin Associate an admin with this organization. | |
| associate_ig Associate an ig with this organization. | |
| copy Copy an organization. | |
| create Create an organization. | |
| delete Remove the given organization. | |
| disassociate Disassociate a user with this organization. | |
| disassociate_admin Disassociate an admin with this organization. | |
| disassociate_ig Disassociate an ig with this organization. | |
| get Return one and exactly one organization. | |
| list Return a list of organizations. | |
| modify Modify an already existing organization. | |
| # tower-cli organization associate --help | |
| Usage: tower-cli organization associate [OPTIONS] | |
| Associate a user with this organization. | |
| Local Options: | |
| --organization ORGANIZATION [required] | |
| --user USER [required] | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli organization associate_admin --help | |
| Usage: tower-cli organization associate_admin [OPTIONS] | |
| Associate an admin with this organization. | |
| Local Options: | |
| --organization ORGANIZATION [required] | |
| --user USER [required] | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli organization associate_ig --help | |
| Usage: tower-cli organization associate_ig [OPTIONS] | |
| Associate an ig with this organization. | |
| Local Options: | |
| --organization ORGANIZATION [required] | |
| --instance_group INSTANCE_GROUP | |
| [required] | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli organization copy --help | |
| Usage: tower-cli organization copy [OPTIONS] [ID] | |
| Copy an organization. | |
| Only the ID is used for the lookup. All provided fields are used to | |
| override the old data from the copied resource. | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| -d, --description TEXT The description field. | |
| Local Options: | |
| --new-name TEXT The name to give the new resource, if used, will deep copy | |
| in the backend. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli organization create --help | |
| Usage: tower-cli organization create [OPTIONS] | |
| Create an organization. | |
| Fields in the resource's --identity tuple are used for a lookup; if a | |
| match is found, then no-op (unless --force-on-exists is set) but do not | |
| fail (unless --fail-on-found is set). | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| -d, --description TEXT The description field. | |
| Local Options: | |
| --fail-on-found If used, return an error if a matching record already | |
| exists. [default: False] | |
| --force-on-exists If used, if a match is found on unique fields, other | |
| fields will be updated to the provided values. If False, | |
| a match causes the request to be a no-op. [default: | |
| False] | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli organization delete --help | |
| Usage: tower-cli organization delete [OPTIONS] [ID] | |
| Remove the given organization. | |
| If --fail-on-missing is True, then the organization's not being found is | |
| considered a failure; otherwise, a success with no change is reported. | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| -d, --description TEXT The description field. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli organization disassociate --help | |
| Usage: tower-cli organization disassociate [OPTIONS] | |
| Disassociate a user with this organization. | |
| Local Options: | |
| --organization ORGANIZATION [required] | |
| --user USER [required] | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli organization disassociate_admin --help | |
| Usage: tower-cli organization disassociate_admin [OPTIONS] | |
| Disassociate an admin with this organization. | |
| Local Options: | |
| --organization ORGANIZATION [required] | |
| --user USER [required] | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli organization disassociate_ig --help | |
| Usage: tower-cli organization disassociate_ig [OPTIONS] | |
| Disassociate an ig with this organization. | |
| Local Options: | |
| --organization ORGANIZATION [required] | |
| --instance_group INSTANCE_GROUP | |
| [required] | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli organization get --help | |
| Usage: tower-cli organization get [OPTIONS] [ID] | |
| Return one and exactly one organization. | |
| Lookups may be through a primary key, specified as a positional argument, | |
| and/or through filters specified through options. | |
| If the number of results does not equal one, abort with an error. | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| -d, --description TEXT The description field. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli organization list --help | |
| Usage: tower-cli organization list [OPTIONS] | |
| Return a list of organizations. | |
| If one or more filters are provided through options, filter the results | |
| accordingly. | |
| If no filters are provided, return all results. | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| -d, --description TEXT The description field. | |
| Local Options: | |
| -a, --all-pages If set, collate all pages of content from the API when | |
| returning results. [default: False] | |
| --page INTEGER The page to show. Ignored if --all-pages is sent. | |
| [default: 1] | |
| --page-size INTEGER Number of records to show. Ignored if --all-pages. | |
| -Q, --query TEXT... A key and value to be passed as an HTTP query string | |
| key and value to the Tower API. Will be run through | |
| HTTP escaping. This argument may be sent multiple | |
| times. | |
| Example: `--query foo bar` would be passed to | |
| Tower as ?foo=bar | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli organization modify --help | |
| Usage: tower-cli organization modify [OPTIONS] [ID] | |
| Modify an already existing organization. | |
| Fields in the resource's --identity tuple can be used in lieu of a primary | |
| key for a lookup; in such a case, only other fields are written. | |
| To modify unique fields, you must use the primary key for the lookup. | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| -d, --description TEXT The description field. | |
| Local Options: | |
| --create-on-missing If used, and if options rather than a primary key are | |
| used to attempt to match a record, will create the | |
| record if it does not exist. This is an alias to | |
| `create --force-on-exists`. [default: False] | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli project --help | |
| Usage: tower-cli project [OPTIONS] COMMAND [ARGS]... | |
| Manage projects within Ansible Tower. | |
| Options: | |
| --help Show this message and exit. | |
| Commands: | |
| copy Copy a project. | |
| create Create a new item of resource, with or w/o... | |
| delete Remove the given project. | |
| get Return one and exactly one project. | |
| list Return a list of projects. | |
| modify Modify an already existing. | |
| monitor Stream the standard output from a job,... | |
| status Print the status of the most recent update. | |
| stdout Print out the standard out of a unified job... | |
| update Trigger a project update job within Ansible... | |
| wait Wait for a running job to finish. | |
| # tower-cli project copy --help | |
| Usage: tower-cli project copy [OPTIONS] [ID] | |
| Copy a project. | |
| Only the ID is used for the lookup. All provided fields are used to | |
| override the old data from the copied resource. | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| -d, --description TEXT The description field. | |
| --organization ORGANIZATION The organization field. | |
| --scm-type [manual|git|hg|svn|insights] | |
| The scm_type field. | |
| --scm-url TEXT The scm_url field. | |
| --local-path TEXT For manual projects, the server playbook | |
| directory name. | |
| --scm-branch TEXT The scm_branch field. | |
| --scm-credential CREDENTIAL The scm_credential field. | |
| --scm-clean BOOLEAN The scm_clean field. | |
| --scm-delete-on-update BOOLEAN The scm_delete_on_update field. | |
| --scm-update-on-launch BOOLEAN The scm_update_on_launch field. | |
| --scm-update-cache-timeout INTEGER | |
| The scm_update_cache_timeout field. | |
| --job-timeout INTEGER The timeout field (in seconds). | |
| Local Options: | |
| --new-name TEXT The name to give the new resource, if used, will deep copy | |
| in the backend. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli project create --help | |
| Usage: tower-cli project create [OPTIONS] | |
| Create a new item of resource, with or w/o org. This would be a shared | |
| class with user, but it needs the ability to monitor if the flag is set. | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| -d, --description TEXT The description field. | |
| --organization ORGANIZATION The organization field. | |
| --scm-type [manual|git|hg|svn|insights] | |
| The scm_type field. | |
| --scm-url TEXT The scm_url field. | |
| --local-path TEXT For manual projects, the server playbook | |
| directory name. | |
| --scm-branch TEXT The scm_branch field. | |
| --scm-credential CREDENTIAL The scm_credential field. | |
| --scm-clean BOOLEAN The scm_clean field. | |
| --scm-delete-on-update BOOLEAN The scm_delete_on_update field. | |
| --scm-update-on-launch BOOLEAN The scm_update_on_launch field. | |
| --scm-update-cache-timeout INTEGER | |
| The scm_update_cache_timeout field. | |
| --job-timeout INTEGER The timeout field (in seconds). | |
| Local Options: | |
| --fail-on-found If used, return an error if a matching record already | |
| exists. [default: False] | |
| --force-on-exists If used, if a match is found on unique fields, other | |
| fields will be updated to the provided values. If False, | |
| a match causes the request to be a no-op. [default: | |
| False] | |
| --monitor If sent, immediately calls `project monitor` on the | |
| project rather than exiting with a success.It polls for | |
| status until the SCM is updated. | |
| --wait Polls server for status, exists when finished. | |
| --timeout INTEGER If provided with --monitor, the SCM update will time out | |
| after the given number of seconds. Does nothing if | |
| --monitor is not sent. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli project delete --help | |
| Usage: tower-cli project delete [OPTIONS] [ID] | |
| Remove the given project. | |
| If --fail-on-missing is True, then the project's not being found is | |
| considered a failure; otherwise, a success with no change is reported. | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| -d, --description TEXT The description field. | |
| --organization ORGANIZATION The organization field. | |
| --scm-type [manual|git|hg|svn|insights] | |
| The scm_type field. | |
| --scm-url TEXT The scm_url field. | |
| --local-path TEXT For manual projects, the server playbook | |
| directory name. | |
| --scm-branch TEXT The scm_branch field. | |
| --scm-credential CREDENTIAL The scm_credential field. | |
| --scm-clean BOOLEAN The scm_clean field. | |
| --scm-delete-on-update BOOLEAN The scm_delete_on_update field. | |
| --scm-update-on-launch BOOLEAN The scm_update_on_launch field. | |
| --scm-update-cache-timeout INTEGER | |
| The scm_update_cache_timeout field. | |
| --job-timeout INTEGER The timeout field (in seconds). | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli project get --help | |
| Usage: tower-cli project get [OPTIONS] [ID] | |
| Return one and exactly one project. | |
| Lookups may be through a primary key, specified as a positional argument, | |
| and/or through filters specified through options. | |
| If the number of results does not equal one, abort with an error. | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| -d, --description TEXT The description field. | |
| --organization ORGANIZATION The organization field. | |
| --scm-type [manual|git|hg|svn|insights] | |
| The scm_type field. | |
| --scm-url TEXT The scm_url field. | |
| --local-path TEXT For manual projects, the server playbook | |
| directory name. | |
| --scm-branch TEXT The scm_branch field. | |
| --scm-credential CREDENTIAL The scm_credential field. | |
| --scm-clean BOOLEAN The scm_clean field. | |
| --scm-delete-on-update BOOLEAN The scm_delete_on_update field. | |
| --scm-update-on-launch BOOLEAN The scm_update_on_launch field. | |
| --scm-update-cache-timeout INTEGER | |
| The scm_update_cache_timeout field. | |
| --job-timeout INTEGER The timeout field (in seconds). | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli project list --help | |
| Usage: tower-cli project list [OPTIONS] | |
| Return a list of projects. | |
| If one or more filters are provided through options, filter the results | |
| accordingly. | |
| If no filters are provided, return all results. | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| -d, --description TEXT The description field. | |
| --organization ORGANIZATION The organization field. | |
| --scm-type [manual|git|hg|svn|insights] | |
| The scm_type field. | |
| --scm-url TEXT The scm_url field. | |
| --local-path TEXT For manual projects, the server playbook | |
| directory name. | |
| --scm-branch TEXT The scm_branch field. | |
| --scm-credential CREDENTIAL The scm_credential field. | |
| --scm-clean BOOLEAN The scm_clean field. | |
| --scm-delete-on-update BOOLEAN The scm_delete_on_update field. | |
| --scm-update-on-launch BOOLEAN The scm_update_on_launch field. | |
| --scm-update-cache-timeout INTEGER | |
| The scm_update_cache_timeout field. | |
| --job-timeout INTEGER The timeout field (in seconds). | |
| Local Options: | |
| -a, --all-pages If set, collate all pages of content from the API when | |
| returning results. [default: False] | |
| --page INTEGER The page to show. Ignored if --all-pages is sent. | |
| [default: 1] | |
| --page-size INTEGER Number of records to show. Ignored if --all-pages. | |
| -Q, --query TEXT... A key and value to be passed as an HTTP query string | |
| key and value to the Tower API. Will be run through | |
| HTTP escaping. This argument may be sent multiple | |
| times. | |
| Example: `--query foo bar` would be passed to | |
| Tower as ?foo=bar | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli project modify --help | |
| Usage: tower-cli project modify [OPTIONS] [ID] | |
| Modify an already existing. | |
| To edit the project's organizations, see help for organizations. | |
| Fields in the resource's --identity tuple can be used in lieu of a primary | |
| key for a lookup; in such a case, only other fields are written. | |
| To modify unique fields, you must use the primary key for the lookup. | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| -d, --description TEXT The description field. | |
| --scm-type [manual|git|hg|svn|insights] | |
| The scm_type field. | |
| --scm-url TEXT The scm_url field. | |
| --local-path TEXT For manual projects, the server playbook | |
| directory name. | |
| --scm-branch TEXT The scm_branch field. | |
| --scm-credential CREDENTIAL The scm_credential field. | |
| --scm-clean BOOLEAN The scm_clean field. | |
| --scm-delete-on-update BOOLEAN The scm_delete_on_update field. | |
| --scm-update-on-launch BOOLEAN The scm_update_on_launch field. | |
| --job-timeout INTEGER The timeout field (in seconds). | |
| Local Options: | |
| --create-on-missing If used, and if options rather than a primary key are | |
| used to attempt to match a record, will create the | |
| record if it does not exist. This is an alias to | |
| `create --force-on-exists`. [default: False] | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli project monitor --help | |
| Usage: tower-cli project monitor [OPTIONS] [ID] | |
| Stream the standard output from a job, project update, or inventory | |
| udpate. | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| -d, --description TEXT The description field. | |
| --organization ORGANIZATION The organization field. | |
| --scm-type [manual|git|hg|svn|insights] | |
| The scm_type field. | |
| --scm-url TEXT The scm_url field. | |
| --local-path TEXT For manual projects, the server playbook | |
| directory name. | |
| --scm-branch TEXT The scm_branch field. | |
| --scm-credential CREDENTIAL The scm_credential field. | |
| --scm-clean BOOLEAN The scm_clean field. | |
| --scm-delete-on-update BOOLEAN The scm_delete_on_update field. | |
| --scm-update-on-launch BOOLEAN The scm_update_on_launch field. | |
| --scm-update-cache-timeout INTEGER | |
| The scm_update_cache_timeout field. | |
| --job-timeout INTEGER The timeout field (in seconds). | |
| Local Options: | |
| --interval FLOAT Polling interval to refresh content from Tower. | |
| --timeout INTEGER If provided, this command (not the job) will time out | |
| after the given number of seconds. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli project status --help | |
| Usage: tower-cli project status [OPTIONS] [ID] | |
| Print the status of the most recent update. | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| -d, --description TEXT The description field. | |
| --organization ORGANIZATION The organization field. | |
| --scm-type [manual|git|hg|svn|insights] | |
| The scm_type field. | |
| --scm-url TEXT The scm_url field. | |
| --local-path TEXT For manual projects, the server playbook | |
| directory name. | |
| --scm-branch TEXT The scm_branch field. | |
| --scm-credential CREDENTIAL The scm_credential field. | |
| --scm-clean BOOLEAN The scm_clean field. | |
| --scm-delete-on-update BOOLEAN The scm_delete_on_update field. | |
| --scm-update-on-launch BOOLEAN The scm_update_on_launch field. | |
| --scm-update-cache-timeout INTEGER | |
| The scm_update_cache_timeout field. | |
| --job-timeout INTEGER The timeout field (in seconds). | |
| Local Options: | |
| --detail Print more detail. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli project stdout --help | |
| Usage: tower-cli project stdout [OPTIONS] [ID] | |
| Print out the standard out of a unified job to the command line. For | |
| Projects, print the standard out of most recent update. For Inventory | |
| Sources, print standard out of most recent sync. For Jobs, print the job's | |
| standard out. For Workflow Jobs, print a status table of its jobs. | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| -d, --description TEXT The description field. | |
| --organization ORGANIZATION The organization field. | |
| --scm-type [manual|git|hg|svn|insights] | |
| The scm_type field. | |
| --scm-url TEXT The scm_url field. | |
| --local-path TEXT For manual projects, the server playbook | |
| directory name. | |
| --scm-branch TEXT The scm_branch field. | |
| --scm-credential CREDENTIAL The scm_credential field. | |
| --scm-clean BOOLEAN The scm_clean field. | |
| --scm-delete-on-update BOOLEAN The scm_delete_on_update field. | |
| --scm-update-on-launch BOOLEAN The scm_update_on_launch field. | |
| --scm-update-cache-timeout INTEGER | |
| The scm_update_cache_timeout field. | |
| --job-timeout INTEGER The timeout field (in seconds). | |
| Local Options: | |
| --start-line INTEGER Line at which to start printing the standard out. | |
| --end-line INTEGER Line at which to end printing the standard out. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli project update --help | |
| Usage: tower-cli project update [OPTIONS] [ID] | |
| Trigger a project update job within Ansible Tower. Only meaningful on non- | |
| manual projects. | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| --organization ORGANIZATION The organization field. | |
| Local Options: | |
| --monitor If sent, immediately calls `job monitor` on the newly | |
| launched job rather than exiting with a success. | |
| --wait Polls server for status, exists when finished. | |
| --timeout INTEGER If provided with --monitor, this command (not the job) | |
| will time out after the given number of seconds. Does | |
| nothing if --monitor is not sent. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli project wait --help | |
| Usage: tower-cli project wait [OPTIONS] [ID] | |
| Wait for a running job to finish. Blocks further input until the job | |
| completes (whether successfully or unsuccessfully) and a final status can | |
| be given. | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| -d, --description TEXT The description field. | |
| --organization ORGANIZATION The organization field. | |
| --scm-type [manual|git|hg|svn|insights] | |
| The scm_type field. | |
| --scm-url TEXT The scm_url field. | |
| --local-path TEXT For manual projects, the server playbook | |
| directory name. | |
| --scm-branch TEXT The scm_branch field. | |
| --scm-credential CREDENTIAL The scm_credential field. | |
| --scm-clean BOOLEAN The scm_clean field. | |
| --scm-delete-on-update BOOLEAN The scm_delete_on_update field. | |
| --scm-update-on-launch BOOLEAN The scm_update_on_launch field. | |
| --scm-update-cache-timeout INTEGER | |
| The scm_update_cache_timeout field. | |
| --job-timeout INTEGER The timeout field (in seconds). | |
| Local Options: | |
| --min-interval INTEGER The minimum interval to request an update from | |
| Tower. | |
| --max-interval INTEGER The maximum interval to request an update from | |
| Tower. | |
| --timeout INTEGER If provided, this command (not the job) will time | |
| out after the given number of seconds. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli project_update --help | |
| Usage: tower-cli project_update [OPTIONS] COMMAND [ARGS]... | |
| Launch or monitor project updates. | |
| Options: | |
| --help Show this message and exit. | |
| Commands: | |
| cancel Cancel a currently running job. | |
| delete Remove the given project update. | |
| get Return one and exactly one project update. | |
| list Return a list of project updates. | |
| monitor Stream the standard output from a job,... | |
| relaunch Relaunch a stopped job. | |
| status Print the current job status. | |
| stdout Print out the standard out of a unified job... | |
| wait Wait for a running job to finish. | |
| # tower-cli project_update cancel --help | |
| Usage: tower-cli project_update cancel [OPTIONS] [ID] | |
| Cancel a currently running job. | |
| Fails with a non-zero exit status if the job cannot be canceled. You must | |
| provide either a pk or parameters in the job's identity. | |
| Field Options: | |
| -P, --project PROJECT [REQUIRED] The project field. | |
| -n, --name TEXT [READ ONLY] The name field. | |
| --launch-type [manual|relaunch|relaunch|callback|scheduled|dependency|workflow|sync|scm] | |
| [REQUIRED] The launch_type field. | |
| --status [new|pending|waiting|running|successful|failed|error|canceled] | |
| [REQUIRED] The status field. | |
| --job-type [run|check] [REQUIRED] The job_type field. | |
| --job-explanation TEXT [READ ONLY] The job_explanation field. | |
| --created TEXT [READ ONLY] The created field. | |
| --elapsed TEXT [READ ONLY] The elapsed field. | |
| --scm-type [manual|git|hg|svn|insights] | |
| [REQUIRED] The scm_type field. | |
| Local Options: | |
| --fail-if-not-running Fail loudly if the job is not currently running. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli project_update delete --help | |
| Usage: tower-cli project_update delete [OPTIONS] [ID] | |
| Remove the given project update. | |
| If --fail-on-missing is True, then the project update's not being found is | |
| considered a failure; otherwise, a success with no change is reported. | |
| Field Options: | |
| -P, --project PROJECT [REQUIRED] The project field. | |
| -n, --name TEXT [READ ONLY] The name field. | |
| --launch-type [manual|relaunch|relaunch|callback|scheduled|dependency|workflow|sync|scm] | |
| [REQUIRED] The launch_type field. | |
| --status [new|pending|waiting|running|successful|failed|error|canceled] | |
| [REQUIRED] The status field. | |
| --job-type [run|check] [REQUIRED] The job_type field. | |
| --job-explanation TEXT [READ ONLY] The job_explanation field. | |
| --created TEXT [READ ONLY] The created field. | |
| --elapsed TEXT [READ ONLY] The elapsed field. | |
| --scm-type [manual|git|hg|svn|insights] | |
| [REQUIRED] The scm_type field. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli project_update get --help | |
| Usage: tower-cli project_update get [OPTIONS] [ID] | |
| Return one and exactly one project update. | |
| Lookups may be through a primary key, specified as a positional argument, | |
| and/or through filters specified through options. | |
| If the number of results does not equal one, abort with an error. | |
| Field Options: | |
| -P, --project PROJECT [REQUIRED] The project field. | |
| -n, --name TEXT [READ ONLY] The name field. | |
| --launch-type [manual|relaunch|relaunch|callback|scheduled|dependency|workflow|sync|scm] | |
| [REQUIRED] The launch_type field. | |
| --status [new|pending|waiting|running|successful|failed|error|canceled] | |
| [REQUIRED] The status field. | |
| --job-type [run|check] [REQUIRED] The job_type field. | |
| --job-explanation TEXT [READ ONLY] The job_explanation field. | |
| --created TEXT [READ ONLY] The created field. | |
| --elapsed TEXT [READ ONLY] The elapsed field. | |
| --scm-type [manual|git|hg|svn|insights] | |
| [REQUIRED] The scm_type field. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli project_update list --help | |
| Usage: tower-cli project_update list [OPTIONS] | |
| Return a list of project updates. | |
| If one or more filters are provided through options, filter the results | |
| accordingly. | |
| If no filters are provided, return all results. | |
| Field Options: | |
| -P, --project PROJECT [REQUIRED] The project field. | |
| -n, --name TEXT [READ ONLY] The name field. | |
| --launch-type [manual|relaunch|relaunch|callback|scheduled|dependency|workflow|sync|scm] | |
| [REQUIRED] The launch_type field. | |
| --status [new|pending|waiting|running|successful|failed|error|canceled] | |
| [REQUIRED] The status field. | |
| --job-type [run|check] [REQUIRED] The job_type field. | |
| --job-explanation TEXT [READ ONLY] The job_explanation field. | |
| --created TEXT [READ ONLY] The created field. | |
| --elapsed TEXT [READ ONLY] The elapsed field. | |
| --scm-type [manual|git|hg|svn|insights] | |
| [REQUIRED] The scm_type field. | |
| Local Options: | |
| -a, --all-pages If set, collate all pages of content from the API when | |
| returning results. [default: False] | |
| --page INTEGER The page to show. Ignored if --all-pages is sent. | |
| [default: 1] | |
| --page-size INTEGER Number of records to show. Ignored if --all-pages. | |
| -Q, --query TEXT... A key and value to be passed as an HTTP query string | |
| key and value to the Tower API. Will be run through | |
| HTTP escaping. This argument may be sent multiple | |
| times. | |
| Example: `--query foo bar` would be passed to | |
| Tower as ?foo=bar | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli project_update monitor --help | |
| Usage: tower-cli project_update monitor [OPTIONS] [ID] | |
| Stream the standard output from a job, project update, or inventory | |
| udpate. | |
| Field Options: | |
| -P, --project PROJECT [REQUIRED] The project field. | |
| -n, --name TEXT [READ ONLY] The name field. | |
| --launch-type [manual|relaunch|relaunch|callback|scheduled|dependency|workflow|sync|scm] | |
| [REQUIRED] The launch_type field. | |
| --status [new|pending|waiting|running|successful|failed|error|canceled] | |
| [REQUIRED] The status field. | |
| --job-type [run|check] [REQUIRED] The job_type field. | |
| --job-explanation TEXT [READ ONLY] The job_explanation field. | |
| --created TEXT [READ ONLY] The created field. | |
| --elapsed TEXT [READ ONLY] The elapsed field. | |
| --scm-type [manual|git|hg|svn|insights] | |
| [REQUIRED] The scm_type field. | |
| Local Options: | |
| --interval FLOAT Polling interval to refresh content from Tower. | |
| --timeout INTEGER If provided, this command (not the job) will time out | |
| after the given number of seconds. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli project_update relaunch --help | |
| Usage: tower-cli project_update relaunch [OPTIONS] [ID] | |
| Relaunch a stopped job. | |
| Fails with a non-zero exit status if the job cannot be relaunched. You | |
| must provide either a pk or parameters in the job's identity. | |
| Field Options: | |
| -P, --project PROJECT [REQUIRED] The project field. | |
| -n, --name TEXT [READ ONLY] The name field. | |
| --launch-type [manual|relaunch|relaunch|callback|scheduled|dependency|workflow|sync|scm] | |
| [REQUIRED] The launch_type field. | |
| --status [new|pending|waiting|running|successful|failed|error|canceled] | |
| [REQUIRED] The status field. | |
| --job-type [run|check] [REQUIRED] The job_type field. | |
| --job-explanation TEXT [READ ONLY] The job_explanation field. | |
| --created TEXT [READ ONLY] The created field. | |
| --elapsed TEXT [READ ONLY] The elapsed field. | |
| --scm-type [manual|git|hg|svn|insights] | |
| [REQUIRED] The scm_type field. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli project_update status --help | |
| Usage: tower-cli project_update status [OPTIONS] [ID] | |
| Print the current job status. This is used to check a running job. You can | |
| look up the job with the same parameters used for a get request. | |
| Field Options: | |
| -P, --project PROJECT [REQUIRED] The project field. | |
| -n, --name TEXT [READ ONLY] The name field. | |
| --launch-type [manual|relaunch|relaunch|callback|scheduled|dependency|workflow|sync|scm] | |
| [REQUIRED] The launch_type field. | |
| --status [new|pending|waiting|running|successful|failed|error|canceled] | |
| [REQUIRED] The status field. | |
| --job-type [run|check] [REQUIRED] The job_type field. | |
| --job-explanation TEXT [READ ONLY] The job_explanation field. | |
| --created TEXT [READ ONLY] The created field. | |
| --elapsed TEXT [READ ONLY] The elapsed field. | |
| --scm-type [manual|git|hg|svn|insights] | |
| [REQUIRED] The scm_type field. | |
| Local Options: | |
| --detail Print more detail. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli project_update stdout --help | |
| Usage: tower-cli project_update stdout [OPTIONS] [ID] | |
| Print out the standard out of a unified job to the command line. For | |
| Projects, print the standard out of most recent update. For Inventory | |
| Sources, print standard out of most recent sync. For Jobs, print the job's | |
| standard out. For Workflow Jobs, print a status table of its jobs. | |
| Field Options: | |
| -P, --project PROJECT [REQUIRED] The project field. | |
| -n, --name TEXT [READ ONLY] The name field. | |
| --launch-type [manual|relaunch|relaunch|callback|scheduled|dependency|workflow|sync|scm] | |
| [REQUIRED] The launch_type field. | |
| --status [new|pending|waiting|running|successful|failed|error|canceled] | |
| [REQUIRED] The status field. | |
| --job-type [run|check] [REQUIRED] The job_type field. | |
| --job-explanation TEXT [READ ONLY] The job_explanation field. | |
| --created TEXT [READ ONLY] The created field. | |
| --elapsed TEXT [READ ONLY] The elapsed field. | |
| --scm-type [manual|git|hg|svn|insights] | |
| [REQUIRED] The scm_type field. | |
| Local Options: | |
| --start-line INTEGER Line at which to start printing the standard out. | |
| --end-line INTEGER Line at which to end printing the standard out. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli project_update wait --help | |
| Usage: tower-cli project_update wait [OPTIONS] [ID] | |
| Wait for a running job to finish. Blocks further input until the job | |
| completes (whether successfully or unsuccessfully) and a final status can | |
| be given. | |
| Field Options: | |
| -P, --project PROJECT [REQUIRED] The project field. | |
| -n, --name TEXT [READ ONLY] The name field. | |
| --launch-type [manual|relaunch|relaunch|callback|scheduled|dependency|workflow|sync|scm] | |
| [REQUIRED] The launch_type field. | |
| --status [new|pending|waiting|running|successful|failed|error|canceled] | |
| [REQUIRED] The status field. | |
| --job-type [run|check] [REQUIRED] The job_type field. | |
| --job-explanation TEXT [READ ONLY] The job_explanation field. | |
| --created TEXT [READ ONLY] The created field. | |
| --elapsed TEXT [READ ONLY] The elapsed field. | |
| --scm-type [manual|git|hg|svn|insights] | |
| [REQUIRED] The scm_type field. | |
| Local Options: | |
| --min-interval INTEGER The minimum interval to request an update from | |
| Tower. | |
| --max-interval INTEGER The maximum interval to request an update from | |
| Tower. | |
| --timeout INTEGER If provided, this command (not the job) will time | |
| out after the given number of seconds. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli role --help | |
| Usage: tower-cli role [OPTIONS] COMMAND [ARGS]... | |
| Add and remove users/teams from roles. | |
| Options: | |
| --help Show this message and exit. | |
| Commands: | |
| copy Copy a role. | |
| get Get information about a role. | |
| grant Add a user or a team to a role. | |
| list Return a list of roles. | |
| revoke Remove a user or a team from a role. | |
| # tower-cli role copy --help | |
| Usage: tower-cli role copy [OPTIONS] [ID] | |
| Copy a role. | |
| Only the ID is used for the lookup. All provided fields are used to | |
| override the old data from the copied resource. | |
| Field Options: | |
| --user USER The user field. | |
| --team TEAM The team that receives the permissions | |
| specified by the role. | |
| --type [admin|read|member|execute|adhoc|update|use|auditor|project_admin|inventory_admin|credential_admin|workflow_admin|notification_admin] | |
| The type of permission that the role | |
| controls. | |
| --resource-name TEXT The resource_name field. | |
| --resource-type TEXT The resource_type field. | |
| --target-team TEAM The team that the role acts on. | |
| -i, --inventory INVENTORY The inventory field. | |
| --job-template JOB_TEMPLATE The job_template field. | |
| --credential CREDENTIAL The credential field. | |
| --organization ORGANIZATION The organization field. | |
| --project PROJECT The project field. | |
| --workflow WORKFLOW The workflow field. | |
| Local Options: | |
| --new-name TEXT The name to give the new resource, if used, will deep copy | |
| in the backend. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli role get --help | |
| Usage: tower-cli role get [OPTIONS] [ID] | |
| Get information about a role. | |
| Field Options: | |
| --user USER The user field. | |
| --team TEAM The team that receives the permissions | |
| specified by the role. | |
| --type [admin|read|member|execute|adhoc|update|use|auditor|project_admin|inventory_admin|credential_admin|workflow_admin|notification_admin] | |
| The type of permission that the role | |
| controls. | |
| --target-team TEAM The team that the role acts on. | |
| -i, --inventory INVENTORY The inventory field. | |
| --job-template JOB_TEMPLATE The job_template field. | |
| --credential CREDENTIAL The credential field. | |
| --organization ORGANIZATION The organization field. | |
| --project PROJECT The project field. | |
| --workflow WORKFLOW The workflow field. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli role grant --help | |
| Usage: tower-cli role grant [OPTIONS] | |
| Add a user or a team to a role. Required information: 1) Type of the role | |
| 2) Resource of the role, inventory, credential, or any other 3) A user or | |
| a team to add to the role | |
| Field Options: | |
| --user USER The user field. | |
| --team TEAM The team that receives the permissions | |
| specified by the role. | |
| --type [admin|read|member|execute|adhoc|update|use|auditor|project_admin|inventory_admin|credential_admin|workflow_admin|notification_admin] | |
| The type of permission that the role | |
| controls. | |
| --target-team TEAM The team that the role acts on. | |
| -i, --inventory INVENTORY The inventory field. | |
| --job-template JOB_TEMPLATE The job_template field. | |
| --credential CREDENTIAL The credential field. | |
| --organization ORGANIZATION The organization field. | |
| --project PROJECT The project field. | |
| --workflow WORKFLOW The workflow field. | |
| Local Options: | |
| --fail-on-found If used, return an error if the user already has the role. | |
| [default: False] | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli role list --help | |
| Usage: tower-cli role list [OPTIONS] | |
| Return a list of roles. | |
| Field Options: | |
| --user USER The user field. | |
| --team TEAM The team that receives the permissions | |
| specified by the role. | |
| --type [admin|read|member|execute|adhoc|update|use|auditor|project_admin|inventory_admin|credential_admin|workflow_admin|notification_admin] | |
| The type of permission that the role | |
| controls. | |
| --target-team TEAM The team that the role acts on. | |
| -i, --inventory INVENTORY The inventory field. | |
| --job-template JOB_TEMPLATE The job_template field. | |
| --credential CREDENTIAL The credential field. | |
| --organization ORGANIZATION The organization field. | |
| --project PROJECT The project field. | |
| --workflow WORKFLOW The workflow field. | |
| Local Options: | |
| -a, --all-pages If set, collate all pages of content from the API when | |
| returning results. [default: False] | |
| --page INTEGER The page to show. Ignored if --all-pages is sent. | |
| [default: 1] | |
| --page-size INTEGER Number of records to show. Ignored if --all-pages. | |
| -Q, --query TEXT... A key and value to be passed as an HTTP query string | |
| key and value to the Tower API. Will be run through | |
| HTTP escaping. This argument may be sent multiple | |
| times. | |
| Example: `--query foo bar` would be passed to | |
| Tower as ?foo=bar | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli role revoke --help | |
| Usage: tower-cli role revoke [OPTIONS] | |
| Remove a user or a team from a role. Required information: 1) Type of the | |
| role 2) Resource of the role, inventory, credential, or any other 3) A | |
| user or a team to add to the role | |
| Field Options: | |
| --user USER The user field. | |
| --team TEAM The team that receives the permissions | |
| specified by the role. | |
| --type [admin|read|member|execute|adhoc|update|use|auditor|project_admin|inventory_admin|credential_admin|workflow_admin|notification_admin] | |
| The type of permission that the role | |
| controls. | |
| --target-team TEAM The team that the role acts on. | |
| -i, --inventory INVENTORY The inventory field. | |
| --job-template JOB_TEMPLATE The job_template field. | |
| --credential CREDENTIAL The credential field. | |
| --organization ORGANIZATION The organization field. | |
| --project PROJECT The project field. | |
| --workflow WORKFLOW The workflow field. | |
| Local Options: | |
| --fail-on-found If used, return an error if the user is already not a | |
| member of the role. [default: False] | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli schedule --help | |
| Usage: tower-cli schedule [OPTIONS] COMMAND [ARGS]... | |
| Manage schedules within Ansible Tower. | |
| Options: | |
| --help Show this message and exit. | |
| Commands: | |
| associate_credential Associate a credential with this schedule. | |
| copy Copy a schedule. | |
| create Create a schedule. | |
| delete Remove the given schedule. | |
| disassociate_credential Disassociate a credential with this schedule. | |
| get Return one and exactly one schedule. | |
| list Return a list of schedules. | |
| modify Modify an already existing schedule. | |
| # tower-cli schedule associate_credential --help | |
| Usage: tower-cli schedule associate_credential [OPTIONS] | |
| Associate a credential with this schedule. | |
| Local Options: | |
| --schedule SCHEDULE [required] | |
| --credential CREDENTIAL [required] | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli schedule copy --help | |
| Usage: tower-cli schedule copy [OPTIONS] [ID] | |
| Copy a schedule. | |
| Only the ID is used for the lookup. All provided fields are used to | |
| override the old data from the copied resource. | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| -d, --description TEXT The description field. | |
| --job-template JOB_TEMPLATE The job_template field. | |
| --inventory-source INVENTORY_SOURCE | |
| The inventory_source field. | |
| --project PROJECT The project field. | |
| --unified-job-template INTEGER Integer used to display unified job template | |
| in result, Do not use it for create/modify. | |
| --enabled BOOLEAN Whether this schedule will be used. | |
| --rrule TEXT Schedule rules specifications which is less | |
| than 255 characters. | |
| --extra-data VARIABLES Extra data for schedule rules in the form of | |
| a .json file. | |
| -i, --inventory INVENTORY The inventory field. | |
| --job-type TEXT The job_type field. | |
| --job-tags TEXT The job_tags field. | |
| --skip-tags TEXT The skip_tags field. | |
| --limit TEXT The limit field. | |
| --diff-mode BOOLEAN The diff_mode field. | |
| --verbosity [default|verbose|more_verbose|debug|connection|winrm] | |
| The verbosity field. | |
| Local Options: | |
| --new-name TEXT The name to give the new resource, if used, will deep copy | |
| in the backend. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli schedule create --help | |
| Usage: tower-cli schedule create [OPTIONS] | |
| Create a schedule. | |
| Fields in the resource's --identity tuple are used for a lookup; if a | |
| match is found, then no-op (unless --force-on-exists is set) but do not | |
| fail (unless --fail-on-found is set). | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| -d, --description TEXT The description field. | |
| --job-template JOB_TEMPLATE The job_template field. | |
| --inventory-source INVENTORY_SOURCE | |
| The inventory_source field. | |
| --project PROJECT The project field. | |
| --unified-job-template INTEGER Integer used to display unified job template | |
| in result, Do not use it for create/modify. | |
| --enabled BOOLEAN Whether this schedule will be used. | |
| [default: True] | |
| --rrule TEXT Schedule rules specifications which is less | |
| than 255 characters. | |
| --extra-data VARIABLES Extra data for schedule rules in the form of | |
| a .json file. | |
| -i, --inventory INVENTORY The inventory field. | |
| --job-type TEXT The job_type field. | |
| --job-tags TEXT The job_tags field. | |
| --skip-tags TEXT The skip_tags field. | |
| --limit TEXT The limit field. | |
| --diff-mode BOOLEAN The diff_mode field. | |
| --verbosity [default|verbose|more_verbose|debug|connection|winrm] | |
| The verbosity field. | |
| Local Options: | |
| --fail-on-found If used, return an error if a matching record already | |
| exists. [default: False] | |
| --force-on-exists If used, if a match is found on unique fields, other | |
| fields will be updated to the provided values. If False, | |
| a match causes the request to be a no-op. [default: | |
| False] | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli schedule delete --help | |
| Usage: tower-cli schedule delete [OPTIONS] [ID] | |
| Remove the given schedule. | |
| If --fail-on-missing is True, then the schedule's not being found is | |
| considered a failure; otherwise, a success with no change is reported. | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| -d, --description TEXT The description field. | |
| --job-template JOB_TEMPLATE The job_template field. | |
| --inventory-source INVENTORY_SOURCE | |
| The inventory_source field. | |
| --project PROJECT The project field. | |
| --unified-job-template INTEGER Integer used to display unified job template | |
| in result, Do not use it for create/modify. | |
| --enabled BOOLEAN Whether this schedule will be used. | |
| [default: True] | |
| --rrule TEXT Schedule rules specifications which is less | |
| than 255 characters. | |
| --extra-data VARIABLES Extra data for schedule rules in the form of | |
| a .json file. | |
| -i, --inventory INVENTORY The inventory field. | |
| --job-type TEXT The job_type field. | |
| --job-tags TEXT The job_tags field. | |
| --skip-tags TEXT The skip_tags field. | |
| --limit TEXT The limit field. | |
| --diff-mode BOOLEAN The diff_mode field. | |
| --verbosity [default|verbose|more_verbose|debug|connection|winrm] | |
| The verbosity field. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli schedule disassociate_credential --help | |
| Usage: tower-cli schedule disassociate_credential [OPTIONS] | |
| Disassociate a credential with this schedule. | |
| Local Options: | |
| --schedule SCHEDULE [required] | |
| --credential CREDENTIAL [required] | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli schedule get --help | |
| Usage: tower-cli schedule get [OPTIONS] [ID] | |
| Return one and exactly one schedule. | |
| Lookups may be through a primary key, specified as a positional argument, | |
| and/or through filters specified through options. | |
| If the number of results does not equal one, abort with an error. | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| -d, --description TEXT The description field. | |
| --job-template JOB_TEMPLATE The job_template field. | |
| --inventory-source INVENTORY_SOURCE | |
| The inventory_source field. | |
| --project PROJECT The project field. | |
| --unified-job-template INTEGER Integer used to display unified job template | |
| in result, Do not use it for create/modify. | |
| --enabled BOOLEAN Whether this schedule will be used. | |
| --rrule TEXT Schedule rules specifications which is less | |
| than 255 characters. | |
| --extra-data VARIABLES Extra data for schedule rules in the form of | |
| a .json file. | |
| -i, --inventory INVENTORY The inventory field. | |
| --job-type TEXT The job_type field. | |
| --job-tags TEXT The job_tags field. | |
| --skip-tags TEXT The skip_tags field. | |
| --limit TEXT The limit field. | |
| --diff-mode BOOLEAN The diff_mode field. | |
| --verbosity [default|verbose|more_verbose|debug|connection|winrm] | |
| The verbosity field. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli schedule list --help | |
| Usage: tower-cli schedule list [OPTIONS] | |
| Return a list of schedules. | |
| If one or more filters are provided through options, filter the results | |
| accordingly. | |
| If no filters are provided, return all results. | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| -d, --description TEXT The description field. | |
| --job-template JOB_TEMPLATE The job_template field. | |
| --inventory-source INVENTORY_SOURCE | |
| The inventory_source field. | |
| --project PROJECT The project field. | |
| --unified-job-template INTEGER Integer used to display unified job template | |
| in result, Do not use it for create/modify. | |
| --enabled BOOLEAN Whether this schedule will be used. | |
| --rrule TEXT Schedule rules specifications which is less | |
| than 255 characters. | |
| --extra-data VARIABLES Extra data for schedule rules in the form of | |
| a .json file. | |
| -i, --inventory INVENTORY The inventory field. | |
| --job-type TEXT The job_type field. | |
| --job-tags TEXT The job_tags field. | |
| --skip-tags TEXT The skip_tags field. | |
| --limit TEXT The limit field. | |
| --diff-mode BOOLEAN The diff_mode field. | |
| --verbosity [default|verbose|more_verbose|debug|connection|winrm] | |
| The verbosity field. | |
| Local Options: | |
| -a, --all-pages If set, collate all pages of content from the API when | |
| returning results. [default: False] | |
| --page INTEGER The page to show. Ignored if --all-pages is sent. | |
| [default: 1] | |
| --page-size INTEGER Number of records to show. Ignored if --all-pages. | |
| -Q, --query TEXT... A key and value to be passed as an HTTP query string | |
| key and value to the Tower API. Will be run through | |
| HTTP escaping. This argument may be sent multiple | |
| times. | |
| Example: `--query foo bar` would be passed to | |
| Tower as ?foo=bar | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli schedule modify --help | |
| Usage: tower-cli schedule modify [OPTIONS] [ID] | |
| Modify an already existing schedule. | |
| Fields in the resource's --identity tuple can be used in lieu of a primary | |
| key for a lookup; in such a case, only other fields are written. | |
| To modify unique fields, you must use the primary key for the lookup. | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| -d, --description TEXT The description field. | |
| --job-template JOB_TEMPLATE The job_template field. | |
| --inventory-source INVENTORY_SOURCE | |
| The inventory_source field. | |
| --project PROJECT The project field. | |
| --unified-job-template INTEGER Integer used to display unified job template | |
| in result, Do not use it for create/modify. | |
| --enabled BOOLEAN Whether this schedule will be used. | |
| --rrule TEXT Schedule rules specifications which is less | |
| than 255 characters. | |
| --extra-data VARIABLES Extra data for schedule rules in the form of | |
| a .json file. | |
| -i, --inventory INVENTORY The inventory field. | |
| --job-type TEXT The job_type field. | |
| --job-tags TEXT The job_tags field. | |
| --skip-tags TEXT The skip_tags field. | |
| --limit TEXT The limit field. | |
| --diff-mode BOOLEAN The diff_mode field. | |
| --verbosity [default|verbose|more_verbose|debug|connection|winrm] | |
| The verbosity field. | |
| Local Options: | |
| --create-on-missing If used, and if options rather than a primary key are | |
| used to attempt to match a record, will create the | |
| record if it does not exist. This is an alias to | |
| `create --force-on-exists`. [default: False] | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli setting --help | |
| Usage: tower-cli setting [OPTIONS] COMMAND [ARGS]... | |
| Manage settings within Ansible Tower. | |
| Options: | |
| --help Show this message and exit. | |
| Commands: | |
| copy Copy a setting. | |
| get Return one and exactly one setting | |
| list Return a list of settings. | |
| modify Modify an already existing setting. | |
| # tower-cli setting copy --help | |
| Usage: tower-cli setting copy [OPTIONS] [ID] | |
| Copy a setting. | |
| Only the ID is used for the lookup. All provided fields are used to | |
| override the old data from the copied resource. | |
| Field Options: | |
| --value VARIABLES [REQUIRED] The value field. | |
| Local Options: | |
| --new-name TEXT The name to give the new resource, if used, will deep copy | |
| in the backend. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli setting get --help | |
| Usage: tower-cli setting get [OPTIONS] [ID] | |
| Return one and exactly one setting | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli setting list --help | |
| Usage: tower-cli setting list [OPTIONS] | |
| Return a list of settings. | |
| Field Options: | |
| --value VARIABLES [REQUIRED] The value field. | |
| Local Options: | |
| --page-size INTEGER Number of records to show. Ignored if --all-pages. | |
| -c, --category TEXT If set, filter settings by a specific category | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli setting modify --help | |
| Usage: tower-cli setting modify [OPTIONS] SETTING [VALUE] | |
| Modify an already existing setting. | |
| Positional argument SETTING is the setting name and VALUE is its value, | |
| which can be provided directly or obtained from a file name if prefixed | |
| with '@'. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli team --help | |
| Usage: tower-cli team [OPTIONS] COMMAND [ARGS]... | |
| Manage teams within Ansible Tower. | |
| Options: | |
| --help Show this message and exit. | |
| Commands: | |
| associate Associate a user with this team. | |
| copy Copy a team. | |
| create Create a team. | |
| delete Remove the given team. | |
| disassociate Disassociate a user with this team. | |
| get Return one and exactly one team. | |
| list Return a list of teams. | |
| modify Modify an already existing team. | |
| # tower-cli team associate --help | |
| Usage: tower-cli team associate [OPTIONS] | |
| Associate a user with this team. | |
| Local Options: | |
| --team TEAM [required] | |
| --user USER [required] | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli team copy --help | |
| Usage: tower-cli team copy [OPTIONS] [ID] | |
| Copy a team. | |
| Only the ID is used for the lookup. All provided fields are used to | |
| override the old data from the copied resource. | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| --organization ORGANIZATION [REQUIRED] The organization field. | |
| -d, --description TEXT The description field. | |
| Local Options: | |
| --new-name TEXT The name to give the new resource, if used, will deep copy | |
| in the backend. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli team create --help | |
| Usage: tower-cli team create [OPTIONS] | |
| Create a team. | |
| Fields in the resource's --identity tuple are used for a lookup; if a | |
| match is found, then no-op (unless --force-on-exists is set) but do not | |
| fail (unless --fail-on-found is set). | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| --organization ORGANIZATION [REQUIRED] The organization field. | |
| -d, --description TEXT The description field. | |
| Local Options: | |
| --fail-on-found If used, return an error if a matching record already | |
| exists. [default: False] | |
| --force-on-exists If used, if a match is found on unique fields, other | |
| fields will be updated to the provided values. If False, | |
| a match causes the request to be a no-op. [default: | |
| False] | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli team delete --help | |
| Usage: tower-cli team delete [OPTIONS] [ID] | |
| Remove the given team. | |
| If --fail-on-missing is True, then the team's not being found is | |
| considered a failure; otherwise, a success with no change is reported. | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| --organization ORGANIZATION [REQUIRED] The organization field. | |
| -d, --description TEXT The description field. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli team disassociate --help | |
| Usage: tower-cli team disassociate [OPTIONS] | |
| Disassociate a user with this team. | |
| Local Options: | |
| --team TEAM [required] | |
| --user USER [required] | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli team get --help | |
| Usage: tower-cli team get [OPTIONS] [ID] | |
| Return one and exactly one team. | |
| Lookups may be through a primary key, specified as a positional argument, | |
| and/or through filters specified through options. | |
| If the number of results does not equal one, abort with an error. | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| --organization ORGANIZATION [REQUIRED] The organization field. | |
| -d, --description TEXT The description field. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli team list --help | |
| Usage: tower-cli team list [OPTIONS] | |
| Return a list of teams. | |
| If one or more filters are provided through options, filter the results | |
| accordingly. | |
| If no filters are provided, return all results. | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| --organization ORGANIZATION [REQUIRED] The organization field. | |
| -d, --description TEXT The description field. | |
| Local Options: | |
| -a, --all-pages If set, collate all pages of content from the API when | |
| returning results. [default: False] | |
| --page INTEGER The page to show. Ignored if --all-pages is sent. | |
| [default: 1] | |
| --page-size INTEGER Number of records to show. Ignored if --all-pages. | |
| -Q, --query TEXT... A key and value to be passed as an HTTP query string | |
| key and value to the Tower API. Will be run through | |
| HTTP escaping. This argument may be sent multiple | |
| times. | |
| Example: `--query foo bar` would be passed to | |
| Tower as ?foo=bar | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli team modify --help | |
| Usage: tower-cli team modify [OPTIONS] [ID] | |
| Modify an already existing team. | |
| Fields in the resource's --identity tuple can be used in lieu of a primary | |
| key for a lookup; in such a case, only other fields are written. | |
| To modify unique fields, you must use the primary key for the lookup. | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| --organization ORGANIZATION [REQUIRED] The organization field. | |
| -d, --description TEXT The description field. | |
| Local Options: | |
| --create-on-missing If used, and if options rather than a primary key are | |
| used to attempt to match a record, will create the | |
| record if it does not exist. This is an alias to | |
| `create --force-on-exists`. [default: False] | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli user --help | |
| Usage: tower-cli user [OPTIONS] COMMAND [ARGS]... | |
| Manage users within Ansible Tower. | |
| Options: | |
| --help Show this message and exit. | |
| Commands: | |
| copy Copy a user. | |
| create Create a user. | |
| delete Remove the given user. | |
| get Return one and exactly one user. | |
| list Return a list of users. | |
| modify Modify an already existing user. | |
| # tower-cli user copy --help | |
| Usage: tower-cli user copy [OPTIONS] [ID] | |
| Copy a user. | |
| Only the ID is used for the lookup. All provided fields are used to | |
| override the old data from the copied resource. | |
| Field Options: | |
| --username TEXT [REQUIRED] The username field. | |
| --password TEXT The password field. | |
| --email TEXT [REQUIRED] The email field. | |
| --first-name TEXT The first_name field. | |
| --last-name TEXT The last_name field. | |
| --is-superuser BOOLEAN The is_superuser field. | |
| --is-system-auditor BOOLEAN The is_system_auditor field. | |
| Local Options: | |
| --new-name TEXT The name to give the new resource, if used, will deep copy | |
| in the backend. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli user create --help | |
| Usage: tower-cli user create [OPTIONS] | |
| Create a user. | |
| Fields in the resource's --identity tuple are used for a lookup; if a | |
| match is found, then no-op (unless --force-on-exists is set) but do not | |
| fail (unless --fail-on-found is set). | |
| Field Options: | |
| --username TEXT [REQUIRED] The username field. | |
| --password TEXT The password field. | |
| --email TEXT [REQUIRED] The email field. | |
| --first-name TEXT The first_name field. | |
| --last-name TEXT The last_name field. | |
| --is-superuser BOOLEAN The is_superuser field. | |
| --is-system-auditor BOOLEAN The is_system_auditor field. | |
| Local Options: | |
| --fail-on-found If used, return an error if a matching record already | |
| exists. [default: False] | |
| --force-on-exists If used, if a match is found on unique fields, other | |
| fields will be updated to the provided values. If False, | |
| a match causes the request to be a no-op. [default: | |
| False] | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli user delete --help | |
| Usage: tower-cli user delete [OPTIONS] [ID] | |
| Remove the given user. | |
| If --fail-on-missing is True, then the user's not being found is | |
| considered a failure; otherwise, a success with no change is reported. | |
| Field Options: | |
| --username TEXT [REQUIRED] The username field. | |
| --password TEXT The password field. | |
| --email TEXT [REQUIRED] The email field. | |
| --first-name TEXT The first_name field. | |
| --last-name TEXT The last_name field. | |
| --is-superuser BOOLEAN The is_superuser field. | |
| --is-system-auditor BOOLEAN The is_system_auditor field. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli user get --help | |
| Usage: tower-cli user get [OPTIONS] [ID] | |
| Return one and exactly one user. | |
| Lookups may be through a primary key, specified as a positional argument, | |
| and/or through filters specified through options. | |
| If the number of results does not equal one, abort with an error. | |
| Field Options: | |
| --username TEXT [REQUIRED] The username field. | |
| --password TEXT The password field. | |
| --email TEXT [REQUIRED] The email field. | |
| --first-name TEXT The first_name field. | |
| --last-name TEXT The last_name field. | |
| --is-superuser BOOLEAN The is_superuser field. | |
| --is-system-auditor BOOLEAN The is_system_auditor field. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli user list --help | |
| Usage: tower-cli user list [OPTIONS] | |
| Return a list of users. | |
| If one or more filters are provided through options, filter the results | |
| accordingly. | |
| If no filters are provided, return all results. | |
| Field Options: | |
| --username TEXT [REQUIRED] The username field. | |
| --password TEXT The password field. | |
| --email TEXT [REQUIRED] The email field. | |
| --first-name TEXT The first_name field. | |
| --last-name TEXT The last_name field. | |
| --is-superuser BOOLEAN The is_superuser field. | |
| --is-system-auditor BOOLEAN The is_system_auditor field. | |
| Local Options: | |
| -a, --all-pages If set, collate all pages of content from the API when | |
| returning results. [default: False] | |
| --page INTEGER The page to show. Ignored if --all-pages is sent. | |
| [default: 1] | |
| --page-size INTEGER Number of records to show. Ignored if --all-pages. | |
| -Q, --query TEXT... A key and value to be passed as an HTTP query string | |
| key and value to the Tower API. Will be run through | |
| HTTP escaping. This argument may be sent multiple | |
| times. | |
| Example: `--query foo bar` would be passed to | |
| Tower as ?foo=bar | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli user modify --help | |
| Usage: tower-cli user modify [OPTIONS] [ID] | |
| Modify an already existing user. | |
| Fields in the resource's --identity tuple can be used in lieu of a primary | |
| key for a lookup; in such a case, only other fields are written. | |
| To modify unique fields, you must use the primary key for the lookup. | |
| Field Options: | |
| --username TEXT [REQUIRED] The username field. | |
| --password TEXT The password field. | |
| --email TEXT [REQUIRED] The email field. | |
| --first-name TEXT The first_name field. | |
| --last-name TEXT The last_name field. | |
| --is-superuser BOOLEAN The is_superuser field. | |
| --is-system-auditor BOOLEAN The is_system_auditor field. | |
| Local Options: | |
| --create-on-missing If used, and if options rather than a primary key are | |
| used to attempt to match a record, will create the | |
| record if it does not exist. This is an alias to | |
| `create --force-on-exists`. [default: False] | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli workflow --help | |
| Usage: tower-cli workflow [OPTIONS] COMMAND [ARGS]... | |
| Manage workflow job templates. | |
| Options: | |
| --help Show this message and exit. | |
| Commands: | |
| associate_label Associate a label with this... | |
| associate_notification_template | |
| Associate a notification template from | |
| this... | |
| copy Copy a workflow. | |
| create Create a workflow. | |
| delete Remove the given workflow. | |
| disassociate_label Disassociate a label with this... | |
| disassociate_notification_template | |
| Disassociate a notification template from... | |
| get Return one and exactly one workflow. | |
| list Return a list of workflows. | |
| modify Modify an already existing workflow. | |
| schema Convert YAML/JSON content into workflow | |
| node... | |
| survey Get the survey_spec for the job template. | |
| # tower-cli workflow associate_label --help | |
| Usage: tower-cli workflow associate_label [OPTIONS] | |
| Associate a label with this workflow_job_template. | |
| Local Options: | |
| --workflow_job_template WORKFLOW_JOB_TEMPLATE | |
| [required] | |
| --label LABEL [required] | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli workflow associate_notification_template --help | |
| Usage: tower-cli workflow associate_notification_template [OPTIONS] | |
| Associate a notification template from this workflow. | |
| Local Options: | |
| --workflow WORKFLOW | |
| --notification-template NOTIFICATION_TEMPLATE | |
| --status [any|error|success] Specify job run status of job template to | |
| relate to. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli workflow copy --help | |
| Usage: tower-cli workflow copy [OPTIONS] [ID] | |
| Copy a workflow. | |
| Only the ID is used for the lookup. All provided fields are used to | |
| override the old data from the copied resource. | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| -d, --description TEXT The description field. | |
| -e, --extra-vars VARIABLES Extra variables used by Ansible in YAML or | |
| key=value format. Use @ to get YAML from a | |
| file. Use the option multiple times to add | |
| multiple extra variables. | |
| --organization ORGANIZATION The organization field. | |
| --survey-enabled BOOLEAN Prompt user for job type on launch. | |
| --allow-simultaneous BOOLEAN The allow_simultaneous field. | |
| --survey-spec VARIABLES On write commands, perform extra POST to the | |
| survey_spec endpoint. | |
| Local Options: | |
| --new-name TEXT The name to give the new resource, if used, will deep copy | |
| in the backend. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli workflow create --help | |
| Usage: tower-cli workflow create [OPTIONS] | |
| Create a workflow. | |
| Fields in the resource's --identity tuple are used for a lookup; if a | |
| match is found, then no-op (unless --force-on-exists is set) but do not | |
| fail (unless --fail-on-found is set). | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| -d, --description TEXT The description field. | |
| -e, --extra-vars VARIABLES Extra variables used by Ansible in YAML or | |
| key=value format. Use @ to get YAML from a | |
| file. Use the option multiple times to add | |
| multiple extra variables. | |
| --organization ORGANIZATION The organization field. | |
| --survey-enabled BOOLEAN Prompt user for job type on launch. | |
| --allow-simultaneous BOOLEAN The allow_simultaneous field. | |
| --survey-spec VARIABLES On write commands, perform extra POST to the | |
| survey_spec endpoint. | |
| Local Options: | |
| --fail-on-found If used, return an error if a matching record already | |
| exists. [default: False] | |
| --force-on-exists If used, if a match is found on unique fields, other | |
| fields will be updated to the provided values. If False, | |
| a match causes the request to be a no-op. [default: | |
| False] | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli workflow delete --help | |
| Usage: tower-cli workflow delete [OPTIONS] [ID] | |
| Remove the given workflow. | |
| If --fail-on-missing is True, then the workflow's not being found is | |
| considered a failure; otherwise, a success with no change is reported. | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| -d, --description TEXT The description field. | |
| -e, --extra-vars VARIABLES Extra variables used by Ansible in YAML or | |
| key=value format. Use @ to get YAML from a | |
| file. Use the option multiple times to add | |
| multiple extra variables. | |
| --organization ORGANIZATION The organization field. | |
| --survey-enabled BOOLEAN Prompt user for job type on launch. | |
| --allow-simultaneous BOOLEAN The allow_simultaneous field. | |
| --survey-spec VARIABLES On write commands, perform extra POST to the | |
| survey_spec endpoint. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli workflow disassociate_label --help | |
| Usage: tower-cli workflow disassociate_label [OPTIONS] | |
| Disassociate a label with this workflow_job_template. | |
| Local Options: | |
| --workflow_job_template WORKFLOW_JOB_TEMPLATE | |
| [required] | |
| --label LABEL [required] | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli workflow disassociate_notification_template --help | |
| Usage: tower-cli workflow disassociate_notification_template | |
| [OPTIONS] | |
| Disassociate a notification template from this workflow. | |
| Local Options: | |
| --workflow WORKFLOW | |
| --notification-template NOTIFICATION_TEMPLATE | |
| --status [any|error|success] Specify job run status of job template to | |
| relate to. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli workflow get --help | |
| Usage: tower-cli workflow get [OPTIONS] [ID] | |
| Return one and exactly one workflow. | |
| Lookups may be through a primary key, specified as a positional argument, | |
| and/or through filters specified through options. | |
| If the number of results does not equal one, abort with an error. | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| -d, --description TEXT The description field. | |
| -e, --extra-vars VARIABLES Extra variables used by Ansible in YAML or | |
| key=value format. Use @ to get YAML from a | |
| file. Use the option multiple times to add | |
| multiple extra variables. | |
| --organization ORGANIZATION The organization field. | |
| --survey-enabled BOOLEAN Prompt user for job type on launch. | |
| --allow-simultaneous BOOLEAN The allow_simultaneous field. | |
| --survey-spec VARIABLES On write commands, perform extra POST to the | |
| survey_spec endpoint. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli workflow list --help | |
| Usage: tower-cli workflow list [OPTIONS] | |
| Return a list of workflows. | |
| If one or more filters are provided through options, filter the results | |
| accordingly. | |
| If no filters are provided, return all results. | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| -d, --description TEXT The description field. | |
| -e, --extra-vars VARIABLES Extra variables used by Ansible in YAML or | |
| key=value format. Use @ to get YAML from a | |
| file. Use the option multiple times to add | |
| multiple extra variables. | |
| --organization ORGANIZATION The organization field. | |
| --survey-enabled BOOLEAN Prompt user for job type on launch. | |
| --allow-simultaneous BOOLEAN The allow_simultaneous field. | |
| --survey-spec VARIABLES On write commands, perform extra POST to the | |
| survey_spec endpoint. | |
| Local Options: | |
| -a, --all-pages If set, collate all pages of content from the API when | |
| returning results. [default: False] | |
| --page INTEGER The page to show. Ignored if --all-pages is sent. | |
| [default: 1] | |
| --page-size INTEGER Number of records to show. Ignored if --all-pages. | |
| -Q, --query TEXT... A key and value to be passed as an HTTP query string | |
| key and value to the Tower API. Will be run through | |
| HTTP escaping. This argument may be sent multiple | |
| times. | |
| Example: `--query foo bar` would be passed to | |
| Tower as ?foo=bar | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli workflow modify --help | |
| Usage: tower-cli workflow modify [OPTIONS] [ID] | |
| Modify an already existing workflow. | |
| Fields in the resource's --identity tuple can be used in lieu of a primary | |
| key for a lookup; in such a case, only other fields are written. | |
| To modify unique fields, you must use the primary key for the lookup. | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| -d, --description TEXT The description field. | |
| -e, --extra-vars VARIABLES Extra variables used by Ansible in YAML or | |
| key=value format. Use @ to get YAML from a | |
| file. Use the option multiple times to add | |
| multiple extra variables. | |
| --organization ORGANIZATION The organization field. | |
| --survey-enabled BOOLEAN Prompt user for job type on launch. | |
| --allow-simultaneous BOOLEAN The allow_simultaneous field. | |
| --survey-spec VARIABLES On write commands, perform extra POST to the | |
| survey_spec endpoint. | |
| Local Options: | |
| --create-on-missing If used, and if options rather than a primary key are | |
| used to attempt to match a record, will create the | |
| record if it does not exist. This is an alias to | |
| `create --force-on-exists`. [default: False] | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli workflow schema --help | |
| Usage: tower-cli workflow schema [OPTIONS] WFJT [NODE_NETWORK] | |
| Convert YAML/JSON content into workflow node workflows if node_network | |
| param is given. If not, print a YAML representation of the node network. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli workflow survey --help | |
| Usage: tower-cli workflow survey [OPTIONS] [ID] | |
| Get the survey_spec for the job template. To write a survey, use the | |
| modify command with the --survey-spec parameter. | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| -d, --description TEXT The description field. | |
| -e, --extra-vars VARIABLES Extra variables used by Ansible in YAML or | |
| key=value format. Use @ to get YAML from a | |
| file. Use the option multiple times to add | |
| multiple extra variables. | |
| --organization ORGANIZATION The organization field. | |
| --survey-enabled BOOLEAN Prompt user for job type on launch. | |
| --allow-simultaneous BOOLEAN The allow_simultaneous field. | |
| --survey-spec VARIABLES On write commands, perform extra POST to the | |
| survey_spec endpoint. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli workflow_job --help | |
| Usage: tower-cli workflow_job [OPTIONS] COMMAND [ARGS]... | |
| Launch or monitor workflow jobs. | |
| Options: | |
| --help Show this message and exit. | |
| Commands: | |
| cancel Cancel a currently running job. | |
| delete Remove the given workflow job. | |
| get Return one and exactly one workflow job. | |
| launch Launch a new workflow job based on a workflow... | |
| list Return a list of workflow jobs. | |
| monitor Stream the standard output from a job,... | |
| relaunch Relaunch a stopped job. | |
| status Print the current job status. | |
| summary Print out the standard out of a unified job... | |
| wait Wait for a running job to finish. | |
| # tower-cli workflow_job cancel --help | |
| Usage: tower-cli workflow_job cancel [OPTIONS] [ID] | |
| Cancel a currently running job. | |
| Fails with a non-zero exit status if the job cannot be canceled. You must | |
| provide either a pk or parameters in the job's identity. | |
| Field Options: | |
| -W, --workflow-job-template WORKFLOW | |
| [REQUIRED] The workflow_job_template field. | |
| -e, --extra-vars VARIABLES The extra_vars field. | |
| --created TEXT The created field. | |
| --status TEXT The status field. | |
| Local Options: | |
| --fail-if-not-running Fail loudly if the job is not currently running. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli workflow_job delete --help | |
| Usage: tower-cli workflow_job delete [OPTIONS] [ID] | |
| Remove the given workflow job. | |
| If --fail-on-missing is True, then the workflow job's not being found is | |
| considered a failure; otherwise, a success with no change is reported. | |
| Field Options: | |
| -W, --workflow-job-template WORKFLOW | |
| [REQUIRED] The workflow_job_template field. | |
| -e, --extra-vars VARIABLES The extra_vars field. | |
| --created TEXT The created field. | |
| --status TEXT The status field. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli workflow_job get --help | |
| Usage: tower-cli workflow_job get [OPTIONS] [ID] | |
| Return one and exactly one workflow job. | |
| Lookups may be through a primary key, specified as a positional argument, | |
| and/or through filters specified through options. | |
| If the number of results does not equal one, abort with an error. | |
| Field Options: | |
| -W, --workflow-job-template WORKFLOW | |
| [REQUIRED] The workflow_job_template field. | |
| -e, --extra-vars VARIABLES The extra_vars field. | |
| --created TEXT The created field. | |
| --status TEXT The status field. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli workflow_job launch --help | |
| Usage: tower-cli workflow_job launch [OPTIONS] | |
| Launch a new workflow job based on a workflow job template. | |
| Creates a new workflow job in Ansible Tower, starts it, and returns back | |
| an ID in order for its status to be monitored. | |
| Field Options: | |
| -W, --workflow-job-template WORKFLOW | |
| [REQUIRED] The workflow_job_template field. | |
| -e, --extra-vars VARIABLES The extra_vars field. | |
| Local Options: | |
| --monitor If used, immediately calls monitor on the newly launched | |
| workflow job rather than exiting. | |
| --wait Wait until completion to exit, displaying placeholder | |
| text while in progress. | |
| --timeout INTEGER If provided with --monitor, this command (not the job) | |
| will time out after the given number of seconds. Does | |
| nothing if --monitor is not sent. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli workflow_job list --help | |
| Usage: tower-cli workflow_job list [OPTIONS] | |
| Return a list of workflow jobs. | |
| If one or more filters are provided through options, filter the results | |
| accordingly. | |
| If no filters are provided, return all results. | |
| Field Options: | |
| -W, --workflow-job-template WORKFLOW | |
| [REQUIRED] The workflow_job_template field. | |
| -e, --extra-vars VARIABLES The extra_vars field. | |
| --created TEXT The created field. | |
| --status TEXT The status field. | |
| Local Options: | |
| -a, --all-pages If set, collate all pages of content from the API when | |
| returning results. [default: False] | |
| --page INTEGER The page to show. Ignored if --all-pages is sent. | |
| [default: 1] | |
| --page-size INTEGER Number of records to show. Ignored if --all-pages. | |
| -Q, --query TEXT... A key and value to be passed as an HTTP query string | |
| key and value to the Tower API. Will be run through | |
| HTTP escaping. This argument may be sent multiple | |
| times. | |
| Example: `--query foo bar` would be passed to | |
| Tower as ?foo=bar | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli workflow_job monitor --help | |
| Usage: tower-cli workflow_job monitor [OPTIONS] [ID] | |
| Stream the standard output from a job, project update, or inventory | |
| udpate. | |
| Field Options: | |
| -W, --workflow-job-template WORKFLOW | |
| [REQUIRED] The workflow_job_template field. | |
| -e, --extra-vars VARIABLES The extra_vars field. | |
| --created TEXT The created field. | |
| --status TEXT The status field. | |
| Local Options: | |
| --interval FLOAT Polling interval to refresh content from Tower. | |
| --timeout INTEGER If provided, this command (not the job) will time out | |
| after the given number of seconds. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli workflow_job relaunch --help | |
| Usage: tower-cli workflow_job relaunch [OPTIONS] [ID] | |
| Relaunch a stopped job. | |
| Fails with a non-zero exit status if the job cannot be relaunched. You | |
| must provide either a pk or parameters in the job's identity. | |
| Field Options: | |
| -W, --workflow-job-template WORKFLOW | |
| [REQUIRED] The workflow_job_template field. | |
| -e, --extra-vars VARIABLES The extra_vars field. | |
| --created TEXT The created field. | |
| --status TEXT The status field. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli workflow_job status --help | |
| Usage: tower-cli workflow_job status [OPTIONS] [ID] | |
| Print the current job status. This is used to check a running job. You can | |
| look up the job with the same parameters used for a get request. | |
| Field Options: | |
| -W, --workflow-job-template WORKFLOW | |
| [REQUIRED] The workflow_job_template field. | |
| -e, --extra-vars VARIABLES The extra_vars field. | |
| --created TEXT The created field. | |
| --status TEXT The status field. | |
| Local Options: | |
| --detail Print more detail. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli workflow_job summary --help | |
| Usage: tower-cli workflow_job summary [OPTIONS] [ID] | |
| Print out the standard out of a unified job to the command line. For | |
| Projects, print the standard out of most recent update. For Inventory | |
| Sources, print standard out of most recent sync. For Jobs, print the job's | |
| standard out. For Workflow Jobs, print a status table of its jobs. | |
| Field Options: | |
| -W, --workflow-job-template WORKFLOW | |
| [REQUIRED] The workflow_job_template field. | |
| -e, --extra-vars VARIABLES The extra_vars field. | |
| --created TEXT The created field. | |
| --status TEXT The status field. | |
| Local Options: | |
| --start-line INTEGER Line at which to start printing the standard out. | |
| --end-line INTEGER Line at which to end printing the standard out. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| # tower-cli workflow_job wait --help | |
| Usage: tower-cli workflow_job wait [OPTIONS] [ID] | |
| Wait for a running job to finish. Blocks further input until the job | |
| completes (whether successfully or unsuccessfully) and a final status can | |
| be given. | |
| Field Options: | |
| -W, --workflow-job-template WORKFLOW | |
| [REQUIRED] The workflow_job_template field. | |
| -e, --extra-vars VARIABLES The extra_vars field. | |
| --created TEXT The created field. | |
| --status TEXT The status field. | |
| Local Options: | |
| --min-interval INTEGER The minimum interval to request an update from | |
| Tower. | |
| --max-interval INTEGER The maximum interval to request an update from | |
| Tower. | |
| --timeout INTEGER If provided, this command (not the job) will time | |
| out after the given number of seconds. | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| Other Options: | |
| --help Show this message and exit. | |
| bash -x ./autoinstall.d/data/awx/3/collect_tower-cli_help_texts.sh 105.64s user 11.98s system 99% cpu 1:58.41 total | |
| tee /tmp/collect_tower-cli_help_texts.sh.txt 0.00s user 0.03s system 0% cpu 1:58.41 total | |
| ssato@localhost% ~/repos/public/github.com/ssato/miniascape-templates.git |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| ssato@localhost% time ./autoinstall.d/data/awx/3/collect_tower-cli_help_texts.sh -h ~/repos/public/github.com/ssato/miniascape-templates.git | |
| Usage: ./autoinstall.d/data/awx/3/collect_tower-cli_help_texts.sh [Options ...] | |
| Options: | |
| -o specify outputs dir to save help texts for each sub commands | |
| -h show this help text | |
| ./autoinstall.d/data/awx/3/collect_tower-cli_help_texts.sh -h 0.01s user 0.00s system 97% cpu 0.020 total | |
| ssato@localhost% time ./autoinstall.d/data/awx/3/collect_tower-cli_help_texts.sh -o /tmp/0 ~/repos/public/github.com/ssato/miniascape-templates.git | |
| [Info] Saving the output of 'tower-cli --help' to /tmp/0/tower-cli_help.txt ... | |
| [Info] Saving the output of 'tower-cli config --help' to /tmp/0/tower-cli_config_help.txt ... | |
| [Info] Saving the output of 'tower-cli empty --help' to /tmp/0/tower-cli_empty_help.txt ... | |
| [Info] Saving the output of 'tower-cli login --help' to /tmp/0/tower-cli_login_help.txt ... | |
| [Info] Saving the output of 'tower-cli logout --help' to /tmp/0/tower-cli_logout_help.txt ... | |
| [Info] Saving the output of 'tower-cli receive --help' to /tmp/0/tower-cli_receive_help.txt ... | |
| [Info] Saving the output of 'tower-cli send --help' to /tmp/0/tower-cli_send_help.txt ... | |
| [Info] Saving the output of 'tower-cli version --help' to /tmp/0/tower-cli_version_help.txt ... | |
| [Info] Saving the output of 'tower-cli activity_stream --help' to /tmp/0/tower-cli_activity_stream_help.txt ... | |
| [Info] Saving the output of 'tower-cli activity_stream get --help' to /tmp/0/tower-cli_activity_stream_get_help.txt ... | |
| [Info] Saving the output of 'tower-cli activity_stream list --help' to /tmp/0/tower-cli_activity_stream_list_help.txt ... | |
| [Info] Saving the output of 'tower-cli ad_hoc --help' to /tmp/0/tower-cli_ad_hoc_help.txt ... | |
| [Info] Saving the output of 'tower-cli ad_hoc cancel --help' to /tmp/0/tower-cli_ad_hoc_cancel_help.txt ... | |
| [Info] Saving the output of 'tower-cli ad_hoc delete --help' to /tmp/0/tower-cli_ad_hoc_delete_help.txt ... | |
| [Info] Saving the output of 'tower-cli ad_hoc get --help' to /tmp/0/tower-cli_ad_hoc_get_help.txt ... | |
| [Info] Saving the output of 'tower-cli ad_hoc launch --help' to /tmp/0/tower-cli_ad_hoc_launch_help.txt ... | |
| [Info] Saving the output of 'tower-cli ad_hoc list --help' to /tmp/0/tower-cli_ad_hoc_list_help.txt ... | |
| [Info] Saving the output of 'tower-cli ad_hoc monitor --help' to /tmp/0/tower-cli_ad_hoc_monitor_help.txt ... | |
| [Info] Saving the output of 'tower-cli ad_hoc relaunch --help' to /tmp/0/tower-cli_ad_hoc_relaunch_help.txt ... | |
| [Info] Saving the output of 'tower-cli ad_hoc status --help' to /tmp/0/tower-cli_ad_hoc_status_help.txt ... | |
| [Info] Saving the output of 'tower-cli ad_hoc stdout --help' to /tmp/0/tower-cli_ad_hoc_stdout_help.txt ... | |
| [Info] Saving the output of 'tower-cli ad_hoc wait --help' to /tmp/0/tower-cli_ad_hoc_wait_help.txt ... | |
| [Info] Saving the output of 'tower-cli application --help' to /tmp/0/tower-cli_application_help.txt ... | |
| [Info] Saving the output of 'tower-cli application copy --help' to /tmp/0/tower-cli_application_copy_help.txt ... | |
| [Info] Saving the output of 'tower-cli application create --help' to /tmp/0/tower-cli_application_create_help.txt ... | |
| [Info] Saving the output of 'tower-cli application delete --help' to /tmp/0/tower-cli_application_delete_help.txt ... | |
| [Info] Saving the output of 'tower-cli application get --help' to /tmp/0/tower-cli_application_get_help.txt ... | |
| [Info] Saving the output of 'tower-cli application list --help' to /tmp/0/tower-cli_application_list_help.txt ... | |
| [Info] Saving the output of 'tower-cli application modify --help' to /tmp/0/tower-cli_application_modify_help.txt ... | |
| [Info] Saving the output of 'tower-cli credential --help' to /tmp/0/tower-cli_credential_help.txt ... | |
| [Info] Saving the output of 'tower-cli credential copy --help' to /tmp/0/tower-cli_credential_copy_help.txt ... | |
| [Info] Saving the output of 'tower-cli credential create --help' to /tmp/0/tower-cli_credential_create_help.txt ... | |
| [Info] Saving the output of 'tower-cli credential delete --help' to /tmp/0/tower-cli_credential_delete_help.txt ... | |
| [Info] Saving the output of 'tower-cli credential get --help' to /tmp/0/tower-cli_credential_get_help.txt ... | |
| [Info] Saving the output of 'tower-cli credential list --help' to /tmp/0/tower-cli_credential_list_help.txt ... | |
| [Info] Saving the output of 'tower-cli credential modify --help' to /tmp/0/tower-cli_credential_modify_help.txt ... | |
| [Info] Saving the output of 'tower-cli credential_type --help' to /tmp/0/tower-cli_credential_type_help.txt ... | |
| [Info] Saving the output of 'tower-cli credential_type copy --help' to /tmp/0/tower-cli_credential_type_copy_help.txt ... | |
| [Info] Saving the output of 'tower-cli credential_type create --help' to /tmp/0/tower-cli_credential_type_create_help.txt ... | |
| [Info] Saving the output of 'tower-cli credential_type delete --help' to /tmp/0/tower-cli_credential_type_delete_help.txt ... | |
| [Info] Saving the output of 'tower-cli credential_type get --help' to /tmp/0/tower-cli_credential_type_get_help.txt ... | |
| [Info] Saving the output of 'tower-cli credential_type list --help' to /tmp/0/tower-cli_credential_type_list_help.txt ... | |
| [Info] Saving the output of 'tower-cli credential_type modify --help' to /tmp/0/tower-cli_credential_type_modify_help.txt ... | |
| [Info] Saving the output of 'tower-cli group --help' to /tmp/0/tower-cli_group_help.txt ... | |
| [Info] Saving the output of 'tower-cli group associate --help' to /tmp/0/tower-cli_group_associate_help.txt ... | |
| [Info] Saving the output of 'tower-cli group copy --help' to /tmp/0/tower-cli_group_copy_help.txt ... | |
| [Info] Saving the output of 'tower-cli group create --help' to /tmp/0/tower-cli_group_create_help.txt ... | |
| [Info] Saving the output of 'tower-cli group delete --help' to /tmp/0/tower-cli_group_delete_help.txt ... | |
| [Info] Saving the output of 'tower-cli group disassociate --help' to /tmp/0/tower-cli_group_disassociate_help.txt ... | |
| [Info] Saving the output of 'tower-cli group get --help' to /tmp/0/tower-cli_group_get_help.txt ... | |
| [Info] Saving the output of 'tower-cli group list --help' to /tmp/0/tower-cli_group_list_help.txt ... | |
| [Info] Saving the output of 'tower-cli group modify --help' to /tmp/0/tower-cli_group_modify_help.txt ... | |
| [Info] Saving the output of 'tower-cli host --help' to /tmp/0/tower-cli_host_help.txt ... | |
| [Info] Saving the output of 'tower-cli host associate --help' to /tmp/0/tower-cli_host_associate_help.txt ... | |
| [Info] Saving the output of 'tower-cli host copy --help' to /tmp/0/tower-cli_host_copy_help.txt ... | |
| [Info] Saving the output of 'tower-cli host create --help' to /tmp/0/tower-cli_host_create_help.txt ... | |
| [Info] Saving the output of 'tower-cli host delete --help' to /tmp/0/tower-cli_host_delete_help.txt ... | |
| [Info] Saving the output of 'tower-cli host disassociate --help' to /tmp/0/tower-cli_host_disassociate_help.txt ... | |
| [Info] Saving the output of 'tower-cli host get --help' to /tmp/0/tower-cli_host_get_help.txt ... | |
| [Info] Saving the output of 'tower-cli host insights --help' to /tmp/0/tower-cli_host_insights_help.txt ... | |
| [Info] Saving the output of 'tower-cli host list --help' to /tmp/0/tower-cli_host_list_help.txt ... | |
| [Info] Saving the output of 'tower-cli host list_facts --help' to /tmp/0/tower-cli_host_list_facts_help.txt ... | |
| [Info] Saving the output of 'tower-cli host modify --help' to /tmp/0/tower-cli_host_modify_help.txt ... | |
| [Info] Saving the output of 'tower-cli instance --help' to /tmp/0/tower-cli_instance_help.txt ... | |
| [Info] Saving the output of 'tower-cli instance get --help' to /tmp/0/tower-cli_instance_get_help.txt ... | |
| [Info] Saving the output of 'tower-cli instance list --help' to /tmp/0/tower-cli_instance_list_help.txt ... | |
| [Info] Saving the output of 'tower-cli instance_group --help' to /tmp/0/tower-cli_instance_group_help.txt ... | |
| [Info] Saving the output of 'tower-cli instance_group get --help' to /tmp/0/tower-cli_instance_group_get_help.txt ... | |
| [Info] Saving the output of 'tower-cli instance_group list --help' to /tmp/0/tower-cli_instance_group_list_help.txt ... | |
| [Info] Saving the output of 'tower-cli inventory --help' to /tmp/0/tower-cli_inventory_help.txt ... | |
| [Info] Saving the output of 'tower-cli inventory associate_ig --help' to /tmp/0/tower-cli_inventory_associate_ig_help.txt ... | |
| [Info] Saving the output of 'tower-cli inventory batch_update --help' to /tmp/0/tower-cli_inventory_batch_update_help.txt ... | |
| [Info] Saving the output of 'tower-cli inventory copy --help' to /tmp/0/tower-cli_inventory_copy_help.txt ... | |
| [Info] Saving the output of 'tower-cli inventory create --help' to /tmp/0/tower-cli_inventory_create_help.txt ... | |
| [Info] Saving the output of 'tower-cli inventory delete --help' to /tmp/0/tower-cli_inventory_delete_help.txt ... | |
| [Info] Saving the output of 'tower-cli inventory disassociate_ig --help' to /tmp/0/tower-cli_inventory_disassociate_ig_help.txt ... | |
| [Info] Saving the output of 'tower-cli inventory get --help' to /tmp/0/tower-cli_inventory_get_help.txt ... | |
| [Info] Saving the output of 'tower-cli inventory list --help' to /tmp/0/tower-cli_inventory_list_help.txt ... | |
| [Info] Saving the output of 'tower-cli inventory modify --help' to /tmp/0/tower-cli_inventory_modify_help.txt ... | |
| [Info] Saving the output of 'tower-cli inventory_script --help' to /tmp/0/tower-cli_inventory_script_help.txt ... | |
| [Info] Saving the output of 'tower-cli inventory_script copy --help' to /tmp/0/tower-cli_inventory_script_copy_help.txt ... | |
| [Info] Saving the output of 'tower-cli inventory_script create --help' to /tmp/0/tower-cli_inventory_script_create_help.txt ... | |
| [Info] Saving the output of 'tower-cli inventory_script delete --help' to /tmp/0/tower-cli_inventory_script_delete_help.txt ... | |
| [Info] Saving the output of 'tower-cli inventory_script get --help' to /tmp/0/tower-cli_inventory_script_get_help.txt ... | |
| [Info] Saving the output of 'tower-cli inventory_script list --help' to /tmp/0/tower-cli_inventory_script_list_help.txt ... | |
| [Info] Saving the output of 'tower-cli inventory_script modify --help' to /tmp/0/tower-cli_inventory_script_modify_help.txt ... | |
| [Info] Saving the output of 'tower-cli inventory_source --help' to /tmp/0/tower-cli_inventory_source_help.txt ... | |
| [Info] Saving the output of 'tower-cli inventory_source copy --help' to /tmp/0/tower-cli_inventory_source_copy_help.txt ... | |
| [Info] Saving the output of 'tower-cli inventory_source create --help' to /tmp/0/tower-cli_inventory_source_create_help.txt ... | |
| [Info] Saving the output of 'tower-cli inventory_source delete --help' to /tmp/0/tower-cli_inventory_source_delete_help.txt ... | |
| [Info] Saving the output of 'tower-cli inventory_source get --help' to /tmp/0/tower-cli_inventory_source_get_help.txt ... | |
| [Info] Saving the output of 'tower-cli inventory_source list --help' to /tmp/0/tower-cli_inventory_source_list_help.txt ... | |
| [Info] Saving the output of 'tower-cli inventory_source modify --help' to /tmp/0/tower-cli_inventory_source_modify_help.txt ... | |
| [Info] Saving the output of 'tower-cli inventory_source monitor --help' to /tmp/0/tower-cli_inventory_source_monitor_help.txt ... | |
| [Info] Saving the output of 'tower-cli inventory_source status --help' to /tmp/0/tower-cli_inventory_source_status_help.txt ... | |
| [Info] Saving the output of 'tower-cli inventory_source stdout --help' to /tmp/0/tower-cli_inventory_source_stdout_help.txt ... | |
| [Info] Saving the output of 'tower-cli inventory_source update --help' to /tmp/0/tower-cli_inventory_source_update_help.txt ... | |
| [Info] Saving the output of 'tower-cli inventory_source wait --help' to /tmp/0/tower-cli_inventory_source_wait_help.txt ... | |
| [Info] Saving the output of 'tower-cli inventory_update --help' to /tmp/0/tower-cli_inventory_update_help.txt ... | |
| [Info] Saving the output of 'tower-cli inventory_update cancel --help' to /tmp/0/tower-cli_inventory_update_cancel_help.txt ... | |
| [Info] Saving the output of 'tower-cli inventory_update delete --help' to /tmp/0/tower-cli_inventory_update_delete_help.txt ... | |
| [Info] Saving the output of 'tower-cli inventory_update get --help' to /tmp/0/tower-cli_inventory_update_get_help.txt ... | |
| [Info] Saving the output of 'tower-cli inventory_update list --help' to /tmp/0/tower-cli_inventory_update_list_help.txt ... | |
| [Info] Saving the output of 'tower-cli inventory_update monitor --help' to /tmp/0/tower-cli_inventory_update_monitor_help.txt ... | |
| [Info] Saving the output of 'tower-cli inventory_update relaunch --help' to /tmp/0/tower-cli_inventory_update_relaunch_help.txt ... | |
| [Info] Saving the output of 'tower-cli inventory_update status --help' to /tmp/0/tower-cli_inventory_update_status_help.txt ... | |
| [Info] Saving the output of 'tower-cli inventory_update stdout --help' to /tmp/0/tower-cli_inventory_update_stdout_help.txt ... | |
| [Info] Saving the output of 'tower-cli inventory_update wait --help' to /tmp/0/tower-cli_inventory_update_wait_help.txt ... | |
| [Info] Saving the output of 'tower-cli job --help' to /tmp/0/tower-cli_job_help.txt ... | |
| [Info] Saving the output of 'tower-cli job cancel --help' to /tmp/0/tower-cli_job_cancel_help.txt ... | |
| [Info] Saving the output of 'tower-cli job delete --help' to /tmp/0/tower-cli_job_delete_help.txt ... | |
| [Info] Saving the output of 'tower-cli job get --help' to /tmp/0/tower-cli_job_get_help.txt ... | |
| [Info] Saving the output of 'tower-cli job launch --help' to /tmp/0/tower-cli_job_launch_help.txt ... | |
| [Info] Saving the output of 'tower-cli job list --help' to /tmp/0/tower-cli_job_list_help.txt ... | |
| [Info] Saving the output of 'tower-cli job monitor --help' to /tmp/0/tower-cli_job_monitor_help.txt ... | |
| [Info] Saving the output of 'tower-cli job relaunch --help' to /tmp/0/tower-cli_job_relaunch_help.txt ... | |
| [Info] Saving the output of 'tower-cli job status --help' to /tmp/0/tower-cli_job_status_help.txt ... | |
| [Info] Saving the output of 'tower-cli job stdout --help' to /tmp/0/tower-cli_job_stdout_help.txt ... | |
| [Info] Saving the output of 'tower-cli job wait --help' to /tmp/0/tower-cli_job_wait_help.txt ... | |
| [Info] Saving the output of 'tower-cli job_template --help' to /tmp/0/tower-cli_job_template_help.txt ... | |
| [Info] Saving the output of 'tower-cli job_template associate_credential --help' to /tmp/0/tower-cli_job_template_associate_credential_help.txt ... | |
| [Info] Saving the output of 'tower-cli job_template associate_ig --help' to /tmp/0/tower-cli_job_template_associate_ig_help.txt ... | |
| [Info] Saving the output of 'tower-cli job_template associate_label --help' to /tmp/0/tower-cli_job_template_associate_label_help.txt ... | |
| [Info] Saving the output of 'tower-cli job_template associate_notification_template --help' to /tmp/0/tower-cli_job_template_associate_notification_template_help.txt ... | |
| [Info] Saving the output of 'tower-cli job_template callback --help' to /tmp/0/tower-cli_job_template_callback_help.txt ... | |
| [Info] Saving the output of 'tower-cli job_template copy --help' to /tmp/0/tower-cli_job_template_copy_help.txt ... | |
| [Info] Saving the output of 'tower-cli job_template create --help' to /tmp/0/tower-cli_job_template_create_help.txt ... | |
| [Info] Saving the output of 'tower-cli job_template delete --help' to /tmp/0/tower-cli_job_template_delete_help.txt ... | |
| [Info] Saving the output of 'tower-cli job_template disassociate_credential --help' to /tmp/0/tower-cli_job_template_disassociate_credential_help.txt ... | |
| [Info] Saving the output of 'tower-cli job_template disassociate_ig --help' to /tmp/0/tower-cli_job_template_disassociate_ig_help.txt ... | |
| [Info] Saving the output of 'tower-cli job_template disassociate_label --help' to /tmp/0/tower-cli_job_template_disassociate_label_help.txt ... | |
| [Info] Saving the output of 'tower-cli job_template disassociate_notification_template --help' to /tmp/0/tower-cli_job_template_disassociate_notification_template_help.txt ... | |
| [Info] Saving the output of 'tower-cli job_template get --help' to /tmp/0/tower-cli_job_template_get_help.txt ... | |
| [Info] Saving the output of 'tower-cli job_template list --help' to /tmp/0/tower-cli_job_template_list_help.txt ... | |
| [Info] Saving the output of 'tower-cli job_template modify --help' to /tmp/0/tower-cli_job_template_modify_help.txt ... | |
| [Info] Saving the output of 'tower-cli job_template survey --help' to /tmp/0/tower-cli_job_template_survey_help.txt ... | |
| [Info] Saving the output of 'tower-cli label --help' to /tmp/0/tower-cli_label_help.txt ... | |
| [Info] Saving the output of 'tower-cli label copy --help' to /tmp/0/tower-cli_label_copy_help.txt ... | |
| [Info] Saving the output of 'tower-cli label create --help' to /tmp/0/tower-cli_label_create_help.txt ... | |
| [Info] Saving the output of 'tower-cli label get --help' to /tmp/0/tower-cli_label_get_help.txt ... | |
| [Info] Saving the output of 'tower-cli label list --help' to /tmp/0/tower-cli_label_list_help.txt ... | |
| [Info] Saving the output of 'tower-cli label modify --help' to /tmp/0/tower-cli_label_modify_help.txt ... | |
| [Info] Saving the output of 'tower-cli node --help' to /tmp/0/tower-cli_node_help.txt ... | |
| [Info] Saving the output of 'tower-cli node associate_always_node --help' to /tmp/0/tower-cli_node_associate_always_node_help.txt ... | |
| [Info] Saving the output of 'tower-cli node associate_credential --help' to /tmp/0/tower-cli_node_associate_credential_help.txt ... | |
| [Info] Saving the output of 'tower-cli node associate_failure_node --help' to /tmp/0/tower-cli_node_associate_failure_node_help.txt ... | |
| [Info] Saving the output of 'tower-cli node associate_success_node --help' to /tmp/0/tower-cli_node_associate_success_node_help.txt ... | |
| [Info] Saving the output of 'tower-cli node copy --help' to /tmp/0/tower-cli_node_copy_help.txt ... | |
| [Info] Saving the output of 'tower-cli node create --help' to /tmp/0/tower-cli_node_create_help.txt ... | |
| [Info] Saving the output of 'tower-cli node delete --help' to /tmp/0/tower-cli_node_delete_help.txt ... | |
| [Info] Saving the output of 'tower-cli node disassociate_always_node --help' to /tmp/0/tower-cli_node_disassociate_always_node_help.txt ... | |
| [Info] Saving the output of 'tower-cli node disassociate_credential --help' to /tmp/0/tower-cli_node_disassociate_credential_help.txt ... | |
| [Info] Saving the output of 'tower-cli node disassociate_failure_node --help' to /tmp/0/tower-cli_node_disassociate_failure_node_help.txt ... | |
| [Info] Saving the output of 'tower-cli node disassociate_success_node --help' to /tmp/0/tower-cli_node_disassociate_success_node_help.txt ... | |
| [Info] Saving the output of 'tower-cli node get --help' to /tmp/0/tower-cli_node_get_help.txt ... | |
| [Info] Saving the output of 'tower-cli node list --help' to /tmp/0/tower-cli_node_list_help.txt ... | |
| [Info] Saving the output of 'tower-cli node modify --help' to /tmp/0/tower-cli_node_modify_help.txt ... | |
| [Info] Saving the output of 'tower-cli notification_template --help' to /tmp/0/tower-cli_notification_template_help.txt ... | |
| [Info] Saving the output of 'tower-cli notification_template copy --help' to /tmp/0/tower-cli_notification_template_copy_help.txt ... | |
| [Info] Saving the output of 'tower-cli notification_template create --help' to /tmp/0/tower-cli_notification_template_create_help.txt ... | |
| [Info] Saving the output of 'tower-cli notification_template delete --help' to /tmp/0/tower-cli_notification_template_delete_help.txt ... | |
| [Info] Saving the output of 'tower-cli notification_template get --help' to /tmp/0/tower-cli_notification_template_get_help.txt ... | |
| [Info] Saving the output of 'tower-cli notification_template list --help' to /tmp/0/tower-cli_notification_template_list_help.txt ... | |
| [Info] Saving the output of 'tower-cli notification_template modify --help' to /tmp/0/tower-cli_notification_template_modify_help.txt ... | |
| [Info] Saving the output of 'tower-cli organization --help' to /tmp/0/tower-cli_organization_help.txt ... | |
| [Info] Saving the output of 'tower-cli organization associate --help' to /tmp/0/tower-cli_organization_associate_help.txt ... | |
| [Info] Saving the output of 'tower-cli organization associate_admin --help' to /tmp/0/tower-cli_organization_associate_admin_help.txt ... | |
| [Info] Saving the output of 'tower-cli organization associate_ig --help' to /tmp/0/tower-cli_organization_associate_ig_help.txt ... | |
| [Info] Saving the output of 'tower-cli organization copy --help' to /tmp/0/tower-cli_organization_copy_help.txt ... | |
| [Info] Saving the output of 'tower-cli organization create --help' to /tmp/0/tower-cli_organization_create_help.txt ... | |
| [Info] Saving the output of 'tower-cli organization delete --help' to /tmp/0/tower-cli_organization_delete_help.txt ... | |
| [Info] Saving the output of 'tower-cli organization disassociate --help' to /tmp/0/tower-cli_organization_disassociate_help.txt ... | |
| [Info] Saving the output of 'tower-cli organization disassociate_admin --help' to /tmp/0/tower-cli_organization_disassociate_admin_help.txt ... | |
| [Info] Saving the output of 'tower-cli organization disassociate_ig --help' to /tmp/0/tower-cli_organization_disassociate_ig_help.txt ... | |
| [Info] Saving the output of 'tower-cli organization get --help' to /tmp/0/tower-cli_organization_get_help.txt ... | |
| [Info] Saving the output of 'tower-cli organization list --help' to /tmp/0/tower-cli_organization_list_help.txt ... | |
| [Info] Saving the output of 'tower-cli organization modify --help' to /tmp/0/tower-cli_organization_modify_help.txt ... | |
| [Info] Saving the output of 'tower-cli project --help' to /tmp/0/tower-cli_project_help.txt ... | |
| [Info] Saving the output of 'tower-cli project copy --help' to /tmp/0/tower-cli_project_copy_help.txt ... | |
| [Info] Saving the output of 'tower-cli project create --help' to /tmp/0/tower-cli_project_create_help.txt ... | |
| [Info] Saving the output of 'tower-cli project delete --help' to /tmp/0/tower-cli_project_delete_help.txt ... | |
| [Info] Saving the output of 'tower-cli project get --help' to /tmp/0/tower-cli_project_get_help.txt ... | |
| [Info] Saving the output of 'tower-cli project list --help' to /tmp/0/tower-cli_project_list_help.txt ... | |
| [Info] Saving the output of 'tower-cli project modify --help' to /tmp/0/tower-cli_project_modify_help.txt ... | |
| [Info] Saving the output of 'tower-cli project monitor --help' to /tmp/0/tower-cli_project_monitor_help.txt ... | |
| [Info] Saving the output of 'tower-cli project status --help' to /tmp/0/tower-cli_project_status_help.txt ... | |
| [Info] Saving the output of 'tower-cli project stdout --help' to /tmp/0/tower-cli_project_stdout_help.txt ... | |
| [Info] Saving the output of 'tower-cli project update --help' to /tmp/0/tower-cli_project_update_help.txt ... | |
| [Info] Saving the output of 'tower-cli project wait --help' to /tmp/0/tower-cli_project_wait_help.txt ... | |
| [Info] Saving the output of 'tower-cli project_update --help' to /tmp/0/tower-cli_project_update_help.txt ... | |
| [Info] Saving the output of 'tower-cli project_update cancel --help' to /tmp/0/tower-cli_project_update_cancel_help.txt ... | |
| [Info] Saving the output of 'tower-cli project_update delete --help' to /tmp/0/tower-cli_project_update_delete_help.txt ... | |
| [Info] Saving the output of 'tower-cli project_update get --help' to /tmp/0/tower-cli_project_update_get_help.txt ... | |
| [Info] Saving the output of 'tower-cli project_update list --help' to /tmp/0/tower-cli_project_update_list_help.txt ... | |
| [Info] Saving the output of 'tower-cli project_update monitor --help' to /tmp/0/tower-cli_project_update_monitor_help.txt ... | |
| [Info] Saving the output of 'tower-cli project_update relaunch --help' to /tmp/0/tower-cli_project_update_relaunch_help.txt ... | |
| [Info] Saving the output of 'tower-cli project_update status --help' to /tmp/0/tower-cli_project_update_status_help.txt ... | |
| [Info] Saving the output of 'tower-cli project_update stdout --help' to /tmp/0/tower-cli_project_update_stdout_help.txt ... | |
| [Info] Saving the output of 'tower-cli project_update wait --help' to /tmp/0/tower-cli_project_update_wait_help.txt ... | |
| [Info] Saving the output of 'tower-cli role --help' to /tmp/0/tower-cli_role_help.txt ... | |
| [Info] Saving the output of 'tower-cli role copy --help' to /tmp/0/tower-cli_role_copy_help.txt ... | |
| [Info] Saving the output of 'tower-cli role get --help' to /tmp/0/tower-cli_role_get_help.txt ... | |
| [Info] Saving the output of 'tower-cli role grant --help' to /tmp/0/tower-cli_role_grant_help.txt ... | |
| [Info] Saving the output of 'tower-cli role list --help' to /tmp/0/tower-cli_role_list_help.txt ... | |
| [Info] Saving the output of 'tower-cli role revoke --help' to /tmp/0/tower-cli_role_revoke_help.txt ... | |
| [Info] Saving the output of 'tower-cli schedule --help' to /tmp/0/tower-cli_schedule_help.txt ... | |
| [Info] Saving the output of 'tower-cli schedule associate_credential --help' to /tmp/0/tower-cli_schedule_associate_credential_help.txt ... | |
| [Info] Saving the output of 'tower-cli schedule copy --help' to /tmp/0/tower-cli_schedule_copy_help.txt ... | |
| [Info] Saving the output of 'tower-cli schedule create --help' to /tmp/0/tower-cli_schedule_create_help.txt ... | |
| [Info] Saving the output of 'tower-cli schedule delete --help' to /tmp/0/tower-cli_schedule_delete_help.txt ... | |
| [Info] Saving the output of 'tower-cli schedule disassociate_credential --help' to /tmp/0/tower-cli_schedule_disassociate_credential_help.txt ... | |
| [Info] Saving the output of 'tower-cli schedule get --help' to /tmp/0/tower-cli_schedule_get_help.txt ... | |
| [Info] Saving the output of 'tower-cli schedule list --help' to /tmp/0/tower-cli_schedule_list_help.txt ... | |
| [Info] Saving the output of 'tower-cli schedule modify --help' to /tmp/0/tower-cli_schedule_modify_help.txt ... | |
| [Info] Saving the output of 'tower-cli setting --help' to /tmp/0/tower-cli_setting_help.txt ... | |
| [Info] Saving the output of 'tower-cli setting copy --help' to /tmp/0/tower-cli_setting_copy_help.txt ... | |
| [Info] Saving the output of 'tower-cli setting get --help' to /tmp/0/tower-cli_setting_get_help.txt ... | |
| [Info] Saving the output of 'tower-cli setting list --help' to /tmp/0/tower-cli_setting_list_help.txt ... | |
| [Info] Saving the output of 'tower-cli setting modify --help' to /tmp/0/tower-cli_setting_modify_help.txt ... | |
| [Info] Saving the output of 'tower-cli team --help' to /tmp/0/tower-cli_team_help.txt ... | |
| [Info] Saving the output of 'tower-cli team associate --help' to /tmp/0/tower-cli_team_associate_help.txt ... | |
| [Info] Saving the output of 'tower-cli team copy --help' to /tmp/0/tower-cli_team_copy_help.txt ... | |
| [Info] Saving the output of 'tower-cli team create --help' to /tmp/0/tower-cli_team_create_help.txt ... | |
| [Info] Saving the output of 'tower-cli team delete --help' to /tmp/0/tower-cli_team_delete_help.txt ... | |
| [Info] Saving the output of 'tower-cli team disassociate --help' to /tmp/0/tower-cli_team_disassociate_help.txt ... | |
| [Info] Saving the output of 'tower-cli team get --help' to /tmp/0/tower-cli_team_get_help.txt ... | |
| [Info] Saving the output of 'tower-cli team list --help' to /tmp/0/tower-cli_team_list_help.txt ... | |
| [Info] Saving the output of 'tower-cli team modify --help' to /tmp/0/tower-cli_team_modify_help.txt ... | |
| [Info] Saving the output of 'tower-cli user --help' to /tmp/0/tower-cli_user_help.txt ... | |
| [Info] Saving the output of 'tower-cli user copy --help' to /tmp/0/tower-cli_user_copy_help.txt ... | |
| [Info] Saving the output of 'tower-cli user create --help' to /tmp/0/tower-cli_user_create_help.txt ... | |
| [Info] Saving the output of 'tower-cli user delete --help' to /tmp/0/tower-cli_user_delete_help.txt ... | |
| [Info] Saving the output of 'tower-cli user get --help' to /tmp/0/tower-cli_user_get_help.txt ... | |
| [Info] Saving the output of 'tower-cli user list --help' to /tmp/0/tower-cli_user_list_help.txt ... | |
| [Info] Saving the output of 'tower-cli user modify --help' to /tmp/0/tower-cli_user_modify_help.txt ... | |
| [Info] Saving the output of 'tower-cli workflow --help' to /tmp/0/tower-cli_workflow_help.txt ... | |
| [Info] Saving the output of 'tower-cli workflow associate_label --help' to /tmp/0/tower-cli_workflow_associate_label_help.txt ... | |
| [Info] Saving the output of 'tower-cli workflow associate_notification_template --help' to /tmp/0/tower-cli_workflow_associate_notification_template_help.txt ... | |
| [Info] Saving the output of 'tower-cli workflow copy --help' to /tmp/0/tower-cli_workflow_copy_help.txt ... | |
| [Info] Saving the output of 'tower-cli workflow create --help' to /tmp/0/tower-cli_workflow_create_help.txt ... | |
| [Info] Saving the output of 'tower-cli workflow delete --help' to /tmp/0/tower-cli_workflow_delete_help.txt ... | |
| [Info] Saving the output of 'tower-cli workflow disassociate_label --help' to /tmp/0/tower-cli_workflow_disassociate_label_help.txt ... | |
| [Info] Saving the output of 'tower-cli workflow disassociate_notification_template --help' to /tmp/0/tower-cli_workflow_disassociate_notification_template_help.txt ... | |
| [Info] Saving the output of 'tower-cli workflow get --help' to /tmp/0/tower-cli_workflow_get_help.txt ... | |
| [Info] Saving the output of 'tower-cli workflow list --help' to /tmp/0/tower-cli_workflow_list_help.txt ... | |
| [Info] Saving the output of 'tower-cli workflow modify --help' to /tmp/0/tower-cli_workflow_modify_help.txt ... | |
| [Info] Saving the output of 'tower-cli workflow schema --help' to /tmp/0/tower-cli_workflow_schema_help.txt ... | |
| [Info] Saving the output of 'tower-cli workflow survey --help' to /tmp/0/tower-cli_workflow_survey_help.txt ... | |
| [Info] Saving the output of 'tower-cli workflow_job --help' to /tmp/0/tower-cli_workflow_job_help.txt ... | |
| [Info] Saving the output of 'tower-cli workflow_job cancel --help' to /tmp/0/tower-cli_workflow_job_cancel_help.txt ... | |
| [Info] Saving the output of 'tower-cli workflow_job delete --help' to /tmp/0/tower-cli_workflow_job_delete_help.txt ... | |
| [Info] Saving the output of 'tower-cli workflow_job get --help' to /tmp/0/tower-cli_workflow_job_get_help.txt ... | |
| [Info] Saving the output of 'tower-cli workflow_job launch --help' to /tmp/0/tower-cli_workflow_job_launch_help.txt ... | |
| [Info] Saving the output of 'tower-cli workflow_job list --help' to /tmp/0/tower-cli_workflow_job_list_help.txt ... | |
| [Info] Saving the output of 'tower-cli workflow_job monitor --help' to /tmp/0/tower-cli_workflow_job_monitor_help.txt ... | |
| [Info] Saving the output of 'tower-cli workflow_job relaunch --help' to /tmp/0/tower-cli_workflow_job_relaunch_help.txt ... | |
| [Info] Saving the output of 'tower-cli workflow_job status --help' to /tmp/0/tower-cli_workflow_job_status_help.txt ... | |
| [Info] Saving the output of 'tower-cli workflow_job summary --help' to /tmp/0/tower-cli_workflow_job_summary_help.txt ... | |
| [Info] Saving the output of 'tower-cli workflow_job wait --help' to /tmp/0/tower-cli_workflow_job_wait_help.txt ... | |
| ./autoinstall.d/data/awx/3/collect_tower-cli_help_texts.sh -o /tmp/0 99.18s user 10.82s system 99% cpu 1:50.32 total | |
| ssato@localhost% ls /tmp/0 ~/repos/public/github.com/ssato/miniascape-templates.git | |
| tower-cli_activity_stream_get_help.txt tower-cli_inventory_source_list_help.txt tower-cli_organization_list_help.txt | |
| tower-cli_activity_stream_help.txt tower-cli_inventory_source_modify_help.txt tower-cli_organization_modify_help.txt | |
| tower-cli_activity_stream_list_help.txt tower-cli_inventory_source_monitor_help.txt tower-cli_project_copy_help.txt | |
| tower-cli_ad_hoc_cancel_help.txt tower-cli_inventory_source_status_help.txt tower-cli_project_create_help.txt | |
| tower-cli_ad_hoc_delete_help.txt tower-cli_inventory_source_stdout_help.txt tower-cli_project_delete_help.txt | |
| tower-cli_ad_hoc_get_help.txt tower-cli_inventory_source_update_help.txt tower-cli_project_get_help.txt | |
| tower-cli_ad_hoc_help.txt tower-cli_inventory_source_wait_help.txt tower-cli_project_help.txt | |
| tower-cli_ad_hoc_launch_help.txt tower-cli_inventory_update_cancel_help.txt tower-cli_project_list_help.txt | |
| tower-cli_ad_hoc_list_help.txt tower-cli_inventory_update_delete_help.txt tower-cli_project_modify_help.txt | |
| tower-cli_ad_hoc_monitor_help.txt tower-cli_inventory_update_get_help.txt tower-cli_project_monitor_help.txt | |
| tower-cli_ad_hoc_relaunch_help.txt tower-cli_inventory_update_help.txt tower-cli_project_status_help.txt | |
| tower-cli_ad_hoc_status_help.txt tower-cli_inventory_update_list_help.txt tower-cli_project_stdout_help.txt | |
| tower-cli_ad_hoc_stdout_help.txt tower-cli_inventory_update_monitor_help.txt tower-cli_project_update_cancel_help.txt | |
| tower-cli_ad_hoc_wait_help.txt tower-cli_inventory_update_relaunch_help.txt tower-cli_project_update_delete_help.txt | |
| tower-cli_application_copy_help.txt tower-cli_inventory_update_status_help.txt tower-cli_project_update_get_help.txt | |
| tower-cli_application_create_help.txt tower-cli_inventory_update_stdout_help.txt tower-cli_project_update_help.txt | |
| tower-cli_application_delete_help.txt tower-cli_inventory_update_wait_help.txt tower-cli_project_update_list_help.txt | |
| tower-cli_application_get_help.txt tower-cli_job_cancel_help.txt tower-cli_project_update_monitor_help.txt | |
| tower-cli_application_help.txt tower-cli_job_delete_help.txt tower-cli_project_update_relaunch_help.txt | |
| tower-cli_application_list_help.txt tower-cli_job_get_help.txt tower-cli_project_update_status_help.txt | |
| tower-cli_application_modify_help.txt tower-cli_job_help.txt tower-cli_project_update_stdout_help.txt | |
| tower-cli_config_help.txt tower-cli_job_launch_help.txt tower-cli_project_update_wait_help.txt | |
| tower-cli_credential_copy_help.txt tower-cli_job_list_help.txt tower-cli_project_wait_help.txt | |
| tower-cli_credential_create_help.txt tower-cli_job_monitor_help.txt tower-cli_receive_help.txt | |
| tower-cli_credential_delete_help.txt tower-cli_job_relaunch_help.txt tower-cli_role_copy_help.txt | |
| tower-cli_credential_get_help.txt tower-cli_job_status_help.txt tower-cli_role_get_help.txt | |
| tower-cli_credential_help.txt tower-cli_job_stdout_help.txt tower-cli_role_grant_help.txt | |
| tower-cli_credential_list_help.txt tower-cli_job_template_associate_credential_help.txt tower-cli_role_help.txt | |
| tower-cli_credential_modify_help.txt tower-cli_job_template_associate_ig_help.txt tower-cli_role_list_help.txt | |
| tower-cli_credential_type_copy_help.txt tower-cli_job_template_associate_label_help.txt tower-cli_role_revoke_help.txt | |
| tower-cli_credential_type_create_help.txt tower-cli_job_template_associate_notification_template_help.txt tower-cli_schedule_associate_credential_help.txt | |
| tower-cli_credential_type_delete_help.txt tower-cli_job_template_callback_help.txt tower-cli_schedule_copy_help.txt | |
| tower-cli_credential_type_get_help.txt tower-cli_job_template_copy_help.txt tower-cli_schedule_create_help.txt | |
| tower-cli_credential_type_help.txt tower-cli_job_template_create_help.txt tower-cli_schedule_delete_help.txt | |
| tower-cli_credential_type_list_help.txt tower-cli_job_template_delete_help.txt tower-cli_schedule_disassociate_credential_help.txt | |
| tower-cli_credential_type_modify_help.txt tower-cli_job_template_disassociate_credential_help.txt tower-cli_schedule_get_help.txt | |
| tower-cli_empty_help.txt tower-cli_job_template_disassociate_ig_help.txt tower-cli_schedule_help.txt | |
| tower-cli_group_associate_help.txt tower-cli_job_template_disassociate_label_help.txt tower-cli_schedule_list_help.txt | |
| tower-cli_group_copy_help.txt tower-cli_job_template_disassociate_notification_template_help.txt tower-cli_schedule_modify_help.txt | |
| tower-cli_group_create_help.txt tower-cli_job_template_get_help.txt tower-cli_send_help.txt | |
| tower-cli_group_delete_help.txt tower-cli_job_template_help.txt tower-cli_setting_copy_help.txt | |
| tower-cli_group_disassociate_help.txt tower-cli_job_template_list_help.txt tower-cli_setting_get_help.txt | |
| tower-cli_group_get_help.txt tower-cli_job_template_modify_help.txt tower-cli_setting_help.txt | |
| tower-cli_group_help.txt tower-cli_job_template_survey_help.txt tower-cli_setting_list_help.txt | |
| tower-cli_group_list_help.txt tower-cli_job_wait_help.txt tower-cli_setting_modify_help.txt | |
| tower-cli_group_modify_help.txt tower-cli_label_copy_help.txt tower-cli_team_associate_help.txt | |
| tower-cli_help.txt tower-cli_label_create_help.txt tower-cli_team_copy_help.txt | |
| tower-cli_host_associate_help.txt tower-cli_label_get_help.txt tower-cli_team_create_help.txt | |
| tower-cli_host_copy_help.txt tower-cli_label_help.txt tower-cli_team_delete_help.txt | |
| tower-cli_host_create_help.txt tower-cli_label_list_help.txt tower-cli_team_disassociate_help.txt | |
| tower-cli_host_delete_help.txt tower-cli_label_modify_help.txt tower-cli_team_get_help.txt | |
| tower-cli_host_disassociate_help.txt tower-cli_login_help.txt tower-cli_team_help.txt | |
| tower-cli_host_get_help.txt tower-cli_logout_help.txt tower-cli_team_list_help.txt | |
| tower-cli_host_help.txt tower-cli_node_associate_always_node_help.txt tower-cli_team_modify_help.txt | |
| tower-cli_host_insights_help.txt tower-cli_node_associate_credential_help.txt tower-cli_user_copy_help.txt | |
| tower-cli_host_list_facts_help.txt tower-cli_node_associate_failure_node_help.txt tower-cli_user_create_help.txt | |
| tower-cli_host_list_help.txt tower-cli_node_associate_success_node_help.txt tower-cli_user_delete_help.txt | |
| tower-cli_host_modify_help.txt tower-cli_node_copy_help.txt tower-cli_user_get_help.txt | |
| tower-cli_instance_get_help.txt tower-cli_node_create_help.txt tower-cli_user_help.txt | |
| tower-cli_instance_group_get_help.txt tower-cli_node_delete_help.txt tower-cli_user_list_help.txt | |
| tower-cli_instance_group_help.txt tower-cli_node_disassociate_always_node_help.txt tower-cli_user_modify_help.txt | |
| tower-cli_instance_group_list_help.txt tower-cli_node_disassociate_credential_help.txt tower-cli_version_help.txt | |
| tower-cli_instance_help.txt tower-cli_node_disassociate_failure_node_help.txt tower-cli_workflow_associate_label_help.txt | |
| tower-cli_instance_list_help.txt tower-cli_node_disassociate_success_node_help.txt tower-cli_workflow_associate_notification_template_help.txt | |
| tower-cli_inventory_associate_ig_help.txt tower-cli_node_get_help.txt tower-cli_workflow_copy_help.txt | |
| tower-cli_inventory_batch_update_help.txt tower-cli_node_help.txt tower-cli_workflow_create_help.txt | |
| tower-cli_inventory_copy_help.txt tower-cli_node_list_help.txt tower-cli_workflow_delete_help.txt | |
| tower-cli_inventory_create_help.txt tower-cli_node_modify_help.txt tower-cli_workflow_disassociate_label_help.txt | |
| tower-cli_inventory_delete_help.txt tower-cli_notification_template_copy_help.txt tower-cli_workflow_disassociate_notification_template_help.txt | |
| tower-cli_inventory_disassociate_ig_help.txt tower-cli_notification_template_create_help.txt tower-cli_workflow_get_help.txt | |
| tower-cli_inventory_get_help.txt tower-cli_notification_template_delete_help.txt tower-cli_workflow_help.txt | |
| tower-cli_inventory_help.txt tower-cli_notification_template_get_help.txt tower-cli_workflow_job_cancel_help.txt | |
| tower-cli_inventory_list_help.txt tower-cli_notification_template_help.txt tower-cli_workflow_job_delete_help.txt | |
| tower-cli_inventory_modify_help.txt tower-cli_notification_template_list_help.txt tower-cli_workflow_job_get_help.txt | |
| tower-cli_inventory_script_copy_help.txt tower-cli_notification_template_modify_help.txt tower-cli_workflow_job_help.txt | |
| tower-cli_inventory_script_create_help.txt tower-cli_organization_associate_admin_help.txt tower-cli_workflow_job_launch_help.txt | |
| tower-cli_inventory_script_delete_help.txt tower-cli_organization_associate_help.txt tower-cli_workflow_job_list_help.txt | |
| tower-cli_inventory_script_get_help.txt tower-cli_organization_associate_ig_help.txt tower-cli_workflow_job_monitor_help.txt | |
| tower-cli_inventory_script_help.txt tower-cli_organization_copy_help.txt tower-cli_workflow_job_relaunch_help.txt | |
| tower-cli_inventory_script_list_help.txt tower-cli_organization_create_help.txt tower-cli_workflow_job_status_help.txt | |
| tower-cli_inventory_script_modify_help.txt tower-cli_organization_delete_help.txt tower-cli_workflow_job_summary_help.txt | |
| tower-cli_inventory_source_copy_help.txt tower-cli_organization_disassociate_admin_help.txt tower-cli_workflow_job_wait_help.txt | |
| tower-cli_inventory_source_create_help.txt tower-cli_organization_disassociate_help.txt tower-cli_workflow_list_help.txt | |
| tower-cli_inventory_source_delete_help.txt tower-cli_organization_disassociate_ig_help.txt tower-cli_workflow_modify_help.txt | |
| tower-cli_inventory_source_get_help.txt tower-cli_organization_get_help.txt tower-cli_workflow_schema_help.txt | |
| tower-cli_inventory_source_help.txt tower-cli_organization_help.txt tower-cli_workflow_survey_help.txt | |
| ssato@localhost% cat /tmp/0/tower-cli_job_template_create_help.txt ~/repos/public/github.com/ssato/miniascape-templates.git | |
| # tower-cli job_template create --help | |
| Usage: tower-cli job_template create [OPTIONS] | |
| Create a job template. | |
| Fields in the resource's --identity tuple are used for a lookup; if a | |
| match is found, then no-op (unless --force-on-exists is set) but do not | |
| fail (unless --fail-on-found is set). | |
| Field Options: | |
| -n, --name TEXT [REQUIRED] The name field. | |
| -d, --description TEXT The description field. | |
| --job-type [run|check] The job_type field. | |
| -i, --inventory INVENTORY The inventory field. | |
| --project PROJECT [REQUIRED] The project field. | |
| --playbook TEXT [REQUIRED] The playbook field. | |
| --credential CREDENTIAL The credential field. | |
| --vault-credential CREDENTIAL The vault_credential field. | |
| --forks INTEGER The forks field. | |
| --limit TEXT The limit field. | |
| --verbosity [default|verbose|more_verbose|debug|connection|winrm] | |
| The verbosity field. | |
| -e, --extra-vars VARIABLES Extra variables used by Ansible in YAML or | |
| key=value format. Use @ to get YAML from a | |
| file. | |
| --job-tags TEXT The job_tags field. | |
| --force-handlers BOOLEAN The force_handlers field. | |
| --skip-tags TEXT The skip_tags field. | |
| --start-at-task TEXT The start_at_task field. | |
| --timeout INTEGER The amount of time (in seconds) to run | |
| before the task is canceled. | |
| --use-fact-cache BOOLEAN If enabled, Tower will act as an Ansible | |
| Fact Cache Plugin; persisting facts at the | |
| end of a playbook run to the database and | |
| caching facts for use by Ansible. | |
| --host-config-key TEXT Allow Provisioning Callbacks using this host | |
| config key | |
| --ask-diff-mode-on-launch BOOLEAN | |
| Ask diff mode on launch. | |
| --ask-variables-on-launch BOOLEAN | |
| Prompt user for extra_vars on launch. | |
| --ask-limit-on-launch BOOLEAN Prompt user for host limits on launch. | |
| --ask-tags-on-launch BOOLEAN Prompt user for job tags on launch. | |
| --ask-skip-tags-on-launch BOOLEAN | |
| Prompt user for tags to skip on launch. | |
| --ask-job-type-on-launch BOOLEAN | |
| Prompt user for job type on launch. | |
| --ask-verbosity-on-launch BOOLEAN | |
| Prompt user for verbosity on launch. | |
| --ask-inventory-on-launch BOOLEAN | |
| Prompt user for inventory on launch. | |
| --ask-credential-on-launch BOOLEAN | |
| Prompt user for machine credential on | |
| launch. | |
| --survey-enabled BOOLEAN Prompt user for job type on launch. | |
| --become-enabled BOOLEAN The become_enabled field. | |
| --diff-mode BOOLEAN If enabled, textual changes made to any | |
| templated files on the host are shown in the | |
| standard output. | |
| --allow-simultaneous BOOLEAN The allow_simultaneous field. | |
| --survey-spec VARIABLES On write commands, perform extra POST to the | |
| survey_spec endpoint. | |
| Local Options: | |
| --fail-on-found If used, return an error if a matching record already | |
| exists. [default: False] | |
| --force-on-exists If used, if a match is found on unique fields, other | |
| fields will be updated to the provided values. If False, | |
| a match causes the request to be a no-op. [default: | |
| False] | |
| Global Options: | |
| --use-token Turn on Tower's token-based authentication. | |
| No longer supported in Tower 3.3 and above. | |
| --certificate TEXT Path to a custom certificate file that will | |
| be used throughout the command. Overwritten | |
| by --insecure flag if set. | |
| --insecure Turn off insecure connection warnings. Set | |
| config verify_ssl to make this permanent. | |
| --description-on Show description in human-formatted output. | |
| -v, --verbose Show information about requests being made. | |
| -f, --format [human|json|yaml|id] | |
| Output format. The "human" format is | |
| intended for humans reading output on the | |
| CLI; the "json" and "yaml" formats provide | |
| more data, and "id" echos the object id | |
| only. | |
| -p, --tower-password TEXT Password to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| password provided to `tower config`, if any. | |
| -u, --tower-username TEXT Username to use to authenticate to Ansible | |
| Tower. This will take precedence over a | |
| username provided to `tower config`, if any. | |
| -t, --tower-oauth-token TEXT OAuth2 token to use to authenticate to | |
| Ansible Tower. This will take precedence | |
| over a token provided to `tower config`, if | |
| any. | |
| -h, --tower-host TEXT The location of the Ansible Tower host. | |
| HTTPS is assumed as the protocol unless | |
| "http://" is explicitly provided. This will | |
| take precedence over a host provided to | |
| `tower config`, if any. | |
| Other Options: | |
| --help Show this message and exit. | |
| ssato@localhost% ~/repos/public/github.com/ssato/miniascape-templates.git |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment