scale_computing.hypercore.dns_config_info module – List 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_info.

New in scale_computing.hypercore 1.2.0

Synopsis

  • Use this module to list information about the 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.

See Also

See also

scale_computing.hypercore.dns_config

Modify DNS configuration on HyperCore API.

Examples

- name: List all configurations on DNS configuration on HyperCore API
  scale_computing.hypercore.dns_config_info:
  register: dns_config

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

record

dictionary

DNS configuration record.

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)