Docs4dev
Docs
ansible / 2.4 / rax_dns_module.html

rax_dns - Manage domains on Rackspace Cloud DNS

New in version 1.5.

Synopsis

  • Manage domains on Rackspace Cloud DNS

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
comment
 no
Brief description of the domain. Maximum length of 160 characters
credentials
 no
File to find the Rackspace credentials in. Ignored if api_key and username are provided.
aliases: creds_file
email
 no
Email address of the domain administrator
env
(added in 1.5)
no
name
 no
Domain name to create
region
 no DFW
Region to create an instance in.
state
 no present
  • present
  • absent
Indicate desired state of the resource
ttl
 no 3600
Time to live of domain in seconds
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: 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

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 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–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/rax_dns_module.html