cisco.intersight.intersight_domain_info module – Gather information about UCS Domain Profiles in Cisco Intersight

Note

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

Synopsis

  • Gather information about UCS Domain Profiles (SwitchClusterProfiles) in Cisco Intersight.

  • Returns enriched data including SwitchProfiles (A and B), their assigned Fabric Interconnects, and attached PolicyBuckets.

  • Information can be filtered by name and organization.

  • If no filters are passed, all UCS Domain Profiles will be returned.

  • 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"

name

string

The name of the UCS Domain Profile to gather information from.

organization

string

The name of the Organization to filter UCS Domain Profiles by.

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: Fetch a specific UCS Domain Profile by name
  cisco.intersight.intersight_domain_info:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    organization: "default"
    name: "Domain-01"

- name: Fetch all UCS Domain Profiles in an organization
  cisco.intersight.intersight_domain_info:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    organization: "default"

- name: Fetch all UCS Domain Profiles
  cisco.intersight.intersight_domain_info:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

api_response

list / elements=dictionary

List of UCS Domain Profiles with enriched SwitchProfile details.

Each profile includes a SwitchProfiles list containing the SwitchProfile data for Fabric Interconnect A and B, including their AssignedSwitch and PolicyBucket.

Returned: always

Sample: [{"Name": "Domain-01", "ObjectType": "fabric.SwitchClusterProfile", "SwitchProfiles": [{"AssignedSwitch": {"Moid": "abc123", "ObjectType": "network.Element"}, "Name": "Domain-01-A", "PolicyBucket": [{"Moid": "pol123", "ObjectType": "fabric.SystemQosPolicy"}], "SwitchId": "A"}, {"AssignedSwitch": null, "Name": "Domain-01-B", "PolicyBucket": [], "SwitchId": "B"}]}]

Authors

  • Ron Gershburg (@rgershbu)