dellemc.openmanage.ome_identity_pool (2.1.5) — module

Manages identity pool settings on OpenManage Enterprise.

| "added in version" 2.9.10 of dellemc.openmanage"

Authors: Sajna Shetty(@Sajna-Shetty), Deepak Joshi(@Dell-Deepak-Joshi))

preview | supported by community

Install collection

Install with ansible-galaxy collection install dellemc.openmanage:==2.1.5


Add to requirements.yml

  collections:
    - name: dellemc.openmanage
      version: 2.1.5

Description

This module allows to create, modify, or delete a single identity pool on OpenManage Enterprise.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
---
- 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"
    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
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Create an identity pool using only ethernet settings.
  dellemc.openmanage.ome_identity_pool:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    pool_name: "pool2"
    pool_description: "create identity pool with ethernet"
    ethernet_settings:
        starting_mac_address: "aa-bb-cc-dd-ee-aa"
        identity_count: 80
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Modify an identity pool
  dellemc.openmanage.ome_identity_pool:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    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
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: "Modify an identity pool using iSCSI and FC settings."
  dellemc.openmanage.ome_identity_pool:
    hostname: "{{hostname}}"
    username: "{{username}}"
    password: "{{password}}"
    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
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Delete an identity pool
  dellemc.openmanage.ome_identity_pool:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    state: "absent"
    pool_name: "pool2"

Inputs

    
port:
    default: 443
    description: Target 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.
    required: false
    type: str

hostname:
    description: Target IP address or hostname.
    required: true
    type: str

password:
    description: Target user password.
    required: true
    type: str

username:
    description: Target 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.
    required: false
    suboptions:
      identity_count:
        description: Number of MAC addresses.I(identity_count) is required to option to
          create FC settings.
        required: false
        type: int
      starting_address:
        description: Starting MAC Address of FC setting.I(starting_address) is required
          to option to create FC settings.
        required: false
        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.
    required: false
    suboptions:
      identity_count:
        description: Number of MAC addresses.
        required: false
        type: int
      starting_mac_address:
        description: Starting MAC Address of the FCoE setting.
        required: false
        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.
    required: false
    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.
    required: false
    suboptions:
      identity_count:
        description: Number of MAC addresses.
        required: false
        type: int
      initiator_config:
        description:
        - Applicable for creating and modifying an identity pool using iSCSI Initiator
          settings.
        required: false
        suboptions:
          iqn_prefix:
            description: IQN prefix addresses.
            required: false
            type: str
        type: dict
      initiator_ip_pool_settings:
        description:
        - Applicable for creating and modifying an identity pool using ISCSI Initiator
          IP pool settings.
        required: false
        suboptions:
          gateway:
            description: IP address of gateway.
            required: false
            type: str
          ip_range:
            description: Range of non-multicast IP addresses.
            required: false
            type: str
          primary_dns_server:
            description: IP address of the primary DNS server.
            required: false
            type: str
          secondary_dns_server:
            description: IP address of the secondary DNS server.
            required: false
            type: str
          subnet_mask:
            description: Subnet mask for I(ip_range).
            required: false
            type: str
        type: dict
      starting_mac_address:
        description: Starting MAC address of the iSCSI setting.This is required option
          for iSCSI setting.
        required: false
        type: str
    type: dict

pool_description:
    description:
    - Description of the identity pool.
    required: false
    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.
    required: false
    suboptions:
      identity_count:
        description: Number of MAC addresses.
        required: false
        type: int
      starting_mac_address:
        description: Starting MAC address of the ethernet setting.
        required: false
        type: str
    type: dict

Outputs

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