W3cubDocs

/Ansible

awx.awx.execution_environment module – create, update, or destroy Execution Environments in 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.

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

Synopsis
Parameters
Notes
Examples

Synopsis

Create, update, or destroy Execution Environments in Automation Platform Controller. See https://www.ansible.com/tower for an overview.

Aliases: tower_execution_environment

Parameters

Parameter	Comments
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 string	Name, ID, or named URL of the credential to use for the execution environment.
description string	Description to use for the execution environment.
image string	The fully qualified url of the container image.
name string / required	Name to use for the execution environment.
new_name string	Setting this option will change the existing name (looked up via the name field.
organization string	The organization name, ID, or named URL that the execution environment belongs to.
pull string	determine image pull behavior Choices: `"always"` `"missing"` ← (default) `"never"`
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
state string	Desired state of the resource. Choices: `"present"` ← (default) `"absent"` `"exists"`
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`

Notes

Note

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: Add EE to the controller instance
  execution_environment:
    name: "My EE"
    image: quay.io/ansible/awx-ee

Authors

Shane McDonald (@shanemcd)

Collection links

© 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/execution_environment_module.html