cisco.intersight.intersight_link_control_policy module – Link Control Policy configuration for 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_link_control_policy.

Synopsis
Parameters
Examples
Return Values

Synopsis

Manages Link Control Policy configuration on Cisco Intersight.
A policy to configure UDLD (UniDirectional Link Detection) settings on Cisco Intersight managed devices.
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"`
description aliases: descr string	The user-defined description for the Link Control Policy. Description can contain letters(a-z, A-Z), numbers(0-9), hyphen(-), period(.), colon(:), or an underscore(_).
name string / required	The name assigned to the Link Control Policy. The name must be between 1 and 62 alphanumeric characters, allowing special characters :-_.
organization string	The name of the Organization this resource is assigned to. Profiles, Policies, and Pools that are created within a Custom Organization are applicable only to devices in the same Organization. Default: `"default"`
state string	If `present`, will verify the resource is present and will create if needed. If `absent`, will verify the resource is absent and will delete if needed. Choices: `"present"` ← (default) `"absent"`
tags list / elements=dictionary	List of tags in Key:<user-defined key> Value:<user-defined value> format.
udld_admin_state string	UDLD Admin configured Link State for this port. Choices: `"Enabled"` ← (default) `"Disabled"`
udld_mode string	UDLD Admin configured Mode for this port. Cannot be set to ‘aggressive’ when udld_admin_state is ‘Disabled’. Choices: `"normal"` ← (default) `"aggressive"`
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: Configure Link Control Policy with UDLD enabled in aggressive mode
  cisco.intersight.intersight_link_control_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    name: "test-link-aggressive"
    description: "Link Control Policy with aggressive UDLD"
    udld_admin_state: "Enabled"
    udld_mode: "aggressive"
    tags:
      - Key: Site
        Value: DataCenter-A

- name: Configure Link Control Policy with UDLD disabled
  cisco.intersight.intersight_link_control_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    name: "test-link-disabled"
    description: "Link Control Policy with UDLD disabled"
    udld_admin_state: "Disabled"
    udld_mode: "normal"

- name: Delete Link Control Policy
  cisco.intersight.intersight_link_control_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    name: "test-link-policy"
    state: absent

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 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"}}}`

Authors

Ron Gershburg (@rgershbu)

Collection links

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/cisco/intersight/intersight_link_control_policy_module.html