vmware.vmware_rest.appliance_networking_dns_servers module – Set the DNS server configuration
Note
This module is part of the vmware.vmware_rest collection (version 4.2.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install vmware.vmware_rest
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: vmware.vmware_rest.appliance_networking_dns_servers
.
New in vmware.vmware_rest 2.0.0
Synopsis
Set the DNS server configuration. If you set the mode argument to “DHCP”, a DHCP refresh is forced.
Requirements
The below requirements are needed on the host that executes this module.
vSphere 7.0.3 or greater
python >= 3.6
aiohttp
Parameters
Parameter |
Comments |
---|---|
dns_server_mode enumerated type Describes DNS Server source (DHCP,static) Required with state=[‘set’] Choices:
|
|
DNS server. Required with state=[‘add’] |
|
List of the currently used DNS servers. Required with state=[‘set’, ‘test’] |
|
Timeout settings for client session. The maximal number of seconds for the whole operation including connection establishment, request sending and response. The default value is 300s. |
|
Choices:
|
|
The hostname or IP address of the vSphere vCenter If the value is not specified in the task, the value of environment variable |
|
The vSphere vCenter password If the value is not specified in the task, the value of environment variable |
|
You can use this optional parameter to set the location of a log file. This file will be used to record the HTTP REST interaction. The file will be stored on the host that runs the module. If the value is not specified in the task, the value of environment variable |
|
The vSphere vCenter username If the value is not specified in the task, the value of environment variable |
|
Allows connection when SSL certificates are not valid. Set to If the value is not specified in the task, the value of environment variable Choices:
|
Notes
Note
Tested on vSphere 7.0.3
See Also
See also
- vmware.vmware.vcsa_settings
Configure vCenter Server Appliance settings.
Examples
- name: Set static DNS servers
vmware.vmware_rest.appliance_networking_dns_servers:
servers:
- 1.1.1.1
mode: is_static
state: set
register: result
- name: Add another DNS server
vmware.vmware_rest.appliance_networking_dns_servers:
server: 8.8.4.4
state: add
register: result
- name: Use the DNS servers from the DHCP
vmware.vmware_rest.appliance_networking_dns_servers:
mode: dhcp
servers: []
state: set
register: result
- name: Test the DNS servers
vmware.vmware_rest.appliance_networking_dns_servers:
state: test
servers:
- google.com
register: result
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Add another DNS server Returned: On success Sample: |