scale_computing.hypercore.version_update_status_info module – Returns status of the latest update applied.

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

New in scale_computing.hypercore 1.2.0

Synopsis

  • Returns status of the latest update applied.

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

Install an update on the cluster.

scale_computing.hypercore.version_update_info

Get a list of updates that can be applied to this cluster.

Examples

- name: Get status of the latest update applied
  scale_computing.hypercore.version_update_status_info:
  register: result

Return Values

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

Key

Description

record

dictionary

Status of the latest update applied

None/null is returned if no update was ever applied.

Returned: success

from_build

string

Old build version

Returned: success

Sample: "207183"

percent

string

Update progress in percentage

Returned: success

Sample: "100"

prepare_status

string

Status of preparation necessary for update to start

Returned: success

Sample: ""

to_build

string

New build version

Returned: success

Sample: "209840"

to_version

string

New hypercore version

Returned: success

Sample: "9.1.18.209840"

update_status

string

Update status

Returned: success

Sample: "COMPLETE"

update_status_details

string

Update status details

Returned: success

Sample: "Update Complete. Press 'Reload' to reconnect"

usernotes

string

Update status usernotes

Returned: success

Sample: "Update Complete. Press 'Reload' to reconnect"

Authors

  • Polona Mihalič (@PolonaM)