azure_rm_dnsrecordset - Create, delete and update DNS record sets and records.
New in version 2.4.
Synopsis
- Creates, deletes, and updates DNS records sets and records within an existing Azure DNS Zone.
Requirements
The below requirements are needed on the host that executes this module.
- python >= 2.7
- azure >= 2.0.0
Parameters
| Parameter | Choices/Defaults | Comments | |
|---|---|---|---|
| ad_user | Default: None | Active Directory username. Use when authenticating with an Active Directory user rather than service principal. | |
| api_profile (added in 2.5) |
| Selects an API profile to use when communicating with Azure services. Default value of latest is appropriate for public clouds; future values will allow use with Azure Stack. | |
| auth_source (added in 2.5) |
| Controls the source of the credentials to use for authentication. auto will follow the default precedence of module parameters -> environment variables -> default profile in credential file ~/.azure/credentials.When set to cli, the credentials will be sources from the default Azure CLI profile.Can also be set via the ANSIBLE_AZURE_AUTH_SOURCE environment variable. | |
| cert_validation_mode (added in 2.5) |
None | 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 ignore. Can also be set via credential file profile or the AZURE_CERT_VALIDATION environment variable. | |
| client_id | Default: None | Azure client ID. Use when authenticating with a Service Principal. | |
| cloud_environment (added in 2.4) | Default: AzureCloud | For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, AzureChinaCloud, AzureUSGovernment), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the AZURE_CLOUD_ENVIRONMENT environment variable. | |
| password | Default: None | Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. | |
| profile | Default: None | Security profile found in ~/.azure/credentials file. | |
| record_mode |
| whether existing record values not sent to the module should be purged | |
| record_type required |
| the type of record set to create or delete | |
| records | list of records to be created depending on the type of record (set) | ||
| priority | used for creating an SRV record set/records | ||
| entry | primary data value for all record types. | ||
| preference | used for creating an MX record set/records | ||
| weight | used for creating an SRV record set/records | ||
| port | used for creating an SRV record set/records | ||
| relative_name required | relative name of the record set | ||
| resource_group required | name of resource group | ||
| secret | Default: None | Azure client secret. Use when authenticating with a Service Principal. | |
| state |
| Assert the state of the record set. Use present to create or update and absent to delete. | |
| subscription_id | Default: None | Your Azure subscription Id. | |
| tenant | Default: None | Azure tenant ID. Use when authenticating with a Service Principal. | |
| time_to_live | Default: 3600 | time to live of the record set in seconds | |
| zone_name required | name of the existing DNS zone in which to manage the record set | ||
Notes
Note
- For authentication with Azure you can pass parameters, set environment variables or use a profile stored in ~/.azure/credentials. Authentication is possible using a service principal or Active Directory user. To authenticate via service principal, pass subscription_id, client_id, secret and tenant or set environment variables AZURE_SUBSCRIPTION_ID, AZURE_CLIENT_ID, AZURE_SECRET and AZURE_TENANT.
- To authenticate via Active Directory user, pass ad_user and password, or set AZURE_AD_USER and AZURE_PASSWORD in the environment.
- Alternatively, credentials can be stored in ~/.azure/credentials. This is an ini file containing a [default] section and the following keys: subscription_id, client_id, secret and tenant or subscription_id, ad_user and password. It is also possible to add additional profiles. Specify the profile by passing profile or setting AZURE_PROFILE in the environment.
Examples
- name: ensure an "A" record set with multiple records
azure_rm_dnsrecordset:
resource_group: Testing
relative_name: www
zone_name: testing.com
record_type: A
state: present
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: Testing
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: Testing
zone_name: testing.com
state: present
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: Testing
relative_name: _sip._tcp.testing.com
zone_name: testing.com
time_to_live: 7200
record_type: SRV
state: present
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: Testing
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: Testing
relative_name: mail.testing.com
zone_name: testing.com
record_type: TXT
records:
- entry: 'v=spf1 a -all'
Status
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Author
- Obezimnaka Boms (@ozboms)
- Matt Davis (@nitzmahone)
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.5/modules/azure_rm_dnsrecordset_module.html