intersight_link_aggregation_policy

Link Aggregation Policy configuration for Cisco Intersight

Collection: cisco.intersight

Full Name: cisco.intersight.intersight_link_aggregation_policy

Synopsis

Link Aggregation Policy configuration for Cisco Intersight

Parameters

Name	Type	Required	Default	Description
api_private_key	string			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—– —–END EC PRIVATE KEY—–’ If not set, the value of the INTERSIGHT_API_PRIVATE_KEY environment variable is used. Required if I(api_bearer_token) is not provided. Secret value; omitted from logs and results.
api_uri	string		`https://intersight.com/api/v1`	URI used to access the Intersight API. If not set, the value of the INTERSIGHT_API_URI environment variable is used.
api_key_id	string			Public API Key ID associated with the private key. If not set, the value of the INTERSIGHT_API_KEY_ID environment variable is used. Required if I(api_bearer_token) is not provided.
api_bearer_token	string			Bearer token for OAuth2 authentication with the Intersight API. When provided, I(api_key_id) and I(api_private_key) are not required and the C(cryptography) Python library is not needed. If not set, the value of the INTERSIGHT_API_BEARER_TOKEN environment variable is used. Secret value; omitted from logs and results.
validate_certs	bool		`true`	Boolean control for verifying the api_uri TLS certificate
use_proxy	bool		`true`	If C(no), it will not use a proxy, even if one is defined in an environment variable on the target hosts.
state	string		`present`	If C(present), will verify the resource is present and will create if needed. If C(absent), will verify the resource is absent and will delete if needed. Choices: `present`, `absent`
organization	string		`default`	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.
name	string	yes		The name assigned to the Link Aggregation Policy. The name must be between 1 and 64 alphanumeric characters, allowing special characters :-_.
description	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(_).
tags	list			List of tags in Key: Value: format.
suspend_individual	bool		`false`	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.
lacp_rate	string		`normal`	Flag used to indicate whether LACP PDUs are to be sent ‘fast’, i.e., every 1 second. C(normal) - LACP PDUs are sent every 30 seconds. C(fast) - LACP PDUs are sent every 1 second. Choices: `normal`, `fast`

Example

yaml

- cisco.intersight.intersight_link_aggregation_policy:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    description: Link aggregation policy with default LACP settings
    name: LinkAgg-Policy-01
    organization: default
    state: present
    tags:
        - Key: Site
          Value: DataCenter-A
  name: Create a Link Aggregation Policy with default settings

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

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

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

- cisco.intersight.intersight_link_aggregation_policy:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    name: LinkAgg-Policy-01
    state: absent
  name: Delete a Link Aggregation Policy