scale_computing.hypercore.cluster_info module – Retrieve cluster info.

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.cluster_info.

New in scale_computing.hypercore 1.2.0

Synopsis

  • Retrieve cluster’s uuid, name and icos version from the HyperCore API endpoint /rest/v1/Cluster.

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.cluster_name

Update cluster name.

Examples

- name: Get cluster info
  scale_computing.hypercore.cluster_info:
  register: result

Return Values

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

Key

Description

record

dictionary

Cluster info.

Returned: success

icos_version

string

HyperCore ICOS version

Returned: success

Sample: "9.2.11.210763"

name

string

Cluster name

Returned: success

Sample: "PUB4"

uuid

string

Cluster UUID

Returned: success

Sample: "a5d9148c-37f7-4b43-843c-196751d3c050"

Authors

  • Polona Mihalič (@PolonaM)