scale_computing.hypercore.registration module – Handles cluster registration.

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

New in scale_computing.hypercore 1.1.0

Synopsis

  • Can create, update or delete cluster registration.

  • A single registration per 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.

company_name

string

Name of the company registering the cluster.

contact

string

Name of the person registering the cluster.

email

string

Email address for company contact.

phone

string

Phone number for company contact.

state

string / required

Desired state of the registration.

Choices:

  • "present"

  • "absent"

Notes

Note

  • check_mode is not supported.

Examples

- name: New registration
  scale_computing.hypercore.registration:
    company_name: New company
    contact: John Smith
    phone: 056789987
    email: john_smith@gmail.com
    state: present

- name: Update registration
  scale_computing.hypercore.registration:
    contact: Janez Novak
    state: present

- name: Delete registration
  scale_computing.hypercore.registration:
    state: absent

Return Values

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

Key

Description

record

dictionary

Registration record.

Returned: success

company_name

string

Name of the company registering the cluster

Returned: success

Sample: "New company"

contact

string

Name of the person registering the cluster

Returned: success

Sample: "John Smith"

email

string

Email address for company contact

Returned: success

Sample: "john_smith@gmail.com"

phone

string

Phone number for company contact

Returned: success

Sample: "056789987"

Authors

  • Domen Dobnikar (@domen_dobnikar)