cisco.intersight.intersight_wwn_pool module – WWNN/WWPN Pool configuration for Cisco Intersight

Note

This module is part of the cisco.intersight collection (version 2.3.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install cisco.intersight.

To use it in a playbook, specify: cisco.intersight.intersight_wwn_pool.

Synopsis

  • WWNN/WWPN Pool configuration for Cisco Intersight.

  • Used to configure WWN pools settings on Cisco Intersight managed devices.

  • For more information see Cisco Intersight.

Parameters

Parameter

Comments

api_key_id

string / required

Public API Key ID associated with the private key.

If not set, the value of the INTERSIGHT_API_KEY_ID environment variable is used.

api_private_key

path / required

Filename (absolute path) or string of PEM formatted private key data to be used for Intersight API authentication.

If a string is used, Ansible vault should be used to encrypt string data.

Ex. ansible-vault encrypt_string –vault-id tme@/Users/dsoper/Documents/vault_password_file ‘—–BEGIN EC PRIVATE KEY—–

<your private key data>

—–END EC PRIVATE KEY—–’

If not set, the value of the INTERSIGHT_API_PRIVATE_KEY environment variable is used.

api_uri

string

URI used to access the Intersight API.

If not set, the value of the INTERSIGHT_API_URI environment variable is used.

Default: "https://intersight.com/api/v1"

description

aliases: descr

string

The user-defined description of the WWNN/WWPN Pool.

Description can contain letters(a-z, A-Z), numbers(0-9), hyphen(-), period(.), colon(:), or an underscore(_).

id_blocks

list / elements=dictionary

WWN Blocks

Block of WWNN/WWPN Identifiers.

size

integer / required

Number of identifiers this block can hold.

This value must be an integer between 1 and 1024, inclusive.

wwn_from

string / required

Starting WWN identifier of the block must be in hexadecimal format xx:xx:xx:xx:xx:xx:xx:xx.

Allowed ranges are 20:00:00:00:00:00:00:00 to 20:FF:FF:FF:FF:FF:FF:FF

Or from 50:00:00:00:00:00:00:00 to 5F:FF:FF:FF:FF:FF:FF:FF.

To ensure uniqueness of WWN’s in the SAN fabric, you are strongly encouraged to use the following WWN prefix; 20:00:00:25:B5:xx:xx:xx.

name

string / required

The name assigned to the WWNN/WWPN Pool.

The name must be between 1 and 62 alphanumeric characters, allowing special characters :-_.

Two pools WWNN and WWNP can have the same name.

organization

string

The name of the Organization this resource is assigned to.

Profiles, Policies, and Pools that are created within a Custom Organization are applicable only to devices in the same Organization.

Default: "default"

pool_purpose

string / required

The pool type WWNN or WWPN.

Required also for absent - Two pools WWNN and WWNP can have the same name.

state

string

If present, will verify the resource is present and will create if needed.

If absent, will verify the resource is absent and will delete if needed.

Choices:

  • "present" ← (default)

  • "absent"

tags

list / elements=dictionary

List of tags in Key:<user-defined key> Value:<user-defined value> format.

use_proxy

boolean

If no, it will not use a proxy, even if one is defined in an environment variable on the target hosts.

Choices:

  • false

  • true ← (default)

validate_certs

boolean

Boolean control for verifying the api_uri TLS certificate

Choices:

  • false

  • true ← (default)

Examples

- name: Create WWNN pool
  cisco.intersight.intersight_wwn_pool:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    name: wwn_pool_1
    description: "Test WWNN pool description"
    tags:
      - "Key": "Site"
        "Value": "tag1"
    pool_purpose: "WWNN"
    id_blocks:
      - "wwn_from": "20:00:00:25:B5:00:00:00"
        "size": 100
      - "wwn_from": "20:00:00:25:B5:FF:00:00"
        "size": 100

- name: Create WWPN pool
  cisco.intersight.intersight_wwn_pool:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    name: wwn_pool_2
    description: "Test WWPN pool description"
    tags:
      - "Key": "Site"
        "Value": "tag2"
    pool_purpose: "WWPN"
    id_blocks:
      - "wwn_from": "20:00:00:25:B5:00:FF:00"
        "size": 200
      - "wwn_from": "20:00:00:25:B5:FF:FF:00"
        "size": 200

- name: Delete WWN pool
  cisco.intersight.intersight_wwn_pool:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    name: wwn_pool_1
    pool_purpose: "WWPN"
    state: absent

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

api_repsonse

dictionary

The API response output returned by the specified resource.

Returned: always

Sample: {"api_response": {"IdBlocks": [{"ClassId": "fcpool.Block", "From": "20:00:00:25:B5:00:00:00", "ObjectType": "fcpool.Block", "Size": 100, "To": "20:00:00:25:B5:00:00:63"}, {"ClassId": "fcpool.Block", "From": "20:00:00:25:B5:FF:00:00", "ObjectType": "fcpool.Block", "Size": 100, "To": "20:00:00:25:B5:FF:00:63"}], "Name": "wwn_pool_1", "ObjectType": "fcpool.Pool", "PoolPurpose": "WWNN  ", "Tags": [{"Key": "Site", "Value": "tag1"}, {"Key": "Site2", "Value": "tag2"}]}}

Authors

  • Shahar Golshani (@sgolshan)