You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

community.general.rax_network module – Create / delete an isolated network in Rackspace Public Cloud

Note

This module is part of the community.general collection (version 6.6.2).

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 community.general. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: community.general.rax_network.

Synopsis

• creates / deletes a Rackspace Public Cloud isolated network.

Requirements

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

• python >= 2.6

• pyrax

Parameters

Parameter	Comments
api_key aliases: password string	Rackspace API key, overrides credentials.
auth_endpoint string	The URI of the authentication service. If not specified will be set to https://identity.api.rackspacecloud.com/v2.0/
cidr string	cidr of the network being created
credentials aliases: creds_file path	File to find the Rackspace credentials in. Ignored if api_key and username are provided.
env string	Environment as configured in ~/.pyrax.cfg, see https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#pyrax-configuration.
identity_type string	Authentication mechanism to use, such as rackspace or keystone. Default: "rackspace"
label string / required	Label (name) to give the network
region string	Region to create an instance in.
state string	Indicate desired state of the resource Choices: "present" ← (default) "absent"
tenant_id string	The tenant ID used for authentication.
tenant_name string	The tenant name used for authentication.
username string	Rackspace username, overrides credentials.
validate_certs aliases: verify_ssl boolean	Whether or not to require SSL validation of API endpoints. Choices: false true

Attributes

Attribute	Support	Description
check_mode	Support: none	Can run in check_mode and return changed status prediction without modifying target.
diff_mode	Support: none	Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.

Notes

Note

• The following environment variables can be used, RAX_USERNAME, RAX_API_KEY, RAX_CREDS_FILE, RAX_CREDENTIALS, RAX_REGION.

• RAX_CREDENTIALS and RAX_CREDS_FILE points to a credentials file appropriate for pyrax. See https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#authenticating

• RAX_USERNAME and RAX_API_KEY obviate the use of a credentials file

• RAX_REGION defines a Rackspace Public Cloud region (DFW, ORD, LON, …)

Examples

- name: Build an Isolated Network
  gather_facts: false

  tasks:
    - name: Network create request
      local_action:
        module: rax_network
        credentials: ~/.raxpub
        label: my-net
        cidr: 192.168.3.0/24
        state: present

Authors

• Christopher H. Laco (@claco)

• Jesse Keating (@omgjlk)

Collection links

Issue Tracker Repository (Sources) Submit a bug report Request a feature Communication