Users Guide

Parameter Required Default Choices Comments
user_id No NA NA
Unique ID of the user to be deleted.
NOTE: This option is mandatory for C(absent)
operations.
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",
"DirectoryServiceId": 0,
"Enabled": true,
"Id": "61546",
"IsBuiltin": false,
"Locked": false,
"Name": "test",
"ObjectGuid": null,
"Oem": null,
"Password": null,
"PlainTextPassword": null,
"RoleId": "10",
"UserName": "test",
"UserTypeId": 1
}
Examples
- name: create user with required parameters.
ome_user:
hostname: "192.168.0.1"
username: "username"
password: "password"
attributes:
UserName: "user1"
Password: "UserPassword"
RoleId: "10",
68
Modules for OpenManage Enterprise (OME)