On this page
win_dns_record – Manage Windows Server DNS records
New in version 2.8.
Synopsis
- Manage DNS records within an existing Windows Server DNS zone.
Requirements
The below requirements are needed on the host that executes this module.
- This module requires Windows 8, Server 2012, or newer.
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
computer_name
string
|
Specifies a DNS server.
You can specify an IP address or any value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name.
|
|
name
string / required
|
The name of the record.
|
|
state
string
|
|
Whether the record should exist or not.
|
ttl
integer
|
Default:
3600
|
The "time to live" of the record, in seconds.
Ignored when
state=absent .
Valid range is 1 - 31557600.
Note that an Active Directory forest can specify a minimum TTL, and will dynamically "round up" other values to that minimum.
|
type
string / required
|
|
The type of DNS record to manage.
|
value
list
|
The value(s) to specify. Required when
state=present .
aliases: values |
|
zone
string / required
|
The name of the zone to manage (eg
example.com ).
The zone must already exist.
|
Examples
- name: Create database server alias
win_dns_record:
name: "db1"
type: "CNAME"
value: "cgyl1404p.amer.example.com"
zone: "amer.example.com"
- name: Remove static record
win_dns_record:
name: "db1"
type: "A"
state: absent
zone: "amer.example.com"
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors
- John Nelson (@johnboy2)
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.8/modules/win_dns_record_module.html