dellemc.openmanage.ome_domain_user_groups module – Create, modify, or delete an Active Directory/LDAP user group on OpenManage Enterprise and OpenManage Enterprise Modular
Note
This module is part of the dellemc.openmanage collection (version 8.5.0).
To install it, use: ansible-galaxy collection install dellemc.openmanage
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: dellemc.openmanage.ome_domain_user_groups
.
New in dellemc.openmanage 4.0.0
Synopsis
This module allows to create, modify, or delete an Active Directory/LDAP user group on OpenManage Enterprise and OpenManage Enterprise Modular.
Requirements
The below requirements are needed on the host that executes this module.
python >= 3.9.6
Parameters
Parameter |
Comments |
---|---|
The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for the validation. |
|
The ID of the Active Directory/LDAP. directory_id is mutually exclusive with directory_name. |
|
The directory name set while adding the Active Directory/LDAP. directory_name is mutually exclusive with directory_id. |
|
Type of the account. Choices:
|
|
Active Directory/LDAP domain password. |
|
Active Directory/LDAP domain username. Example: username@domain or domain\username. |
|
The desired Active Directory/LDAP 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. |
|
OpenManage Enterprise or OpenManage Enterprise Modular IP address or hostname. |
|
OpenManage Enterprise or OpenManage Enterprise Modular password. |
|
OpenManage Enterprise or OpenManage Enterprise Modular HTTPS port. Default: |
|
The desired roles and privilege for the imported Active Directory/LDAP 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. |
|
Choices:
|
|
The socket level timeout in seconds. Default: |
|
OpenManage Enterprise or OpenManage Enterprise Modular username. |
|
If Configure Prior to collection version Choices:
|
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"
ca_path: "/path/to/ca_cert.pem"
state: present
group_name: account operators
directory_name: directory_name
role: administrator
domain_username: username@domain
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"
ca_path: "/path/to/ca_cert.pem"
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"
ca_path: "/path/to/ca_cert.pem"
state: absent
group_name: administrators
- name: Import LDAP directory group.
dellemc.openmanage.ome_domain_user_groups:
hostname: "192.168.0.1"
username: "username"
password: "password"
ca_path: "/path/to/ca_cert.pem"
directory_type: LDAP
state: present
group_name: account operators
directory_name: directory_name
role: administrator
domain_username: username@domain
domain_password: domain_password
- name: Remove LDAP directory group.
dellemc.openmanage.ome_domain_user_groups:
hostname: "192.168.0.1"
username: "username"
password: "password"
ca_path: "/path/to/ca_cert.pem"
state: absent
group_name: account operators
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Details of the domain user operation, when state is Returned: When state is Sample: |
|
Details of the HTTP Error. Returned: on HTTP error Sample: |
|
Overall status of the Active Directory/LDAP user group operation. Returned: always Sample: |