ansible / ansible.builtin / v2.5.11 / module / vr_dns_record Manages DNS records on Vultr. | "added in version" 2.5 of ansible.builtin" Authors: René Moser (@resmo) preview | supported by communityansible.builtin.vr_dns_record (v2.5.11) — module
pip
Install with pip install ansible==2.5.11
Create, update and remove DNS records.
- name: Ensure an A record exists vr_dns_record: name: www domain: example.com data: 10.10.10.10 ttl: 3600
- name: Ensure a second A record exists for round robin LB vr_dns_record: name: www domain: example.com data: 10.10.10.11 ttl: 60 multiple: yes
- name: Ensure a CNAME record exists vr_dns_record: name: web record_type: CNAME domain: example.com data: www.example.com
- name: Ensure MX record exists vr_dns_record: record_type: MX domain: example.com data: "{{ item.data }}" priority: "{{ item.priority }}" multiple: yes with_items: - { data: mx1.example.com, priority: 10 } - { data: mx2.example.com, priority: 10 } - { data: mx3.example.com, priority: 20 }
- name: Ensure a record is absent local_action: module: vr_dns_record name: www domain: example.com state: absent
- name: Ensure MX record is absent in case multiple exists vr_dns_record: record_type: MX domain: example.com data: mx1.example.com multiple: yes state: absent
ttl: default: 300 description: - TTL of the record. data: description: - Data of the record. - Required if C(state=present) or C(multiple=yes). name: aliases: - subrecord default: '' description: - The record name (subrecord). state: choices: - present - absent default: present description: - State of the DNS record. domain: description: - The domain the record is related to. required: true api_key: description: - API key of the Vultr API. - The ENV variable C(VULTR_API_KEY) is used as default, when defined. type: str multiple: default: false description: - Whether to use more than one record with similar C(name) including no name and C(record_type). - Only allowed for a few record types, e.g. C(record_type=A), C(record_type=NS) or C(record_type=MX). - C(data) will not be updated, instead it is used as a key to find existing records. type: bool priority: default: 0 description: - Priority of the record. api_account: default: default description: - Name of the ini section in the C(vultr.ini) file. - The ENV variable C(VULTR_API_ACCOUNT) is used as default, when defined. type: str api_retries: description: - Amount of retries in case of the Vultr API retuns an HTTP 503 code. - The ENV variable C(VULTR_API_RETRIES) is used as default, when defined. - Fallback value is 5 retries if not specified. type: int api_timeout: description: - HTTP timeout to Vultr API. - The ENV variable C(VULTR_API_TIMEOUT) is used as default, when defined. - Fallback value is 60 seconds if not specified. type: int record_type: aliases: - type choices: - A - AAAA - CNAME - MX - SRV - ALIAS - SPF - TXT - NS default: A description: - Type of the record. api_endpoint: description: - URL to API endpint (without trailing slash). - The ENV variable C(VULTR_API_ENDPOINT) is used as default, when defined. - Fallback value is U(https://api.vultr.com) if not specified. type: str validate_certs: default: true description: - Validate SSL certs of the Vultr API. type: bool api_retry_max_delay: description: - Retry backoff delay in seconds is exponential up to this max. value, in seconds. - The ENV variable C(VULTR_API_RETRY_MAX_DELAY) is used as default, when defined. - Fallback value is 12 seconds. type: int
vultr_api: contains: api_account: description: Account used in the ini file to select the key returned: success sample: default type: string api_timeout: description: Timeout used for the API requests returned: success sample: 60 type: int description: Response from Vultr API with a few additions/modification returned: success type: complex vultr_dns_record: contains: data: description: Data of the DNS record. returned: success sample: 10.10.10.10 type: string domain: description: Domain the DNS record is related to. returned: success sample: example.com type: string id: description: The ID of the DNS record. returned: success sample: 1265277 type: int name: description: The name of the DNS record. returned: success sample: web type: string priority: description: Priority of the DNS record. returned: success sample: 10 type: int record_type: description: The name of the DNS record. returned: success sample: web type: string ttl: description: Time to live of the DNS record. returned: success sample: 300 type: int description: Response from Vultr API returned: success type: complex