Try SpotterManage port channel interface policies on Cisco ACI fabrics (lacp:LagPol)
| "added in version" 2.4 of ansible.builtin"
Authors: Swetha Chunduri (@schunduri), Dag Wieers (@dagwieers), Jacob McGill (@jmcgill298)
preview | supported by community
pipInstall with pip install ansible==2.4.3.0.post1
Manage port channel interface policies on Cisco ACI fabrics.
More information from the internal APIC class I(lacp:LagPol) at U(https://developer.cisco.com/media/mim-ref/MO-lacpLagPol.html).
- aci_intf_policy_port_channel:
hostname: '{{ inventory_hostname }}'
username: '{{ username }}'
password: '{{ password }}'
port_channel: '{{ port_channel }}'
description: '{{ description }}'
min_links: '{{ min_links }}'
max_links: '{{ max_links }}'
mode: '{{ mode }}'
host:
aliases:
- hostname
description:
- 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 C(ACI_HOST)
will be used instead.
required: true
type: str
mode:
choices:
- active
- mac-pin
- mac-pin-nicload
- false
- passive
default: false
description:
- Port channel interface policy mode.
- Determines the LACP method to use for forming port-channels.
- The APIC defaults new Port Channel Polices to C(off).
port:
description:
- Port number to be used for REST connection.
- The default value depends on parameter C(use_ssl).
- If the value is not specified in the task, the value of environment variable C(ACI_PORT)
will be used instead.
type: int
state:
choices:
- absent
- present
- query
default: present
description:
- Use C(present) or C(absent) for adding or removing.
- Use C(query) for listing an object or multiple objects.
timeout:
default: 30
description:
- The socket level timeout in seconds.
- If the value is not specified in the task, the value of environment variable C(ACI_TIMEOUT)
will be used instead.
type: int
use_ssl:
default: true
description:
- If C(no), 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 C(ACI_USE_SSL)
will be used instead.
type: bool
password:
description:
- The password to use for authentication.
- This option is mutual exclusive with C(private_key). If C(private_key) is provided
too, it will be used instead.
- If the value is not specified in the task, the value of environment variables C(ACI_PASSWORD)
or C(ANSIBLE_NET_PASSWORD) will be used instead.
type: str
username:
aliases:
- user
default: admin
description:
- The username to use for authentication.
- If the value is not specified in the task, the value of environment variables C(ACI_USERNAME)
or C(ANSIBLE_NET_USERNAME) will be used instead.
type: str
max_links:
choices:
- Ranges from 1 to 16
default: 16
description:
- Maximum links (range 1-16).
- The APIC defaults new Port Channel Policies to C(16).
min_links:
choices:
- Ranges from 1 to 16
default: 1
description:
- Minimum links (range 1-16).
- The APIC defaults new Port Channel Policies to C(1).
owner_key:
description:
- 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 C(ACI_OWNER_KEY)
will be used instead.
type: str
owner_tag:
description:
- 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 C(ACI_OWNER_TAG)
will be used instead.
type: str
use_proxy:
default: true
description:
- If C(no), 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 C(ACI_USE_PROXY)
will be used instead.
type: bool
annotation:
description:
- User-defined string for annotating an object.
- If the value is not specified in the task, the value of environment variable C(ACI_ANNOTATION)
will be used instead.
type: str
load_defer:
default: false
description:
- Determines if Load Defer is enabled.
- This makes up the LACP Policy Control Policy; if one setting is defined, then all
other Control Properties left undefined or set to false will not exist after the
task is ran.
- The APIC defaults new LACP Policies to C(false).
type: bool
description:
aliases:
- descr
description:
- The description for the port channel.
fast_select:
default: true
description:
- Determines if Fast Select is enabled for Hot Standby Ports.
- This makes up the LACP Policy Control Policy; if one setting is defined, then all
other Control Properties left undefined or set to false will not exist after the
task is ran.
- The APIC defaults new LACP Policies to C(true).
type: bool
output_path:
description:
- 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 C(ACI_OUTPUT_PATH)
will be used instead.
type: str
private_key:
aliases:
- cert_key
description:
- Either a PEM-formatted private key file or the private key content used for signature-based
authentication.
- This value also influences the default C(certificate_name) that is used.
- This option is mutual exclusive with C(password). If C(password) is provided too,
it will be ignored.
- If the value is not specified in the task, the value of environment variable C(ACI_PRIVATE_KEY)
will be used instead.
type: str
output_level:
choices:
- debug
- info
- normal
default: normal
description:
- Influence the output of this ACI module.
- C(normal) means the standard output, incl. C(current) dict
- C(info) adds informational output, incl. C(previous), C(proposed) and C(sent) dicts
- C(debug) adds debugging output, incl. C(filter_string), C(method), C(response),
C(status) and C(url) information
- If the value is not specified in the task, the value of environment variable C(ACI_OUTPUT_LEVEL)
will be used instead.
type: str
port_channel:
aliases:
- name
description:
- Name of the port channel.
required: true
symmetric_hash:
default: false
description:
- Determines if Symmetric Hashing is enabled.
- This makes up the LACP Policy Control Policy; if one setting is defined, then all
other Control Properties left undefined or set to false will not exist after the
task is ran.
- The APIC defaults new LACP Policies to C(false).
type: bool
validate_certs:
default: true
description:
- If C(no), SSL certificates will not be validated.
- This should only set to C(no) when used on personally controlled sites using self-signed
certificates.
- If the value is not specified in the task, the value of environment variable C(ACI_VALIDATE_CERTS)
will be used instead.
type: bool
certificate_name:
aliases:
- cert_name
description:
- The X.509 certificate name attached to the APIC AAA user used for signature-based
authentication.
- If a C(private_key) filename was provided, this defaults to the C(private_key) basename,
without extension.
- If PEM-formatted content was provided for C(private_key), this defaults to the C(username)
value.
- If the value is not specified in the task, the value of environment variable C(ACI_CERTIFICATE_NAME)
will be used instead.
type: str
suspend_individual:
default: true
description:
- Determines if Suspend Individual is enabled.
- This makes up the LACP Policy Control Policy; if one setting is defined, then all
other Control Properties left undefined or set to false will not exist after the
task is ran.
- The APIC defaults new LACP Policies to C(true).
type: bool
graceful_convergence:
default: true
description:
- Determines if Graceful Convergence is enabled.
- This makes up the LACP Policy Control Policy; if one setting is defined, then all
other Control Properties left undefined or set to false will not exist after the
task is ran.
- The APIC defaults new LACP Policies to C(true).
type: bool