cisco.aci.aci_vmm_enhanced_lag_policy module – Manage Enhanced LACP Policy for Virtual Machine Manager (VMM) in Cisco ACI (lacp:EnhancedLagPol)

Note

This module is part of the cisco.aci collection (version 2.12.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.aci.

To use it in a playbook, specify: cisco.aci.aci_vmm_enhanced_lag_policy.

New in cisco.aci 2.12.0

Synopsis

  • Manage Enhanced LACP Policy for VMM domains on Cisco ACI fabrics.

  • The Enhanced LACP Policy allows you to configure advanced Link Aggregation Control Protocol settings for virtual switches in VMM domains.

Parameters

Parameter

Comments

annotation

string

User-defined string for annotating an object.

If the value is not specified in the task, the value of environment variable ACI_ANNOTATION will be used instead.

If the value is not specified in the task and environment variable ACI_ANNOTATION then the default value will be used.

Default: "orchestrator:ansible"

certificate_name

aliases: cert_name

string

The X.509 certificate name attached to the APIC AAA user used for signature-based authentication.

If a private_key filename was provided, this defaults to the private_key basename, without extension.

If PEM-formatted content was provided for private_key, this defaults to the username value.

If the value is not specified in the task, the value of environment variable ACI_CERTIFICATE_NAME will be used instead.

domain

aliases: domain_name, domain_profile

string

The name of the virtual domain profile where the Enhanced LACP Policy is applied.

host

aliases: hostname

string

IP Address or hostname of APIC resolvable by Ansible control host.

If the value is not specified in the task, the value of environment variable ACI_HOST will be used instead.

lacp_mode

string

The LACP mode for the policy.

Determines whether the policy initiates or responds to LACP negotiations.

The APIC defaults to active when unset during creation.

Choices:

  • "active"

  • "passive"

load_balancing_mode

string

The load balancing algorithm for distributing traffic across links in the port channel.

See the APIC Management Information Model reference for more details.

The APIC defaults to src-dst-ip when unset during creation

Choices:

  • "dst-ip"

  • "dst-ip-l4port"

  • "dst-ip-vlan"

  • "dst-ip-l4port-vlan"

  • "dst-mac"

  • "dst-l4port"

  • "src-ip"

  • "src-ip-l4port"

  • "src-ip-vlan"

  • "src-ip-l4port-vlan"

  • "src-mac"

  • "src-l4port"

  • "src-dst-ip"

  • "src-dst-ip-l4port"

  • "src-dst-ip-vlan"

  • "src-dst-ip-l4port-vlan"

  • "src-dst-mac"

  • "src-dst-l4port"

  • "src-port-id"

  • "vlan"

name

string

The name of the Enhanced LACP Policy.

integer

The minimum number of uplinks required for the port channel.

Must be a value between 2 and 8.

The APIC defaults to 2 when unset during creation

output_level

string

Influence the output of this ACI module.

normal means the standard output, incl. current dict

info adds informational output, incl. previous, proposed and sent dicts

debug adds debugging output, incl. filter_string, method, response, status and url information

If the value is not specified in the task, the value of environment variable ACI_OUTPUT_LEVEL will be used instead.

Choices:

  • "debug"

  • "info"

  • "normal" ← (default)

output_path

string

Path to a file that will be used to dump the ACI JSON configuration objects generated by the module.

If the value is not specified in the task, the value of environment variable ACI_OUTPUT_PATH will be used instead.

owner_key

string

User-defined string for the ownerKey attribute of an ACI object.

This attribute represents a key for enabling clients to own their data for entity correlation.

If the value is not specified in the task, the value of environment variable ACI_OWNER_KEY will be used instead.

owner_tag

string

User-defined string for the ownerTag attribute of an ACI object.

This attribute represents a tag for enabling clients to add their own data.

For example, to indicate who created this object.

If the value is not specified in the task, the value of environment variable ACI_OWNER_TAG will be used instead.

password

string

The password to use for authentication.

This option is mutual exclusive with private_key. If private_key is provided too, it will be used instead.

If the value is not specified in the task, the value of environment variables ACI_PASSWORD or ANSIBLE_NET_PASSWORD will be used instead.

port

integer

Port number to be used for REST connection.

The default value depends on parameter use_ssl.

If the value is not specified in the task, the value of environment variable ACI_PORT will be used instead.

private_key

aliases: cert_key

string

Either a PEM-formatted private key file or the private key content used for signature-based authentication.

This value also influences the default certificate_name that is used.

This option is mutual exclusive with password. If password is provided too, it will be ignored.

If the value is not specified in the task, the value of environment variable ACI_PRIVATE_KEY or ANSIBLE_NET_SSH_KEYFILE will be used instead.

state

string

The desired state of the Enhanced LACP Policy.

Use present to create or update the policy.

Use absent to delete the policy.

Use query to retrieve information about the policy.

Choices:

  • "absent"

  • "present" ← (default)

  • "query"

suppress_previous

aliases: no_previous, ignore_previous

boolean

If true, a GET to check previous will not be sent before a POST update to APIC.

If the value is not specified in the task, the value of environment variable ACI_SUPPRESS_PREVIOUS will be used instead.

The default value is false.

WARNING - This causes the previous return value to be empty.

The previous state of the object will not be checked and the POST update will contain all properties.

Choices:

  • false

  • true

suppress_verification

aliases: no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification

boolean

If true, a verifying GET will not be sent after a POST update to APIC.

If the value is not specified in the task, the value of environment variable ACI_SUPPRESS_VERIFICATION will be used instead.

The default value is false.

WARNING - This causes the current return value to be set to the proposed value.

The current object including default values will be unverifiable in a single task.

Choices:

  • false

  • true

timeout

integer

The socket level timeout in seconds.

If the value is not specified in the task, the value of environment variable ACI_TIMEOUT will be used instead.

The default value is 30.

use_proxy

boolean

If false, it will not use a proxy, even if one is defined in an environment variable on the target hosts.

If the value is not specified in the task, the value of environment variable ACI_USE_PROXY will be used instead.

The default value is true.

Choices:

  • false

  • true

use_ssl

boolean

If false, an HTTP connection will be used instead of the default HTTPS connection.

If the value is not specified in the task, the value of environment variable ACI_USE_SSL will be used instead.

The default value is true when the connection is local.

Choices:

  • false

  • true

username

aliases: user

string

The username to use for authentication.

If the value is not specified in the task, the value of environment variables ACI_USERNAME or ANSIBLE_NET_USERNAME will be used instead.

The default value is admin.

validate_certs

boolean

If false, SSL certificates will not be validated.

This should only set to false when used on personally controlled sites using self-signed certificates.

If the value is not specified in the task, the value of environment variable ACI_VALIDATE_CERTS will be used instead.

The default value is true.

Choices:

  • false

  • true

vm_provider

string

The virtualization platform provider for the VMM domain.

Choices:

  • "cloudfoundry"

  • "kubernetes"

  • "microsoft"

  • "openshift"

  • "openstack"

  • "redhat"

  • "vmware"

Notes

Note

See Also

See also

cisco.aci.aci_domain

Manage physical, virtual, bridged, routed or FC domain profiles (phys:DomP, vmm:DomP, l2ext:DomP, l3ext:DomP, and fc:DomP).

cisco.aci.aci_vmm_vswitch_policy

Manage vSwitch policy for VMware virtual domains profiles (vmm:VSwitchPolicyCont).

APIC Management Information Model reference

More information about the internal APIC classes lacp:EnhancedLagPol.

Cisco ACI Guide

Detailed information on how to manage your ACI infrastructure using Ansible.

Developing Cisco ACI modules

Detailed guide on how to write your own Cisco ACI modules to contribute.

Examples

- name: Create an Enhanced LACP Policy
  cisco.aci.aci_vmm_enhanced_lag_policy:
    host: apic.example.com
    username: admin
    password: SomeSecretPassword
    name: my_enhanced_lag_policy
    domain: my_vmm_domain
    vm_provider: vmware
    lacp_mode: active
    load_balancing_mode: src-dst-ip
    number_uplinks: 4
    state: present

- name: Update an existing Enhanced LACP Policy
  cisco.aci.aci_vmm_enhanced_lag_policy:
    host: apic.example.com
    username: admin
    password: SomeSecretPassword
    name: my_enhanced_lag_policy
    domain: my_vmm_domain
    vm_provider: vmware
    lacp_mode: passive
    load_balancing_mode: src-dst-ip-l4port
    number_uplinks: 6
    state: present

- name: Query a specific Enhanced LACP Policy
  cisco.aci.aci_vmm_enhanced_lag_policy:
    host: apic.example.com
    username: admin
    password: SomeSecretPassword
    name: my_enhanced_lag_policy
    domain: my_vmm_domain
    vm_provider: vmware
    state: query
  register: query_result

- name: Query all Enhanced LACP Policies in a VMM domain
  cisco.aci.aci_vmm_enhanced_lag_policy:
    host: apic.example.com
    username: admin
    password: SomeSecretPassword
    domain: my_vmm_domain
    vm_provider: vmware
    state: query
  register: query_all_result

- name: Delete an Enhanced LACP Policy
  cisco.aci.aci_vmm_enhanced_lag_policy:
    host: apic.example.com
    username: admin
    password: SomeSecretPassword
    name: my_enhanced_lag_policy
    domain: my_vmm_domain
    vm_provider: vmware
    state: absent

Return Values

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

Key

Description

current

list / elements=string

The existing configuration of the Enhanced LACP Policy from the APIC after the module has finished.

Returned: success

Sample: [{"lacpEnhancedLagPol": {"attributes": {"dn": "uni/vmmp-VMware/dom-test_vmm_dom/vswitchpolcont/enlacplagp-test_enhanced_lag_policy", "lbmode": "src-dst-ip", "mode": "active", "name": "test_enhanced_lag_policy", "numLinks": "4"}}}]

error

dictionary

The error information as returned from the APIC.

Returned: failure

Sample: {"code": "801", "text": "property name of enlacplagp-test_enhanced_lag_policy failed validation"}

proposed

dictionary

The configuration sent to the APIC.

Returned: info

Sample: {"lacpEnhancedLagPol": {"attributes": {"lbmode": "src-dst-ip", "mode": "active", "name": "test_enhanced_lag_policy", "numLinks": "4"}}}

Authors

  • Dev Sinha (@DevSinha13)