cloudera.cluster.user_info module – Retrieve user details and associated authentication roles.

Note

This module is part of the cloudera.cluster collection (version 5.0.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 cloudera.cluster. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: cloudera.cluster.user_info.

New in cloudera.cluster 4.4.0

Synopsis

  • Provides details for a specific user or retrieves all users configured in Cloudera Manager.

  • Includes information about authentication roles associated with each user.

Requirements

The below requirements are needed on the host that executes this module.

  • cm_client

Parameters

Parameter

Comments

account_name

string

The name of the user account to be managed.

Examples

- name: Get list of all users in Cloudera Manager
  cloudera.cluster.user_info:
    host: example.cloudera.com
    port: "7180"
    username: "jane_smith"
    password: "S&peR4Ec*re"

- name: Get details for specific user
  cloudera.cluster.user_info:
    host: example.cloudera.com
    port: "7180"
    username: "jane_smith"
    password: "S&peR4Ec*re"
    account_name: "john"

Return Values

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

Key

Description

users

list / elements=dictionary

Retrieve details of single user or all users within the Cloudera Manager

Returned: always

auth_roles

list / elements=string

Cloudera Manager authorization roles assigned to the user.

Returned: optional

name

string

The username, which is unique within a Cloudera Manager installation.

Returned: always

Authors

  • Ronald Suplina (@rsuplina)