Try SpotterManage port channel interface policies (lacp:LagPol)
| "added in version" 2.4 of ansible.builtin"
Authors: Dag Wieers (@dagwieers)
preview | supported by certified
pipInstall with pip install ansible==2.9.0
Manage port channel interface policies on Cisco ACI fabrics.
- aci_interface_policy_port_channel:
host: '{{ inventory_hostname }}'
username: '{{ username }}'
password: '{{ password }}'
port_channel: '{{ port_channel }}'
description: '{{ description }}'
min_links: '{{ min_links }}'
max_links: '{{ max_links }}'
mode: '{{ mode }}'
delegate_to: localhost
host:
aliases:
- hostname
description:
- IP Address or hostname of APIC resolvable by Ansible control host.
required: true
type: str
mode:
choices:
- active
- mac-pin
- mac-pin-nicload
- 'off'
- passive
description:
- Port channel interface policy mode.
- Determines the LACP method to use for forming port-channels.
- The APIC defaults to C(off) when unset during creation.
type: str
port:
description:
- Port number to be used for REST connection.
- The default value depends on parameter C(use_ssl).
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.
type: str
timeout:
default: 30
description:
- The socket level timeout in seconds.
type: int
use_ssl:
default: true
description:
- If C(no), an HTTP connection will be used instead of the default HTTPS connection.
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.
required: true
type: str
username:
aliases:
- user
default: admin
description:
- The username to use for authentication.
type: str
max_links:
description:
- Maximum links.
- Accepted values range between 1 and 16.
- The APIC defaults to C(16) when unset during creation.
type: int
min_links:
description:
- Minimum links.
- Accepted values range between 1 and 16.
- The APIC defaults to C(1) when unset during creation.
type: int
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.
type: bool
load_defer:
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 to C(no) when unset during creation.
type: bool
description:
aliases:
- descr
description:
- The description for the port channel.
type: str
fast_select:
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 to C(yes) when unset during creation.
type: bool
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.
required: true
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
type: str
port_channel:
aliases:
- name
description:
- Name of the port channel.
required: true
type: str
symmetric_hash:
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 to C(no) when unset during creation.
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.
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.
type: str
suspend_individual:
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 to C(yes) when unset during creation.
type: bool
graceful_convergence:
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 to C(yes) when unset during creation.
type: bool
current:
description: The existing configuration from the APIC after the module has finished
returned: success
sample:
- fvTenant:
attributes:
descr: Production environment
dn: uni/tn-production
name: production
nameAlias: ''
ownerKey: ''
ownerTag: ''
type: list
error:
description: The error information as returned from the APIC
returned: failure
sample:
code: '122'
text: unknown managed object class foo
type: dict
filter_string:
description: The filter string used for the request
returned: failure or debug
sample: ?rsp-prop-include=config-only
type: str
method:
description: The HTTP method used for the request to the APIC
returned: failure or debug
sample: POST
type: str
previous:
description: The original configuration from the APIC before the module has started
returned: info
sample:
- fvTenant:
attributes:
descr: Production
dn: uni/tn-production
name: production
nameAlias: ''
ownerKey: ''
ownerTag: ''
type: list
proposed:
description: The assembled configuration from the user-provided parameters
returned: info
sample:
fvTenant:
attributes:
descr: Production environment
name: production
type: dict
raw:
description: The raw output returned by the APIC REST API (xml or json)
returned: parse error
sample: <?xml version="1.0" encoding="UTF-8"?><imdata totalCount="1"><error code="122"
text="unknown managed object class foo"/></imdata>
type: str
response:
description: The HTTP response from the APIC
returned: failure or debug
sample: OK (30 bytes)
type: str
sent:
description: The actual/minimal configuration pushed to the APIC
returned: info
sample:
fvTenant:
attributes:
descr: Production environment
type: list
status:
description: The HTTP status from the APIC
returned: failure or debug
sample: 200
type: int
url:
description: The HTTP url used for the request to the APIC
returned: failure or debug
sample: https://10.11.12.13/api/mo/uni/tn-production.json
type: str