On this page
rax_dns - Manage domains on Rackspace Cloud DNS
New in version 1.5.
Synopsis
- Manage domains on Rackspace Cloud DNS
Requirements
The below requirements are needed on the host that executes this module.
- pyrax
- python >= 2.6
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
api_key |
Rackspace API key, overrides credentials.
aliases: password |
|
auth_endpoint
(added in 1.5)
|
Default:
"https://identity.api.rackspacecloud.com/v2.0/"
|
The URI of the authentication service.
|
comment |
Brief description of the domain. Maximum length of 160 characters
|
|
credentials |
File to find the Rackspace credentials in. Ignored if api_key and username are provided.
aliases: creds_file |
|
Email address of the domain administrator
|
||
env
(added in 1.5)
|
Environment as configured in ~/.pyrax.cfg, see https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#pyrax-configuration.
|
|
identity_type
(added in 1.5)
|
Default:
"rackspace"
|
Authentication mechanism to use, such as rackspace or keystone.
|
name |
Domain name to create
|
|
region | Default:
"DFW"
|
Region to create an instance in.
|
state |
|
Indicate desired state of the resource
|
tenant_id
(added in 1.5)
|
The tenant ID used for authentication.
|
|
tenant_name
(added in 1.5)
|
The tenant name used for authentication.
|
|
ttl | Default:
3600
|
Time to live of domain in seconds
|
username |
Rackspace username, overrides credentials.
|
|
verify_ssl
(added in 1.5)
|
Whether or not to require SSL validation of API endpoints.
|
Notes
Note
- It is recommended that plays utilizing this module be run with
serial: 1
to avoid exceeding the API request limit imposed by the Rackspace CloudDNS API - The following environment variables can be used,
RAX_USERNAME
,RAX_API_KEY
,RAX_CREDS_FILE
,RAX_CREDENTIALS
,RAX_REGION
. RAX_CREDENTIALS
andRAX_CREDS_FILE
points to a credentials file appropriate for pyrax. See https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#authenticatingRAX_USERNAME
andRAX_API_KEY
obviate the use of a credentials fileRAX_REGION
defines a Rackspace Public Cloud region (DFW, ORD, LON, …)- The following environment variables can be used,
RAX_USERNAME
,RAX_API_KEY
,RAX_CREDS_FILE
,RAX_CREDENTIALS
,RAX_REGION
. RAX_CREDENTIALS
andRAX_CREDS_FILE
points to a credentials file appropriate for pyrax. See https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#authenticatingRAX_USERNAME
andRAX_API_KEY
obviate the use of a credentials fileRAX_REGION
defines a Rackspace Public Cloud region (DFW, ORD, LON, …)
Examples
- name: Create domain
hosts: all
gather_facts: False
tasks:
- name: Domain create request
local_action:
module: rax_dns
credentials: ~/.raxpub
name: example.org
email: admin@example.org
register: rax_dns
Status
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Maintenance
This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.
For a list of other modules that are also maintained by the Ansible Community, see here.
Author
- Matt Martz (@sivel)
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.6/modules/rax_dns_module.html