scale_computing.hypercore.node_info module – Returns information about the nodes in a cluster.

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

New in scale_computing.hypercore 1.0.0

Synopsis

  • Returns information about the nodes in a 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.vm_node_affinity

Update virtual machine’s node affinity.

Examples

- name: List all cluster nodes
  scale_computing.hypercore.node_info:
  register: nodes

Return Values

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

Key

Description

records

list / elements=dictionary

A list of node records.

Returned: success

backplane_ip

string

IP address on the backplane network

Returned: success

Sample: "10.0.0.1"

lan_ip

string

IP address on the LAN network

Returned: success

Sample: "10.0.0.2"

node_uuid

string

Unique identifier

Returned: success

Sample: "51e6d073-7566-4273-9196-58720117bd7f"

peer_id

string

Cluster map peer identifier

Returned: success

Sample: "1"

Authors

  • Polona Mihalič (@PolonaM)