dellemc.openmanage.ome_active_directory 模块 – 配置与目录服务一起使用的 Active Directory 组

注意

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

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

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

要在剧本中使用它，请指定：dellemc.openmanage.ome_active_directory。

dellemc.openmanage 4.0.0 中的新增功能

概要

• 此模块允许添加、修改和删除与 Active Directory 服务的 OpenManage Enterprise 连接。

要求

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

• python >= 3.9.6

参数

参数	注释
ca_path 路径 在 dellemc.openmanage 5.0.0 中添加	包含用于验证的 CA 证书的隐私增强邮件 (PEM) 文件。
certificate_file 路径	提供 SSL 证书的完整路径。 证书应为以 Base64 格式编码的根 CA 证书。 当 validate_certificate 为 true 时适用。
domain_controller_lookup 字符串	选择域控制器查找方法。 选项 "DNS" ← (默认) "MANUAL"
domain_controller_port 整数	域控制器端口。 默认情况下，将填充全局目录地址端口号 3269。 对于域控制器访问，请输入 636 作为端口号。 注意，仅支持 LDAPS 端口。 默认值： 3269
domain_password 字符串	提供域密码。 当 test_connection 为 true 时适用。
domain_server 列表 / 元素=字符串	输入域控制器的域名或 FQDN 或 IP 地址。 如果 domain_controller_lookup 为 DNS，请输入域名以查询 DNS 以获取域控制器。 如果 domain_controller_lookup 为 MANUAL，请输入域控制器的 FQDN 或 IP 地址。最多可以添加三个 Active Directory 服务器。
domain_username 字符串	以 UPN (username@domain) 或 NetBIOS (domain\\username) 格式提供域用户名。 当 test_connection 为 true 时适用。
group_domain 字符串	以 example.com 或 ou=org, dc=example, dc=com 格式提供组域名。
hostname 字符串 / 必填	OpenManage Enterprise 或 OpenManage Enterprise Modular 的 IP 地址或主机名。
id 整数	提供现有 Active Directory 服务连接的 ID。 这适用于修改和删除。 这与 name 互斥。
name 字符串	为 Active Directory 连接提供名称。 这适用于创建和删除。 这与 name 互斥。
network_timeout 整数	输入网络超时持续时间（秒）。 支持的超时持续时间范围为 15 到 300 秒。 默认值： 120
password 字符串	OpenManage Enterprise 或 OpenManage Enterprise Modular 密码。 如果未提供密码，则使用环境变量 OME_PASSWORD。 示例：export OME_PASSWORD=password
port 整数	OpenManage Enterprise 或 OpenManage Enterprise Modular HTTPS 端口。 默认值： 443
search_timeout 整数	输入搜索超时持续时间（秒）。 支持的超时持续时间范围为 15 到 300 秒。 默认值： 120
state 字符串	present 允许创建或修改 Active Directory 服务。 absent 允许删除 Active Directory 服务。 选项 "present" ← (默认) "absent"
test_connection 布尔值	启用测试与域控制器的连接。 使用提供的 Active Directory 服务详细信息测试与域控制器的连接。 如果测试失败，模块将出错。 如果为 true，则必须提供 domain_username 和 domain_password。 选项 false ← (默认) true
timeout 整数 在 dellemc.openmanage 5.0.0 中添加	套接字级别的超时时间（秒）。 默认值： 30
username 字符串	OpenManage Enterprise 或 OpenManage Enterprise Modular 用户名。 如果未提供用户名，则使用环境变量 OME_USERNAME。 示例：export OME_USERNAME=username
validate_certificate 布尔值	启用域控制器的 SSL 证书验证。 当此值为 true 时，模块将始终报告更改。 选项 false ← (默认) true
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

备注

注意

• 当 validate_certificate 为 true 时，模块将始终报告更改。

• 从可以直接访问 OpenManage Enterprise 的系统运行此模块。

• 此模块支持 check_mode。

示例

---
- name: Add Active Directory service using DNS lookup along with the test connection
  dellemc.openmanage.ome_active_directory:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    name: my_ad1
    domain_server:
      - domainname.com
    group_domain: domainname.com
    test_connection: true
    domain_username: user@domainname
    domain_password: domain_password

- name: Add Active Directory service using IP address of the domain controller with certificate validation
  dellemc.openmanage.ome_active_directory:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    name: my_ad2
    domain_controller_lookup: MANUAL
    domain_server:
      - 192.68.20.181
    group_domain: domainname.com
    validate_certificate: true
    certificate_file: "/path/to/certificate/file.cer"

- name: Modify domain controller IP address, network_timeout and group_domain
  dellemc.openmanage.ome_active_directory:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    name: my_ad2
    domain_controller_lookup: MANUAL
    domain_server:
      - 192.68.20.189
    group_domain: newdomain.in
    network_timeout: 150

- name: Delete Active Directory service
  dellemc.openmanage.ome_active_directory:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    name: my_ad2
    state: absent

- name: Test connection to existing Active Directory service with certificate validation
  dellemc.openmanage.ome_active_directory:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    name: my_ad2
    test_connection: true
    domain_username: user@domainname
    domain_password: domain_password
    validate_certificate: true
    certificate_file: "/path/to/certificate/file.cer"

返回值

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

键	描述
active_directory 字典	此模块添加、修改或删除的活动目录。 返回值：如有更改 示例： {"CertificateValidation": false, "DnsServer": [], "GroupDomain": "dellemcdomain.com", "Id": 21789, "Name": "ad_test", "NetworkTimeOut": 120, "Password": null, "SearchTimeOut": 120, "ServerName": ["192.168.20.181"], "ServerPort": 3269, "ServerType": "MANUAL"}
error_info 字典	HTTP 错误的详细信息。 返回值：HTTP 错误时 示例： {"error_info": {"error": {"@Message.ExtendedInfo": [{"Message": "Unable to connect to the LDAP or AD server because the entered credentials are invalid.", "MessageArgs": [], "MessageId": "CSEC5002", "RelatedProperties": [], "Resolution": "Make sure the server input configuration are valid and retry the operation.", "Severity": "Critical"}], "code": "Base.1.0.GeneralError", "message": "A general error has occurred. See ExtendedInfo for more information."}}}
msg 字符串	活动目录操作的整体状态。 返回值：始终 示例： "Successfully renamed the slot(s)."

作者

• Jagadeesh N V(@jagadeeshnv)

集合链接

• 问题追踪器
• 主页
• 代码库 (源代码)