dellemc.openmanage.ome_domain_user_groups – Create, modify, or delete an Active Directory user group on OpenManage Enterprise and OpenManage Enterprise Modular

Note

This plugin is part of the dellemc.openmanage collection (version 4.3.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_domain_user_groups.

New in version 4.0.0: of dellemc.openmanage

Synopsis

  • This module allows to create, modify, or delete an Active Directory user group on OpenManage Enterprise and OpenManage Enterprise Modular.

Requirements

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

  • python >= 2.7.17

Parameters

Parameter Choices/Defaults Comments
directory_id
integer
The ID of the Active Directory.
directory_id is mutually exclusive with directory_name.
directory_name
string
The directory name set while adding the Active Directory.
directory_name is mutually exclusive with directory_id.
domain_password
string
Active directory domain password.
domain_username
string
Active directory domain username.
Example: [email protected] or domain\username.
group_name
string / required
The desired Active Directory user group name to be imported or removed.
Examples for user group name: Administrator or Account Operators or Access Control Assistance Operator.
group_name value is case insensitive.
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
Default:
443
OpenManage Enterprise or OpenManage Enterprise Modular HTTPS port.
role
string
The desired roles and privilege for the imported Active Directory user group.
OpenManage Enterprise Modular Roles: CHASSIS ADMINISTRATOR, COMPUTE MANAGER, STORAGE MANAGER, FABRIC MANAGER, VIEWER.
OpenManage Enterprise Roles: ADMINISTRATOR, DEVICE MANAGER, VIEWER.
role value is case insensitive.
state
string
    Choices:
  • present ←
  • absent
present imports or modifies the Active Directory user group.
absent deletes an existing Active Directory user group.
username
string / required
OpenManage Enterprise or OpenManage Enterprise Modular username.

Notes

Note

  • This module supports check_mode and idempotency.

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

Examples

---
- name: Create Active Directory user group
  dellemc.openmanage.ome_domain_user_groups:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    state: present
    group_name: account operators
    directory_name: directory_name
    role: administrator
    domain_username: [email protected]
    domain_password: domain_password

- name: Update Active Directory user group
  dellemc.openmanage.ome_domain_user_groups:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    state: present
    group_name: account operators
    role: viewer

- name: Delete active directory user group
  dellemc.openmanage.ome_domain_user_groups:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    state: absent
    group_name: administrators

Return Values

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

Key Returned Description
domain_user_status
dictionary
When state is present.
Details of the domain user operation, when state is present.

Sample:
{'Description': None, 'DirectoryServiceId': 16097, 'Enabled': True, 'Id': '16617', 'IsBuiltin': False, 'IsVisible': True, 'Locked': False, 'Name': 'Account Operators', 'ObjectGuid': 'a491859c-031e-42a3-ae5e-0ab148ecf1d6', 'ObjectSid': None, 'Oem': None, 'Password': None, 'PlainTextPassword': None, 'RoleId': '16', 'UserName': 'Account Operators', 'UserTypeId': 2}
error_info
dictionary
on HTTP error
Details of the HTTP Error.

Sample:
{'error': {'@Message.ExtendedInfo': [{'Message': 'Unable to process the request because an error occurred.', 'MessageArgs': [], 'MessageId': 'GEN1234', 'RelatedProperties': [], 'Resolution': 'Retry the operation. If the issue persists, contact your system administrator.', 'Severity': 'Critical'}], 'code': 'Base.1.0.GeneralError', 'message': 'A general error has occurred. See ExtendedInfo for more information.'}}
msg
string
always
Overall status of the Active Directory user group operation.

Sample:
Successfully imported the active directory user group.


Authors

  • Felix Stephen (@felixs88)