W3cubDocs

/Ansible

awx.awx.export module – export resources from Automation Platform Controller.

Note

This module is part of the awx.awx collection (version 24.6.1).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install awx.awx. You need further requirements to be able to use this module, see Requirements for details.

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

New in awx.awx 3.7.0

Synopsis

  • Export assets from Automation Platform Controller.

Aliases: tower_export

Requirements

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

  • awxkit >= 9.3.0

Parameters

Parameter

Comments

all

boolean

Export all assets

Choices:

  • false ← (default)
  • true

applications

list / elements=string

OAuth2 application names, IDs, or named URLs to export

controller_config_file

aliases: tower_config_file

path

Path to the controller config file.

If provided, the other locations for config files will not be considered.

controller_host

aliases: tower_host

string

URL to your Automation Platform Controller instance.

If value not set, will try environment variable CONTROLLER_HOST and then config files

If value not specified by any means, the value of 127.0.0.1 will be used

controller_oauthtoken

aliases: tower_oauthtoken

any

added in awx.awx 3.7.0

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 CONTROLLER_OAUTH_TOKEN and then config files

controller_password

aliases: tower_password

string

Password for your controller instance.

If value not set, will try environment variable CONTROLLER_PASSWORD and then config files

controller_username

aliases: tower_username

string

Username for your controller instance.

If value not set, will try environment variable CONTROLLER_USERNAME and then config files

credential_types

list / elements=string

credential type names, IDs, or named URLs to export

credentials

list / elements=string

credential names, IDs, or named URLs to export

execution_environments

list / elements=string

execution environment names, IDs, or named URLs to export

inventory

list / elements=string

inventory names, IDs, or named URLs to export

inventory_sources

list / elements=string

inventory source name, ID, or named URLs to export

job_templates

list / elements=string

job template names, IDs, or named URLs to export

notification_templates

list / elements=string

notification template names, IDs, or named URLs to export

organizations

list / elements=string

organization names, IDs, or named URLs to export

projects

list / elements=string

project names, IDs, or named URLs to export

request_timeout

float

Specify the timeout Ansible should use in requests to the controller host.

Defaults to 10s, but this is handled by the shared module_utils code

schedules

list / elements=string

schedule names, IDs, or named URLs to export

teams

list / elements=string

team names, IDs, or named URLs to export

users

list / elements=string

user names, IDs, or named URLs to export

validate_certs

aliases: tower_verify_ssl

boolean

Whether to allow insecure connections to 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 CONTROLLER_VERIFY_SSL and then config files

Choices:

  • false
  • true

workflow_job_templates

list / elements=string

workflow names, IDs, or named URLs 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 host information.
  • config_file should be in the following format host=hostname username=username password=password

Examples

- name: Export all assets
  export:
    all: True

- name: Export all inventories
  export:
    inventory: 'all'

- name: Export a job template named "My Template" and all Credentials
  export:
    job_templates: "My Template"
    credentials: 'all'

- name: Export a list of inventories
  export:
    inventory: ['My Inventory 1', 'My Inventory 2']

Authors

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

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