os_recordset – Manage OpenStack DNS recordsets

From Get docs
Ansible/docs/2.7/modules/os recordset module


os_recordset – Manage OpenStack DNS recordsets

New in version 2.2.


Synopsis

  • Manage OpenStack DNS recordsets. Recordsets can be created, deleted or updated. Only the records, description, and ttl values can be updated.

Requirements

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

  • openstacksdk
  • python >= 2.7

Parameters

Parameter Choices/Defaults Comments

api_timeout

-

How long should the socket layer wait before timing out for API calls. If this is omitted, nothing will be passed to the requests library.

auth

-

Dictionary containing auth information as needed by the cloud's auth plugin strategy. For the default password plugin, this would contain auth_url, username, password, project_name and any information about domains if the cloud supports them. For other plugins, this param will need to contain whatever parameters that auth plugin requires. This parameter is not needed if a named cloud is provided or OpenStack OS_* environment variables are present.

auth_type

-

Name of the auth plugin to use. If the cloud uses something other than password authentication, the name of the plugin should be indicated here and the contents of the auth parameter should be updated accordingly.

availability_zone

-

Ignored. Present for backwards compatibility

cacert

-

A path to a CA Cert bundle that can be used as part of verifying SSL API requests.

cert

-

A path to a client certificate to use as part of the SSL transaction.

cloud

-

Named cloud or cloud config to operate against. If cloud is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for auth and auth_type. This parameter is not needed if auth is provided or if OpenStack OS_* environment variables are present. If cloud is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml.

description

-

Description of the recordset

interface

-

added in 2.3

  • public

  • internal
  • admin

Endpoint URL type to fetch from the service catalog.


aliases: endpoint_type

key

-

A path to a client key to use as part of the SSL transaction.

name

- / required

Name of the recordset

records

- / required

List of recordset definitions

recordset_type

- / required

Recordset type

region_name

-

Name of the region.

state

-

  • present

  • absent

Should the resource be present or absent.

timeout

-

Default:

180

How long should ansible wait for the requested resource.

ttl

-

TTL (Time To Live) value in seconds

verify

boolean

  • no
  • yes

Whether or not SSL API requests should be verified. Before 2.3 this defaulted to True.


aliases: validate_certs

wait

boolean

  • no
  • yes

Should ansible wait until the requested resource is complete.

zone

- / required

Zone managing the recordset



Notes

Note

  • The standard OpenStack environment variables, such as OS_USERNAME may be used instead of providing explicit values.
  • Auth information is driven by os-client-config, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at http://docs.openstack.org/developer/os-client-config


Examples

# Create a recordset named "www.example.net."
- os_recordset:
    cloud: mycloud
    state: present
    zone: example.net.
    name: www
    recordset_type: primary
    records: ['10.1.1.1']
    description: test recordset
    ttl: 3600

# Update the TTL on existing "www.example.net." recordset
- os_recordset:
    cloud: mycloud
    state: present
    zone: example.net.
    name: www
    ttl: 7200

# Delete recorset named "www.example.net."
- os_recordset:
    cloud: mycloud
    state: absent
    zone: example.net.
    name: www

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description

recordset

complex

On success when state is 'present'.

Dictionary describing the recordset.


description

string

Recordset description


Sample:

Test description

id

string

Unique recordset ID


Sample:

c1c530a3-3619-46f3-b0f6-236927b2618c

name

string

Recordset name


Sample:

www.example.net.

records

list

Recordset records


Sample:

['10.0.0.1']

ttl

integer

Zone TTL value


Sample:

3600

type

string

Recordset type


Sample:

A

zone_id

string

Zone id


Sample:

9508e177-41d8-434e-962c-6fe6ca880af7




Status

Authors

  • Ricardo Carrillo Cruz (@rcarrillocruz)

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.7/modules/os_recordset_module.html