scale_computing.hypercore.remote_cluster_info module – Retrieve a list of remote clusters.

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

New in scale_computing.hypercore 1.0.0

Synopsis

  • Retrieve a list of remote clusters from the HyperCore API endpoint /rest/v1/RemoteClusterConnection.

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.

remote_cluster

string

Remote cluster’s name.

If specified, the remote cluster with that specific name will get returned.

Otherwise, all remote clusters are going to get listed.

See Also

See also

scale_computing.hypercore.vm_replication

Handles VM replications.

scale_computing.hypercore.snapshot_schedule

Manage snap schedule to configure the desired schedule of snapshot creation.

Examples

- name: Get info about specific remote cluster
  scale_computing.hypercore.remote_cluster_info:
    remote_cluster: PUB4
  register: result

- name: Get info about all remote clusters
  scale_computing.hypercore.remote_cluster_info:
  register: result

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 remote cluster records.

Returned: success

connection_status

string

Remote cluster connection status

Returned: success

Sample: "ESTABLISHED"

name

string

Assigned name to the system

Returned: success

Sample: "PUB4"

remote_node_ips

list / elements=string

The ipAddresses of the remote nodes

Returned: success

Sample: ["10.5.11.11"]

remote_node_uuids

list / elements=string

The uuids of the the remote nodes

Returned: success

Sample: ["32c5012d-7d7b-49b4-9201-70e02b0d8758"]

replication_ok

boolean

Indicates if the remote system is able to accept additional replication work

Returned: success

Sample: true

Authors

  • Polona Mihalič (@PolonaM)