W3cubDocs

/Ansible

rax_network - create / delete an isolated network in Rackspace Public Cloud

New in version 1.4.

Synopsis

  • creates / deletes a Rackspace Public Cloud isolated network.

Requirements (on host that executes module)

  • python >= 2.6
  • pyrax

Options

parameter required default choices comments
api_key
no
Rackspace API key, overrides credentials.
aliases: password
auth_endpoint
(added in 1.5)
no https://identity.api.rackspacecloud.com/v2.0/
The URI of the authentication service.
cidr
no
cidr of the network being created
credentials
no
File to find the Rackspace credentials in. Ignored if api_key and username are provided.
aliases: creds_file
env
(added in 1.5)
no
identity_type
(added in 1.5)
no rackspace
Authentication mechanism to use, such as rackspace or keystone.
label
no
Label (name) to give the network
region
no DFW
Region to create an instance in.
state
no present
  • present
  • absent
Indicate desired state of the resource
tenant_id
(added in 1.5)
no
The tenant ID used for authentication.
tenant_name
(added in 1.5)
no
The tenant name used for authentication.
username
no
Rackspace username, overrides credentials.
verify_ssl
(added in 1.5)
no
Whether or not to require SSL validation of API endpoints.

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

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, ...)

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.

© 2012–2017 Michael DeHaan
© 2017 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/rax_network_module.html