W3cubDocs

/Ansible

nxos_portchannel - Manages port-channel interfaces.

New in version 2.2.

Synopsis

Manages port-channel specific configuration parameters.

Options

parameter required default choices comments
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.
group
 yes
Channel-group number for the port-channel.
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.
mode
 no True
  • active
  • passive
  • on
Mode for the port-channel, i.e. on, active, passive.
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).
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.
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.
state
 no present
  • present
  • absent
Manage the state of the resource.
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.
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.
username
 no
Configures the username to use to authenticate the connection to the remote device. The value of username 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.

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
    username: "{{ un }}"
    password: "{{ pwd }}"
    host: "{{ inventory_hostname }}"

Return Values

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

name description returned type sample
end_state k/v pairs of portchannel info after module execution always dict {'members_detail': {'Ethernet2/6': {'status': 'D', 'mode': 'on'}, 'Ethernet2/5': {'status': 'D', 'mode': 'on'}}, 'group': '12', 'mode': 'on', 'members': ['Ethernet2/5', 'Ethernet2/6'], 'min_links': None}
changed check to see if a change was made on the device always boolean True
updates 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']
proposed k/v pairs of parameters passed into module always dict {'group': '12', 'mode': 'on', 'members': ['Ethernet2/5', 'Ethernet2/6']}
existing ['k/v pairs of existing portchannel'] dict {'members_detail': {'Ethernet2/6': {'status': 'D', 'mode': 'active'}, 'Ethernet2/5': {'status': 'D', 'mode': 'active'}}, 'group': '12', 'mode': 'active', 'members': ['Ethernet2/5', 'Ethernet2/6'], 'min_links': None}

Notes

Note

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.

Note

Members must be a list.

Note

LACP needs to be enabled first if active/passive modes are used.

This is a Core Module

For more information on what this means please read Core Modules

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

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