Users Guide
Table Of Contents
- Dell EMC OpenManage Ansible Modules Version 4.0.0 User’s Guide
- Contents
- Overview
- Getting Started
- Modules for iDRAC
- How OpenManage Ansible Modules work with iDRAC
- Running your first iDRAC Playbook
- Updating Firmware
- Configuring PowerEdge Servers
- Deploying operating system
- Server Inventory
- Server administration tasks
- Storage controller
- Modules for OpenManage Enterprise (OME)
- How OpenManage Ansible Modules work with OME
- Running your first OME Playbook
- Manage Devices
- Manage device configuration templates
- Template Service
- Manage the device firmware
- Manage jobs
- Manage users
- Manage identity pool
- Manage application settings
- Manage network configuration
- Manage fabrics
- Manage Profiles
- Device discovery
- Manage Chassis
- Manage Active Directory service and user groups
- Diagnostics
- Modules for Redfish APIs
- Deprecated modules
Table 42. ome_user (continued)
Parameter Required Default Choices Comments
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
dellemc.openmanage.ome_user:
hostname: "192.168.0.1"
username: "username"
password: "password"
attributes:
UserName: "user1"
Password: "UserPassword"
RoleId: "10",
Enabled: True
- name: Create user with all parameters
dellemc.openmanage.ome_user:
hostname: "192.168.0.1"
username: "username"
password: "password"
attributes:
UserName: "user2"
Description: "user2 description"
Password: "UserPassword"
RoleId: "10"
Enabled: True
DirectoryServiceId: 0
UserTypeId: 1
Locked: False
Name: "user2"
- name: Modify existing user
dellemc.openmanage.ome_user:
hostname: "192.168.0.1"
Modules for OpenManage Enterprise (OME)
107