mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-07-22 12:50:22 -07:00
Refactoring cnos_vlan in line with ios, eos etc. (#48924)
* Refactoring cnos_vlan in line with ios, eos etc.
This commit is contained in:
Anil Kumar Muraleedharan
Nathaniel Case
parent
ca918def18
commit
7a81d859c5
13 changed files with 837 additions and 676 deletions
|
|
@ -1,10 +1,8 @@
|
|||
#!/usr/bin/python
|
||||
# -*- coding: utf-8 -*-
|
||||
from __future__ import (absolute_import, division, print_function)
|
||||
__metaclass__ = type
|
||||
#
|
||||
|
||||
# Copyright (C) 2017 Lenovo, Inc.
|
||||
#
|
||||
# (c) 2017, Ansible by Red Hat, inc
|
||||
# This file is part of Ansible
|
||||
#
|
||||
# Ansible is free software: you can redistribute it and/or modify
|
||||
|
|
@ -23,532 +21,398 @@ __metaclass__ = type
|
|||
# Module to send VLAN commands to Lenovo Switches
|
||||
# Overloading aspect of vlan creation in a range is pending
|
||||
# Lenovo Networking
|
||||
#
|
||||
|
||||
|
||||
from __future__ import absolute_import, division, print_function
|
||||
__metaclass__ = type
|
||||
|
||||
|
||||
ANSIBLE_METADATA = {'metadata_version': '1.1',
|
||||
'status': ['preview'],
|
||||
'supported_by': 'community'}
|
||||
|
||||
|
||||
DOCUMENTATION = '''
|
||||
DOCUMENTATION = """
|
||||
---
|
||||
module: cnos_vlan
|
||||
author: "Anil Kumar Muraleedharan (@amuraleedhar)"
|
||||
short_description: Manage VLAN resources and attributes on devices running
|
||||
Lenovo CNOS
|
||||
description:
|
||||
- This module allows you to work with VLAN related configurations. The
|
||||
operators used are overloaded to ensure control over switch VLAN
|
||||
configurations. The first level of VLAN configuration allows to set up the
|
||||
VLAN range, the VLAN tag persistence, a VLAN access map and access map
|
||||
filter. After passing this level, there are five VLAN arguments that will
|
||||
perform further configurations. They are vlanArg1, vlanArg2, vlanArg3,
|
||||
vlanArg4, and vlanArg5. The value of vlanArg1 will determine the way
|
||||
following arguments will be evaluated. 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.
|
||||
version_added: "2.3"
|
||||
extends_documentation_fragment: cnos
|
||||
author: "Anil Kumar Mureleedharan(@amuraleedhar)"
|
||||
short_description: Manage VLANs on CNOS network devices
|
||||
description:
|
||||
- This module provides declarative management of VLANs
|
||||
on Lenovo CNOS network devices.
|
||||
notes:
|
||||
- Tested against CNOS 10.8.1
|
||||
options:
|
||||
vlanArg1:
|
||||
name:
|
||||
description:
|
||||
- This is an overloaded vlan first argument. Usage of this argument can
|
||||
be found is the User Guide referenced above.
|
||||
- Name of the VLAN.
|
||||
version_added: "2.8"
|
||||
vlan_id:
|
||||
description:
|
||||
- ID of the VLAN. Range 1-4094.
|
||||
required: true
|
||||
choices: [access-map, dot1q, filter, <1-3999> VLAN ID 1-3999 or range]
|
||||
vlanArg2:
|
||||
version_added: "2.8"
|
||||
interfaces:
|
||||
description:
|
||||
- This is an overloaded vlan second argument. Usage of this argument can
|
||||
be found is the User Guide referenced above.
|
||||
choices: [VLAN Access Map name,egress-only,name, flood,state, ip]
|
||||
vlanArg3:
|
||||
- List of interfaces that should be associated to the VLAN.
|
||||
required: true
|
||||
version_added: "2.8"
|
||||
associated_interfaces:
|
||||
description:
|
||||
- This is an overloaded vlan third argument. Usage of this argument can
|
||||
be found is the User Guide referenced above.
|
||||
choices: [action, match, statistics, enter VLAN id or range of vlan,
|
||||
ascii name for the VLAN, ipv4 or ipv6, active or suspend,
|
||||
fast-leave, last-member-query-interval, mrouter, querier,
|
||||
querier-timeout, query-interval, query-max-response-time,
|
||||
report-suppression, robustness-variable, startup-query-count,
|
||||
startup-query-interval, static-group]
|
||||
vlanArg4:
|
||||
- This is a intent option and checks the operational state of the for
|
||||
given vlan C(name) for associated interfaces. If the value in the
|
||||
C(associated_interfaces) does not match with the operational state of
|
||||
vlan interfaces on device it will result in failure.
|
||||
version_added: "2.8"
|
||||
delay:
|
||||
description:
|
||||
- This is an overloaded vlan fourth argument. Usage of this argument can
|
||||
be found is the User Guide referenced above.
|
||||
choices: [drop or forward or redirect, ip or mac,Interval in seconds,
|
||||
ethernet, port-aggregation, Querier IP address,
|
||||
Querier Timeout in seconds, Query Interval in seconds,
|
||||
Query Max Response Time in seconds, Robustness Variable value,
|
||||
Number of queries sent at startup, Query Interval at startup]
|
||||
vlanArg5:
|
||||
- Delay the play should wait to check for declarative intent params
|
||||
values.
|
||||
default: 10
|
||||
version_added: "2.8"
|
||||
aggregate:
|
||||
description: List of VLANs definitions.
|
||||
version_added: "2.8"
|
||||
purge:
|
||||
description:
|
||||
- This is an overloaded vlan fifth argument. Usage of this argument can
|
||||
be found is the User Guide referenced above.
|
||||
choices: [access-list name, Slot/chassis number, Port Aggregation Number]
|
||||
- Purge VLANs not defined in the I(aggregate) parameter.
|
||||
default: no
|
||||
type: bool
|
||||
version_added: "2.8"
|
||||
state:
|
||||
description:
|
||||
- State of the VLAN configuration.
|
||||
default: present
|
||||
version_added: "2.8"
|
||||
choices: ['present', 'absent', 'active', 'suspend']
|
||||
provider:
|
||||
description:
|
||||
- B(Deprecated)
|
||||
- "Starting with Ansible 2.5 we recommend using C(connection: network_cli)."
|
||||
- For more information please see the L(IOS Platform Options guide, ../network/user_guide/platform_ios.html).
|
||||
- HORIZONTALLINE
|
||||
- A dict object containing connection details.
|
||||
version_added: "2.8"
|
||||
suboptions:
|
||||
host:
|
||||
description:
|
||||
- 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.
|
||||
required: true
|
||||
port:
|
||||
description:
|
||||
- Specifies the port to use when building the connection to the remote device.
|
||||
default: 22
|
||||
username:
|
||||
description:
|
||||
- Configures the username to use to authenticate the connection to
|
||||
the remote device. This value is used to authenticate
|
||||
the SSH session. If the value is not specified in the task, the
|
||||
value of environment variable C(ANSIBLE_NET_USERNAME) will be used instead.
|
||||
password:
|
||||
description:
|
||||
- Specifies the password to use to authenticate the connection to
|
||||
the remote device. This value is used to authenticate
|
||||
the SSH session. If the value is not specified in the task, the
|
||||
value of environment variable C(ANSIBLE_NET_PASSWORD) will be used instead.
|
||||
timeout:
|
||||
description:
|
||||
- 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.
|
||||
default: 10
|
||||
ssh_keyfile:
|
||||
description:
|
||||
- Specifies the SSH key to use to authenticate the connection to
|
||||
the remote device. This value is the path to the
|
||||
key used to authenticate the SSH session. If the value is not specified
|
||||
in the task, the value of environment variable C(ANSIBLE_NET_SSH_KEYFILE)
|
||||
will be used instead.
|
||||
authorize:
|
||||
description:
|
||||
- Instructs the module to enter privileged mode on the remote device
|
||||
before sending any commands. If not specified, the device will
|
||||
attempt to execute all commands in non-privileged mode. If the value
|
||||
is not specified in the task, the value of environment variable
|
||||
C(ANSIBLE_NET_AUTHORIZE) will be used instead.
|
||||
type: bool
|
||||
default: 'no'
|
||||
auth_pass:
|
||||
description:
|
||||
- Specifies the password to use if required to enter privileged mode
|
||||
on the remote device. If I(authorize) is false, then this argument
|
||||
does nothing. If the value is not specified in the task, the value of
|
||||
environment variable C(ANSIBLE_NET_AUTH_PASS) will be used instead.
|
||||
"""
|
||||
|
||||
'''
|
||||
EXAMPLES = '''
|
||||
|
||||
Tasks: The following are examples of using the module cnos_vlan. These are
|
||||
written in the main.yml file of the tasks directory.
|
||||
---
|
||||
- name: Test Vlan - Create a vlan, name it
|
||||
EXAMPLES = """
|
||||
- name: Create vlan
|
||||
cnos_vlan:
|
||||
deviceType: "{{ hostvars[inventory_hostname]['deviceType'] }}"
|
||||
outputfile: "./results/test_vlan_{{ inventory_hostname }}_output.txt"
|
||||
vlanArg1: 13
|
||||
vlanArg2: "name"
|
||||
vlanArg3: "Anil"
|
||||
vlan_id: 100
|
||||
name: test-vlan
|
||||
state: present
|
||||
|
||||
- name: Test Vlan - Create a vlan, Flood configuration
|
||||
- name: Add interfaces to VLAN
|
||||
cnos_vlan:
|
||||
deviceType: "{{ hostvars[inventory_hostname]['deviceType'] }}"
|
||||
outputfile: "./results/test_vlan_{{ inventory_hostname }}_output.txt"
|
||||
vlanArg1: 13
|
||||
vlanArg2: "flood"
|
||||
vlanArg3: "ipv4"
|
||||
vlan_id: 100
|
||||
interfaces:
|
||||
- Ethernet1/33
|
||||
- Ethernet1/44
|
||||
|
||||
- name: Test Vlan - Create a vlan, State configuration
|
||||
- name: Check if interfaces is assigned to VLAN
|
||||
cnos_vlan:
|
||||
deviceType: "{{ hostvars[inventory_hostname]['deviceType'] }}"
|
||||
outputfile: "./results/test_vlan_{{ inventory_hostname }}_output.txt"
|
||||
vlanArg1: 13
|
||||
vlanArg2: "state"
|
||||
vlanArg3: "active"
|
||||
vlan_id: 100
|
||||
associated_interfaces:
|
||||
- Ethernet1/33
|
||||
- Ethernet1/44
|
||||
|
||||
- name: Test Vlan - VLAN Access map1
|
||||
- name: Delete vlan
|
||||
cnos_vlan:
|
||||
deviceType: "{{ hostvars[inventory_hostname]['deviceType'] }}"
|
||||
outputfile: "./results/test_vlan_{{ inventory_hostname }}_output.txt"
|
||||
vlanArg1: "access-map"
|
||||
vlanArg2: "Anil"
|
||||
vlanArg3: "statistics"
|
||||
vlan_id: 100
|
||||
state: absent
|
||||
"""
|
||||
|
||||
- name: Test Vlan - VLAN Accep Map2
|
||||
cnos_vlan:
|
||||
deviceType: "{{ hostvars[inventory_hostname]['deviceType'] }}"
|
||||
outputfile: "./results/test_vlan_{{ inventory_hostname }}_output.txt"
|
||||
vlanArg1: "access-map"
|
||||
vlanArg2: "Anil"
|
||||
vlanArg3: "action"
|
||||
vlanArg4: "forward"
|
||||
|
||||
- name: Test Vlan - ip igmp snooping query interval
|
||||
cnos_vlan:
|
||||
deviceType: "{{ hostvars[inventory_hostname]['deviceType'] }}"
|
||||
outputfile: "./results/test_vlan_{{ inventory_hostname }}_output.txt"
|
||||
vlanArg1: 13
|
||||
vlanArg2: "ip"
|
||||
vlanArg3: "query-interval"
|
||||
vlanArg4: 1313
|
||||
|
||||
- name: Test Vlan - ip igmp snooping mrouter interface port-aggregation 23
|
||||
cnos_vlan:
|
||||
deviceType: "{{ hostvars[inventory_hostname]['deviceType'] }}"
|
||||
outputfile: "./results/test_vlan_{{ inventory_hostname }}_output.txt"
|
||||
vlanArg1: 13
|
||||
vlanArg2: "ip"
|
||||
vlanArg3: "mrouter"
|
||||
vlanArg4: "port-aggregation"
|
||||
vlanArg5: 23
|
||||
|
||||
'''
|
||||
RETURN = '''
|
||||
msg:
|
||||
description: Success or failure message
|
||||
RETURN = """
|
||||
commands:
|
||||
description: The list of configuration mode commands to send to the device
|
||||
returned: always
|
||||
type: string
|
||||
sample: "VLAN configuration is accomplished"
|
||||
'''
|
||||
type: list
|
||||
sample:
|
||||
- vlan 100
|
||||
- name test-vlan
|
||||
"""
|
||||
|
||||
import sys
|
||||
import time
|
||||
import socket
|
||||
import array
|
||||
import json
|
||||
import time
|
||||
import re
|
||||
try:
|
||||
from ansible.module_utils.network.cnos import cnos
|
||||
HAS_LIB = True
|
||||
except:
|
||||
HAS_LIB = False
|
||||
import time
|
||||
|
||||
from copy import deepcopy
|
||||
|
||||
from ansible.module_utils.basic import AnsibleModule
|
||||
from collections import defaultdict
|
||||
from ansible.module_utils.network.common.utils import remove_default_spec
|
||||
from ansible.module_utils.network.cnos.cnos import load_config, run_commands
|
||||
from ansible.module_utils.network.cnos.cnos import debugOutput, check_args
|
||||
from ansible.module_utils.network.cnos.cnos import cnos_argument_spec
|
||||
from ansible.module_utils._text import to_text
|
||||
|
||||
|
||||
def vlanAccessMapConfig(module, cmd):
|
||||
retVal = ''
|
||||
# Wait time to get response from server
|
||||
command = ''
|
||||
vlanArg3 = module.params['vlanArg3']
|
||||
vlanArg4 = module.params['vlanArg4']
|
||||
vlanArg5 = module.params['vlanArg5']
|
||||
deviceType = module.params['deviceType']
|
||||
if(vlanArg3 == "action"):
|
||||
command = command + vlanArg3 + ' '
|
||||
value = cnos.checkSanityofVariable(
|
||||
deviceType, "vlan_accessmap_action", vlanArg4)
|
||||
if(value == "ok"):
|
||||
command = command + vlanArg4
|
||||
else:
|
||||
retVal = "Error-135"
|
||||
return retVal
|
||||
elif(vlanArg3 == "match"):
|
||||
command = command + vlanArg3 + ' '
|
||||
if(vlanArg4 == "ip" or vlanArg4 == "mac"):
|
||||
command = command + vlanArg4 + ' address '
|
||||
value = cnos.checkSanityofVariable(
|
||||
deviceType, "vlan_access_map_name", vlanArg5)
|
||||
if(value == "ok"):
|
||||
command = command + vlanArg5
|
||||
def search_obj_in_list(vlan_id, lst):
|
||||
obj = list()
|
||||
for o in lst:
|
||||
if o['vlan_id'] == vlan_id:
|
||||
return o
|
||||
|
||||
|
||||
def map_obj_to_commands(updates, module):
|
||||
commands = list()
|
||||
want, have = updates
|
||||
purge = module.params['purge']
|
||||
|
||||
for w in want:
|
||||
vlan_id = w['vlan_id']
|
||||
name = w['name']
|
||||
interfaces = w['interfaces']
|
||||
state = w['state']
|
||||
|
||||
obj_in_have = search_obj_in_list(vlan_id, have)
|
||||
|
||||
if state == 'absent':
|
||||
if obj_in_have:
|
||||
commands.append('no vlan {0}'.format(vlan_id))
|
||||
|
||||
elif state == 'present':
|
||||
if not obj_in_have:
|
||||
commands.append('vlan {0}'.format(vlan_id))
|
||||
if name:
|
||||
commands.append('name {0}'.format(name))
|
||||
|
||||
if interfaces:
|
||||
for i in interfaces:
|
||||
commands.append('interface {0}'.format(i))
|
||||
commands.append('switchport mode access')
|
||||
commands.append('switchport access vlan {0}'.format(vlan_id))
|
||||
|
||||
else:
|
||||
retVal = "Error-136"
|
||||
return retVal
|
||||
if name:
|
||||
if name != obj_in_have['name']:
|
||||
commands.append('vlan {0}'.format(vlan_id))
|
||||
commands.append('name {0}'.format(name))
|
||||
|
||||
if interfaces:
|
||||
if not obj_in_have['interfaces']:
|
||||
for i in interfaces:
|
||||
commands.append('vlan {0}'.format(vlan_id))
|
||||
commands.append('interface {0}'.format(i))
|
||||
commands.append('switchport mode access')
|
||||
commands.append('switchport access vlan {0}'.format(vlan_id))
|
||||
|
||||
elif set(interfaces) != set(obj_in_have['interfaces']):
|
||||
missing_interfaces = list(set(interfaces) - set(obj_in_have['interfaces']))
|
||||
for i in missing_interfaces:
|
||||
commands.append('vlan {0}'.format(vlan_id))
|
||||
commands.append('interface {0}'.format(i))
|
||||
commands.append('switchport mode access')
|
||||
commands.append('switchport access vlan {0}'.format(vlan_id))
|
||||
|
||||
superfluous_interfaces = list(set(obj_in_have['interfaces']) - set(interfaces))
|
||||
for i in superfluous_interfaces:
|
||||
commands.append('vlan {0}'.format(vlan_id))
|
||||
commands.append('interface {0}'.format(i))
|
||||
commands.append('switchport mode access')
|
||||
commands.append('no switchport access vlan')
|
||||
else:
|
||||
retVal = "Error-137"
|
||||
return retVal
|
||||
elif(vlanArg3 == "statistics"):
|
||||
command = vlanArg3 + " per-entry"
|
||||
commands.append('vlan {0}'.format(vlan_id))
|
||||
if name:
|
||||
commands.append('name {0}'.format(name))
|
||||
commands.append('state {0}'.format(state))
|
||||
|
||||
if purge:
|
||||
for h in have:
|
||||
obj_in_want = search_obj_in_list(h['vlan_id'], want)
|
||||
if not obj_in_want and h['vlan_id'] != '1':
|
||||
commands.append('no vlan {0}'.format(h['vlan_id']))
|
||||
|
||||
return commands
|
||||
|
||||
|
||||
def map_params_to_obj(module):
|
||||
obj = []
|
||||
aggregate = module.params.get('aggregate')
|
||||
if aggregate:
|
||||
for item in aggregate:
|
||||
for key in item:
|
||||
if item.get(key) is None:
|
||||
item[key] = module.params[key]
|
||||
|
||||
d = item.copy()
|
||||
d['vlan_id'] = str(d['vlan_id'])
|
||||
|
||||
obj.append(d)
|
||||
else:
|
||||
retVal = "Error-138"
|
||||
return retVal
|
||||
obj.append({
|
||||
'vlan_id': str(module.params['vlan_id']),
|
||||
'name': module.params['name'],
|
||||
'interfaces': module.params['interfaces'],
|
||||
# 'associated_interfaces': module.params['associated_interfaces'],
|
||||
'state': module.params['state']
|
||||
})
|
||||
|
||||
inner_cmd = [{'command': command, 'prompt': None, 'answer': None}]
|
||||
cmd.extend(inner_cmd)
|
||||
retVal = retVal + str(cnos.run_cnos_commands(module, cmd))
|
||||
# debugOutput(command)
|
||||
return retVal
|
||||
# EOM
|
||||
return obj
|
||||
|
||||
|
||||
def checkVlanNameNotAssigned(module, prompt, answer):
|
||||
retVal = "ok"
|
||||
vlanId = module.params['vlanArg1']
|
||||
vlanName = module.params['vlanArg3']
|
||||
command = "show vlan id " + vlanId
|
||||
cmd = [{'command': command, 'prompt': None, 'answer': None}]
|
||||
retVal = str(cnos.run_cnos_commands(module, cmd))
|
||||
if(retVal.find('Error') != -1):
|
||||
command = "display vlan id " + vlanId
|
||||
retVal = str(cnos.run_cnos_commands(module, cmd))
|
||||
if(retVal.find(vlanName) != -1):
|
||||
return "Nok"
|
||||
else:
|
||||
return "ok"
|
||||
# EOM
|
||||
def parse_to_logical_rows(out):
|
||||
relevant_data = False
|
||||
cur_row = []
|
||||
for line in out.splitlines():
|
||||
if not line:
|
||||
"""Skip empty lines."""
|
||||
continue
|
||||
if '0' < line[0] <= '9':
|
||||
"""Line starting with a number."""
|
||||
if len(cur_row) > 0:
|
||||
yield cur_row
|
||||
cur_row = [] # Reset it to hold a next chunk
|
||||
relevant_data = True
|
||||
if relevant_data:
|
||||
data = line.strip().split('(')
|
||||
cur_row.append(data[0])
|
||||
yield cur_row
|
||||
|
||||
|
||||
# Utility Method to create vlan
|
||||
def createVlan(module, prompt, answer):
|
||||
|
||||
# vlan config command happens here. It creates if not present
|
||||
vlanArg1 = module.params['vlanArg1']
|
||||
vlanArg2 = module.params['vlanArg2']
|
||||
vlanArg3 = module.params['vlanArg3']
|
||||
vlanArg4 = module.params['vlanArg4']
|
||||
vlanArg5 = module.params['vlanArg5']
|
||||
deviceType = module.params['deviceType']
|
||||
retVal = ''
|
||||
command = 'vlan ' + vlanArg1
|
||||
# debugOutput(command)
|
||||
cmd = [{'command': command, 'prompt': None, 'answer': None}]
|
||||
command = ""
|
||||
if(vlanArg2 == "name"):
|
||||
# debugOutput("name")
|
||||
command = vlanArg2 + " "
|
||||
value = cnos.checkSanityofVariable(deviceType, "vlan_name", vlanArg3)
|
||||
if(value == "ok"):
|
||||
value = checkVlanNameNotAssigned(module, prompt, answer)
|
||||
if(value == "ok"):
|
||||
command = command + vlanArg3
|
||||
else:
|
||||
retVal = retVal + 'VLAN Name is already assigned \n'
|
||||
command = "\n"
|
||||
else:
|
||||
retVal = "Error-139"
|
||||
return retVal
|
||||
elif (vlanArg2 == "flood"):
|
||||
# debugOutput("flood")
|
||||
command = vlanArg2 + " "
|
||||
value = cnos.checkSanityofVariable(deviceType, "vlan_flood", vlanArg3)
|
||||
if(value == "ok"):
|
||||
command = command + vlanArg3
|
||||
else:
|
||||
retVal = "Error-140"
|
||||
return retVal
|
||||
|
||||
elif(vlanArg2 == "state"):
|
||||
# debugOutput("state")
|
||||
command = vlanArg2 + " "
|
||||
value = cnos.checkSanityofVariable(deviceType, "vlan_state", vlanArg3)
|
||||
if(value == "ok"):
|
||||
command = command + vlanArg3
|
||||
else:
|
||||
retVal = "Error-141"
|
||||
return retVal
|
||||
|
||||
elif(vlanArg2 == "ip"):
|
||||
# debugOutput("ip")
|
||||
command = vlanArg2 + " igmp snooping "
|
||||
# debugOutput("vlanArg3")
|
||||
if(vlanArg3 is None or vlanArg3 == ""):
|
||||
# debugOutput("None or empty")
|
||||
command = command.strip()
|
||||
elif(vlanArg3 == "fast-leave"):
|
||||
# debugOutput("fast-leave")
|
||||
command = command + vlanArg3
|
||||
|
||||
elif (vlanArg3 == "last-member-query-interval"):
|
||||
# debugOutput("last-member-query-interval")
|
||||
command = command + vlanArg3 + " "
|
||||
value = cnos.checkSanityofVariable(
|
||||
deviceType, "vlan_last_member_query_interval", vlanArg4)
|
||||
if(value == "ok"):
|
||||
command = command + vlanArg4
|
||||
else:
|
||||
retVal = "Error-142"
|
||||
return retVal
|
||||
|
||||
elif (vlanArg3 == "querier"):
|
||||
# debugOutput("querier")
|
||||
command = command + vlanArg3 + " "
|
||||
value = cnos.checkSanityofVariable(deviceType,
|
||||
"vlan_querier", vlanArg4)
|
||||
if(value == "ok"):
|
||||
command = command + vlanArg4
|
||||
else:
|
||||
retVal = "Error-143"
|
||||
return retVal
|
||||
elif (vlanArg3 == "querier-timeout"):
|
||||
# debugOutput("querier-timeout")
|
||||
command = command + vlanArg3 + " "
|
||||
value = cnos.checkSanityofVariable(
|
||||
deviceType, "vlan_querier_timeout", vlanArg4)
|
||||
if(value == "ok"):
|
||||
command = command + vlanArg4
|
||||
else:
|
||||
retVal = "Error-144"
|
||||
return retVal
|
||||
elif (vlanArg3 == "query-interval"):
|
||||
# debugOutput("query-interval")
|
||||
command = command + vlanArg3 + " "
|
||||
value = cnos.checkSanityofVariable(
|
||||
deviceType, "vlan_query_interval", vlanArg4)
|
||||
if(value == "ok"):
|
||||
command = command + vlanArg4
|
||||
else:
|
||||
retVal = "Error-145"
|
||||
return retVal
|
||||
elif (vlanArg3 == "query-max-response-time"):
|
||||
# debugOutput("query-max-response-time")
|
||||
command = command + vlanArg3 + " "
|
||||
value = cnos.checkSanityofVariable(
|
||||
deviceType, "vlan_query_max_response_time", vlanArg4)
|
||||
if(value == "ok"):
|
||||
command = command + vlanArg4
|
||||
else:
|
||||
retVal = "Error-146"
|
||||
return retVal
|
||||
elif (vlanArg3 == "report-suppression"):
|
||||
# debugOutput("report-suppression")
|
||||
command = command + vlanArg3
|
||||
|
||||
elif (vlanArg3 == "robustness-variable"):
|
||||
# debugOutput("robustness-variable")
|
||||
command = command + vlanArg3 + " "
|
||||
value = cnos.checkSanityofVariable(
|
||||
deviceType, "vlan_startup_query_count", vlanArg4)
|
||||
if(value == "ok"):
|
||||
command = command + vlanArg4
|
||||
else:
|
||||
retVal = "Error-148"
|
||||
return retVal
|
||||
elif (vlanArg3 == "startup-query-interval"):
|
||||
# debugOutput("startup-query-interval")
|
||||
command = command + vlanArg3 + " "
|
||||
value = cnos.checkSanityofVariable(
|
||||
deviceType, "vlan_startup_query_interval", vlanArg4)
|
||||
if(value == "ok"):
|
||||
command = command + vlanArg4
|
||||
else:
|
||||
retVal = "Error-149"
|
||||
return retVal
|
||||
elif (vlanArg3 == "static-group"):
|
||||
retVal = "Error-102"
|
||||
return retVal
|
||||
elif (vlanArg3 == "version"):
|
||||
# debugOutput("version")
|
||||
command = command + vlanArg3 + " "
|
||||
value = cnos.checkSanityofVariable(
|
||||
deviceType, "vlan_snooping_version", vlanArg4)
|
||||
if(value == "ok"):
|
||||
command = command + vlanArg4
|
||||
else:
|
||||
retVal = "Error-150"
|
||||
return retVal
|
||||
elif (vlanArg3 == "mrouter"):
|
||||
# debugOutput("mrouter")
|
||||
command = command + vlanArg3 + " interface "
|
||||
if(vlanArg4 == "ethernet"):
|
||||
command = command + vlanArg4 + " "
|
||||
value = cnos.checkSanityofVariable(
|
||||
deviceType, "vlan_ethernet_interface", vlanArg5)
|
||||
if(value == "ok"):
|
||||
command = command + vlanArg5
|
||||
else:
|
||||
retVal = "Error-151"
|
||||
return retVal
|
||||
elif(vlanArg4 == "port-aggregation"):
|
||||
command = command + vlanArg4 + " "
|
||||
value = cnos.checkSanityofVariable(
|
||||
deviceType, "vlan_portagg_number", vlanArg5)
|
||||
if(value == "ok"):
|
||||
command = command + vlanArg5
|
||||
else:
|
||||
retVal = "Error-152"
|
||||
return retVal
|
||||
else:
|
||||
retVal = "Error-153"
|
||||
return retVal
|
||||
else:
|
||||
command = command + vlanArg3
|
||||
|
||||
else:
|
||||
retVal = "Error-154"
|
||||
return retVal
|
||||
inner_cmd = [{'command': command, 'prompt': None, 'answer': None}]
|
||||
cmd.extend(inner_cmd)
|
||||
retVal = retVal + str(cnos.run_cnos_commands(module, cmd))
|
||||
# debugOutput(command)
|
||||
return retVal
|
||||
# EOM
|
||||
def parse_to_obj(logical_rows):
|
||||
first_row = logical_rows[0]
|
||||
rest_rows = logical_rows[1:]
|
||||
vlan_data = first_row.split()
|
||||
obj = {}
|
||||
obj['vlan_id'] = vlan_data[0]
|
||||
obj['name'] = vlan_data[1]
|
||||
obj['state'] = vlan_data[2]
|
||||
obj['interfaces'] = rest_rows
|
||||
return obj
|
||||
|
||||
|
||||
def vlanConfig(module, prompt, answer):
|
||||
def parse_vlan_brief(vlan_out):
|
||||
return [parse_to_obj(r) for r in parse_to_logical_rows(vlan_out)]
|
||||
|
||||
retVal = ''
|
||||
# Wait time to get response from server
|
||||
vlanArg1 = module.params['vlanArg1']
|
||||
vlanArg2 = module.params['vlanArg2']
|
||||
vlanArg3 = module.params['vlanArg3']
|
||||
vlanArg4 = module.params['vlanArg4']
|
||||
vlanArg5 = module.params['vlanArg5']
|
||||
deviceType = module.params['deviceType']
|
||||
# vlan config command happens here.
|
||||
command = 'vlan '
|
||||
|
||||
if(vlanArg1 == "access-map"):
|
||||
# debugOutput("access-map ")
|
||||
command = command + vlanArg1 + ' '
|
||||
value = cnos.checkSanityofVariable(
|
||||
deviceType, "vlan_access_map_name", vlanArg2)
|
||||
if(value == "ok"):
|
||||
command = command + vlanArg2
|
||||
# debugOutput(command)
|
||||
cmd = [{'command': command, 'prompt': None, 'answer': None}]
|
||||
retVal = retVal + vlanAccessMapConfig(module, cmd)
|
||||
return retVal
|
||||
else:
|
||||
retVal = "Error-130"
|
||||
return retVal
|
||||
def map_config_to_obj(module):
|
||||
return parse_vlan_brief(run_commands(module, ['show vlan brief'])[0])
|
||||
|
||||
elif(vlanArg1 == "dot1q"):
|
||||
# debugOutput("dot1q")
|
||||
command = command + vlanArg1 + " tag native "
|
||||
if(vlanArg2 is not None):
|
||||
value = cnos.checkSanityofVariable(
|
||||
deviceType, "vlan_dot1q_tag", vlanArg2)
|
||||
if(value == "ok"):
|
||||
command = command + vlanArg2
|
||||
else:
|
||||
retVal = "Error-131"
|
||||
return retVal
|
||||
|
||||
elif(vlanArg1 == "filter"):
|
||||
# debugOutput( "filter")
|
||||
command = command + vlanArg1 + " "
|
||||
if(vlanArg2 is not None):
|
||||
value = cnos.checkSanityofVariable(
|
||||
deviceType, "vlan_filter_name", vlanArg2)
|
||||
if(value == "ok"):
|
||||
command = command + vlanArg2 + " vlan-list "
|
||||
value = cnos.checkSanityofVariable(deviceType, "vlan_id",
|
||||
vlanArg3)
|
||||
if(value == "ok"):
|
||||
command = command + vlanArg3
|
||||
else:
|
||||
value = cnos.checkSanityofVariable(
|
||||
deviceType, "vlan_id_range", vlanArg3)
|
||||
if(value == "ok"):
|
||||
command = command + vlanArg3
|
||||
else:
|
||||
retVal = "Error-133"
|
||||
return retVal
|
||||
else:
|
||||
retVal = "Error-132"
|
||||
return retVal
|
||||
def check_declarative_intent_params(want, module, result):
|
||||
|
||||
else:
|
||||
value = cnos.checkSanityofVariable(deviceType, "vlan_id", vlanArg1)
|
||||
if(value == "ok"):
|
||||
retVal = createVlan(module, '(config-vlan)#', None)
|
||||
return retVal
|
||||
else:
|
||||
value = cnos.checkSanityofVariable(
|
||||
deviceType, "vlan_id_range", vlanArg1)
|
||||
if(value == "ok"):
|
||||
retVal = createVlan(module, '(config-vlan)#', None)
|
||||
return retVal
|
||||
retVal = "Error-133"
|
||||
return retVal
|
||||
have = None
|
||||
is_delay = False
|
||||
|
||||
# debugOutput(command)
|
||||
cmd = [{'command': command, 'prompt': None, 'answer': None}]
|
||||
retVal = retVal + str(cnos.run_cnos_commands(module, cmd))
|
||||
return retVal
|
||||
# EOM
|
||||
for w in want:
|
||||
if w.get('associated_interfaces') is None:
|
||||
continue
|
||||
|
||||
if result['changed'] and not is_delay:
|
||||
time.sleep(module.params['delay'])
|
||||
is_delay = True
|
||||
|
||||
if have is None:
|
||||
have = map_config_to_obj(module)
|
||||
|
||||
for i in w['associated_interfaces']:
|
||||
obj_in_have = search_obj_in_list(w['vlan_id'], have)
|
||||
if obj_in_have and 'interfaces' in obj_in_have and i not in obj_in_have['interfaces']:
|
||||
module.fail_json(msg="Interface %s not configured on vlan %s" % (i, w['vlan_id']))
|
||||
|
||||
|
||||
def main():
|
||||
#
|
||||
# Define parameters for vlan creation entry
|
||||
#
|
||||
module = AnsibleModule(
|
||||
argument_spec=dict(
|
||||
outputfile=dict(required=True),
|
||||
host=dict(required=False),
|
||||
username=dict(required=False),
|
||||
password=dict(required=False, no_log=True),
|
||||
enablePassword=dict(required=False, no_log=True),
|
||||
deviceType=dict(required=True),
|
||||
vlanArg1=dict(required=True),
|
||||
vlanArg2=dict(required=False),
|
||||
vlanArg3=dict(required=False),
|
||||
vlanArg4=dict(required=False),
|
||||
vlanArg5=dict(required=False),),
|
||||
supports_check_mode=False)
|
||||
""" main entry point for module execution
|
||||
"""
|
||||
element_spec = dict(
|
||||
vlan_id=dict(type='int'),
|
||||
name=dict(),
|
||||
interfaces=dict(type='list'),
|
||||
associated_interfaces=dict(type='list'),
|
||||
delay=dict(default=10, type='int'),
|
||||
state=dict(default='present',
|
||||
choices=['present', 'absent', 'active', 'suspend'])
|
||||
)
|
||||
|
||||
outputfile = module.params['outputfile']
|
||||
aggregate_spec = deepcopy(element_spec)
|
||||
aggregate_spec['vlan_id'] = dict(required=True)
|
||||
|
||||
output = ""
|
||||
# remove default in aggregate spec, to handle common arguments
|
||||
remove_default_spec(aggregate_spec)
|
||||
|
||||
# Send the CLi command
|
||||
output = output + str(vlanConfig(module, "(config)#", None))
|
||||
argument_spec = dict(
|
||||
aggregate=dict(type='list', elements='dict', options=aggregate_spec),
|
||||
purge=dict(default=False, type='bool')
|
||||
)
|
||||
|
||||
# Save it operation details into the file
|
||||
file = open(outputfile, "a")
|
||||
file.write(output)
|
||||
file.close()
|
||||
argument_spec.update(element_spec)
|
||||
argument_spec.update(cnos_argument_spec)
|
||||
|
||||
# need to add logic to check when changes occur or not
|
||||
errorMsg = cnos.checkOutputForError(output)
|
||||
if(errorMsg is None):
|
||||
module.exit_json(changed=True,
|
||||
msg="VLAN configuration is accomplished")
|
||||
else:
|
||||
module.fail_json(msg=errorMsg)
|
||||
required_one_of = [['vlan_id', 'aggregate']]
|
||||
mutually_exclusive = [['vlan_id', 'aggregate']]
|
||||
|
||||
module = AnsibleModule(argument_spec=argument_spec,
|
||||
required_one_of=required_one_of,
|
||||
mutually_exclusive=mutually_exclusive,
|
||||
supports_check_mode=True)
|
||||
warnings = list()
|
||||
result = {'changed': False}
|
||||
if warnings:
|
||||
result['warnings'] = warnings
|
||||
|
||||
want = map_params_to_obj(module)
|
||||
have = map_config_to_obj(module)
|
||||
commands = map_obj_to_commands((want, have), module)
|
||||
result['commands'] = commands
|
||||
|
||||
if commands:
|
||||
if not module.check_mode:
|
||||
load_config(module, commands)
|
||||
result['changed'] = True
|
||||
|
||||
check_declarative_intent_params(want, module, result)
|
||||
|
||||
module.exit_json(**result)
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue