zhmc_user_list – List HMC users
Synopsis
List users on the HMC.
Requirements
The HMC userid must have object-access permission to the target users, or task permission to the ‘Manage Users’ task.
Parameters
- hmc_host
The hostnames or IP addresses of a single HMC or of a list of redundant HMCs. A single HMC can be specified as a string type or as an HMC list with one item. An HMC list can be specified as a list type or as a string type containing a Python list representation.
The first available HMC of a list of redundant HMCs is used for the entire execution of the module.
required: Truetype: raw- hmc_auth
The authentication credentials for the HMC.
required: Truetype: dict- userid
The userid (username) for authenticating with the HMC. This is mutually exclusive with providing
hmc_auth.session_id
.required: Falsetype: str- password
The password for authenticating with the HMC. This is mutually exclusive with providing
hmc_auth.session_id
.required: Falsetype: str- session_id
HMC session ID to be used. This is mutually exclusive with providing
hmc_auth.userid
andhmc_auth.password
and can be created as described in the zhmc_session module.required: Falsetype: str- ca_certs
Path name of certificate file or certificate directory to be used for verifying the HMC certificate. If null (default), the path name in the
REQUESTS_CA_BUNDLE
environment variable or the path name in theCURL_CA_BUNDLE
environment variable is used, or if neither of these variables is set, the certificates in the Mozilla CA Certificate List provided by the ‘certifi’ Python package are used for verifying the HMC certificate.required: Falsetype: str- verify
If True (default), verify the HMC certificate as specified in the
hmc_auth.ca_certs
parameter. If False, ignore what is specified in thehmc_auth.ca_certs
parameter and do not verify the HMC certificate.required: Falsetype: booldefault: True
- full_properties
If True, all properties of each user will be returned. Default: False.
Note: Setting this to True causes a loop of ‘Get User Properties’ operations to be executed.
required: Falsetype: bool- expand_names
If True and
full_properties
is set, additional artificial properties will be returned for the names of referenced objects, such as user roles, password rule, etc. Default: False.required: Falsetype: bool- log_file
File path of a log file to which the logic flow of this module as well as interactions with the HMC are logged. If null, logging will be propagated to the Python root logger.
required: Falsetype: str
Examples
---
# Note: The following examples assume that some variables named 'my_*' are set.
- name: List users
zhmc_user_list:
hmc_host: "{{ my_hmc_host }}"
hmc_auth: "{{ my_hmc_auth }}"
register: user_list
Return Values
- changed
Indicates if any change has been made by the module. This will always be false.
returned: alwaystype: bool- msg
An error message that describes the failure.
returned: failuretype: str- users
The list of users, with a subset of their properties.
returned: successtype: listelements: dictsample:[ { "name": "Standard", "type": "system-defined" }, { "name": "User 1", "type": "standard" } ]
- name
User name
type: str- type
Type of the user (
standard
,template
,pattern-based
,system-defined
)type: str- {additional_property}
Additional properties requested via
full_properties
. The property names will have underscores instead of hyphens.type: raw- user_role_names
Only present if
expand_names=true
: Name of the user roles referenced by propertyuser_roles
.type: str- user_pattern_name
Only present for users with
type=pattern
and ifexpand_names=true
: Name of the user pattern referenced by propertyuser_pattern_uri
.type: str- user_template_name
Only present for users with
type=pattern
and ifexpand_names=true
: Name of the template user referenced by propertyuser_template_uri
.type: str- password_rule_name
Only present if
expand_names=true
: Name of the password rule referenced by propertypassword_rule_uri
.type: str- ldap_server_definition_name
Only present if
expand_names=true
: Name of the LDAP server definition referenced by propertyldap_server_definition_uri
.type: str- primary_mfa_server_definition_name
Only present if
expand_names=true
: Name of the MFA server definition referenced by propertyprimary_mfa_server_definition_uri
.type: str- backup_mfa_server_definition_name
Only present if
expand_names=true
: Name of the MFA server definition referenced by propertybackup_mfa_server_definition_uri
.type: str- default_group_name
Only present if
expand_names=true
: Name of the Group referenced by propertydefault_group_uri
.type: str