scale_computing.hypercore.support_tunnel module – Opens or closes remote support tunnel.

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

New in scale_computing.hypercore 1.2.0

Synopsis

  • Opens or closes remote support tunnel on the node.

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.

code

integer

Code from support used to open remote support tunnel.

Relevant only if state is present.

state

string / required

The desired state of the remote support tunnel.

If state is absent the remote support tunnel will be closed.

If state is present the remote support tunnel will be opened.

Choices:

  • "present"

  • "absent"

Notes

Note

  • check_mode is not supported.

Examples

- name: Open support tunnel
  scale_computing.hypercore.support_tunnel:
    state: present
    code: 4422

- name: Close support tunnel
  scale_computing.hypercore.support_tunnel:
    state: absent

Return Values

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

Key

Description

record

dictionary

Support tunnel status.

Returned: success

Sample: {"code": 4422, "open": true}

Authors

  • Polona Mihalič (@PolonaM)