cisco.intersight.intersight_iscsi_static_target_policy_info module – Gather information about iSCSI Static Target Policies in Cisco Intersight
Note
This module is part of the cisco.intersight collection (version 2.6.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_iscsi_static_target_policy_info.
Synopsis
Retrieve information about iSCSI Static Target Policies from Cisco Intersight.
Query policies by organization or policy name.
Returns structured data with policy metadata and iSCSI target configuration details.
If no filters are provided, all iSCSI Static Target Policies will be returned.
Parameters
Parameter |
Comments |
|---|---|
Public API Key ID associated with the private key. If not set, the value of the INTERSIGHT_API_KEY_ID environment variable is used. |
|
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. |
|
URI used to access the Intersight API. If not set, the value of the INTERSIGHT_API_URI environment variable is used. Default: |
|
The exact name of the iSCSI Static Target Policy to retrieve information from. When specified, only the matching policy will be returned. |
|
The name of the organization to filter iSCSI Static Target Policies by. Use ‘default’ for the default organization. When specified, only policies from this organization will be returned. |
|
If Choices:
|
|
Boolean control for verifying the api_uri TLS certificate Choices:
|
Examples
# Basic Usage Examples
- name: Fetch all iSCSI Static Target Policies from all organizations
cisco.intersight.intersight_iscsi_static_target_policy_info:
api_private_key: "{{ api_private_key }}"
api_key_id: "{{ api_key_id }}"
register: all_iscsi_policies
# Organization-specific Examples
- name: Fetch all iSCSI Static Target Policies from the default organization
cisco.intersight.intersight_iscsi_static_target_policy_info:
api_private_key: "{{ api_private_key }}"
api_key_id: "{{ api_key_id }}"
organization: "default"
register: default_org_policies
- name: Fetch all iSCSI Static Target Policies from a custom organization
cisco.intersight.intersight_iscsi_static_target_policy_info:
api_private_key: "{{ api_private_key }}"
api_key_id: "{{ api_key_id }}"
organization: "Engineering"
register: engineering_policies
# Specific Policy Examples
- name: Fetch a specific iSCSI Static Target Policy by name
cisco.intersight.intersight_iscsi_static_target_policy_info:
api_private_key: "{{ api_private_key }}"
api_key_id: "{{ api_key_id }}"
name: "iscsi-static-target-policy-01"
register: specific_policy
- name: Fetch a specific policy from a specific organization
cisco.intersight.intersight_iscsi_static_target_policy_info:
api_private_key: "{{ api_private_key }}"
api_key_id: "{{ api_key_id }}"
organization: "Production"
name: "iscsi-static-target-policy-prod"
register: specific_org_policy
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
The API response containing iSCSI Static Target Policy information. Returns a dictionary when querying a single policy or no policies found. Returns a list when multiple policies are found. Returned: always Sample: |