dellemc.openmanage.ome_user 模块 – 在 OpenManage Enterprise 上创建、修改或删除用户

注意

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

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

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

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

dellemc.openmanage 2.0.0 中的新增功能

概要 

此模块在 OpenManage Enterprise 上创建、修改或删除用户。

要求 

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

python >= 3.9.6

参数 

参数	注释
attributes 字典	用户操作的有效负载数据。对于 `present`，它可以采用以下属性。 UserTypeId, DirectoryServiceId, Description, Name, Password, UserName, RoleId, Locked, Enabled。如果未为操作提供必需的参数，OME 将抛出错误。有关更多详细信息，请参阅 OpenManage Enterprise API 参考指南。默认值： `{}`
ca_path 路径在 dellemc.openmanage 5.0.0 中添加	包含用于验证的 CA 证书的隐私增强邮件 (PEM) 文件。
hostname 字符串 / 必填	OpenManage Enterprise 或 OpenManage Enterprise Modular 的 IP 地址或主机名。
name 字符串	要删除的用户的唯一名称。对于 `absent` 操作，user_id 或 name 必须至少提供一个。
password 字符串	OpenManage Enterprise 或 OpenManage Enterprise Modular 密码。如果未提供密码，则使用环境变量 `OME_PASSWORD`。示例：export OME_PASSWORD=password
port 整数	OpenManage Enterprise 或 OpenManage Enterprise Modular 的 HTTPS 端口。默认值： `443`
state 字符串	`present` 在 attributes 中提供的 UserName 不存在的情况下创建一个用户。 `present` 在 attributes 中提供的 UserName 存在的情况下修改用户。 `absent` 删除现有用户。选项 `"present"` ← (默认) `"absent"`
timeout 整数在 dellemc.openmanage 5.0.0 中添加	以秒为单位的套接字级别超时。默认值： `30`
user_id 整数	要删除的用户的唯一 ID。对于 `absent` 操作，user_id 或 name 必须至少提供一个。
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

注释 

注意

从此模块可以直接访问 Dell OpenManage Enterprise 的系统运行此模块。
此模块不支持 check_mode。

示例 

---
- name: Create user with required parameters
  dellemc.openmanage.ome_user:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    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"
    ca_path: "/path/to/ca_cert.pem"
    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"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    state: "present"
    attributes:
      UserName: "user3"
      RoleId: "10"
      Enabled: true
      Description: "Modify user Description"

- name: Delete existing user using id
  dellemc.openmanage.ome_user:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    state: "absent"
    user_id: 1234

- name: Delete existing user using name
  dellemc.openmanage.ome_user:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    state: "absent"
    name: "name"

返回值 

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

键	描述
msg 字符串	用户操作的总体状态。返回：始终示例： `"Successfully created a User"`
user_status 字典	当 state 为 `present` 时，用户操作的详细信息。返回：当 state 为 `present` 时。示例： `{"Description": "测试用户创建", "DirectoryServiceId": 0, "Enabled": true, "Id": "61546", "IsBuiltin": false, "Locked": false, "Name": "test", "Password": null, "PlainTextPassword": null, "RoleId": "10", "UserName": "test", "UserTypeId": 1}`

作者

Sajna Shetty(@Sajna-Shetty)