ansible.builtin.tower_receive (v2.9.24) — module

Install Ansible via pip

Install with pip install ansible==2.9.24

Description

Receive assets from Ansible Tower. See U(https://www.ansible.com/tower) for an overview.

Requirements

• ansible-tower-cli >= 3.3.0

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Export all tower assets
  tower_receive:
    all: True
    tower_config_file: "~/tower_cli.cfg"

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Export all inventories
  tower_receive:
    inventory:
      - all

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Export a job template named "My Template" and all Credentials
  tower_receive:
    job_template:
      - "My Template"
    credential:
      - all

Inputs

    
all:
    default: 'False'
    description:
    - Export all assets
    type: bool

team:
    default: []
    description:
    - List of team names to export

user:
    default: []
    description:
    - List of user names to export

project:
    default: []
    description:
    - List of project names to export

workflow:
    default: []
    description:
    - List of workflow names to export

inventory:
    default: []
    description:
    - List of inventory names to export

credential:
    default: []
    description:
    - List of credential names to export

job_template:
    default: []
    description:
    - List of job template names to export

organization:
    default: []
    description:
    - List of organization names to export

validate_certs:
    aliases:
    - tower_verify_ssl
    description:
    - 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(CONTROLLER_VERIFY_SSL) and then
      config files
    type: bool

controller_host:
    aliases:
    - tower_host
    description:
    - URL to your Automation Platform Controller instance.
    - If value not set, will try environment variable C(CONTROLLER_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

credential_type:
    default: []
    description:
    - List of credential type names to export

inventory_script:
    default: []
    description:
    - List of inventory script names to export

controller_password:
    aliases:
    - tower_password
    description:
    - Password for your controller instance.
    - If value not set, will try environment variable C(CONTROLLER_PASSWORD) and then
      config files
    type: str

controller_username:
    aliases:
    - tower_username
    description:
    - Username for your controller instance.
    - If value not set, will try environment variable C(CONTROLLER_USERNAME) and then
      config files
    type: str

controller_oauthtoken:
    aliases:
    - tower_oauthtoken
    description:
    - 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 token module.
    - If value not set, will try environment variable C(CONTROLLER_OAUTH_TOKEN) and then
      config files
    type: raw
    version_added: 3.7.0
    version_added_collection: awx.awx

notification_template:
    default: []
    description:
    - List of notification template names to export

controller_config_file:
    aliases:
    - tower_config_file
    description:
    - Path to the controller config file.
    - If provided, the other locations for config files will not be considered.
    type: path

Outputs

assets:
  description: The exported assets
  returned: success
  sample:
  - {}
  - {}
  type: dict