Try SpotterManages identity pool settings on OpenManage Enterprise
| "added in version" 2.1.0 of dellemc.openmanage"
Authors: Sajna Shetty(@Sajna-Shetty), Deepak Joshi(@Dell-Deepak-Joshi))
Install with ansible-galaxy collection install dellemc.openmanage:==9.1.0
collections:
- name: dellemc.openmanage
version: 9.1.0This module allows to create, modify, or delete a single identity pool on OpenManage Enterprise.
---
- 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"
port:
default: 443
description: OpenManage Enterprise or OpenManage Enterprise Modular HTTPS port.
type: int
state:
choices:
- present
- absent
default: present
description:
- C(present) modifies an existing identity pool. If the provided I (pool_name) does
not exist, it creates an identity pool. - C(absent) deletes an existing identity
pool.
type: str
ca_path:
description:
- The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for
the validation.
type: path
version_added: 5.0.0
version_added_collection: dellemc.openmanage
timeout:
default: 30
description: The socket level timeout in seconds.
type: int
version_added: 5.0.0
version_added_collection: dellemc.openmanage
hostname:
description: OpenManage Enterprise or OpenManage Enterprise Modular IP address or
hostname.
required: true
type: str
password:
description:
- OpenManage Enterprise or OpenManage Enterprise Modular password.
- If the password is not provided, then the environment variable C(OME_PASSWORD) is
used.
- 'Example: export OME_PASSWORD=password'
required: true
type: str
username:
description:
- OpenManage Enterprise or OpenManage Enterprise Modular username.
- If the username is not provided, then the environment variable C(OME_USERNAME) is
used.
- 'Example: export OME_USERNAME=username'
required: true
type: str
pool_name:
description:
- This option is mandatory for I(state) when creating, modifying and deleting an identity
pool.
required: true
type: str
fc_settings:
description:
- 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.
- I(starting_address) and I(identity_count) are required to create an identity pool.
suboptions:
identity_count:
description: Number of MAC addresses.I(identity_count) is required to option to
create FC settings.
type: int
starting_address:
description: Starting MAC Address of FC setting.I(starting_address) is required
to option to create FC settings.
type: str
type: dict
fcoe_settings:
description:
- Applicable for creating and modifying an identity pool using FCoE settings.
- I(starting_mac_address) and I(identity_count) are required to create an identity
pool.
suboptions:
identity_count:
description: Number of MAC addresses.
type: int
starting_mac_address:
description: Starting MAC Address of the FCoE setting.
type: str
type: dict
new_pool_name:
description:
- After creating an identity pool, I(pool_name) can be changed to I(new_pool_name).
- This option is ignored when creating an identity pool.
type: str
iscsi_settings:
description:
- Applicable for creating and modifying an identity pool using ISCSI settings.
- I(starting_mac_address), I(identity_count), I(iqn_prefix), I(ip_range) and I(subnet_mask)
are required to create an identity pool.
suboptions:
identity_count:
description: Number of MAC addresses.
type: int
initiator_config:
description:
- Applicable for creating and modifying an identity pool using iSCSI Initiator
settings.
suboptions:
iqn_prefix:
description: IQN prefix addresses.
type: str
type: dict
initiator_ip_pool_settings:
description:
- Applicable for creating and modifying an identity pool using ISCSI Initiator
IP pool settings.
suboptions:
gateway:
description: IP address of gateway.
type: str
ip_range:
description: Range of non-multicast IP addresses.
type: str
primary_dns_server:
description: IP address of the primary DNS server.
type: str
secondary_dns_server:
description: IP address of the secondary DNS server.
type: str
subnet_mask:
description: Subnet mask for I(ip_range).
type: str
type: dict
starting_mac_address:
description: Starting MAC address of the iSCSI setting.This is required option
for iSCSI setting.
type: str
type: dict
validate_certs:
default: true
description:
- If C(false), the SSL certificates will not be validated.
- Configure C(false) only on personally controlled sites where self-signed certificates
are used.
- Prior to collection version C(5.0.0), the I(validate_certs) is C(false) by default.
type: bool
version_added: 5.0.0
version_added_collection: dellemc.openmanage
pool_description:
description:
- Description of the identity pool.
type: str
ethernet_settings:
description:
- Applicable for creating and modifying an identity pool using Ethernet settings.
- I(starting_mac_address) and I(identity_count) are required to create an identity
pool.
suboptions:
identity_count:
description: Number of MAC addresses.
type: int
starting_mac_address:
description: Starting MAC address of the ethernet setting.
type: str
type: dict
error_info:
description: Details of the HTTP Error.
returned: on HTTP error
sample:
error:
'@Message.ExtendedInfo':
- Message: 'Unable to process the request because an error occurred: Ethernet-MAC
Range overlap found (in this Identity Pool or in a different one) .'
MessageArgs:
- Ethernet-MAC Range overlap found (in this Identity Pool or in a different
one)"
MessageId: CGEN6001
RelatedProperties: []
Resolution: Retry the operation. If the issue persists, contact your system
administrator.
Severity: Critical
code: Base.1.0.GeneralError
message: A general error has occurred. See ExtendedInfo for more information.
type: dict
msg:
description: Overall status of the identity pool operation.
returned: always
sample: Successfully created an identity pool.
type: str
pool_status:
description: Details of the user operation, when I(state) is C(present).
returned: success
sample:
Id: 29
IsSuccessful: true
Issues: []
type: dict