Users Guide

Synopsis
This module:
• creates a new user account.
• modifies or deletes an existing user account.
Options
Table 73. ome_user
Parameter Required Default Choices Comments
hostname Yes NA NA Target IP Address or hostname
username Yes NA NA Target username
password Yes NA NA Target user password
port No 443 NA Target device HTTPS port
state No present
• present
• absent
• C(present) creates a user in case the I(UserName)
provided inside I(attributes) does not exist .
• C(present) modifies a user in case the I(UserName)
provided inside I(attributes) exists .
• C(absent) deletes an existing user.
user_id No NA NA
• ID of the user to be deleted.
• Either I (user_id) or I (name) is mandatory for C (absent)
operation.
name No NA NA
• Name of the user to be deleted
• Either I (user_id) or I (name) is mandatory for C (absent)
operation.
attributes No { } NA
Payload data for the user operations. It can take the following
attributes for C(present):
• UserTypeId
• DirectoryServiceId
• Description
• Name
• Password
• UserName
• RoleId
• Locked
• Enabled
NOTE: OME will throw an error message if required
parameter is not provided for the operation.
NOTE: See OpenManage Enterprise API Reference
Guide for more details.
Return Values
msg:
description: Overall status of the user operation.
returned: always
type: str
sample: "Successfully created a User"
user_status:
description: Details of the user operation when I(state) is C(present).
returned: When I(state) is C(present).
type: dict
sample:
{
"Description": "Test user creation",
Modules for OpenManage Enterprise (OME)
97