dellemc.openmanage.ome_identity_pool 模块 – 在 OpenManage Enterprise 上管理身份池设置

注意

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

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

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

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

dellemc.openmanage 2.1.0 中的新增功能

概要 

此模块允许在 OpenManage Enterprise 上创建、修改或删除单个身份池。

要求 

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

python >= 3.9.6

参数 

参数	注释
ca_path 路径 dellemc.openmanage 5.0.0 中新增	包含用于验证的 CA 证书的隐私增强邮件 (PEM) 文件。
ethernet_settings 字典	适用于使用以太网设置创建和修改身份池。创建身份池需要 starting_mac_address 和 identity_count。
identity_count 整数	MAC 地址数量。
starting_mac_address 字符串	以太网设置的起始 MAC 地址。
fc_settings 字典	适用于使用光纤通道 (FC) 设置创建和修改身份池。此选项允许 OpenManage Enterprise 生成全球端口名称 (WWPN) 和全球节点名称 (WWNN) 地址。值 0x2001 是 WWPN 生成起始地址的开始，0x2000 是 WWNN 的起始地址。创建身份池需要 starting_address 和 identity_count。
identity_count 整数	MAC 地址数量。创建 FC 设置需要 identity_count 选项。
starting_address 字符串	FC 设置的起始 MAC 地址。创建 FC 设置需要 starting_address 选项。
fcoe_settings 字典	适用于使用 FCoE 设置创建和修改身份池。创建身份池需要 starting_mac_address 和 identity_count。
identity_count 整数	MAC 地址数量。
starting_mac_address 字符串	FCoE 设置的起始 MAC 地址。
hostname 字符串 / 必需	OpenManage Enterprise 或 OpenManage Enterprise Modular 的 IP 地址或主机名。
iscsi_settings 字典	适用于使用 ISCSI 设置创建和修改身份池。创建身份池需要 starting_mac_address、identity_count、iqn_prefix、ip_range 和 subnet_mask。
identity_count 整数	MAC 地址数量。
initiator_config 字典	适用于使用 iSCSI 发起程序设置创建和修改身份池。
iqn_prefix 字符串	IQN 前缀地址。
initiator_ip_pool_settings 字典	适用于使用 iSCSI 发起程序 IP 池设置创建和修改身份池。
gateway 字符串	网关的 IP 地址。
ip_range 字符串	非组播 IP 地址范围。
primary_dns_server 字符串	主 DNS 服务器的 IP 地址。
secondary_dns_server 字符串	辅助 DNS 服务器的 IP 地址。
subnet_mask 字符串	ip_range 的子网掩码。
starting_mac_address 字符串	iSCSI 设置的起始 MAC 地址。这是 iSCSI 设置的必需选项。
new_pool_name 字符串	创建身份池后，可以将 pool_name 更改为 new_pool_name。创建身份池时忽略此选项。
password 字符串	OpenManage Enterprise 或 OpenManage Enterprise Modular 密码。如果未提供密码，则使用环境变量 `OME_PASSWORD`。示例：export OME_PASSWORD=password
pool_description 字符串	身份池的描述。
pool_name 字符串 / 必需	创建、修改和删除身份池时，此选项对于 state 来说是必需的。
port 整数	OpenManage Enterprise 或 OpenManage Enterprise Modular 的 HTTPS 端口。默认值： `443`
state 字符串	`present` 修改现有身份池。如果提供的 I (pool_name) 不存在，则创建身份池。- `absent` 删除现有身份池。选项 `"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

备注 

注意

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

示例 

---
- name: Create an identity pool using ethernet, FCoE, iSCSI and FC settings
  dellemc.openmanage.ome_identity_pool:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    state: present
    pool_name: "pool1"
    pool_description: "Identity pool with Ethernet, FCoE, iSCSI and FC settings"
    ethernet_settings:
      starting_mac_address: "50:50:50:50:50:00"
      identity_count: 60
    fcoe_settings:
      starting_mac_address: "70:70:70:70:70:00"
      identity_count: 75
    iscsi_settings:
      starting_mac_address: "60:60:60:60:60:00"
      identity_count: 30
      initiator_config:
        iqn_prefix: "iqn.myprefix."
      initiator_ip_pool_settings:
        ip_range: "10.33.0.1-10.33.0.255"
        subnet_mask: "255.255.255.0"
        gateway: "192.168.4.1"
        primary_dns_server: "10.8.8.8"
        secondary_dns_server: "8.8.8.8"
    fc_settings:
      starting_address: "30:30:30:30:30:00"
      identity_count: 45

- name: Create an identity pool using only ethernet settings
  dellemc.openmanage.ome_identity_pool:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    pool_name: "pool2"
    pool_description: "create identity pool with ethernet"
    ethernet_settings:
      starting_mac_address: "aa-bb-cc-dd-ee-aa"
      identity_count: 80

- name: Modify an identity pool
  dellemc.openmanage.ome_identity_pool:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    pool_name: "pool2"
    new_pool_name: "pool3"
    pool_description: "modifying identity pool with ethernet and fcoe settings"
    ethernet_settings:
      starting_mac_address: "90-90-90-90-90-90"
      identity_count: 61
    fcoe_settings:
      starting_mac_address: "aabb.ccdd.5050"
      identity_count: 77

- name: Modify an identity pool using iSCSI and FC settings
  dellemc.openmanage.ome_identity_pool:
    hostname: "{{hostname}}"
    username: "{{username}}"
    password: "{{password}}"
    ca_path: "/path/to/ca_cert.pem"
    pool_name: "pool_new"
    new_pool_name: "pool_new2"
    pool_description: "modifying identity pool with iscsi and fc settings"
    iscsi_settings:
      identity_count: 99
      initiator_config:
        iqn_prefix: "iqn1.myprefix2."
      initiator_ip_pool_settings:
        gateway: "192.168.4.5"
    fc_settings:
      starting_address: "10:10:10:10:10:10"
      identity_count: 98

- name: Delete an identity pool
  dellemc.openmanage.ome_identity_pool:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    state: "absent"
    pool_name: "pool2"

返回值 

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

键	描述
error_info 字典	HTTP 错误的详细信息。返回：HTTP 错误时示例： {"error": {"@Message.ExtendedInfo": [{"Message": "由于发生错误，无法处理请求：发现以太网MAC地址范围重叠（在此身份池或其他身份池中）。", "MessageArgs": ["发现以太网MAC地址范围重叠（在此身份池或其他身份池中）\""], "MessageId": "CGEN6001", "RelatedProperties": [], "Resolution": "重试操作。如果问题仍然存在，请联系您的系统管理员。", "Severity": "Critical"}], "code": "Base.1.0.GeneralError", "message": "发生一般错误。请参阅ExtendedInfo了解更多信息。"}
msg 字符串	身份池操作的整体状态。返回值：始终返回示例： `"成功创建了一个身份池。"`
pool_status 字典	当state为`present`时，用户操作的详细信息。返回值：success 示例： `{"Id": 29, "IsSuccessful": true, "Issues": []}`

作者

Sajna Shetty(@Sajna-Shetty)
Deepak Joshi(@Dell-Deepak-Joshi)