community / community.general / 0.1.1 / module / cnos_vlag Manage VLAG resources and attributes on devices running Lenovo CNOS Authors: Anil Kumar Muraleedharan (@amuraleedhar) preview | supported by communitycommunity.general.cnos_vlag (0.1.1) — module
Install with ansible-galaxy collection install community.general:==0.1.1
collections: - name: community.general version: 0.1.1
This module allows you to work with virtual Link Aggregation Groups (vLAG) related configurations. The operators used are overloaded to ensure control over switch vLAG configurations. Apart from the regular device connection related attributes, there are four vLAG arguments which are overloaded variables that will perform further configurations. They are vlagArg1, vlagArg2, vlagArg3, and vlagArg4. 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_vlag. These are written in the main.yml file of the tasks directory. --- - name: Test Vlag - enable cnos_vlag: deviceType: "{{ hostvars[inventory_hostname]['deviceType']}}" outputfile: "./results/cnos_vlag_{{ inventory_hostname }}_output.txt" vlagArg1: "enable"
- name: Test Vlag - autorecovery cnos_vlag: deviceType: "{{ hostvars[inventory_hostname]['deviceType']}}" outputfile: "./results/cnos_vlag_{{ inventory_hostname }}_output.txt" vlagArg1: "auto-recovery" vlagArg2: 266
- name: Test Vlag - config-consistency cnos_vlag: deviceType: "{{ hostvars[inventory_hostname]['deviceType']}}" outputfile: "./results/cnos_vlag_{{ inventory_hostname }}_output.txt" vlagArg1: "config-consistency" vlagArg2: "strict"
- name: Test Vlag - isl cnos_vlag: deviceType: "{{ hostvars[inventory_hostname]['deviceType']}}" outputfile: "./results/cnos_vlag_{{ inventory_hostname }}_output.txt" vlagArg1: "isl" vlagArg2: 23
- name: Test Vlag - mac-address-table cnos_vlag: deviceType: "{{ hostvars[inventory_hostname]['deviceType']}}" outputfile: "./results/cnos_vlag_{{ inventory_hostname }}_output.txt" vlagArg1: "mac-address-table"
- name: Test Vlag - peer-gateway cnos_vlag: deviceType: "{{ hostvars[inventory_hostname]['deviceType']}}" outputfile: "./results/cnos_vlag_{{ inventory_hostname }}_output.txt" vlagArg1: "peer-gateway"
- name: Test Vlag - priority cnos_vlag: deviceType: "{{ hostvars[inventory_hostname]['deviceType']}}" outputfile: "./results/cnos_vlag_{{ inventory_hostname }}_output.txt" vlagArg1: "priority" vlagArg2: 1313
- name: Test Vlag - startup-delay cnos_vlag: deviceType: "{{ hostvars[inventory_hostname]['deviceType']}}" outputfile: "./results/cnos_vlag_{{ inventory_hostname }}_output.txt" vlagArg1: "startup-delay" vlagArg2: 323
- name: Test Vlag - tier-id cnos_vlag: deviceType: "{{ hostvars[inventory_hostname]['deviceType']}}" outputfile: "./results/cnos_vlag_{{ inventory_hostname }}_output.txt" vlagArg1: "tier-id" vlagArg2: 313
- name: Test Vlag - vrrp cnos_vlag: deviceType: "{{ hostvars[inventory_hostname]['deviceType']}}" outputfile: "./results/cnos_vlag_{{ inventory_hostname }}_output.txt" vlagArg1: "vrrp"
- name: Test Vlag - instance cnos_vlag: deviceType: "{{ hostvars[inventory_hostname]['deviceType']}}" outputfile: "./results/cnos_vlag_{{ inventory_hostname }}_output.txt" vlagArg1: "instance" vlagArg2: 33 vlagArg3: 333
- name: Test Vlag - instance2 cnos_vlag: deviceType: "{{ hostvars[inventory_hostname]['deviceType']}}" outputfile: "./results/cnos_vlag_{{ inventory_hostname }}_output.txt" vlagArg1: "instance" vlagArg2: "33"
- name: Test Vlag - keepalive-attempts cnos_vlag: deviceType: "{{ hostvars[inventory_hostname]['deviceType']}}" outputfile: "./results/cnos_vlag_{{ inventory_hostname }}_output.txt" vlagArg1: "hlthchk" vlagArg2: "keepalive-attempts" vlagArg3: 13
- name: Test Vlag - keepalive-interval cnos_vlag: deviceType: "{{ hostvars[inventory_hostname]['deviceType']}}" outputfile: "./results/cnos_vlag_{{ inventory_hostname }}_output.txt" vlagArg1: "hlthchk" vlagArg2: "keepalive-interval" vlagArg3: 131
- name: Test Vlag - retry-interval cnos_vlag: deviceType: "{{ hostvars[inventory_hostname]['deviceType']}}" outputfile: "./results/cnos_vlag_{{ inventory_hostname }}_output.txt" vlagArg1: "hlthchk" vlagArg2: "retry-interval" vlagArg3: 133
- name: Test Vlag - peer ip cnos_vlag: deviceType: "{{ hostvars[inventory_hostname]['deviceType']}}" outputfile: "./results/cnos_vlag_{{ inventory_hostname }}_output.txt" vlagArg1: "hlthchk" vlagArg2: "peer-ip" vlagArg3: "1.2.3.4"
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 vlagArg1: choices: - enable - auto-recovery - config-consistency - isl - mac-address-table - peer-gateway - priority - startup-delay - tier-id - vrrp - instance - hlthchk default: null description: - This is an overloaded vlag first argument. Usage of this argument can be found is the User Guide referenced above. required: true vlagArg2: choices: - Interval in seconds - disable or strict - Port Aggregation Number - VLAG priority - Delay time in seconds - VLAG tier-id value - VLAG instance number - keepalive-attempts - keepalive-interval - retry-interval - peer-ip default: null description: - This is an overloaded vlag second argument. Usage of this argument can be found is the User Guide referenced above. required: false vlagArg3: choices: - enable or port-aggregation - Number of keepalive attempts - Interval in seconds - Interval in seconds - VLAG health check peer IP4 address default: null description: - This is an overloaded vlag third argument. Usage of this argument can be found is the User Guide referenced above. required: false vlagArg4: choices: - Port Aggregation Number - default or management default: null description: - This is an overloaded vlag fourth argument. Usage of this argument can be found is the User Guide referenced above. required: false 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 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
msg: description: Success or failure message returned: always sample: vLAG configurations accomplished type: str