Docs4dev
Docs
ansible / 2.10 / collections / awx / awx / tower_export_module.html

awx.awx.tower_export – export resources from Ansible Tower.

Note

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

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

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

New in version 3.7: of awx.awx

Synopsis

  • Export assets from Ansible Tower.

Requirements

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

  • awxkit >= 9.3.0

Parameters

Parameter Choices/Defaults Comments
all
boolean
    Choices:
  • no
  • yes
Default:
"False"
Export all assets
credential_types
string
credential type name to export
credentials
string
credential name to export
inventory
string
inventory name to export
inventory_sources
string
inventory soruce to export
job_templates
string
job template name to export
notification_templates
string
notification template name to export
organizations
string
organization name to export
projects
string
project name to export
teams
string
team name 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_oauthtoken
raw
added in 3.7 of awx.awx
The Tower 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.
If value not set, will try environment variable TOWER_OAUTH_TOKEN and then config files
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
users
string
user name 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_job_templates
string
workflow name 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_export:
    all: True
- name: Export all inventories
  tower_export:
    inventory: 'all'
- name: Export a job template named "My Template" and all Credentials
  tower_export:
    job_template: "My Template"
    credential: 'all'

Authors

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

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/awx/awx/tower_export_module.html