scale_computing.hypercore.version_update module – Install an update on the 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.version_update.

New in scale_computing.hypercore 1.2.0

Synopsis

  • From available hypercore version updates install selected update on the 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.

icos_version

string / required

Hypercore version update to be installed on the cluster.

Notes

Note

  • check_mode is not supported.

See Also

See also

scale_computing.hypercore.version_update_info

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

scale_computing.hypercore.version_update_status_info

Returns status of the latest update applied.

Examples

- name: Update hypercore version
  scale_computing.hypercore.version_update:
    icos_version: 9.2.11.210763
  register: result

Return Values

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

Key

Description

record

dictionary

Version applied.

Returned: success

build_id

integer

ID of the build which corresponds to this update

Returned: success

Sample: 210763

change_log

string

Description of all changes that are in this update, in HTML format

Returned: success

Sample: "...Please allow between 20-40 minutes per node for the update to complete..."

description

string

Human-readable name for the update

Returned: success

Sample: "9.2.11 General Availability"

major_version

integer

Major version number

Returned: success

Sample: 9

minor_version

integer

Minor version number

Returned: success

Sample: 2

revision

integer

Revision number

Returned: success

Sample: 11

timestamp

integer

Unix timestamp when the update was released

Returned: success

Sample: 0

uuid

string

Unique identifier in format major_version.minor_version.revision.build_id

Returned: success

Sample: "9.2.11.210763"

Authors

  • Polona Mihalič (@PolonaM)