scale_computing.hypercore.dns_config module – Modify DNS configuration on HyperCore API
Note
This module is part of the scale_computing.hypercore collection (version 1.6.0).
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 scale_computing.hypercore
.
To use it in a playbook, specify: scale_computing.hypercore.dns_config
.
New in scale_computing.hypercore 1.2.0
Synopsis
Use this module to add to or delete from a DNS configuration on HyperCore API.
Parameters
Parameter |
Comments |
---|---|
Scale Computing HyperCore instance information. |
|
Select login method. If not set, the value of the Value local - username/password is verified by the HyperCore server (the local users). Value oidc - username/password is verified by the configured OIDC provider. Choices:
|
|
The HyperCore instance URL. If not set, the value of the For example “https://10.1.2.3:443”. |
|
Password used for authentication. If not set, the value of the |
|
Timeout in seconds for the connection with the Scale Computing HyperCore API instance. If not set, the value of the |
|
Username used for authentication. If not set, the value of the |
|
List of DNS server IPs to use as new DNS configuration or to add to DNS configuration. If the configuration is added, then, if all of the provided DNS names already exist on HyperCore API, and DNS server IPs on server are in correct order, there will be no changes made. |
|
List of DNS names to use as new DNS configuration or to add to DNS configuration. If the configuration is added, then, if all of the provided DNS names already exist on HyperCore API, and DNS names on server are in correct order, there will be no changes made. |
|
With state=set, the DNS configuration entries are set to new specified entries. With state=before, the specified entries are prepended to the existing DNS configuration. With state=after, the specified entries are appended to the existing DNS configuration. Choices:
|
Notes
Note
check_mode
is not supported.
See Also
See also
- scale_computing.hypercore.dns_config_info
List DNS configuration on HyperCore API.
Examples
- name: Add entry to existing DNS configuration
scale_computing.hypercore.dns_config:
search_domains:
- example.domain1.com
- example.domain2.com
dns_servers:
- 1.2.3.4
- 5.6.7.8
state: before # or after
- name: Overwrite all the existing DNS configuration entries
scale_computing.hypercore.dns_config:
search_domains: []
dns_servers: []
state: set
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Output from modifying entries of the DNS configuration on HyperCore API. Returned: success |
|
Latest Task Tag Returned: success Sample: |
|
Domain search list used to resolve fully qualified domain names Returned: success Sample: |
|
IP address or hostname of DNS servers Returned: success Sample: |
|
Unique identifer Returned: success Sample: |