scale_computing.hypercore.certificate module – Handles cluster SSL certificates.

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

New in scale_computing.hypercore 1.1.0

Synopsis

  • Can upload and verify SSL certificates.

Parameters

Parameter

Comments

certificate

string / required

File location containing the X.509 PEM-encode certificate.

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.

private_key

string / required

File location containing the RSA PEM-encoded private key.

Notes

Note

  • check_mode is not supported.

Examples

- name: Upload new certificate
  scale_computing.hypercore.certificate:
    private_key: "{{ lookup('file', 'private_key.pem') }}"
    certificate: "{{ lookup('file', 'scale_cert.cer') }}"

Return Values

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

Key

Description

record

dictionary

Certificate record.

Returned: success

certificate

string

Cluster SSL certificate

Returned: success

Sample: "-----BEGIN CERTIFICATE----- MIIGKzCCBBOgAwIBAgIUWaGzXfgSUuwwPJu3F2Q/Ru/O8JQwDQYJKoZIhvcNAQEL ... -----END CERTIFICATE-----"

Authors

  • Domen Dobnikar (@domen_dobnikar)