dellemc.openmanage.ome_domain_user_groups 模块 – 在 OpenManage Enterprise 和 OpenManage Enterprise Modular 上创建、修改或删除 Active Directory/LDAP 用户组

注意

此模块是 dellemc.openmanage 集合（版本 9.9.0）的一部分。

如果您使用的是 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install dellemc.openmanage。您需要其他要求才能使用此模块，请参阅要求以了解详细信息。

要在 playbook 中使用它，请指定：dellemc.openmanage.ome_domain_user_groups。

dellemc.openmanage 4.0.0 中的新增功能

概要 

此模块允许在 OpenManage Enterprise 和 OpenManage Enterprise Modular 上创建、修改或删除 Active Directory/LDAP 用户组。

要求 

执行此模块的主机上需要以下要求。

python >= 3.9.6

参数 

参数	注释
ca_path 路径在 dellemc.openmanage 5.0.0 中添加	包含用于验证的 CA 证书的隐私增强邮件 (PEM) 文件。
directory_id 整数	Active Directory/LDAP 的 ID。 directory_id 与 directory_name 互斥。
directory_name 字符串	添加 Active Directory/LDAP 时设置的目录名称。 directory_name 与 directory_id 互斥。
directory_type 字符串	帐户类型。选项 `"AD"` ← (默认) `"LDAP"`
domain_password 字符串	Active Directory/LDAP 域密码。
domain_username 字符串	Active Directory/LDAP 域用户名。示例：username@domain 或 domain\username。
group_name 字符串 / 必需	要导入或删除的所需 Active Directory/LDAP 用户组名称。用户组名称示例：Administrator 或 Account Operators 或 Access Control Assistance Operator。 group_name 值不区分大小写。
hostname 字符串 / 必需	OpenManage Enterprise 或 OpenManage Enterprise Modular IP 地址或主机名。
password 字符串	OpenManage Enterprise 或 OpenManage Enterprise Modular 密码。如果未提供密码，则使用环境变量 `OME_PASSWORD`。示例：export OME_PASSWORD=password
port 整数	OpenManage Enterprise 或 OpenManage Enterprise Modular HTTPS 端口。默认值： `443`
role 字符串	导入的 Active Directory/LDAP 用户组所需的角色和权限。 OpenManage Enterprise Modular 角色：CHASSIS ADMINISTRATOR、COMPUTE MANAGER、STORAGE MANAGER、FABRIC MANAGER、VIEWER。 OpenManage Enterprise 角色：ADMINISTRATOR、DEVICE MANAGER、VIEWER。 role 值不区分大小写。
state 字符串	`present` 导入或修改 Active Directory/LDAP 用户组。 `absent` 删除现有的 Active Directory/LDAP 用户组。选项 `"present"` ← (默认) `"absent"`
timeout 整数在 dellemc.openmanage 5.0.0 中添加	套接字级别的超时（以秒为单位）。默认值： `30`
username 字符串	OpenManage Enterprise 或 OpenManage Enterprise Modular 用户名。如果未提供用户名，则使用环境变量 `OME_USERNAME`。示例：export OME_USERNAME=username
validate_certs 布尔值在 dellemc.openmanage 5.0.0 中添加	如果 `false`，则不会验证 SSL 证书。仅在个人控制的站点（使用自签名证书）上配置 `false`。在集合版本 `5.0.0` 之前，validate_certs 默认为 `false`。选项 `false` `true` ← (默认)
x_auth_token 字符串在 dellemc.openmanage 9.3.0 中添加	身份验证令牌。如果未提供 x_auth_token，则使用环境变量 `OME_X_AUTH_TOKEN`。示例：export OME_X_AUTH_TOKEN=x_auth_token

备注 

注意

此模块支持 check_mode 和幂等性。
从可以直接访问 OpenManage Enterprise 或 OpenManage Enterprise Modular 的系统运行此模块。

示例 

---
- 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

返回值 

常用的返回值记录在此处，以下是此模块特有的字段

键	描述
domain_user_status 字典	当state为`present`时，域用户操作的详细信息。返回: 当state为`present`时。示例: `{"Description": null, "DirectoryServiceId": 16097, "Enabled": true, "Id": "16617", "IsBuiltin": false, "IsVisible": true, "Locked": false, "Name": "Account Operators", "ObjectGuid": "a491859c-031e-42a3-ae5e-0ab148ecf1d6", "ObjectSid": null, "Oem": null, "Password": null, "PlainTextPassword": null, "RoleId": "16", "UserName": "Account Operators", "UserTypeId": 2}`
error_info 字典	HTTP 错误的详细信息。返回: 在HTTP错误时示例: `{"error": {"@Message.ExtendedInfo": [{"Message": "无法处理请求，因为发生了错误。", "MessageArgs": [], "MessageId": "GEN1234", "RelatedProperties": [], "Resolution": "重试操作。如果问题仍然存在，请联系您的系统管理员。", "Severity": "Critical"}], "code": "Base.1.0.GeneralError", "message": "发生了一般错误。有关更多信息，请参阅ExtendedInfo。"}}`
msg 字符串	Active Directory/LDAP 用户组操作的整体状态。返回: 总是示例: `"成功导入了Active Directory/LDAP用户组。"`

作者

Felix Stephen (@felixs88)
Abhishek Sinha (@Abhishek-Dell)