dellemc.openmanage.ome_user_info module – Retrieves details of all accounts or a specific account on OpenManage Enterprise

Note

This module is part of the dellemc.openmanage collection (version 5.4.0).

You might already have this collection installed if you are using the ansible package. 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 dellemc.openmanage.

To use it in a playbook, specify: dellemc.openmanage.ome_user_info.

New in version 2.0.0: of dellemc.openmanage

Synopsis

  • This module retrieves the list and basic details of all accounts or details of a specific account on OpenManage Enterprise.

Requirements

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

  • python >= 3.8.6

Parameters

Parameter

Comments

account_id

integer

Unique Id of the account.

ca_path

path

added in 5.0.0 of dellemc.openmanage

The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for the validation.

hostname

string / required

OpenManage Enterprise or OpenManage Enterprise Modular IP address or hostname.

password

string / required

OpenManage Enterprise or OpenManage Enterprise Modular password.

port

integer

OpenManage Enterprise or OpenManage Enterprise Modular HTTPS port.

Default: 443

system_query_options

dictionary

Options for filtering the output.

filter

string

Filter records for the supported values.

timeout

integer

added in 5.0.0 of dellemc.openmanage

The socket level timeout in seconds.

Default: 30

username

string / required

OpenManage Enterprise or OpenManage Enterprise Modular username.

validate_certs

boolean

added in 5.0.0 of dellemc.openmanage

If False, the SSL certificates will not be validated.

Configure False only on personally controlled sites where self-signed certificates are used.

Prior to collection version 5.0.0, the validate_certs is False by default.

Choices:

  • no

  • yes ← (default)

Notes

Note

  • Run this module from a system that has direct access to DellEMC OpenManage Enterprise.

  • This module supports check_mode.

Examples

---
- name: Retrieve basic details of all accounts
  dellemc.openmanage.ome_user_info:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"

- name: Retrieve details of a specific account identified by its account ID
  dellemc.openmanage.ome_user_info:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    account_id: 1

- name: Get filtered user info based on user name
  dellemc.openmanage.ome_user_info:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    system_query_options:
      filter: "UserName eq 'test'"

Return Values

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

Key

Description

msg

string

Over all status of fetching user facts.

Returned: on error

Sample: “Unable to retrieve the account details.”

user_info

dictionary

Details of the user.

Returned: success

Sample: {“192.168.0.1”: {“Description”: “user name description”, “DirectoryServiceId”: 0, “Enabled”: true, “Id”: “1814”, “IsBuiltin”: true, “Locked”: false, “Name”: “user_name”, “Password”: null, “RoleId”: “10”, “UserName”: “user_name”, “UserTypeId”: 1}}

Authors

  • Jagadeesh N V(@jagadeeshnv)