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

cluster_instance

dictionary

Scale Computing HyperCore instance information.

auth_method

string

Select login method. If not set, the value of the SC_AUTH_METHOD environment variable will be used.

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:

  • "local" ← (default)

  • "oidc"

host

string / required

The HyperCore instance URL.

If not set, the value of the SC_HOST environment variable will be used.

For example “https://10.1.2.3:443”.

password

string / required

Password used for authentication.

If not set, the value of the SC_PASSWORD environment variable will be used.

timeout

float

Timeout in seconds for the connection with the Scale Computing HyperCore API instance.

If not set, the value of the SC_TIMEOUT environment variable will be used.

username

string / required

Username used for authentication.

If not set, the value of the SC_USERNAME environment variable will be used.

dns_servers

list / elements=string

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.

search_domains

list / elements=string

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.

state

string / required

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:

  • "set"

  • "before"

  • "after"

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

results

dictionary

Output from modifying entries of the DNS configuration on HyperCore API.

Returned: success

latest_task_tag

dictionary

Latest Task Tag

Returned: success

Sample: {"completed": 1673946776, "created": 1673946770, "descriptionParameters": [], "formattedDescription": "DNSConfig Update", "formattedMessage": "", "messageParameters": [], "modified": 1673946776, "nodeUUIDs": ["32c5012d-7d7b-49b4-9201-70e02b0d8758"], "objectUUID": "dnsconfig_guid", "progressPercent": 100, "sessionID": "775155cc-bc4e-445c-9efa-a304f4f66c82", "state": "COMPLETE", "taskTag": "359"}

search_domains

list / elements=string

Domain search list used to resolve fully qualified domain names

Returned: success

Sample: ["example.domain1.com"]

server_ips

list / elements=string

IP address or hostname of DNS servers

Returned: success

Sample: ["1.1.1.1"]

uuid

string

Unique identifer

Returned: success

Sample: "dnsconfig_guid"

Authors

  • Ana Zobec (@anazobec)