Record

dns_record

This is a module that supports creating, updating or destroying DNS Records

Example Syntax

name: Create Record
ionoscloudsdk.ionoscloud.dns_record:
  zone: 'test.example.test.ansible.com'
  name: 'sdk-team-test-record'
  type: 'CNAME'
  content: '1.2.3.4'
  ttl: '3600'
  priority: '35535'
  enabled: 'True'
register: record_response


name: Update record
ionoscloudsdk.ionoscloud.dns_record:
  zone: 'test.example.test.ansible.com'
  record: 'sdk-team-test-record'
  type: 'CNAME'
  content: '2.2.3.4'
  ttl: '1800'
  priority: '16'
  enabled: 'False'
  allow_replace: false
  state: update
register: updated_record_response


name: Delete Record
ionoscloudsdk.ionoscloud.dns_record:
  zone: 'test.example.test.ansible.com'
  record: ''
  wait: true
  state: absent

Returned object

{
    "changed": true,
    "failed": false,
    "action": "create",
    "record": {
        "id": "c76bf816-c11a-5dfc-8ef3-badfbee48451",
        "type": "record",
        "href": "/zones/b4021310-5e39-50bb-95f6-448b21bf0142/records/c76bf816-c11a-5dfc-8ef3-badfbee48451",
        "metadata": {
            "last_modified_date": "2023-10-05T14:38:56+00:00",
            "created_date": "2023-10-05T14:38:56+00:00",
            "state": "AVAILABLE",
            "fqdn": "<FQDN>",
            "zone_id": "b4021310-5e39-50bb-95f6-448b21bf0142"
        },
        "properties": {
            "name": "<RECORD_NAME>",
            "type": "CNAME",
            "content": "<CONTENT>",
            "ttl": 3600,
            "priority": 0,
            "enabled": true
        }
    }
}

For more examples please check out the tests here.

NOTE: If you are using a versions 7.0.0 and up: modules can replace resources if certain set parameters differ from the results found in the API!

Parameters that can trigger a resource replacement:

• name

state: present

  
name: Create Record
ionoscloudsdk.ionoscloud.dns_record:
  zone: 'test.example.test.ansible.com'
  name: 'sdk-team-test-record'
  type: 'CNAME'
  content: '1.2.3.4'
  ttl: '3600'
  priority: '35535'
  enabled: 'True'
register: record_response

Available parameters for state present:

Name	Required	Description
name str	True	The Record name.
type str	True	Holds supported DNS resource record types. In the DNS context a record is a DNS resource record.
content str	True	The conted of the Record.
ttl int	False	Time to live for the record, recommended 3600.
priority int	False	Priority value is between 0 and 65535. Priority is mandatory for MX, SRV and URI record types and ignored for all other types.
enabled bool	False	When true - the record is visible for lookup.
zone str	True	The ID or name of an existing Zone.
allow_replace bool	False	Boolean indicating if the resource should be recreated when the state cannot be reached in another way. This may be used to prevent resources from being deleted from specifying a different value to an immutable property. An error will be thrown instead Default: False
api_url str	False	The Ionos API base URL.
certificate_fingerprint str	False	The Ionos API certificate fingerprint.
username str	False	The Ionos username. Overrides the IONOS_USERNAME environment variable.
password str	False	The Ionos password. Overrides the IONOS_PASSWORD environment variable.
token str	False	The Ionos token. Overrides the IONOS_TOKEN environment variable.
wait bool	False	Wait for the resource to be created before returning. Default: True Options: [True, False]
wait_timeout int	False	How long before wait gives up, in seconds. Default: 600
state str	False	Indicate desired state of the resource. Default: present Options: ['present', 'absent', 'update']

state: absent

  
name: Delete Record
ionoscloudsdk.ionoscloud.dns_record:
  zone: 'test.example.test.ansible.com'
  record: ''
  wait: true
  state: absent

Available parameters for state absent:

Name	Required	Description
record str	True	The ID or name of an existing Record.
zone str	True	The ID or name of an existing Zone.
api_url str	False	The Ionos API base URL.
certificate_fingerprint str	False	The Ionos API certificate fingerprint.
username str	False	The Ionos username. Overrides the IONOS_USERNAME environment variable.
password str	False	The Ionos password. Overrides the IONOS_PASSWORD environment variable.
token str	False	The Ionos token. Overrides the IONOS_TOKEN environment variable.
wait bool	False	Wait for the resource to be created before returning. Default: True Options: [True, False]
wait_timeout int	False	How long before wait gives up, in seconds. Default: 600
state str	False	Indicate desired state of the resource. Default: present Options: ['present', 'absent', 'update']

state: update

  
name: Update record
ionoscloudsdk.ionoscloud.dns_record:
  zone: 'test.example.test.ansible.com'
  record: 'sdk-team-test-record'
  type: 'CNAME'
  content: '2.2.3.4'
  ttl: '1800'
  priority: '16'
  enabled: 'False'
  allow_replace: false
  state: update
register: updated_record_response

Available parameters for state update:

Name	Required	Description
name str	False	The Record name.
type str	False	Holds supported DNS resource record types. In the DNS context a record is a DNS resource record.
content str	False	The conted of the Record.
ttl int	False	Time to live for the record, recommended 3600.
priority int	False	Priority value is between 0 and 65535. Priority is mandatory for MX, SRV and URI record types and ignored for all other types.
enabled bool	False	When true - the record is visible for lookup.
record str	True	The ID or name of an existing Record.
zone str	True	The ID or name of an existing Zone.
allow_replace bool	False	Boolean indicating if the resource should be recreated when the state cannot be reached in another way. This may be used to prevent resources from being deleted from specifying a different value to an immutable property. An error will be thrown instead Default: False
api_url str	False	The Ionos API base URL.
certificate_fingerprint str	False	The Ionos API certificate fingerprint.
username str	False	The Ionos username. Overrides the IONOS_USERNAME environment variable.
password str	False	The Ionos password. Overrides the IONOS_PASSWORD environment variable.
token str	False	The Ionos token. Overrides the IONOS_TOKEN environment variable.
wait bool	False	Wait for the resource to be created before returning. Default: True Options: [True, False]
wait_timeout int	False	How long before wait gives up, in seconds. Default: 600
state str	False	Indicate desired state of the resource. Default: present Options: ['present', 'absent', 'update']