awx.awx.tower_receive – Receive assets from Ansible Tower.

Note

This plugin is part of the awx.awx collection (version 17.1.0).

To install it use: ansible-galaxy collection install awx.awx.

To use it in a playbook, specify: awx.awx.tower_receive.

DEPRECATED

Removed in

version 14.0.0

Why

Deprecated in favor of upcoming _export module.

Alternative

Once published, use tower_export instead.

Synopsis

Requirements

The below requirements are needed on the host that executes this module.

  • ansible-tower-cli >= 3.3.0

Parameters

Parameter Choices/Defaults Comments
all
boolean
    Choices:
  • no
  • yes
Default:
"False"
Export all assets
credential
list / elements=string
Default:
[]
List of credential names to export
credential_type
list / elements=string
Default:
[]
List of credential type names to export
inventory
list / elements=string
Default:
[]
List of inventory names to export
inventory_script
list / elements=string
Default:
[]
List of inventory script names to export
job_template
list / elements=string
Default:
[]
List of job template names to export
notification_template
list / elements=string
Default:
[]
List of notification template names to export
organization
list / elements=string
Default:
[]
List of organization names to export
project
list / elements=string
Default:
[]
List of project names to export
team
list / elements=string
Default:
[]
List of team names to export
tower_config_file
path
Path to the Tower or AWX config file.
If provided, the other locations for config files will not be considered.
tower_host
string
URL to your Tower or AWX instance.
If value not set, will try environment variable TOWER_HOST and then config files
If value not specified by any means, the value of 127.0.0.1 will be used
tower_password
string
Password for your Tower or AWX instance.
If value not set, will try environment variable TOWER_PASSWORD and then config files
tower_username
string
Username for your Tower or AWX instance.
If value not set, will try environment variable TOWER_USERNAME and then config files
user
list / elements=string
Default:
[]
List of user names to export
validate_certs
boolean
    Choices:
  • no
  • yes
Whether to allow insecure connections to Tower or AWX.
If 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 TOWER_VERIFY_SSL and then config files

aliases: tower_verify_ssl
workflow
list / elements=string
Default:
[]
List of workflow names to export

Notes

Note

  • Specifying a name of “all” for any asset type will export all items of that asset type.

  • If no config_file is provided we will attempt to use the tower-cli library defaults to find your Tower host information.

  • config_file should contain Tower configuration in the following format host=hostname username=username password=password

Examples

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

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

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

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
assets
dictionary
success
The exported assets

Sample:
[{}, {}]


Status

  • This module will be removed in version 14.0.0. [deprecated]

  • For more information see DEPRECATED.

Authors

  • John Westcott IV (@john-westcott-iv)