intersight_san_connectivity_policy_info

Gather information about SAN Connectivity Policies and their vHBAs in Cisco Intersight

Collection: cisco.intersight

Full Name: cisco.intersight.intersight_san_connectivity_policy_info

Synopsis

Gather information about SAN Connectivity Policies and their vHBAs in Cisco Intersight

Parameters

Name	Type	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.
organization	string		The name of the organization to filter SAN Connectivity Policies by. Use ‘default’ for the default organization. When specified, only policies from this organization will be returned.
name	string		The exact name of the SAN Connectivity Policy to retrieve information from. When specified, only the matching policy and its vHBAs will be returned. Can be combined with vhba_name filter to get specific vHBAs from a specific policy.
vhba_name	string		Filter vHBAs by name within the policies. Can be used with or without policy name filtering. Supports exact matching (e.g., “vhba-a” will match only “vhba-a”). When combined with policy name, filters vHBAs within that specific policy.

Example

yaml

- cisco.intersight.intersight_san_connectivity_policy_info:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
  name: Fetch all SAN Connectivity Policies and their vHBAs from all organizations
  register: all_san_policies

- cisco.intersight.intersight_san_connectivity_policy_info:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    organization: default
  name: Fetch all SAN Connectivity Policies from the default organization
  register: default_org_policies

- cisco.intersight.intersight_san_connectivity_policy_info:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    organization: Engineering
  name: Fetch all SAN Connectivity Policies from a custom organization
  register: engineering_policies

- cisco.intersight.intersight_san_connectivity_policy_info:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    name: fi-attached-san-policy
  name: Fetch a specific SAN Connectivity Policy by name with all its vHBAs
  register: specific_policy

- cisco.intersight.intersight_san_connectivity_policy_info:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    vhba_name: vhba-a
  name: Find all policies containing a specific vHBA
  register: policies_with_vhba_a

- cisco.intersight.intersight_san_connectivity_policy_info:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    name: fi-attached-san-policy
    vhba_name: vhba-b
  name: Find specific vHBA in a specific policy
  register: specific_vhba_in_policy