Documentation

nxos_portchannel - Manages port-channel interfaces.

New in version 2.2.

DEPRECATED

In:version:
Why:
Alternative:

Synopsis

  • Manages port-channel specific configuration parameters.

Options

parameter
required
default
choices
comments
username
no
Configures the username to use to authenticate the connection to the remote device. This value is used to authenticate either the CLI login or the nxapi authentication depending on which transport is used. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
force
no
  • true
  • false
When true it forces port-channel members to match what is declared in the members param. This can be used to remove members.
host
yes
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
members
no
List of interfaces that will be managed in a given portchannel.
min_links
no
Min links required to keep portchannel up.
use_ssl
no
  • yes
  • no
Configures the transport to use SSL if set to true only when the transport=nxapi, otherwise this value is ignored.
password
no
Specifies the password to use to authenticate the connection to the remote device. This is a common argument used for either cli or nxapi transports. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
port
no
0 (use common port)
Specifies the port to use when building the connection to the remote device. This value applies to either cli or nxapi. The port value will default to the appropriate transport common port if none is provided in the task. (cli=22, http=80, https=443).
transport
yes
cli
Configures the transport connection to use when connecting to the remote device. The transport argument supports connectivity to the device over cli (ssh) or nxapi.
ssh_keyfile
no
Specifies the SSH key to use to authenticate the connection to the remote device. This argument is only used for the cli transport. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_SSH_KEYFILE will be used instead.
group
yes
Channel-group number for the port-channel.
use_proxy
(added in 2.5)
no
yes
  • yes
  • no
If no, the environment variables http_proxy and https_proxy will be ignored.
state
no
present
  • present
  • absent
Manage the state of the resource.
mode
no
True
  • active
  • passive
  • on
Mode for the port-channel, i.e. on, active, passive.
timeout
(added in 2.3)
no
10
Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. NX-API can be slow to return on long-running commands (sh mac, sh bgp, etc).
provider
no
Convenience method that allows all nxos arguments to be passed as a dict object. All constraints (required, choices, etc) must be met either by individual arguments or values in this dict.
validate_certs
no
  • yes
  • no
If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. If the transport argument is not nxapi, this value is ignored.

Examples

# Ensure port-channel99 is created, add two members, and set to mode on
- nxos_portchannel:
    group: 99
    members: ['Ethernet1/1','Ethernet1/2']
    mode: 'active'
    state: present

Return Values

Common return values are documented here, the following are the fields unique to this {{plugin_type}}:

name
description
returned
type
sample
commands
command sent to the device
always
list
['interface Ethernet2/6', 'no channel-group 12', 'interface Ethernet2/5', 'no channel-group 12', 'interface Ethernet2/6', 'channel-group 12 mode on', 'interface Ethernet2/5', 'channel-group 12 mode on']


Notes

Note

  • Tested against NXOSv 7.3.(0)D1(1) on VIRL
  • state=absent removes the portchannel config and interface if it already exists. If members to be removed are not explicitly passed, all existing members (if any), are removed.
  • Members must be a list.
  • LACP needs to be enabled first if active/passive modes are used.
  • For more information on using Ansible to manage Cisco devices see https://www.ansible.com/ansible-cisco.

Author

  • Jason Edelman (@jedelman8)
  • Gabriele Gerbino (@GGabriele)

If you want to help with development, please read Community Information & Contributing, Testing Ansible and Developing Modules.