dellemc.openmanage.ome_groups 模块 – 在 OpenManage Enterprise 上管理静态设备组

注意

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

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

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

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

dellemc.openmanage 3.5.0 中的新增功能

概要 

此模块允许创建、修改和删除 OpenManage Enterprise 上的静态设备组。

要求 

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

python >= 3.9.6

参数 

参数	注释
ca_path 路径 dellemc.openmanage 5.0.0 中添加	包含用于验证的 CA 证书的隐私增强邮件 (PEM) 文件。
description 字符串	设备组的描述。这只在 state 为 `present` 时适用。
group_id 列表 / 元素=整数	要创建、修改或删除的设备组的 ID。如果 state 为 absent，则可以提供多个 ID。此选项与 name 互斥。
hostname 字符串 / 必需	OpenManage Enterprise IP 地址或主机名。
name 列表 / 元素=字符串	要创建、修改或删除的设备组的名称。如果 state 为 absent，则可以提供多个名称。此选项不区分大小写。此选项与 group_id 互斥。
new_name 字符串	现有设备组的新名称。这只在 state 为 `present` 时适用。
parent_group_id 整数	要创建或修改的设备组所属的父设备组的 ID。这只在 state 为 `present` 时适用。此选项与 parent_group_name 互斥。
parent_group_name 字符串	要创建或修改的设备组所属的父设备组的名称。这只在 state 为 `present` 时适用。 `注意`如果不存在具有此名称的设备组，则会创建名称为 parent_group_name 的设备组。此选项不区分大小写。此选项与 parent_group_id 互斥。默认值： `"Static Groups"`
password 字符串	OpenManage Enterprise 密码。如果未提供密码，则使用环境变量 `OME_PASSWORD`。示例：export OME_PASSWORD=password
port 整数	OpenManage Enterprise HTTPS 端口。默认值： `443`
state 字符串	`present` 允许创建或修改设备组。 `absent` 允许删除设备组。选项 `"present"` ← (默认) `"absent"`
timeout 整数 dellemc.openmanage 5.0.0 中添加	以秒为单位的套接字级别超时。默认值： `30`
username 字符串	OpenManage Enterprise 用户名。如果未提供用户名，则使用环境变量 `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 上的静态设备组。
如果名为parent_group_name的设备组不存在，则会创建一个同名的新的设备组。
确保输入的父组不是所提供组的子组。
从此模块可以直接访问 Dell OpenManage Enterprise 的系统运行此模块。
此模块支持check_mode。

示例 

---
- name: Create a new device group
  dellemc.openmanage.ome_groups:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    name: "group 1"
    description: "Group 1 description"
    parent_group_name: "group parent 1"

- name: Modify a device group using the group ID
  dellemc.openmanage.ome_groups:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    group_id: 1234
    description: "Group description updated"
    parent_group_name: "group parent 2"

- name: Delete a device group using the device group name
  dellemc.openmanage.ome_groups:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    state: absent
    name: "group 1"

- name: Delete multiple device groups using the group IDs
  dellemc.openmanage.ome_groups:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    state: absent
    group_id:
      - 1234
      - 5678

返回值 

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

键	描述
error_info 字典	HTTP 错误的详细信息。返回：HTTP 错误时示例：`{"error": {"@Message.ExtendedInfo": [{"Message": "无法使用提供的父组 54321 更新组 12345，因为组/父组关系已存在。", "MessageArgs": ["12345", "54321"], "MessageId": "CGRP9013", "RelatedProperties": [], "Resolution": "确保输入的父组 ID 不会创建双向关系，然后重试操作。", "Severity": "Warning"}], "code": "Base.1.0.GeneralError", "message": "发生一般错误。请参阅 ExtendedInfo 以获取更多信息。"} }`
group_ids 列表 / 元素=整数	已删除的设备组 ID 列表。返回：当state 为`absent`时示例：`[1234, 5678]`
group_status 字典	设备组操作状态的详细信息。返回：成功示例：`{"CreatedBy": "admin", "CreationTime": "2021-01-01 10:10:10.100", "DefinitionDescription": "UserDefined", "DefinitionId": 400, "Description": "我的组描述", "GlobalStatus": 5000, "HasAttributes": false, "Id": 12123, "IdOwner": 30, "MembershipTypeId": 12, "Name": "组 1", "ParentId": 12345, "TypeId": 3000, "UpdatedBy": "", "UpdatedTime": "2021-01-01 11:11:10.100", "Visible": true}`
invalid_groups 列表 / 元素=字符串	无效的设备组 ID 或名称列表。返回：当state 为`absent`时示例：`["1234", "5678"]`
msg 字符串	设备组操作的整体状态。返回：始终返回示例：`"已成功删除设备组。"`

作者

Jagadeesh N V(@jagadeeshnv)