cisco.intersight.intersight_iscsi_boot_policy_info module – Gather information about iSCSI Boot Policies in Cisco Intersight

Note

This module is part of the cisco.intersight collection (version 2.7.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_boot_policy_info.

Synopsis

  • Retrieve information about iSCSI Boot Policies from Cisco Intersight.

  • Query policies by organization or policy name.

  • Returns structured data with policy metadata and iSCSI boot configuration details.

  • If no filters are provided, all iSCSI Boot Policies will be returned.

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"

name

string

The exact name of the iSCSI Boot Policy to retrieve information from.

When specified, only the matching policy will be returned.

organization

string

The name of the organization to filter iSCSI Boot Policies by.

Use ‘default’ for the default organization.

When specified, only policies from this organization will be returned.

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

# Basic Usage Examples
- name: Fetch all iSCSI Boot Policies from all organizations
  cisco.intersight.intersight_iscsi_boot_policy_info:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
  register: all_iscsi_boot_policies

# Organization-specific Examples
- name: Fetch all iSCSI Boot Policies from the default organization
  cisco.intersight.intersight_iscsi_boot_policy_info:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    organization: "default"
  register: default_org_policies

- name: Fetch all iSCSI Boot Policies from a custom organization
  cisco.intersight.intersight_iscsi_boot_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 Boot Policy by name
  cisco.intersight.intersight_iscsi_boot_policy_info:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    name: "iscsi-boot-policy-01"
  register: specific_policy

- name: Fetch a specific policy from a specific organization
  cisco.intersight.intersight_iscsi_boot_policy_info:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    organization: "Production"
    name: "iscsi-boot-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

api_response

dictionary

The API response containing iSCSI Boot Policy information.

Returns a list.

Returned: always

Sample: {"AutoTargetvendorName": "", "Chap": {"IsPasswordSet": true, "UserId": "chapuser"}, "Description": "iSCSI boot policy for production servers", "InitiatorIpSource": "DHCP", "IscsiAdapterPolicy": {"Moid": "fedcba0987654321fedcba09", "ObjectType": "vnic.IscsiAdapterPolicy"}, "IscsiIpType": "IPv4", "Moid": "1234567890abcdef12345678", "MutualChap": {"IsPasswordSet": false, "UserId": ""}, "Name": "iscsi-boot-policy-01", "ObjectType": "vnic.IscsiBootPolicy", "Organization": {"Moid": "abcdef1234567890abcdef12", "Name": "default", "ObjectType": "organization.Organization"}, "PrimaryTargetPolicy": {"Moid": "abcdef1234567890abcdef12", "ObjectType": "vnic.IscsiStaticTargetPolicy"}, "SecondaryTargetPolicy": {"Moid": "", "ObjectType": ""}, "Tags": [{"Key": "Environment", "Value": "Production"}, {"Key": "Owner", "Value": "Storage-Team"}], "TargetSourceType": "Static"}

Authors

  • Ron Gershburg (@rgershbu)