cisco.intersight.intersight_link_aggregation_policy module – Link Aggregation 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_aggregation_policy.

Synopsis
Parameters
Examples
Return Values

Synopsis

Manages Link Aggregation Policy configuration on Cisco Intersight.
A policy to configure LACP (Link Aggregation Control Protocol) settings for link aggregation on Cisco Intersight managed fabric interconnects.
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 Aggregation Policy. Description can contain letters(a-z, A-Z), numbers(0-9), hyphen(-), period(.), colon(:), or an underscore(_).
lacp_rate string	Flag used to indicate whether LACP PDUs are to be sent ‘fast’, i.e., every 1 second. `normal` - LACP PDUs are sent every 30 seconds. `fast` - LACP PDUs are sent every 1 second. Choices: `"normal"` ← (default) `"fast"`
name string / required	The name assigned to the Link Aggregation 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"`
suspend_individual boolean	Flag tells the switch whether to suspend the port if it didn’t receive LACP PDU. If enabled, the switch will suspend the port in the port channel if LACP PDUs are not received. Choices: `false` ← (default) `true`
tags list / elements=dictionary	List of tags in Key:<user-defined key> Value:<user-defined value> format.
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: Create a Link Aggregation Policy with default settings
  cisco.intersight.intersight_link_aggregation_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    organization: "default"
    name: "LinkAgg-Policy-01"
    description: "Link aggregation policy with default LACP settings"
    tags:
      - Key: "Site"
        Value: "DataCenter-A"
    state: present

- name: Create a Link Aggregation Policy with fast LACP rate
  cisco.intersight.intersight_link_aggregation_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    name: "LinkAgg-Fast-Policy"
    description: "Link aggregation policy with fast LACP rate"
    lacp_rate: fast
    suspend_individual: true
    state: present

- name: Create a Link Aggregation Policy with normal LACP rate and suspend individual disabled
  cisco.intersight.intersight_link_aggregation_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    name: "LinkAgg-Normal-Policy"
    lacp_rate: normal
    suspend_individual: false
    state: present

- name: Update a Link Aggregation Policy
  cisco.intersight.intersight_link_aggregation_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    name: "LinkAgg-Policy-01"
    description: "Updated link aggregation policy"
    lacp_rate: fast
    suspend_individual: true
    state: present

- name: Delete a Link Aggregation Policy
  cisco.intersight.intersight_link_aggregation_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    name: "LinkAgg-Policy-01"
    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": {"LacpRate": "normal", "Name": "LinkAgg-Policy-01", "ObjectType": "fabric.LinkAggregationPolicy", "SuspendIndividual": false, "Tags": [{"Key": "Site", "Value": "DataCenter-A"}]}}`

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_aggregation_policy_module.html