intersight_iqn_pool

IQN Pool configuration for Cisco Intersight

Collection: cisco.intersight

Full Name: cisco.intersight.intersight_iqn_pool

Synopsis

IQN Pool configuration for Cisco Intersight

Parameters

Name	Type	Required	Default	Description
api_private_key	string			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—– —–END EC PRIVATE KEY—–’ If not set, the value of the INTERSIGHT_API_PRIVATE_KEY environment variable is used. Required if I(api_bearer_token) is not provided. Secret value; omitted from logs and results.
api_uri	string		`https://intersight.com/api/v1`	URI used to access the Intersight API. If not set, the value of the INTERSIGHT_API_URI environment variable is used.
api_key_id	string			Public API Key ID associated with the private key. If not set, the value of the INTERSIGHT_API_KEY_ID environment variable is used. Required if I(api_bearer_token) is not provided.
api_bearer_token	string			Bearer token for OAuth2 authentication with the Intersight API. When provided, I(api_key_id) and I(api_private_key) are not required and the C(cryptography) Python library is not needed. If not set, the value of the INTERSIGHT_API_BEARER_TOKEN environment variable is used. Secret value; omitted from logs and results.
validate_certs	bool		`true`	Boolean control for verifying the api_uri TLS certificate
use_proxy	bool		`true`	If C(no), it will not use a proxy, even if one is defined in an environment variable on the target hosts.
state	string		`present`	If C(present), will verify the resource is present and will create if needed. If C(absent), will verify the resource is absent and will delete if needed. Choices: `present`, `absent`
organization	string		`default`	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.
name	string	yes		The name assigned to the IQN Pool. The name must be between 1 and 64 alphanumeric characters, allowing special characters :-_.
description	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(_).
tags	list			List of tags in Key: Value: format.
assignment_order	string		`default`	Assignment order decides the order in which the next identifier is allocated. If C(sequential), identifiers are assigned in a sequential order. If C(default), the system determines the assignment order. Choices: `default`, `sequential`
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.
iqn_suffix_blocks	list			List of the IQN blocks. Should include the suffix, iqn_from and size per block. Nested options: suffix (str) required; iqn_from (int) required; size (int) required

Example

yaml

- cisco.intersight.intersight_iqn_pool:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    assignment_order: sequential
    description: Test iqn pool description
    iqn_suffix_blocks:
        - iqn_from: 1
          size: 20
          suffix: iqn
        - iqn_from: 21
          size: 40
          suffix: iscsi
    name: iqn_pool_1
    prefix: iqn.2025-08.com.cisco
    tags:
        - Key: Site
          Value: tag1
  name: Create iqn pool

- cisco.intersight.intersight_iqn_pool:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    name: iqn_pool_1
    state: absent
  name: Delete iqn pool