dellemc.openmanage.ome_identity_pool module – Manages identity pool settings on OpenManage Enterprise
Note
This module is part of the dellemc.openmanage collection (version 8.5.0).
To install it, use: ansible-galaxy collection install dellemc.openmanage
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: dellemc.openmanage.ome_identity_pool
.
New in dellemc.openmanage 2.1.0
Synopsis
This module allows to create, modify, or delete a single identity pool on OpenManage Enterprise.
Requirements
The below requirements are needed on the host that executes this module.
python >= 3.8.6
Parameters
Parameter |
Comments |
---|---|
The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for the validation. |
|
Applicable for creating and modifying an identity pool using Ethernet settings. starting_mac_address and identity_count are required to create an identity pool. |
|
Number of MAC addresses. |
|
Starting MAC address of the ethernet setting. |
|
Applicable for creating and modifying an identity pool using fibre channel(FC) settings. This option allows OpenManage Enterprise to generate a Worldwide port name (WWPN) and Worldwide node name (WWNN) address. The value 0x2001 is beginning to the starting address for the generation of a WWPN, and 0x2000 for a WWNN. starting_address and identity_count are required to create an identity pool. |
|
Number of MAC addresses.identity_count is required to option to create FC settings. |
|
Starting MAC Address of FC setting.starting_address is required to option to create FC settings. |
|
Applicable for creating and modifying an identity pool using FCoE settings. starting_mac_address and identity_count are required to create an identity pool. |
|
Number of MAC addresses. |
|
Starting MAC Address of the FCoE setting. |
|
OpenManage Enterprise or OpenManage Enterprise Modular IP address or hostname. |
|
Applicable for creating and modifying an identity pool using ISCSI settings. starting_mac_address, identity_count, iqn_prefix, ip_range and subnet_mask are required to create an identity pool. |
|
Number of MAC addresses. |
|
Applicable for creating and modifying an identity pool using iSCSI Initiator settings. |
|
IQN prefix addresses. |
|
Applicable for creating and modifying an identity pool using ISCSI Initiator IP pool settings. |
|
IP address of gateway. |
|
Range of non-multicast IP addresses. |
|
IP address of the primary DNS server. |
|
IP address of the secondary DNS server. |
|
Subnet mask for ip_range. |
|
Starting MAC address of the iSCSI setting.This is required option for iSCSI setting. |
|
After creating an identity pool, pool_name can be changed to new_pool_name. This option is ignored when creating an identity pool. |
|
OpenManage Enterprise or OpenManage Enterprise Modular password. |
|
Description of the identity pool. |
|
This option is mandatory for state when creating, modifying and deleting an identity pool. |
|
OpenManage Enterprise or OpenManage Enterprise Modular HTTPS port. Default: |
|
Choices:
|
|
The socket level timeout in seconds. Default: |
|
OpenManage Enterprise or OpenManage Enterprise Modular username. |
|
If Configure Prior to collection version Choices:
|
Notes
Note
Run this module from a system that has direct access to Dell OpenManage Enterprise.
This module supports
check_mode
.
Examples
---
- 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"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Details of the HTTP Error. Returned: on HTTP error Sample: |
|
Overall status of the identity pool operation. Returned: always Sample: |
|
Details of the user operation, when state is Returned: success Sample: |