cisco.intersight.intersight_iqn_pool module – IQN 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_iqn_pool.

Synopsis

  • IQN Pool configuration for Cisco Intersight.

  • Used to configure IQN 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 IQN Pool.

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

iqn_suffix_blocks

list / elements=dictionary

List of the IQN blocks.

Should include the suffix, iqn_from and size per block.

iqn_from

integer / required

The first suffix number in the block >= 0.

size

integer / required

Number of identifiers this block can hold.

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

suffix

string / required

The suffix for this block of IQNs.

name

string / required

The name assigned to the IQN Pool.

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

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"

prefix

string

The prefix for any IQN blocks created for this pool.

IQN Prefix must have the following format “iqn.yyyy-mm.naming-authority”

naming-authority is usually the reverse syntax of the Internet domain name of the naming authority.

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 iqn pool
  cisco.intersight.intersight_iqn_pool:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    name: iqn_pool_1
    description: "Test iqn pool description"
    tags:
      - "Key": "Site"
        "Value": "tag1"
    prefix: "iqn.2025-08.com.cisco"
    iqn_suffix_blocks:
      - "suffix": "iqn"
        "iqn_from": 1
        "size": 20
      - "suffix": "iscsi"
        "iqn_from": 21
        "size": 40
- name: Delete iqn pool
  cisco.intersight.intersight_iqn_pool:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    name: iqn_pool_1
    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": {"Name": "iqn_pool_1", "ObjectType": "iqnpool.Pool", "Tags": [{"Key": "Site", "Value": "tag1"}, {"Key": "Site2", "Value": "tag2"}]}}

Authors

  • Shahar Golshani (@sgolshan)