W3cubDocs

/Ansible

aci_intf_policy_port_channel - Manage port channel interface policies on Cisco ACI fabrics (lacp:LagPol)

New in version 2.4.

Synopsis

Requirements (on host that executes module)

  • ACI Fabric 1.0(3f)+

Options

parameter required default choices comments
description
 no
The description for the port channel.
aliases: descr
fast_select
 no True
  • yes
  • no
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 true.
graceful_convergence
 no True
  • yes
  • no
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 true.
hostname
 yes
IP Address or hostname of APIC resolvable by Ansible control host.
aliases: host
load_defer
 no
  • yes
  • no
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 false.
max_links
 no 16
  • Ranges from 1 to 16
Maximum links (range 1-16).
The APIC defaults new Port Channel Policies to 16.
min_links
 no 1
  • Ranges from 1 to 16
Minimum links (range 1-16).
The APIC defaults new Port Channel Policies to 1.
mode
 no
  • active
  • mac-pin
  • mac-pin-nicload
  • False
  • passive
Port channel interface policy mode.
Determines the LACP method to use for forming port-channels.
The APIC defaults new Port Channel Polices to off.
password
 yes
The password to use for authentication.
port_channel
 yes
Name of the port channel.
aliases: name
state
 no present
  • absent
  • present
  • query
Use present or absent for adding or removing.
Use query for listing an object or multiple objects.
suspend_individual
 no True
  • yes
  • no
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 true.
symmetric_hash
 no
  • yes
  • no
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 false.
timeout
 no 30
The socket level timeout in seconds.
use_proxy
 no yes
  • yes
  • no
If no, it will not use a proxy, even if one is defined in an environment variable on the target hosts.
use_ssl
 no yes
  • yes
  • no
If no, an HTTP connection will be used instead of the default HTTPS connection.
username
 yes admin
The username to use for authentication.
aliases: user
validate_certs
 no yes
  • yes
  • no
If no, SSL certificates will not be validated.
This should only set to no used on personally controlled sites using self-signed certificates.

Examples

- 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 }}'

Notes

Note

  • By default, if an environment variable <protocol>_proxy is set on the target host, requests will be sent through that proxy. This behaviour can be overridden by setting a variable for this task (see setting the environment), or by using the use_proxy option.
  • HTTP redirects can redirect from HTTP to HTTPS so you should be sure that your proxy environment for both protocols is correct.

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.

© 2012–2017 Michael DeHaan
© 2017 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/aci_intf_policy_port_channel_module.html