Try SpotterManage portchannel (port channel) configuration on devices running Lenovo CNOS
| "added in version" 2.3 of ansible.builtin"
Authors: Anil Kumar Muraleedharan (@amuraleedhar)
preview | supported by community
pipInstall with pip install ansible==2.7.9
This module allows you to work with port channel related configurations. The operators used are overloaded to ensure control over switch port channel configurations. Apart from the regular device connection related attributes, there are five LAG arguments which are overloaded variables that will perform further configurations. They are interfaceArg1, interfaceArg2, interfaceArg3, interfaceArg4, and interfaceArg5. For more details on how to use these arguments, see[Overloaded Variables]. This module uses SSH to manage network device configuration. The results of the operation will be placed in a directory named 'results' that must be created by the user in their local directory to where the playbook is run.
Tasks : The following are examples of using the module cnos_portchannel. These
are written in the main.yml file of the tasks directory.
---
- name: Test Port Channel - channel-group
cnos_portchannel:
deviceType: "{{ hostvars[inventory_hostname]['deviceType'] }}"
outputfile: "./results/test_portchannel_{{inventory_hostname}}_output.txt"
interfaceRange: 33
interfaceArg1: "channel-group"
interfaceArg2: 33
interfaceArg3: "on"
- name: Test Port Channel - channel-group - Interface Range
cnos_portchannel:
deviceType: "{{ hostvars[inventory_hostname]['deviceType'] }}"
outputfile: "./results/test_portchannel_{{ inventory_hostname }}_output.txt"
interfaceRange: "1/1-2"
interfaceArg1: "channel-group"
interfaceArg2: 33
interfaceArg3: "on"
- name: Test Port Channel - bridge-port
cnos_portchannel:
deviceType: "{{ hostvars[inventory_hostname]['deviceType'] }}"
outputfile: "./results/test_portchannel_{{ inventory_hostname }}_output.txt"
interfaceRange: 33
interfaceArg1: "bridge-port"
interfaceArg2: "access"
interfaceArg3: 33
- name: Test Port Channel - bridgeport mode
cnos_portchannel:
deviceType: "{{ hostvars[inventory_hostname]['deviceType'] }}"
outputfile: "./results/test_portchannel_{{ inventory_hostname }}_output.txt"
interfaceRange: 33
interfaceArg1: "bridge-port"
interfaceArg2: "mode"
interfaceArg3: "access"
- name: Test Port Channel - Description
cnos_portchannel:
deviceType: "{{ hostvars[inventory_hostname]['deviceType'] }}"
outputfile: "./results/test_portchannel_{{ inventory_hostname }}_output.txt"
interfaceRange: 33
interfaceArg1: "description"
interfaceArg2: "Hentammoo "
- name: Test Port Channel - Duplex
cnos_portchannel:
deviceType: "{{ hostvars[inventory_hostname]['deviceType'] }}"
outputfile: "./results/test_portchannel_{{ inventory_hostname }}_output.txt"
interfaceRange: 33
interfaceArg1: "duplex"
interfaceArg2: "auto"
- name: Test Port Channel - flowcontrol
cnos_portchannel:
deviceType: "{{ hostvars[inventory_hostname]['deviceType'] }}"
outputfile: "./results/test_portchannel_{{ inventory_hostname }}_output.txt"
interfaceRange: 33
interfaceArg1: "flowcontrol"
interfaceArg2: "send"
interfaceArg3: "off"
- name: Test Port Channel - lacp
cnos_portchannel:
deviceType: "{{ hostvars[inventory_hostname]['deviceType'] }}"
outputfile: "./results/test_portchannel_{{ inventory_hostname }}_output.txt"
interfaceRange: 33
interfaceArg1: "lacp"
interfaceArg2: "port-priority"
interfaceArg3: 33
- name: Test Port Channel - lldp
cnos_portchannel:
deviceType: "{{ hostvars[inventory_hostname]['deviceType'] }}"
outputfile: "./results/test_portchannel_{{ inventory_hostname }}_output.txt"
interfaceRange: 33
interfaceArg1: "lldp"
interfaceArg2: "tlv-select"
interfaceArg3: "max-frame-size"
- name: Test Port Channel - load-interval
cnos_portchannel:
deviceType: "{{ hostvars[inventory_hostname]['deviceType'] }}"
outputfile: "./results/test_portchannel_{{ inventory_hostname }}_output.txt"
interfaceRange: 33
interfaceArg1: "load-interval"
interfaceArg2: "counter"
interfaceArg3: 2
interfaceArg4: 33
- name: Test Port Channel - microburst-detection
cnos_portchannel:
deviceType: "{{ hostvars[inventory_hostname]['deviceType'] }}"
outputfile: "./results/test_portchannel_{{ inventory_hostname }}_output.txt"
interfaceRange: 33
interfaceArg1: "microburst-detection"
interfaceArg2: 25
- name: Test Port Channel - mtu
cnos_portchannel:
deviceType: "{{ hostvars[inventory_hostname]['deviceType'] }}"
outputfile: "./results/test_portchannel_{{ inventory_hostname }}_output.txt"
interfaceRange: 33
interfaceArg1: "mtu"
interfaceArg2: 66
- name: Test Port Channel - service-policy
cnos_portchannel:
deviceType: "{{ hostvars[inventory_hostname]['deviceType'] }}"
outputfile: "./results/test_portchannel_{{ inventory_hostname }}_output.txt"
interfaceRange: 33
interfaceArg1: "service-policy"
interfaceArg2: "input"
interfaceArg3: "Anil"
- name: Test Port Channel - speed
cnos_portchannel:
deviceType: "{{ hostvars[inventory_hostname]['deviceType'] }}"
outputfile: "./results/test_portchannel_{{ inventory_hostname }}_output.txt"
interfaceRange: 33
interfaceArg1: "speed"
interfaceArg2: "auto"
- name: Test Port Channel - storm
cnos_portchannel:
deviceType: "{{ hostvars[inventory_hostname]['deviceType'] }}"
outputfile: "./results/test_portchannel_{{ inventory_hostname }}_output.txt"
interfaceRange: 33
interfaceArg1: "storm-control"
interfaceArg2: "broadcast"
interfaceArg3: 12.5
- name: Test Port Channel - vlan
cnos_portchannel:
deviceType: "{{ hostvars[inventory_hostname]['deviceType'] }}"
outputfile: "./results/test_portchannel_{{ inventory_hostname }}_output.txt"
interfaceRange: 33
interfaceArg1: "vlan"
interfaceArg2: "disable"
- name: Test Port Channel - vrrp
cnos_portchannel:
deviceType: "{{ hostvars[inventory_hostname]['deviceType'] }}"
outputfile: "./results/test_portchannel_{{ inventory_hostname }}_output.txt"
interfaceRange: 33
interfaceArg1: "vrrp"
interfaceArg2: 33
- name: Test Port Channel - spanning tree1
cnos_portchannel:
deviceType: "{{ hostvars[inventory_hostname]['deviceType'] }}"
outputfile: "./results/test_portchannel_{{ inventory_hostname }}_output.txt"
interfaceRange: 33
interfaceArg1: "spanning-tree"
interfaceArg2: "bpduguard"
interfaceArg3: "enable"
- name: Test Port Channel - spanning tree 2
cnos_portchannel:
deviceType: "{{ hostvars[inventory_hostname]['deviceType'] }}"
outputfile: "./results/test_portchannel_{{ inventory_hostname }}_output.txt"
interfaceRange: 33
interfaceArg1: "spanning-tree"
interfaceArg2: "mst"
interfaceArg3: "33-35"
interfaceArg4: "cost"
interfaceArg5: 33
- name: Test Port Channel - ip1
cnos_portchannel:
deviceType: "{{ hostvars[inventory_hostname]['deviceType'] }}"
outputfile: "./results/test_portchannel_{{ inventory_hostname }}_output.txt"
interfaceRange: 33
interfaceArg1: "ip"
interfaceArg2: "access-group"
interfaceArg3: "anil"
interfaceArg4: "in"
- name: Test Port Channel - ip2
cnos_portchannel:
deviceType: "{{ hostvars[inventory_hostname]['deviceType'] }}"
outputfile: "./results/test_portchannel_{{ inventory_hostname }}_output.txt"
interfaceRange: 33
interfaceArg1: "ip"
interfaceArg2: "port"
interfaceArg3: "anil"
host:
description:
- This is the variable used to search the hosts file at /etc/ansible/hosts and identify
the IP address of the device on which the template is going to be applied. Usually
the Ansible keyword {{ inventory_hostname }} is specified in the playbook as an
abstraction of the group of network elements that need to be configured.
required: true
type: str
password:
description:
- Configures the password used to authenticate the connection to the remote device.
The value of the password parameter is used to authenticate the SSH session. While
generally the value should come from the inventory file, you can also specify it
as a variable. This parameter is optional. If it is not specified, no default value
will be used.
required: true
type: str
username:
description:
- Configures the username used to authenticate the connection to the remote device.
The value of the username parameter is used to authenticate the SSH session. While
generally the value should come from the inventory file, you can also specify it
as a variable. This parameter is optional. If it is not specified, no default value
will be used.
required: true
type: str
deviceType:
choices:
- g8272_cnos
- g8296_cnos
- g8332_cnos
- NE0152T
- NE1072T
- NE1032
- NE1032T
- NE10032
- NE2572
description:
- This specifies the type of device where the method is executed. The choices NE1072T,NE1032,NE1032T,NE10032,NE2572
are added since Ansible 2.4. The choice NE0152T is added since 2.8
required: true
type: str
outputfile:
description:
- This specifies the file path where the output of each command execution is saved.
Each command that is specified in the merged template file and each response from
the device are saved here. Usually the location is the results folder, but you can
choose another location based on your write permission.
required: true
type: str
interfaceArg1:
choices:
- channel-group
- bfd
- bridgeport
- description
- duplex
- flowcontrol
- ip
- ipv6
- lacp
- lldp
- load-interval
- mac
- mac-address
- mac-learn
- microburst-detection
- mtu
- service
- service-policy
- shutdown
- snmp
- spanning-tree
- speed
- storm-control
- vlan
- vrrp
- port-channel
default: null
description:
- This is an overloaded Port Channel first argument. Usage of this argument can be
found is the User Guide referenced above.
required: true
interfaceArg2:
choices:
- channel-group number
- access or mode or trunk
- description
- auto or full or half
- receive or send
- port-priority
- suspend-individual
- timeout
- receive or transmit or trap-notification
- tlv-select
- Load interval delay in seconds
- counter
- Name for the MAC Access List
- mac-address in HHHH.HHHH.HHHH format
- THRESHOLD Value in unit of buffer cell
- <64-9216> MTU in bytes-<64-9216> for L2 packet
- <576-9216> for L3 IPv4 packet
- <1280-9216> L3 IPv6 packet
- enter the instance id
- input or output
- copp-system-policy
- type
- 1000 or 10000 or 40000 or auto
- broadcast or multicast or unicast
- disable or enable or egress-only
- Virtual router identifier
- destination-ip or destination-mac or destination-port or source-dest-ip or source-dest-mac
or source-dest-port or source-interface or source-ip or source-mac or source-port
default: null
description:
- This is an overloaded Port Channel second argument. Usage of this argument can be
found is the User Guide referenced above.
required: false
interfaceArg3:
choices:
- active or on or passive
- on or off
- LACP port priority
- long or short
- link-aggregation or mac-phy-status or management-address or max-frame-size or port-description
or port-protocol-vlan or port-vlan or power-mdi or protocol-identity or system-capabilities
or system-description or system-name or vid-management or vlan-name
- counter for load interval
- policy input name
- all or Copp class name to attach
- qos
- queueing
- Enter the allowed traffic level
- ipv6
default: null
description:
- This is an overloaded Port Channel third argument. Usage of this argument can be
found is the User Guide referenced above.
required: false
interfaceArg4:
choices:
- key-chain
- key-id
- keyed-md5 or keyed-sha1 or meticulous-keyed-md5 or meticulous-keyed-sha1 or simple
- Interval value in milliseconds
- Destination IP (Both IPV4 and IPV6)
- in or out
- MAC address
- Time-out value in seconds
- class-id
- request
- Specify the IPv4 address
- OSPF area ID as a decimal value
- OSPF area ID in IP address format
- anycast or secondary
- ethernet
- vlan
- MAC (hardware) address in HHHH.HHHH.HHHH format
- Load interval delay in seconds
- Specify policy input name
- input or output
- cost
- port-priority
- BFD minimum receive interval
- source-interface
default: null
description:
- This is an overloaded Port Channel fourth argument. Usage of this argument can be
found is the User Guide referenced above.
required: false
interfaceArg5:
choices:
- name of key-chain
- key-Id Value
- key-chain
- key-id
- BFD minimum receive interval
- Value of Hello Multiplier
- admin-down or multihop or non-persistent
- Vendor class-identifier name
- bootfile-name or host-name or log-server or ntp-server or tftp-server-name
- Slot/chassis number
- Vlan interface
- Specify policy input name
- Port path cost or auto
- Port priority increments of 32
default: null
description:
- This is an overloaded Port Channel fifth argument. Usage of this argument can be
found is the User Guide referenced above.
required: false
interfaceArg6:
choices:
- Authentication key string
- name of key-chain
- key-Id Value
- Value of Hello Multiplier
- admin-down or non-persistent
default: null
description:
- This is an overloaded Port Channel sixth argument. Usage of this argument can be
found is the User Guide referenced above.
required: false
interfaceArg7:
choices:
- Authentication key string
- admin-down
default: null
description:
- This is an overloaded Port Channel seventh argument. Usage of this argument can
be found is the User Guide referenced above.
required: false
enablePassword:
description:
- Configures the password used to enter Global Configuration command mode on the switch.
If the switch does not request this password, the parameter is ignored.While generally
the value should come from the inventory file, you can also specify it as a variable.
This parameter is optional. If it is not specified, no default value will be used.
type: str
interfaceRange:
default: null
description:
- This specifies the interface range in which the port channel is envisaged
required: true
msg: description: Success or failure message returned: always sample: Port Channel configurations accomplished type: string