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

Note

This plugin is part of the dellemc.openmanage collection (version 3.0.0).

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
Requirements
Parameters
Notes
Examples
Return Values

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 >= 2.7.5

Parameters

Parameter		Choices/Defaults	Comments
account_id integer			Unique Id of the account.
hostname string / required			Target IP address or hostname.
password string / required			Target user password.
port integer		Default: 443	Target HTTPS port.
system_query_options dictionary			Options for filtering the output.
	filter string		Filter records for the supported values.
username string / required			Target username.

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"

- 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"
    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"
    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	Returned	Description
msg string	on error	Over all status of fetching user facts. Sample: Unable to retrieve the account details.
user_info dictionary	success	Details of the user. Sample: {'192.168.0.1': {'Description': 'user name description', 'DirectoryServiceId': 0, 'Enabled': True, 'Id': '1814', 'IsBuiltin': True, 'Locked': False, 'Name': 'user_name', 'Password': None, 'RoleId': '10', 'UserName': 'user_name', 'UserTypeId': 1}}

Authors

Jagadeesh N V(@jagadeeshnv)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/dellemc/openmanage/ome_user_info_module.html