cisco.intersight.intersight_link_control_policy_info module – Gather information about Link Control Policies in Cisco Intersight

Note

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

Synopsis

• Gather information about Link Control Policies in Cisco Intersight.

• Information can be filtered by organization and name.

• If no filters are passed, all Link Control 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 name of the Link Control Policy to gather information from.
organization string	The name of the organization the Link Control Policy belongs to.
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 Link Control Policy by name
  cisco.intersight.intersight_link_control_policy_info:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    name: "test-link-policy"

- name: Fetch all Link Control Policies in a specific Organization
  cisco.intersight.intersight_link_control_policy_info:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    organization: "default"

- name: Fetch all Link Control Policies
  cisco.intersight.intersight_link_control_policy_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_repsonse dictionary

The API response output returned by the specified resource. Returned: always Sample: {"api_response": [{"Name": "test-link-policy", "ObjectType": "fabric.LinkControlPolicy", "Tags": [{"Key": "Site", "Value": "DataCenter-A"}], "UdldSettings": {"AdminState": "Enabled", "ClassId": "fabric.UdldSettings", "Mode": "aggressive", "ObjectType": "fabric.UdldSettings"}}, {"Name": "test-link-disabled", "ObjectType": "fabric.LinkControlPolicy", "Tags": [], "UdldSettings": {"AdminState": "Disabled", "ClassId": "fabric.UdldSettings", "Mode": "normal", "ObjectType": "fabric.UdldSettings"}}]}

Authors

• Ron Gershburg (@rgershbu)

Collection links

• Issue Tracker
• Repository (Sources)