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

Note

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

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

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

New in version 3.7.0: of awx.awx

Synopsis

  • Export assets from Automation Platform Controller.

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
controller_config_file
path
Path to the controller config file.
If provided, the other locations for config files will not be considered.

aliases: tower_config_file
controller_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

aliases: tower_host
controller_oauthtoken
raw
added in 3.7.0 of awx.awx
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

aliases: tower_oauthtoken
controller_password
string
Password for your controller instance.
If value not set, will try environment variable CONTROLLER_PASSWORD and then config files

aliases: tower_password
controller_username
string
Username for your controller instance.
If value not set, will try environment variable CONTROLLER_USERNAME and then config files

aliases: tower_username
credential_types
string
credential type name to export
credentials
string
credential name to export
execution_environments
string
execution environment 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
users
string
user name to export
validate_certs
boolean
    Choices:
  • no
  • yes
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

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 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_template: "My Template"
    credential: 'all'

Authors

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