scale_computing.hypercore.user_info module – Returns information about the users.

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

New in scale_computing.hypercore 1.2.0

Synopsis

  • Returns information about the users.

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.

username

string

The user name.

Serves as unique identifier.

See Also

See also

scale_computing.hypercore.user

Creates, updates or deletes local hypercore user accounts.

Examples

- name: List all users
  scale_computing.hypercore.user_info:
  register: users

- name: List selected user
  scale_computing.hypercore.user_info:
    username: my_username
  register: user

Return Values

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

Key

Description

records

list / elements=dictionary

A list of user records.

Returned: success

full_name

string

Human-readable display name

Returned: success

Sample: "xlab"

roles

list / elements=dictionary

Role identifiers this user is a member of

Returned: success

Sample: {"name": "Admin", "uuid": "38b346c6-a626-444b-b6ab-92ecd671afc0"}

session_limit

integer

The maximum number of Sessions this user may have at one time

Returned: success

Sample: 0

username

string

Human-readable unique identifier for authentication

Returned: success

Sample: "xlab"

uuid

string

Unique identifier

Returned: success

Sample: "51e6d073-7566-4273-9196-58720117bd7f"

Authors

  • Polona Mihalič (@PolonaM)