External-Mirrors/awx
2
0
Fork 0
mirror of https://github.com/ansible/awx.git synced 2026-03-25 12:55:04 -02:30
Code Issues Packages Projects Releases Wiki Activity

mostly includes renaming non-syntax references to tower

Browse Source
This commit is contained in:
Seth Foster
2021-05-03 17:20:24 -04:00
parent 9f4172ce7b
commit 82c5803e59
92 changed files with 410 additions and 408 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
awx_collection/plugins/doc_fragments/auth.py
View File

@@ -10,37 +10,37 @@ __metaclass__ = type
class ModuleDocFragment(object):
# Ansible Tower documentation fragment
# Automation Platform Controller documentation fragment
DOCUMENTATION = r'''
options:
tower_host:
description:
- URL to your Tower or AWX instance.
- URL to your Automation Platform Controller instance.
- If value not set, will try environment variable C(TOWER_HOST) and then config files
- If value not specified by any means, the value of C(127.0.0.1) will be used
type: str
tower_username:
description:
- Username for your Tower or AWX instance.
- Username for your controller instance.
- If value not set, will try environment variable C(TOWER_USERNAME) and then config files
type: str
tower_password:
description:
- Password for your Tower or AWX instance.
- Password for your controller instance.
- If value not set, will try environment variable C(TOWER_PASSWORD) and then config files
type: str
tower_oauthtoken:
description:
- The Tower OAuth token to use.
- The OAuth token to use.
- This value can be in one of two formats.
- A string which is the token itself. (i.e. bqV5txm97wqJqtkxlMkhQz0pKhRMMX)
- A dictionary structure as returned by the tower_token module.
- A dictionary structure as returned by the token module.
- If value not set, will try environment variable C(TOWER_OAUTH_TOKEN) and then config files
type: raw
version_added: "3.7"
validate_certs:
description:
- Whether to allow insecure connections to Tower or AWX.
- Whether to allow insecure connections to AWX.
- If C(no), SSL certificates will not be validated.
- This should only be used on personally controlled sites using self-signed certificates.
- If value not set, will try environment variable C(TOWER_VERIFY_SSL) and then config files
@@ -48,14 +48,14 @@ options:
aliases: [ tower_verify_ssl ]
tower_config_file:
description:
- Path to the Tower or AWX config file.
- Path to the controller config file.
- If provided, the other locations for config files will not be considered.
type: path
notes:
- If no I(config_file) is provided we will attempt to use the tower-cli library
defaults to find your Tower host information.
- I(config_file) should contain Tower configuration in the following format
defaults to find your host information.
- I(config_file) should be in the following format
host=hostname
username=username
password=password

16
awx_collection/plugins/doc_fragments/auth_legacy.py
View File

@@ -10,28 +10,28 @@ __metaclass__ = type
class ModuleDocFragment(object):
# Automation Controller documentation fragment
# Automation Platform Controller documentation fragment
DOCUMENTATION = r'''
options:
tower_host:
description:
- URL to your Tower or AWX instance.
- URL to your Automation Platform Controller instance.
- If value not set, will try environment variable C(TOWER_HOST) and then config files
- If value not specified by any means, the value of C(127.0.0.1) will be used
type: str
tower_username:
description:
- Username for your Tower or AWX instance.
- Username for your controller instance.
- If value not set, will try environment variable C(TOWER_USERNAME) and then config files
type: str
tower_password:
description:
- Password for your Tower or AWX instance.
- Password for your controller instance.
- If value not set, will try environment variable C(TOWER_PASSWORD) and then config files
type: str
validate_certs:
description:
- Whether to allow insecure connections to Tower or AWX.
- Whether to allow insecure connections.
- If C(no), SSL certificates will not be validated.
- This should only be used on personally controlled sites using self-signed certificates.
- If value not set, will try environment variable C(TOWER_VERIFY_SSL) and then config files
@@ -39,14 +39,14 @@ options:
aliases: [ tower_verify_ssl ]
tower_config_file:
description:
- Path to the Tower or AWX config file.
- Path to the controller config file.
- If provided, the other locations for config files will not be considered.
type: path
notes:
- If no I(config_file) is provided we will attempt to use the tower-cli library
defaults to find your Tower host information.
- I(config_file) should contain Tower configuration in the following format
defaults to find your host information.
- I(config_file) should be in the following format
host=hostname
username=username
password=password

16
awx_collection/plugins/doc_fragments/auth_plugin.py
View File

@@ -10,29 +10,29 @@ __metaclass__ = type
class ModuleDocFragment(object):
# Automation Controller documentation fragment
# Automation Platform Controller documentation fragment
DOCUMENTATION = r'''
options:
host:
description: The network address of your Automation Controller host.
description: The network address of your Automation Platform Controller host.
env:
- name: TOWER_HOST
username:
description: The user that you plan to use to access inventories on Automation Controller.
description: The user that you plan to use to access inventories on the controller.
env:
- name: TOWER_USERNAME
password:
description: The password for your Automation Controller user.
description: The password for your controller user.
env:
- name: TOWER_PASSWORD
oauth_token:
description:
- The Tower OAuth token to use.
- The OAuth token to use.
env:
- name: TOWER_OAUTH_TOKEN
verify_ssl:
description:
- Specify whether Ansible should verify the SSL certificate of Automation Controller host.
- Specify whether Ansible should verify the SSL certificate of the controller host.
- Defaults to True, but this is handled by the shared module_utils code
type: bool
env:
@@ -41,8 +41,8 @@ options:
notes:
- If no I(config_file) is provided we will attempt to use the tower-cli library
defaults to find your Tower host information.
- I(config_file) should contain Tower configuration in the following format
defaults to find your host information.
- I(config_file) should be in the following format
host=hostname
username=username
password=password

24
awx_collection/plugins/inventory/controller.py
View File

@@ -6,14 +6,14 @@ from __future__ import absolute_import, division, print_function
__metaclass__ = type
DOCUMENTATION = '''
name: tower
name: controller
plugin_type: inventory
author:
- Matthew Jones (@matburt)
- Yunfan Zhang (@YunfanZhang42)
short_description: Ansible dynamic inventory plugin for Automation Controller.
short_description: Ansible dynamic inventory plugin for the Automation Platform Controller.
description:
- Reads inventories from Automation Controller.
- Reads inventories from the Automation Platform Controller.
- Supports reading configuration from both YAML config file and environment variables.
- If reading from the YAML file, the file name must end with tower.(yml|yaml) or tower_inventory.(yml|yaml),
the path in the command would be /path/to/tower_inventory.(yml|yaml). If some arguments in the config file
@@ -23,7 +23,7 @@ extends_documentation_fragment: awx.awx.auth_plugin
options:
inventory_id:
description:
- The ID of the Automation Controller inventory that you wish to import.
- The ID of the inventory that you wish to import.
- This is allowed to be either the inventory primary key or its named URL slug.
- Primary key values will be accepted as strings or integers, and URL slugs must be strings.
- Named URL slugs follow the syntax of "inventory_name++organization_name".
@@ -32,7 +32,7 @@ options:
- name: TOWER_INVENTORY
required: True
include_metadata:
description: Make extra requests to provide all group vars with metadata about the source Automation Controller host.
description: Make extra requests to provide all group vars with metadata about the source host.
type: bool
default: False
'''
@@ -43,11 +43,11 @@ EXAMPLES = '''
# Example for using tower_inventory.yml file
plugin: awx.awx.tower
host: your_ansible_tower_server_network_address
username: your_ansible_tower_username
password: your_ansible_tower_password
inventory_id: the_ID_of_targeted_ansible_tower_inventory
plugin: awx.awx.controller
host: your_automation_controller_server_network_address
username: your_automation_controller_username
password: your_automation_controller_password
inventory_id: the_ID_of_targeted_automation_controller_inventory
# Then you can run the following command.
# If some of the arguments are missing, Ansible will attempt to read them from environment variables.
# ansible-inventory -i /path/to/tower_inventory.yml --list
@@ -59,7 +59,7 @@ inventory_id: the_ID_of_targeted_ansible_tower_inventory
# export TOWER_USERNAME=YOUR_TOWER_USERNAME
# export TOWER_PASSWORD=YOUR_TOWER_PASSWORD
# export TOWER_INVENTORY=THE_ID_OF_TARGETED_INVENTORY
# Read the inventory specified in TOWER_INVENTORY from Automation Controller, and list them.
# Read the inventory specified in TOWER_INVENTORY from the controller, and list them.
# The inventory path must always be @tower_inventory if you are reading all settings from environment variables.
# ansible-inventory -i @tower_inventory --list
'''
@@ -80,7 +80,7 @@ def handle_error(**kwargs):
class InventoryModule(BaseInventoryPlugin):
NAME = 'awx.awx.tower' # REPLACE
NAME = 'awx.awx.controller' # REPLACE
# Stays backward compatible with tower inventory script.
# If the user supplies '@tower_inventory' as path, the plugin will read from environment variables.
no_config_file_supplied = False

14
awx_collection/plugins/lookup/controller_api.py
View File

@@ -11,10 +11,10 @@ short_description: Search the API for objects
requirements:
- None
description:
- Returns GET requests from the Automation Controller API. See
- Returns GET requests from the Automation Platform Controller API. See
U(https://docs.ansible.com/ansible-tower/latest/html/towerapi/index.html) for API usage.
- For use that is cross-compatible between the awx.awx and ansible.tower collection
see the tower_meta module
- For use that is cross-compatible between the awx.awx and ansible.controller collection
see the controller_meta module
extends_documentation_fragment: awx.awx.auth_plugin
options:
_terms:
@@ -71,11 +71,11 @@ notes:
EXAMPLES = """
- name: Load the UI settings
set_fact:
tower_settings: "{{ lookup('awx.awx.controller_api', 'settings/ui') }}"
controller_settings: "{{ lookup('awx.awx.controller_api', 'settings/ui') }}"
- name: Load the UI settings specifying the connection info
set_fact:
tower_settings: "{{ lookup('awx.awx.controller_api', 'settings/ui' host='tower.example.com', username='admin', password=my_pass_var, verify_ssl=False) }}"
controller_settings: "{{ lookup('awx.awx.controller_api', 'settings/ui' host='tower.example.com', username='admin', password=my_pass_var, verify_ssl=False) }}"
- name: Report the usernames of all users with admin privs
debug:
@@ -89,14 +89,14 @@ EXAMPLES = """
label: "{{ item['name'] }}"
- name: Make sure user 'john' is an org admin of the default org if the user exists
tower_role:
role:
organization: Default
role: admin
user: john
when: "lookup('awx.awx.controller_api', 'users', query_params={ 'username': 'john' }) | length == 1"
- name: Create an inventory group with all 'foo' hosts
tower_group:
group:
name: "Foo Group"
inventory: "Demo Inventory"
hosts: >-

10
awx_collection/plugins/lookup/schedule_rrule.py
View File

@@ -5,9 +5,9 @@ from __future__ import absolute_import, division, print_function
__metaclass__ = type
DOCUMENTATION = """
lookup: tower_schedule_rrule
lookup: schedule_rrule
author: John Westcott IV (@john-westcott-iv)
short_description: Generate an rrule string which can be used for Tower Schedules
short_description: Generate an rrule string which can be used for Schedules
requirements:
- pytz
- python.dateutil >= 2.7.0
@@ -75,7 +75,7 @@ DOCUMENTATION = """
EXAMPLES = """
- name: Create a string for a schedule
debug:
msg: "{{ query('awx.awx.tower_schedule_rrule', 'none', start_date='1979-09-13 03:45:07') }}"
msg: "{{ query('awx.awx.schedule_rrule', 'none', start_date='1979-09-13 03:45:07') }}"
"""
RETURN = """
@@ -233,7 +233,7 @@ class LookupModule(LookupBase):
my_rule = rrule.rrule(**rrule_kwargs)
# All frequencies can use a timezone but rrule can't support the format that Tower uses.
# All frequencies can use a timezone but rrule can't support the format that AWX uses.
# So we will do a string manip here if we need to
timezone = 'America/New_York'
if 'timezone' in kwargs:
@@ -243,7 +243,7 @@ class LookupModule(LookupBase):
# rrule puts a \n in the rule instad of a space and can't handle timezones
return_rrule = str(my_rule).replace('\n', ' ').replace('DTSTART:', 'DTSTART;TZID={0}:'.format(timezone))
# Tower requires an interval. rrule will not add interval if it's set to 1
# AWX requires an interval. rrule will not add interval if it's set to 1
if kwargs.get('every', 1) == 1:
return_rrule = "{0};INTERVAL=1".format(return_rrule)

22
awx_collection/plugins/module_utils/controller_api.py
View File

@@ -21,7 +21,7 @@ class ControllerAPIModule(ControllerModule):
# Those values can be found in awx/api/generics.py line 204
collection_to_version = {
'awx': 'AWX',
'tower': 'Red Hat Automation Controller',
'controller': 'Red Hat Automation Platform Controller',
}
session = None
IDENTITY_FIELDS = {'users': 'username', 'workflow_job_template_nodes': 'identifier', 'instances': 'hostname'}
@@ -190,7 +190,7 @@ class ControllerAPIModule(ControllerModule):
# Extract the headers, this will be used in a couple of places
headers = kwargs.get('headers', {})
# Authenticate to Tower (if we don't have a token and if not already done so)
# Authenticate to AWX (if we don't have a token and if not already done so)
if not self.oauth_token and not self.authenticated:
# This method will set a cookie in the cookie jar for us and also an oauth_token
self.authenticate(**kwargs)
@@ -218,7 +218,7 @@ class ControllerAPIModule(ControllerModule):
self.fail_json(msg='The host sent back a server error ({1}): {0}. Please check the logs and try again later'.format(url.path, he))
# Sanity check: Did we fail to authenticate properly? If so, fail out now; this is always a failure.
elif he.code == 401:
self.fail_json(msg='Invalid Tower authentication credentials for {0} (HTTP 401).'.format(url.path))
self.fail_json(msg='Invalid authentication credentials for {0} (HTTP 401).'.format(url.path))
# Sanity check: Did we get a forbidden response, which means that the user isn't allowed to do this? Report that.
elif he.code == 403:
self.fail_json(msg="You don't have permission to {1} to {0} (HTTP 403).".format(url.path, method))
@@ -232,7 +232,7 @@ class ControllerAPIModule(ControllerModule):
# A 405 means we used a method that isn't allowed. Usually this is a bad request, but it requires special treatment because the
# API sends it as a logic error in a few situations (e.g. trying to cancel a job that isn't running).
elif he.code == 405:
self.fail_json(msg="The Tower server says you can't make a request with the {0} method to this endpoint {1}".format(method, url.path))
self.fail_json(msg="Cannot make a request with the {0} method to this endpoint {1}".format(method, url.path))
# Sanity check: Did we get some other kind of error? If so, write an appropriate error message.
elif he.code >= 400:
# We are going to return a 400 so the module can decide what to do with it
@@ -302,7 +302,7 @@ class ControllerAPIModule(ControllerModule):
# Attempt to get a token from /api/v2/tokens/ by giving it our username/password combo
# If we have a username and password, we need to get a session cookie
login_data = {
"description": "Automation Controller Module Token",
"description": "Automation Platform Controller Module Token",
"application": None,
"scope": "write",
}
@@ -349,8 +349,8 @@ class ControllerAPIModule(ControllerModule):
# the on_delete parameter will be called as a method pasing in this object and the json from the response
# This will return one of two things:
# 1. None if the existing_item is not defined (so no delete needs to happen)
# 2. The response from Tower from calling the delete on the endpont. It's up to you to process the response and exit from the module
# Note: common error codes from the Tower API can cause the module to fail
# 2. The response from AWX from calling the delete on the endpont. It's up to you to process the response and exit from the module
# Note: common error codes from the AWX API can cause the module to fail
if existing_item:
# If we have an item, we can try to delete it
try:
@@ -472,8 +472,8 @@ class ControllerAPIModule(ControllerModule):
# the on_create parameter will be called as a method pasing in this object and the json from the response
# This will return one of two things:
# 1. None if the existing_item is already defined (so no create needs to happen)
# 2. The response from Tower from calling the patch on the endpont. It's up to you to process the response and exit from the module
# Note: common error codes from the Tower API can cause the module to fail
# 2. The response from AWX from calling the patch on the endpont. It's up to you to process the response and exit from the module
# Note: common error codes from the AWX API can cause the module to fail
response = None
if not endpoint:
self.fail_json(msg="Unable to create new {0} due to missing endpoint".format(item_type))
@@ -595,8 +595,8 @@ class ControllerAPIModule(ControllerModule):
# the on_update parameter will be called as a method pasing in this object and the json from the response
# This will return one of two things:
# 1. None if the existing_item does not need to be updated
# 2. The response from Tower from patching to the endpoint. It's up to you to process the response and exit from the module.
# Note: common error codes from the Tower API can cause the module to fail
# 2. The response from AWX from patching to the endpoint. It's up to you to process the response and exit from the module.
# Note: common error codes from the AWX API can cause the module to fail
response = None
if existing_item:

2
awx_collection/plugins/module_utils/tower_legacy.py
View File

@@ -83,7 +83,7 @@ def tower_auth_config(module):
def tower_check_mode(module):
'''Execute check mode logic for Automation Controller modules'''
'''Execute check mode logic for Automation Platform Controller modules'''
if module.check_mode:
try:
result = client.get('/ping').json()

6
awx_collection/plugins/modules/ad_hoc_command.py
View File

@@ -17,9 +17,9 @@ DOCUMENTATION = '''
module: ad_hoc_command
author: "John Westcott IV (@john-westcott-iv)"
version_added: "4.0"
short_description: create, update, or destroy Automation Controller ad hoc commands.
short_description: create, update, or destroy Automation Platform Controller ad hoc commands.
description:
- Create, update, or destroy Automation Controller ad hoc commands. See
- Create, update, or destroy Automation Platform Controller ad hoc commands. See
U(https://www.ansible.com/tower) for an overview.
options:
job_type:
@@ -84,7 +84,7 @@ options:
type: bool
interval:
description:
- The interval to request an update from Tower.
- The interval to request an update from the controller.
default: 1
type: float
timeout:

8
awx_collection/plugins/modules/ad_hoc_command_cancel.py
View File

@@ -16,9 +16,9 @@ DOCUMENTATION = '''
---
module: ad_hoc_command_cancel
author: "John Westcott IV (@john-westcott-iv)"
short_description: Cancel an Automation Controller Ad Hoc Command.
short_description: Cancel an Ad Hoc Command.
description:
- Cancel Automation Controller ad hoc command. See
- Cancel ad hoc command. See
U(https://www.ansible.com/tower) for an overview.
options:
command_id:
@@ -33,14 +33,14 @@ options:
type: bool
interval:
description:
- The interval in seconds, to request an update from Tower.
- The interval in seconds, to request an update from .
required: False
default: 1
type: float
timeout:
description:
- Maximum time in seconds to wait for a job to finish.
- Not specifying means the task will wait until Tower cancels the command.
- Not specifying means the task will wait until the controller cancels the command.
type: int
extends_documentation_fragment: awx.awx.auth
'''

8
awx_collection/plugins/modules/ad_hoc_command_wait.py
View File

@@ -16,9 +16,9 @@ DOCUMENTATION = '''
---
module: ad_hoc_command_wait
author: "John Westcott IV (@john-westcott-iv)"
short_description: Wait for Automation Controller Ad Hoc Command to finish.
short_description: Wait for Automation Platform Controller Ad Hoc Command to finish.
description:
- Wait for Automation Controller ad hoc command to finish and report success or failure. See
- Wait for Automation Platform Controller ad hoc command to finish and report success or failure. See
U(https://www.ansible.com/tower) for an overview.
options:
command_id:
@@ -28,7 +28,7 @@ options:
type: int
interval:
description:
- The interval in sections, to request an update from Tower.
- The interval in sections, to request an update from the controller.
required: False
default: 1
type: float
@@ -112,7 +112,7 @@ def main():
)
if command is None:
module.fail_json(msg='Unable to wait on ad hoc command {0}; that ID does not exist in Tower.'.format(command_id))
module.fail_json(msg='Unable to wait on ad hoc command {0}; that ID does not exist.'.format(command_id))
# Invoke wait function
module.wait_on_url(url=command['url'], object_name=command_id, object_type='ad hoc command', timeout=timeout, interval=interval)

4
awx_collection/plugins/modules/application.py
View File

@@ -16,9 +16,9 @@ DOCUMENTATION = '''
---
module: application
author: "Geoffrey Bacheot (@jffz)"
short_description: create, update, or destroy Automation Controller applications
short_description: create, update, or destroy Automation Platform Controller applications
description:
- Create, update, or destroy Automation Controller applications. See
- Create, update, or destroy Automation Platform Controller applications. See
U(https://www.ansible.com/tower) for an overview.
options:
name:

20
awx_collection/plugins/modules/credential.py
View File

@@ -16,9 +16,9 @@ DOCUMENTATION = '''
---
module: credential
author: "Wayne Witzel III (@wwitzel3)"
short_description: create, update, or destroy Automation Controller credential.
short_description: create, update, or destroy Automation Platform Controller credential.
description:
- Create, update, or destroy Automation Controller credentials. See
- Create, update, or destroy Automation Platform Controller credentials. See
U(https://www.ansible.com/tower) for an overview.
options:
name:
@@ -56,7 +56,7 @@ options:
description:
- >-
Credential inputs where the keys are var names used in templating.
Refer to the Automation Controller documentation for example syntax.
Refer to the Automation Platform Controller documentation for example syntax.
- Any fields in this dict will take prescedence over any fields mentioned below (i.e. host, username, etc)
type: dict
update_secrets:
@@ -96,7 +96,7 @@ options:
password:
description:
- Password for this credential. ``secret_key`` for AWS. ``api_key`` for RAX.
- Use "ASK" and launch in Tower to be prompted.
- Use "ASK" and launch job to be prompted.
- Deprecated, please use inputs
type: str
project:
@@ -112,7 +112,7 @@ options:
ssh_key_unlock:
description:
- Unlock password for ssh_key.
- Use "ASK" and launch in Tower to be prompted.
- Use "ASK" and launch job to be prompted.
- Deprecated, please use inputs
type: str
authorize:
@@ -166,19 +166,19 @@ options:
become_username:
description:
- Become username.
- Use "ASK" and launch in Tower to be prompted.
- Use "ASK" and launch job to be prompted.
- Deprecated, please use inputs
type: str
become_password:
description:
- Become password.
- Use "ASK" and launch in Tower to be prompted.
- Use "ASK" and launch job to be prompted.
- Deprecated, please use inputs
type: str
vault_password:
description:
- Vault password.
- Use "ASK" and launch in Tower to be prompted.
- Use "ASK" and launch job to be prompted.
- Deprecated, please use inputs
type: str
vault_id:
@@ -203,7 +203,7 @@ notes:
EXAMPLES = '''
- name: Add tower machine credential
- name: Add machine credential
credential:
name: Team Name
description: Team Description
@@ -229,7 +229,7 @@ EXAMPLES = '''
src: '$HOME/.ssh/aws-private.pem'
register: aws_ssh_key
- name: Add Credential Into Tower
- name: Add Credential
credential:
name: Workshop Credential
credential_type: Machine

4
awx_collection/plugins/modules/credential_input_source.py
View File

@@ -17,9 +17,9 @@ DOCUMENTATION = '''
module: credential_input_source
author: "Tom Page (@Tompage1994)"
version_added: "2.3"
short_description: create, update, or destroy Automation Controller credential input sources.
short_description: create, update, or destroy Automation Platform Controller credential input sources.
description:
- Create, update, or destroy Automation Controller credential input sources. See
- Create, update, or destroy Automation Platform Controller credential input sources. See
U(https://www.ansible.com/tower) for an overview.
options:
description:

10
awx_collection/plugins/modules/credential_type.py
View File

@@ -17,9 +17,9 @@ DOCUMENTATION = '''
---
module: credential_type
author: "Adrien Fleury (@fleu42)"
short_description: Create, update, or destroy custom Automation Controller credential type.
short_description: Create, update, or destroy custom Automation Platform Controller credential type.
description:
- Create, update, or destroy Automation Controller credential type. See
- Create, update, or destroy Automation Platform Controller credential type. See
U(https://www.ansible.com/tower) for an overview.
options:
name:
@@ -42,14 +42,14 @@ options:
inputs:
description:
- >-
Enter inputs using either JSON or YAML syntax. Refer to the Ansible
Tower documentation for example syntax.
Enter inputs using either JSON or YAML syntax. Refer to the
Automation Platform Controler documentation for example syntax.
type: dict
injectors:
description:
- >-
Enter injectors using either JSON or YAML syntax. Refer to the
Automation Controller documentation for example syntax.
Automation Platform Controller documentation for example syntax.
type: dict
state:
description:

6
awx_collection/plugins/modules/execution_environment.py
View File

@@ -16,9 +16,9 @@ DOCUMENTATION = '''
---
module: execution_environment
author: "Shane McDonald (@shanemcd)"
short_description: create, update, or destroy Execution Environments in Automation Controller.
short_description: create, update, or destroy Execution Environments in Automation Platform Controller.
description:
- Create, update, or destroy Execution Environments in Automation Controller. See
- Create, update, or destroy Execution Environments in Automation Platform Controller. See
U(https://www.ansible.com/tower) for an overview.
options:
name:
@@ -60,7 +60,7 @@ extends_documentation_fragment: awx.awx.auth
EXAMPLES = '''
- name: Add EE to Tower
- name: Add EE to the controller instance
execution_environment:
name: "My EE"
image: quay.io/ansible/awx-ee

8
awx_collection/plugins/modules/export.py
View File

@@ -17,9 +17,9 @@ DOCUMENTATION = '''
module: export
author: "John Westcott IV (@john-westcott-iv)"
version_added: "3.7"
short_description: export resources from Automation Controller.
short_description: export resources from Automation Platform Controller.
description:
- Export assets from Automation Controller.
- Export assets from Automation Platform Controller.
options:
all:
description:
@@ -82,7 +82,7 @@ extends_documentation_fragment: awx.awx.auth
'''
EXAMPLES = '''
- name: Export all tower assets
- name: Export all assets
export:
all: True
@@ -124,7 +124,7 @@ def main():
if not HAS_EXPORTABLE_RESOURCES:
module.fail_json(msg="Your version of awxkit does not have import/export")
# The export process will never change a Tower system
# The export process will never change the AWX system
module.json_output['changed'] = False
# The exporter code currently works like the following:

12
awx_collection/plugins/modules/group.py
View File

@@ -16,9 +16,9 @@ DOCUMENTATION = '''
---
module: group
author: "Wayne Witzel III (@wwitzel3)"
short_description: create, update, or destroy Automation Controller group.
short_description: create, update, or destroy Automation Platform Controller group.
description:
- Create, update, or destroy Automation Controller groups. See
- Create, update, or destroy Automation Platform Controller groups. See
U(https://www.ansible.com/tower) for an overview.
options:
name:
@@ -53,12 +53,12 @@ options:
- groups
preserve_existing_hosts:
description:
- Provide option (False by default) to preserves existing hosts in an existing group in tower.
- Provide option (False by default) to preserves existing hosts in an existing group.
default: False
type: bool
preserve_existing_children:
description:
- Provide option (False by default) to preserves existing children in an existing group in tower.
- Provide option (False by default) to preserves existing children in an existing group.
default: False
type: bool
aliases:
@@ -78,7 +78,7 @@ extends_documentation_fragment: awx.awx.auth
EXAMPLES = '''
- name: Add tower group
- name: Add group
group:
name: localhost
description: "Local Host Group"
@@ -86,7 +86,7 @@ EXAMPLES = '''
state: present
tower_config_file: "~/tower_cli.cfg"
- name: Add tower group
- name: Add group
group:
name: Cities
description: "Local Host Group"

6
awx_collection/plugins/modules/host.py
View File

@@ -16,9 +16,9 @@ DOCUMENTATION = '''
---
module: host
author: "Wayne Witzel III (@wwitzel3)"
short_description: create, update, or destroy Automation Controller host.
short_description: create, update, or destroy Automation Platform Controller host.
description:
- Create, update, or destroy Automation Controller hosts. See
- Create, update, or destroy Automation Platform Controller hosts. See
U(https://www.ansible.com/tower) for an overview.
options:
name:
@@ -59,7 +59,7 @@ extends_documentation_fragment: awx.awx.auth
EXAMPLES = '''
- name: Add tower host
- name: Add host
host:
name: localhost
description: "Local Host Group"

8
awx_collection/plugins/modules/import.py
View File

@@ -17,15 +17,15 @@ DOCUMENTATION = '''
module: import
author: "John Westcott (@john-westcott-iv)"
version_added: "3.7"
short_description: import resources into Automation Controller.
short_description: import resources into Automation Platform Controller.
description:
- Import assets into Automation Controller. See
- Import assets into Automation Platform Controller. See
U(https://www.ansible.com/tower) for an overview.
options:
assets:
description:
- The assets to import.
- This can be the output of tower_export or loaded from a file
- This can be the output of the export module or loaded from a file
required: True
type: dict
requirements:
@@ -39,7 +39,7 @@ EXAMPLES = '''
all: True
register: export_output
- name: Import all tower assets from our export
- name: Import all assets from our export
import:
assets: "{{ export_output.assets }}"

4
awx_collection/plugins/modules/instance_group.py
View File

@@ -17,9 +17,9 @@ DOCUMENTATION = '''
module: instance_group
author: "John Westcott IV (@john-westcott-iv)"
version_added: "4.0"
short_description: create, update, or destroy Automation Controller instance groups.
short_description: create, update, or destroy Automation Platform Controller instance groups.
description:
- Create, update, or destroy Automation Controller instance groups. See
- Create, update, or destroy Automation Platform Controller instance groups. See
U(https://www.ansible.com/tower) for an overview.
options:
name:

8
awx_collection/plugins/modules/inventory.py
View File

@@ -16,9 +16,9 @@ DOCUMENTATION = '''
---
module: inventory
author: "Wayne Witzel III (@wwitzel3)"
short_description: create, update, or destroy Automation Controller inventory.
short_description: create, update, or destroy Automation Platform Controller inventory.
description:
- Create, update, or destroy Automation Controller inventories. See
- Create, update, or destroy Automation Platform Controller inventories. See
U(https://www.ansible.com/tower) for an overview.
options:
name:
@@ -77,7 +77,7 @@ extends_documentation_fragment: awx.awx.auth
EXAMPLES = '''
- name: Add tower inventory
- name: Add inventory
inventory:
name: "Foo Inventory"
description: "Our Foo Cloud Servers"
@@ -85,7 +85,7 @@ EXAMPLES = '''
state: present
tower_config_file: "~/tower_cli.cfg"
- name: Copy tower inventory
- name: Copy inventory
inventory:
name: Copy Foo Inventory
copy_from: Default Inventory

6
awx_collection/plugins/modules/inventory_source.py
View File

@@ -16,9 +16,9 @@ DOCUMENTATION = '''
---
module: inventory_source
author: "Adrien Fleury (@fleu42)"
short_description: create, update, or destroy Automation Controller inventory source.
short_description: create, update, or destroy Automation Platform Controller inventory source.
description:
- Create, update, or destroy Automation Controller inventory source. See
- Create, update, or destroy Automation Platform Controller inventory source. See
U(https://www.ansible.com/tower) for an overview.
options:
name:
@@ -162,7 +162,7 @@ def main():
description=dict(),
inventory=dict(required=True),
#
# How do we handle manual and file? Tower does not seem to be able to activate them
# How do we handle manual and file? The controller does not seem to be able to activate them
#
source=dict(choices=["scm", "ec2", "gce", "azure_rm", "vmware", "satellite6", "openstack", "rhv", "tower"]),
source_path=dict(),

4
awx_collection/plugins/modules/inventory_source_update.py
View File

@@ -18,7 +18,7 @@ module: inventory_source_update
author: "Bianca Henderson (@beeankha)"
short_description: Update inventory source(s).
description:
- Update Automation Controller inventory source(s). See
- Update Automation Platform Controller inventory source(s). See
U(https://www.ansible.com/tower) for an overview.
options:
name:
@@ -44,7 +44,7 @@ options:
type: bool
interval:
description:
- The interval to request an update from Tower.
- The interval to request an update from the controller.
required: False
default: 1
type: float

6
awx_collection/plugins/modules/job_cancel.py
View File

@@ -16,9 +16,9 @@ DOCUMENTATION = '''
---
module: job_cancel
author: "Wayne Witzel III (@wwitzel3)"
short_description: Cancel an Automation Controller Job.
short_description: Cancel an Automation Platform Controller Job.
description:
- Cancel Automation Controller jobs. See
- Cancel Automation Platform Controller jobs. See
U(https://www.ansible.com/tower) for an overview.
options:
job_id:
@@ -81,7 +81,7 @@ def main():
cancel_page = module.get_endpoint(job['related']['cancel'])
if 'json' not in cancel_page or 'can_cancel' not in cancel_page['json']:
module.fail_json(msg="Failed to cancel job, got unexpected response from tower", **{'response': cancel_page})
module.fail_json(msg="Failed to cancel job, got unexpected response from the controller", **{'response': cancel_page})
if not cancel_page['json']['can_cancel']:
if fail_if_not_running:

8
awx_collection/plugins/modules/job_launch.py
View File

@@ -18,7 +18,7 @@ module: job_launch
author: "Wayne Witzel III (@wwitzel3)"
short_description: Launch an Ansible Job.
description:
- Launch an Automation Controller jobs. See
- Launch an Automation Platform Controller jobs. See
U(https://www.ansible.com/tower) for an overview.
options:
name:
@@ -51,7 +51,7 @@ options:
extra_vars:
description:
- extra_vars to use for the Job Template.
- ask_extra_vars needs to be set to True via tower_job_template module
- ask_extra_vars needs to be set to True via job_template module
when creating the Job Template.
type: dict
limit:
@@ -93,7 +93,7 @@ options:
type: bool
interval:
description:
- The interval to request an update from Tower.
- The interval to request an update from the controller.
required: False
default: 1
type: float
@@ -111,7 +111,7 @@ EXAMPLES = '''
job_template: "My Job Template"
register: job
- name: Launch a job template with extra_vars on remote Tower instance
- name: Launch a job template with extra_vars on remote controller instance
job_launch:
job_template: "My Job Template"
extra_vars:

4
awx_collection/plugins/modules/job_list.py
View File

@@ -16,9 +16,9 @@ DOCUMENTATION = '''
---
module: job_list
author: "Wayne Witzel III (@wwitzel3)"
short_description: List Automation Controller jobs.
short_description: List Automation Platform Controller jobs.
description:
- List Automation Controller jobs. See
- List Automation Platform Controller jobs. See
U(https://www.ansible.com/tower) for an overview.
options:
status:

12
awx_collection/plugins/modules/job_template.py
View File

@@ -16,9 +16,9 @@ DOCUMENTATION = '''
---
module: job_template
author: "Wayne Witzel III (@wwitzel3)"
short_description: create, update, or destroy Automation Controller job templates.
short_description: create, update, or destroy Automation Platform Controller job templates.
description:
- Create, update, or destroy Automation Controller job templates. See
- Create, update, or destroy Automation Platform Controller job templates. See
U(https://www.ansible.com/tower) for an overview.
options:
name:
@@ -57,7 +57,7 @@ options:
- Used to help lookup the object, cannot be modified using this module.
- The Organization is inferred from the associated project
- If not provided, will lookup by name only, which does not work with duplicates.
- Requires Tower Version 3.7.0 or AWX 10.0.0 IS NOT backwards compatible with earlier versions.
- Requires Automation Platform Version 3.7.0 or AWX 10.0.0 IS NOT backwards compatible with earlier versions.
type: str
project:
description:
@@ -297,14 +297,14 @@ options:
extends_documentation_fragment: awx.awx.auth
notes:
- JSON for survey_spec can be found in Tower API Documentation. See
- JSON for survey_spec can be found in the API Documentation. See
U(https://docs.ansible.com/ansible-tower/latest/html/towerapi/api_ref.html#/Job_Templates/Job_Templates_job_templates_survey_spec_create)
for POST operation payload example.
'''
EXAMPLES = '''
- name: Create Tower Ping job template
- name: Create Ping job template
job_template:
name: "Ping"
job_type: "run"
@@ -534,7 +534,7 @@ def main():
}
)
if project_data is None:
module.fail_json(msg="The project {0} in organization {1} was not found on the Tower server".format(project, organization))
module.fail_json(msg="The project {0} in organization {1} was not found on the controller instance server".format(project, organization))
new_fields['project'] = project_data['id']
else:
new_fields['project'] = module.resolve_name_to_id('projects', project)

12
awx_collection/plugins/modules/job_wait.py
View File

@@ -16,9 +16,9 @@ DOCUMENTATION = '''
---
module: job_wait
author: "Wayne Witzel III (@wwitzel3)"
short_description: Wait for Automation Controller job to finish.
short_description: Wait for Automation Platform Controller job to finish.
description:
- Wait for Automation Controller job to finish and report success or failure. See
- Wait for Automation Platform Controller job to finish and report success or failure. See
U(https://www.ansible.com/tower) for an overview.
options:
job_id:
@@ -28,19 +28,19 @@ options:
type: int
interval:
description:
- The interval in sections, to request an update from Tower.
- The interval in sections, to request an update from the controller.
- For backwards compatibility if unset this will be set to the average of min and max intervals
required: False
default: 1
type: float
min_interval:
description:
- Minimum interval in seconds, to request an update from Tower.
- Minimum interval in seconds, to request an update from the controller.
- deprecated, use interval instead
type: float
max_interval:
description:
- Maximum interval in seconds, to request an update from Tower.
- Maximum interval in seconds, to request an update from the controller.
- deprecated, use interval instead
type: float
timeout:
@@ -147,7 +147,7 @@ def main():
)
if job is None:
module.fail_json(msg='Unable to wait on ' + job_type.rstrip("s") + ' {0}; that ID does not exist in Tower.'.format(job_id))
module.fail_json(msg='Unable to wait on ' + job_type.rstrip("s") + ' {0}; that ID does not exist.'.format(job_id))
# Invoke wait function
result = module.wait_on_url(url=job['url'], object_name=job_id, object_type='legacy_job_wait', timeout=timeout, interval=interval)

8
awx_collection/plugins/modules/label.py
View File

@@ -16,11 +16,11 @@ DOCUMENTATION = '''
---
module: label
author: "Wayne Witzel III (@wwitzel3)"
short_description: create, update, or destroy Automation Controller labels.
short_description: create, update, or destroy Automation Platform Controller labels.
description:
- Create, update, or destroy Automation Controller labels. See
- Create, update, or destroy Automation Platform Controller labels. See
U(https://www.ansible.com/tower) for an overview.
- Note, labels can only be created via the Tower API, they can not be deleted.
- Note, labels can only be created via the API, they can not be deleted.
Once they are fully disassociated the API will clean them up on its own.
options:
name:
@@ -47,7 +47,7 @@ extends_documentation_fragment: awx.awx.auth
'''
EXAMPLES = '''
- name: Add label to tower organization
- name: Add label to organization
label:
name: Custom Label
organization: My Organization

4
awx_collection/plugins/modules/license.py
View File

@@ -15,9 +15,9 @@ DOCUMENTATION = '''
---
module: license
author: "John Westcott IV (@john-westcott-iv)"
short_description: Set the license for Automation Controller
short_description: Set the license for Automation Platform Controller
description:
- Get or Set Automation Controller license. See
- Get or Set Automation Platform Controller license. See
U(https://www.ansible.com/tower) for an overview.
options:
manifest:

4
awx_collection/plugins/modules/notification_template.py
View File

@@ -16,9 +16,9 @@ DOCUMENTATION = '''
---
module: notification_template
author: "Samuel Carpentier (@samcarpentier)"
short_description: create, update, or destroy Automation Controller notification.
short_description: create, update, or destroy Automation Platform Controller notification.
description:
- Create, update, or destroy Automation Controller notifications. See
- Create, update, or destroy Automation Platform Controller notifications. See
U(https://www.ansible.com/tower) for an overview.
options:
name:

10
awx_collection/plugins/modules/organization.py
View File

@@ -16,9 +16,9 @@ DOCUMENTATION = '''
---
module: organization
author: "Wayne Witzel III (@wwitzel3)"
short_description: create, update, or destroy Automation Controller organizations
short_description: create, update, or destroy Automation Platform Controller organizations
description:
- Create, update, or destroy Automation Controller organizations. See
- Create, update, or destroy Automation Platform Controller organizations. See
U(https://www.ansible.com/tower) for an overview.
options:
name:
@@ -86,21 +86,21 @@ extends_documentation_fragment: awx.awx.auth
EXAMPLES = '''
- name: Create tower organization
- name: Create organization
organization:
name: "Foo"
description: "Foo bar organization"
state: present
tower_config_file: "~/tower_cli.cfg"
- name: Create tower organization using 'foo-venv' as default Python virtualenv
- name: Create organization using 'foo-venv' as default Python virtualenv
organization:
name: "Foo"
description: "Foo bar organization using foo-venv"
state: present
tower_config_file: "~/tower_cli.cfg"
- name: Create tower organization that pulls content from galaxy.ansible.com
- name: Create organization that pulls content from galaxy.ansible.com
organization:
name: "Foo"
state: present

12
awx_collection/plugins/modules/project.py
View File

@@ -16,9 +16,9 @@ DOCUMENTATION = '''
---
module: project
author: "Wayne Witzel III (@wwitzel3)"
short_description: create, update, or destroy Automation Controller projects
short_description: create, update, or destroy Automation Platform Controller projects
description:
- Create, update, or destroy Automation Controller projects. See
- Create, update, or destroy Automation Platform Controller projects. See
U(https://www.ansible.com/tower) for an overview.
options:
name:
@@ -160,7 +160,7 @@ options:
type: bool
interval:
description:
- The interval to request an update from Tower.
- The interval to request an update from the controller.
- Requires wait.
required: False
default: 1
@@ -170,7 +170,7 @@ extends_documentation_fragment: awx.awx.auth
EXAMPLES = '''
- name: Add tower project
- name: Add project
project:
name: "Foo"
description: "Foo bar project"
@@ -178,7 +178,7 @@ EXAMPLES = '''
state: present
tower_config_file: "~/tower_cli.cfg"
- name: Add Tower Project with cache timeout
- name: Add Project with cache timeout
project:
name: "Foo"
description: "Foo bar project"
@@ -188,7 +188,7 @@ EXAMPLES = '''
state: present
tower_config_file: "~/tower_cli.cfg"
- name: Copy tower project
- name: Copy project
project:
name: copy
copy_from: test

6
awx_collection/plugins/modules/project_update.py
View File

@@ -13,9 +13,9 @@ DOCUMENTATION = '''
---
module: project_update
author: "Sean Sullivan (@sean-m-sullivan)"
short_description: Update a Project in Automation Controller
short_description: Update a Project in Automation Platform Controller
description:
- Update a Automation Controller Project. See
- Update a Automation Platform Controller Project. See
U(https://www.ansible.com/tower) for an overview.
options:
name:
@@ -39,7 +39,7 @@ options:
type: bool
interval:
description:
- The interval to request an update from Tower.
- The interval to request an update from the controller.
required: False
default: 1
type: float

6
awx_collection/plugins/modules/receive.py
View File

@@ -20,9 +20,9 @@ deprecated:
why: Deprecated in favor of upcoming C(_export) module.
alternative: Once published, use M(tower_export) instead.
author: "John Westcott IV (@john-westcott-iv)"
short_description: Receive assets from Automation Controller.
short_description: Receive assets from Automation Platform Controller.
description:
- Receive assets from Automation Controller. See
- Receive assets from Automation Platform Controller. See
U(https://www.ansible.com/tower) for an overview.
options:
all:
@@ -101,7 +101,7 @@ extends_documentation_fragment: awx.awx.auth_legacy
'''
EXAMPLES = '''
- name: Export all tower assets
- name: Export all Automation Platform Controller assets
receive:
all: True
tower_config_file: "~/tower_cli.cfg"

4
awx_collection/plugins/modules/role.py
View File

@@ -16,10 +16,10 @@ DOCUMENTATION = '''
---
module: role
author: "Wayne Witzel III (@wwitzel3)"
short_description: grant or revoke an Automation Controller role.
short_description: grant or revoke an Automation Platform Controller role.
description:
- Roles are used for access control, this module is for managing user access to server resources.
- Grant or revoke Automation Controller roles to users. See U(https://www.ansible.com/tower) for an overview.
- Grant or revoke Automation Platform Controller roles to users. See U(https://www.ansible.com/tower) for an overview.
options:
user:
description:

6
awx_collection/plugins/modules/schedule.py
View File

@@ -16,9 +16,9 @@ DOCUMENTATION = '''
---
module: schedule
author: "John Westcott IV (@john-westcott-iv)"
short_description: create, update, or destroy Automation Controller schedules.
short_description: create, update, or destroy Automation Platform Controller schedules.
description:
- Create, update, or destroy Automation Controller schedules. See
- Create, update, or destroy Automation Platform Controller schedules. See
U(https://www.ansible.com/tower) for an overview.
options:
rrule:
@@ -131,7 +131,7 @@ EXAMPLES = '''
name: "{{ sched1 }}"
state: present
unified_job_template: "Demo Job Template"
rrule: "{{ query('awx.awx.tower_schedule_rrule', 'week', start_date='2019-12-19 13:05:51') }}"
rrule: "{{ query('awx.awx.schedule_rrule', 'week', start_date='2019-12-19 13:05:51') }}"
register: result
'''

6
awx_collection/plugins/modules/send.py
View File

@@ -20,9 +20,9 @@ deprecated:
why: Deprecated in favor of upcoming C(_import) module.
alternative: Once published, use M(tower_import) instead.
author: "John Westcott IV (@john-westcott-iv)"
short_description: Send assets to Automation Controller.
short_description: Send assets to Automation Platform Controller.
description:
- Send assets to Automation Controller. See
- Send assets to Automation Platform Controller. See
U(https://www.ansible.com/tower) for an overview.
options:
assets:
@@ -62,7 +62,7 @@ extends_documentation_fragment: awx.awx.auth_legacy
'''
EXAMPLES = '''
- name: Import all tower assets
- name: Import all Automation Platform Controller assets
send:
assets: "{{ export_output.assets }}"
tower_config_file: "~/tower_cli.cfg"

4
awx_collection/plugins/modules/settings.py
View File

@@ -16,9 +16,9 @@ DOCUMENTATION = '''
---
module: settings
author: "Nikhil Jain (@jainnikhil30)"
short_description: Modify Automation Controller settings.
short_description: Modify Automation Platform Controller settings.
description:
- Modify Automation Controller settings. See
- Modify Automation Platform Controller settings. See
U(https://www.ansible.com/tower) for an overview.
options:
name:

6
awx_collection/plugins/modules/team.py
View File

@@ -16,9 +16,9 @@ DOCUMENTATION = '''
---
module: team
author: "Wayne Witzel III (@wwitzel3)"
short_description: create, update, or destroy Automation Controller team.
short_description: create, update, or destroy Automation Platform Controller team.
description:
- Create, update, or destroy Automation Controller teams. See
- Create, update, or destroy Automation Platform Controller teams. See
U(https://www.ansible.com/tower) for an overview.
options:
name:
@@ -50,7 +50,7 @@ extends_documentation_fragment: awx.awx.auth
EXAMPLES = '''
- name: Create tower team
- name: Create team
team:
name: Team Name
description: Team Description

10
awx_collection/plugins/modules/token.py
View File

@@ -17,15 +17,15 @@ DOCUMENTATION = '''
module: token
author: "John Westcott IV (@john-westcott-iv)"
version_added: "2.3"
short_description: create, update, or destroy Automation Controller tokens.
short_description: create, update, or destroy Automation Platform Controller tokens.
description:
- Create or destroy Automation Controller tokens. See
- Create or destroy Automation Platform Controller tokens. See
U(https://www.ansible.com/tower) for an overview.
- In addition, the module sets an Ansible fact which can be passed into other
tower_* modules as the parameter tower_oauthtoken. See examples for usage.
controller modules as the parameter tower_oauthtoken. See examples for usage.
- Because of the sensitive nature of tokens, the created token value is only available once
through the Ansible fact. (See RETURN for details)
- Due to the nature of tokens in Tower this module is not idempotent. A second will
- Due to the nature of tokens this module is not idempotent. A second will
with the same parameters will create a new token.
- If you are creating a temporary token for use with modules you should delete the token
when you are done with it. See the example for how to do it.
@@ -105,7 +105,7 @@ EXAMPLES = '''
RETURN = '''
token:
type: dict
description: An Ansible Fact variable representing a Tower token object which can be used for auth in subsequent modules. See examples for usage.
description: An Ansible Fact variable representing a token object which can be used for auth in subsequent modules. See examples for usage.
contains:
token:
description: The token that was generated. This token can never be accessed again, make sure this value is noted before it is lost.

12
awx_collection/plugins/modules/user.py
View File

@@ -16,9 +16,9 @@ DOCUMENTATION = '''
---
module: user
author: "John Westcott IV (@john-westcott-iv)"
short_description: create, update, or destroy Automation Controller users.
short_description: create, update, or destroy Automation Platform Controller users.
description:
- Create, update, or destroy Automation Controller users. See
- Create, update, or destroy Automation Platform Controller users. See
U(https://www.ansible.com/tower) for an overview.
options:
username:
@@ -71,7 +71,7 @@ extends_documentation_fragment: awx.awx.auth
EXAMPLES = '''
- name: Add tower user
- name: Add user
user:
username: jdoe
password: foobarbaz
@@ -81,7 +81,7 @@ EXAMPLES = '''
state: present
tower_config_file: "~/tower_cli.cfg"
- name: Add tower user as a system administrator
- name: Add user as a system administrator
user:
username: jdoe
password: foobarbaz
@@ -90,7 +90,7 @@ EXAMPLES = '''
state: present
tower_config_file: "~/tower_cli.cfg"
- name: Add tower user as a system auditor
- name: Add user as a system auditor
user:
username: jdoe
password: foobarbaz
@@ -99,7 +99,7 @@ EXAMPLES = '''
state: present
tower_config_file: "~/tower_cli.cfg"
- name: Delete tower user
- name: Delete user
user:
username: jdoe
email: jdoe@example.org

2
awx_collection/plugins/modules/workflow_approval.py
View File

@@ -43,7 +43,7 @@ options:
type: str
interval:
description:
- The interval in sections, to request an update from Tower.
- The interval in sections, to request an update from the controller.
required: False
default: 1
type: float

6
awx_collection/plugins/modules/workflow_job_template.py
View File

@@ -16,11 +16,11 @@ DOCUMENTATION = '''
---
module: workflow_job_template
author: "John Westcott IV (@john-westcott-iv)"
short_description: create, update, or destroy Automation Controller workflow job templates.
short_description: create, update, or destroy Automation Platform Controller workflow job templates.
description:
- Create, update, or destroy Automation Controller workflow job templates.
- Create, update, or destroy Automation Platform Controller workflow job templates.
- Replaces the deprecated tower_workflow_template module.
- Use the tower_workflow_job_template_node after this, or use the schema parameter to build the workflow's graph
- Use workflow_job_template_node after this, or use the schema parameter to build the workflow's graph
options:
name:
description:

10
awx_collection/plugins/modules/workflow_job_template_node.py
View File

@@ -16,9 +16,9 @@ DOCUMENTATION = '''
---
module: workflow_job_template_node
author: "John Westcott IV (@john-westcott-iv)"
short_description: create, update, or destroy Automation Controller workflow job template nodes.
short_description: create, update, or destroy Automation Platform Controller workflow job template nodes.
description:
- Create, update, or destroy Automation Controller workflow job template nodes.
- Create, update, or destroy Automation Platform Controller workflow job template nodes.
- Use this to build a graph for a workflow, which dictates what the workflow runs.
- Replaces the deprecated tower_workflow_template module schema command.
- You can create nodes first, and link them afterwards, and not worry about ordering.
@@ -157,7 +157,7 @@ extends_documentation_fragment: awx.awx.auth
'''
EXAMPLES = '''
- name: Create a node, follows tower_workflow_job_template example
- name: Create a node, follows workflow_job_template example
workflow_job_template_node:
identifier: my-first-node
workflow: example-workflow
@@ -283,7 +283,9 @@ def main():
wfjt_search_fields['organization'] = organization_id
wfjt_data = module.get_one('workflow_job_templates', name_or_id=workflow_job_template, **{'data': wfjt_search_fields})
if wfjt_data is None:
module.fail_json(msg="The workflow {0} in organization {1} was not found on the Tower server".format(workflow_job_template, organization))
module.fail_json(
msg="The workflow {0} in organization {1} was not found on the controller instance server".format(workflow_job_template, organization)
)
workflow_job_template_id = wfjt_data['id']
search_fields['workflow_job_template'] = new_fields['workflow_job_template'] = workflow_job_template_id

6
awx_collection/plugins/modules/workflow_launch.py
View File

@@ -13,9 +13,9 @@ DOCUMENTATION = '''
---
module: workflow_launch
author: "John Westcott IV (@john-westcott-iv)"
short_description: Run a workflow in Automation Controller
short_description: Run a workflow in Automation Platform Controller
description:
- Launch an Automation Controller workflows. See
- Launch an Automation Platform Controller workflows. See
U(https://www.ansible.com/tower) for an overview.
options:
name:
@@ -55,7 +55,7 @@ options:
type: bool
interval:
description:
- The interval to request an update from Tower.
- The interval to request an update from the controller.
required: False
default: 1
type: float

2
awx_collection/plugins/modules/workflow_node_wait.py
View File

@@ -37,7 +37,7 @@ options:
type: str
interval:
description:
- The interval in sections, to request an update from Tower.
- The interval in sections, to request an update from the controller.
required: False
default: 1
type: float

4
awx_collection/plugins/modules/workflow_template.py
View File

@@ -20,7 +20,7 @@ deprecated:
why: Deprecated in favor of C(_workflow_job_template) and C(_workflow_job_template_node) modules.
alternative: Use M(tower_workflow_job_template) and M(_workflow_job_template_node) instead.
author: "Adrien Fleury (@fleu42)"
short_description: create, update, or destroy Automation Controller workflow template.
short_description: create, update, or destroy Automation Platform Controller workflow template.
description:
- A tower-cli based module for CRUD actions on workflow job templates.
- Enables use of the old schema functionality.
@@ -64,7 +64,7 @@ options:
description:
- >
The schema is a JSON- or YAML-formatted string defining the
hierarchy structure that connects the nodes. Refer to Tower
hierarchy structure that connects the nodes. Refer to the Automation Platform
documentation for more information.
type: list
elements: dict