azure.azcollection.azure_rm_privatednsrecordset – Create, delete and update Private DNS record sets and records
azure.azcollection.azure_rm_privatednsrecordset – Create, delete and update Private DNS record sets and records
Note
This plugin is part of the azure.azcollection collection (version 1.4.0).
To install it use: ansible-galaxy collection install azure.azcollection
.
To use it in a playbook, specify: azure.azcollection.azure_rm_privatednsrecordset
.
New in version 1.1.0: of azure.azcollection
Synopsis
- Creates, deletes, and updates Private DNS records sets and records within an existing Azure Private 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 string |
Active Directory username. Use when authenticating with an Active Directory user rather than service principal. | ||
adfs_authority_url string added in 0.0.1 of azure.azcollection |
Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority. | ||
api_profile string added in 0.0.1 of azure.azcollection |
Default: "latest" |
Selects an API profile to use when communicating with Azure services. Default value of | |
append_tags boolean |
|
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. | |
auth_source string added in 0.0.1 of azure.azcollection |
|
Controls the source of the credentials to use for authentication. Can also be set via the When set to When set to When set to When set to When set to The | |
cert_validation_mode string added in 0.0.1 of azure.azcollection |
|
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 | |
client_id string |
Azure client ID. Use when authenticating with a Service Principal. | ||
cloud_environment string added in 0.0.1 of azure.azcollection |
Default: "AzureCloud" |
For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, | |
password string |
Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. | ||
profile string |
Security profile found in ~/.azure/credentials file. | ||
record_mode string |
|
Whether existing record values not sent to the module should be purged. | |
record_type string / required |
|
The type of record set to create or delete. | |
records list / elements=dictionary |
List of records to be created depending on the type of record (set). | ||
entry string |
Primary data value for all record types. | ||
port integer |
Used for creating an | ||
preference integer |
Used for creating an | ||
priority integer |
Used for creating an | ||
weight integer |
Used for creating an | ||
relative_name string / required |
Relative name of the record set. | ||
resource_group string / required |
Name of resource group. | ||
secret string |
Azure client secret. Use when authenticating with a Service Principal. | ||
state string |
|
Assert the state of the record set. Use | |
subscription_id string |
Your Azure subscription Id. | ||
tags dictionary |
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. | ||
tenant string |
Azure tenant ID. Use when authenticating with a Service Principal. | ||
time_to_live integer |
Default: 3600 |
Time to live of the record set in seconds. | |
zone_name string / required |
Name of the existing Private DNS zone in which to manage the record set. |
Notes
Note
- For authentication with Azure you can pass parameters, set environment variables, use a profile stored in ~/.azure/credentials, or log in before you run your tasks or playbook with
az login
. - Authentication is also 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.
See Also
Examples
- name: ensure an "A" record set with multiple records
azure_rm_privatednsrecordset:
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_privatednsrecordset:
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_privatednsrecordset:
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_privatednsrecordset:
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
priority: 20
weight: 10
port: 5060
- name: create PTR record in a new record set
azure_rm_privatednsrecordset:
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_privatednsrecordset:
resource_group: myResourceGroup
relative_name: mail.testing.com
zone_name: testing.com
record_type: TXT
records:
- entry: 'v=spf1 a -all'
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | |
---|---|---|---|
state complex |
always |
Current state of the DNS record set.
| |
a_records list / elements=dictionary |
always |
A list of records in the record set.
Sample: [{'ipv4_address': '192.0.2.2'}, {'ipv4_address': '192.0.2.4'}, {'ipv4_address': '192.0.2.8'}] | |
etag string |
always |
The etag of the record set.
Sample: 692c3e92-a618-46fc-aecd-8f888807cd6c | |
fqdn string |
always |
Fully qualified domain name of the record set.
Sample: www.b57dc95985712e4523282.com | |
id string |
always |
The DNS record set ID.
Sample: /subscriptions/xxxx......xxx/resourceGroups/v-xisuRG/providers/Microsoft.Network/privateDnsZones/ b57dc95985712e4523282.com/A/www | |
is_auto_registered boolean |
always |
Is the record set auto-registered in the Private DNS zone through a virtual network link.
| |
name string |
always |
Relate name of the record set.
Sample: www | |
ttl integer |
always |
The TTL(time-to-live) of the records in the records set.
Sample: 3600 | |
type string |
always |
The type of DNS record in this record set.
Sample: A |
Authors
- Aparna Patil (@aparna-patil)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/azure/azcollection/azure_rm_privatednsrecordset_module.html