ansible / ansible.builtin / v2.9.17 / module / azure_rm_dnsrecordset Create, delete and update DNS record sets and records | "added in version" 2.4 of ansible.builtin" Authors: Obezimnaka Boms (@ozboms), Matt Davis (@nitzmahone) preview | supported by communityansible.builtin.azure_rm_dnsrecordset (v2.9.17) — module
pip
Install with pip install ansible==2.9.17
Creates, deletes, and updates DNS records sets and records within an existing Azure DNS Zone.
- name: ensure an "A" record set with multiple records azure_rm_dnsrecordset: resource_group: myResourceGroup relative_name: www zone_name: testing.com record_type: A records: - entry: 192.168.100.101 - entry: 192.168.100.102 - entry: 192.168.100.103
- name: delete a record set azure_rm_dnsrecordset: resource_group: myResourceGroup record_type: A relative_name: www zone_name: testing.com state: absent
- name: create multiple "A" record sets with multiple records azure_rm_dnsrecordset: resource_group: myResourceGroup zone_name: testing.com relative_name: "{{ item.name }}" record_type: "{{ item.type }}" records: "{{ item.records }}" with_items: - { name: 'servera', type: 'A', records: [ { entry: '10.10.10.20' }, { entry: '10.10.10.21' }] } - { name: 'serverb', type: 'A', records: [ { entry: '10.10.10.30' }, { entry: '10.10.10.41' }] } - { name: 'serverc', type: 'A', records: [ { entry: '10.10.10.40' }, { entry: '10.10.10.41' }] }
- name: create SRV records in a new record set azure_rm_dnsrecordset: resource_group: myResourceGroup relative_name: _sip._tcp.testing.com zone_name: testing.com time_to_live: 7200 record_type: SRV records: - entry: sip.testing.com preference: 10 priority: 20 weight: 10 port: 5060
- name: create PTR record in a new record set azure_rm_dnsrecordset: resource_group: myResourceGroup relative_name: 192.168.100.101.in-addr.arpa zone_name: testing.com record_type: PTR records: - entry: servera.testing.com
- name: create TXT record in a new record set azure_rm_dnsrecordset: resource_group: myResourceGroup relative_name: mail.testing.com zone_name: testing.com record_type: TXT records: - entry: 'v=spf1 a -all'
tags: description: - Dictionary of string:string pairs to assign as metadata to the object. - Metadata tags on the object will be updated with any provided values. - To remove tags set append_tags option to false. type: dict state: choices: - absent - present default: present description: - Assert the state of the record set. Use C(present) to create or update and C(absent) to delete. secret: description: - Azure client secret. Use when authenticating with a Service Principal. type: str tenant: description: - Azure tenant ID. Use when authenticating with a Service Principal. type: str ad_user: description: - Active Directory username. Use when authenticating with an Active Directory user rather than service principal. type: str profile: description: - Security profile found in ~/.azure/credentials file. type: str records: description: - List of records to be created depending on the type of record (set). suboptions: entry: description: - Primary data value for all record types. port: description: - Used for creating an C(SRV) record set/records. preference: description: - Used for creating an C(MX) record set/records. priority: description: - Used for creating an C(SRV) record set/records. weight: description: - Used for creating an C(SRV) record set/records. password: description: - Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. type: str client_id: description: - Azure client ID. Use when authenticating with a Service Principal. type: str zone_name: description: - Name of the existing DNS zone in which to manage the record set. required: true api_profile: default: latest description: - Selects an API profile to use when communicating with Azure services. Default value of C(latest) is appropriate for public clouds; future values will allow use with Azure Stack. type: str version_added: 0.0.1 version_added_collection: azure.azcollection append_tags: default: true description: - Use to control if tags field is canonical or just appends to existing tags. - When canonical, any tags not found in the tags parameter will be removed from the object's metadata. type: bool auth_source: choices: - auto - cli - credential_file - env - msi default: auto description: - Controls the source of the credentials to use for authentication. - Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable. - When set to C(auto) (the default) the precedence is module parameters -> C(env) -> C(credential_file) -> C(cli). - When set to C(env), the credentials will be read from the environment variables - When set to C(credential_file), it will read the profile from C(~/.azure/credentials). - When set to C(cli), the credentials will be sources from the Azure CLI profile. C(subscription_id) or the environment variable C(AZURE_SUBSCRIPTION_ID) can be used to identify the subscription ID if more than one is present otherwise the default az cli subscription is used. - When set to C(msi), the host machine must be an azure resource with an enabled MSI extension. C(subscription_id) or the environment variable C(AZURE_SUBSCRIPTION_ID) can be used to identify the subscription ID if the resource is granted access to more than one subscription, otherwise the first subscription is chosen. - The C(msi) was added in Ansible 2.6. type: str version_added: 0.0.1 version_added_collection: azure.azcollection record_mode: choices: - append - purge default: purge description: - Whether existing record values not sent to the module should be purged. record_type: choices: - A - AAAA - CNAME - MX - NS - SRV - TXT - PTR - CAA - SOA description: - The type of record set to create or delete. required: true time_to_live: default: 3600 description: - Time to live of the record set in seconds. relative_name: description: - Relative name of the record set. required: true resource_group: description: - Name of resource group. required: true subscription_id: description: - Your Azure subscription Id. type: str cloud_environment: default: AzureCloud description: - For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, C(AzureChinaCloud), C(AzureUSGovernment)), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the C(AZURE_CLOUD_ENVIRONMENT) environment variable. type: str version_added: 0.0.1 version_added_collection: azure.azcollection adfs_authority_url: description: - Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority. type: str version_added: 0.0.1 version_added_collection: azure.azcollection cert_validation_mode: choices: - ignore - validate description: - Controls the certificate validation behavior for Azure endpoints. By default, all modules will validate the server certificate, but when an HTTPS proxy is in use, or against Azure Stack, it may be necessary to disable this behavior by passing C(ignore). Can also be set via credential file profile or the C(AZURE_CERT_VALIDATION) environment variable. type: str version_added: 0.0.1 version_added_collection: azure.azcollection
state: contains: arecords: description: - A list of records in the record set. returned: always sample: - ipv4_address: 192.0.2.2 - ipv4_address: 192.0.2.4 - ipv4_address: 192.0.2.8 type: list etag: description: - The etag of the record set. returned: always sample: 692c3e92-a618-46fc-aecd-8f888807cd6c type: str fqdn: description: - Fully qualified domain name of the record set. returned: always sample: www.b57dc95985712e4523282.com type: str id: description: - The DNS record set ID. returned: always sample: /subscriptions/xxxx......xxx/resourceGroups/v-xisuRG/providers/Microsoft.Network/dnszones/b57dc95985712e4523282.com/A/www type: str name: description: - Relate name of the record set. returned: always sample: www type: str provisioning_state: description: - The DNS record set state. returned: always sample: Succeeded type: str target_resource: description: - The target resource of the record set. returned: always sample: {} type: dict ttl: description: - The TTL(time-to-live) of the records in the records set. returned: always sample: 3600 type: int type: description: - The type of DNS record in this record set. returned: always sample: A type: str description: - Current state of the DNS record set. returned: always type: complex