diff --git a/network/nxos/nxos_vlan.py b/network/nxos/nxos_vlan.py index 0c7db5d26e5..c7071c10918 100644 --- a/network/nxos/nxos_vlan.py +++ b/network/nxos/nxos_vlan.py @@ -20,9 +20,9 @@ DOCUMENTATION = ''' --- module: nxos_vlan version_added: "2.1" -short_description: Manages VLAN resources and attributes +short_description: Manages VLAN resources and attributes. description: - - Manages VLAN configurations on NX-OS switches + - Manages VLAN configurations on NX-OS switches. author: Jason Edelman (@jedelman8) extends_documentation_fragment: nxos options: @@ -33,28 +33,35 @@ options: default: null vlan_range: description: - - A range of VLANs such as I(2-10) or I(2,5,10-15) etc. + - Range of VLANs such as 2-10 or 2,5,10-15, etc. required: false default: null name: description: - - The name of VLAN. + - Name of VLAN. required: false default: null vlan_state: description: - - Manage the VLAN operational state of the VLAN + - Manage the vlan operational state of the VLAN (equivalent to state {active | suspend} command. required: false default: active choices: ['active','suspend'] admin_state: description: - - Manage the VLAN admin state of the VLAN equivalent + - Manage the VLAN administrative state of the VLAN equivalent to shut/no shut in VLAN config mode. required: false default: up choices: ['up','down'] + mapped_vni: + description: + - The Virtual Network Identifier (VNI) ID that is mapped to the + VLAN. Valid values are integer and keyword 'default'. + required: false + default: null + version_added: "2.2" state: description: - Manage the state of the resource. @@ -65,13 +72,13 @@ options: ''' EXAMPLES = ''' # Ensure a range of VLANs are not present on the switch -- nxos_vlan: vlan_range="2-10,20,50,55-60,100-150" host={{ inventory_hostname }} username=cisco password=cisco state=absent transport=nxapi +- nxos_vlan: vlan_range="2-10,20,50,55-60,100-150" host=68.170.147.165 username=cisco password=cisco state=absent transport=nxapi # Ensure VLAN 50 exists with the name WEB and is in the shutdown state -- nxos_vlan: vlan_id=50 host={{ inventory_hostname }} admin_state=down name=WEB transport=nxapi username=cisco password=cisco +- nxos_vlan: vlan_id=50 host=68.170.147.165 admin_state=down name=WEB transport=nxapi username=cisco password=cisco # Ensure VLAN is NOT on the device -- nxos_vlan: vlan_id=50 host={{ inventory_hostname }} state=absent transport=nxapi username=cisco password=cisco +- nxos_vlan: vlan_id=50 host=68.170.147.165 state=absent transport=nxapi username=cisco password=cisco ''' @@ -99,30 +106,25 @@ proposed: returned: always type: dict or null sample: {"admin_state": "down", "name": "app_vlan", - "vlan_state": "suspend"} + "vlan_state": "suspend", "mapped_vni": "5000"} existing: description: k/v pairs of existing vlan or null when using vlan_range returned: always type: dict sample: {"admin_state": "down", "name": "app_vlan", - "vlan_id": "20", "vlan_state": "suspend"} + "vlan_id": "20", "vlan_state": "suspend", "mapped_vni": ""} end_state: description: k/v pairs of the VLAN after executing module or null when using vlan_range returned: always type: dict or null sample: {"admin_state": "down", "name": "app_vlan", "vlan_id": "20", - "vlan_state": "suspend"} -state: - description: state as sent in from the playbook - returned: always - type: string - sample: "present" + "vlan_state": "suspend", "mapped_vni": "5000"} updates: description: command string sent to the device returned: always type: list - sample: ["vlan 20", "vlan 55"] + sample: ["vlan 20", "vlan 55", "vn-segment 5000"] changed: description: check to see if a change was made on the device returned: always @@ -131,6 +133,162 @@ changed: ''' +import json +import collections + +# COMMON CODE FOR MIGRATION +import re + +from ansible.module_utils.basic import get_exception +from ansible.module_utils.netcfg import NetworkConfig, ConfigLine +from ansible.module_utils.shell import ShellError + +try: + from ansible.module_utils.nxos import get_module +except ImportError: + from ansible.module_utils.nxos import NetworkModule + + +def to_list(val): + if isinstance(val, (list, tuple)): + return list(val) + elif val is not None: + return [val] + else: + return list() + + +class CustomNetworkConfig(NetworkConfig): + + def expand_section(self, configobj, S=None): + if S is None: + S = list() + S.append(configobj) + for child in configobj.children: + if child in S: + continue + self.expand_section(child, S) + return S + + def get_object(self, path): + for item in self.items: + if item.text == path[-1]: + parents = [p.text for p in item.parents] + if parents == path[:-1]: + return item + + def to_block(self, section): + return '\n'.join([item.raw for item in section]) + + def get_section(self, path): + try: + section = self.get_section_objects(path) + return self.to_block(section) + except ValueError: + return list() + + def get_section_objects(self, path): + if not isinstance(path, list): + path = [path] + obj = self.get_object(path) + if not obj: + raise ValueError('path does not exist in config') + return self.expand_section(obj) + + + def add(self, lines, parents=None): + """Adds one or lines of configuration + """ + + ancestors = list() + offset = 0 + obj = None + + ## global config command + if not parents: + for line in to_list(lines): + item = ConfigLine(line) + item.raw = line + if item not in self.items: + self.items.append(item) + + else: + for index, p in enumerate(parents): + try: + i = index + 1 + obj = self.get_section_objects(parents[:i])[0] + ancestors.append(obj) + + except ValueError: + # add parent to config + offset = index * self.indent + obj = ConfigLine(p) + obj.raw = p.rjust(len(p) + offset) + if ancestors: + obj.parents = list(ancestors) + ancestors[-1].children.append(obj) + self.items.append(obj) + ancestors.append(obj) + + # add child objects + for line in to_list(lines): + # check if child already exists + for child in ancestors[-1].children: + if child.text == line: + break + else: + offset = len(parents) * self.indent + item = ConfigLine(line) + item.raw = line.rjust(len(line) + offset) + item.parents = ancestors + ancestors[-1].children.append(item) + self.items.append(item) + + +def get_network_module(**kwargs): + try: + return get_module(**kwargs) + except NameError: + return NetworkModule(**kwargs) + +def get_config(module, include_defaults=False): + config = module.params['config'] + if not config: + try: + config = module.get_config() + except AttributeError: + defaults = module.params['include_defaults'] + config = module.config.get_config(include_defaults=defaults) + return CustomNetworkConfig(indent=2, contents=config) + +def load_config(module, candidate): + config = get_config(module) + + commands = candidate.difference(config) + commands = [str(c).strip() for c in commands] + + save_config = module.params['save'] + + result = dict(changed=False) + + if commands: + if not module.check_mode: + try: + module.configure(commands) + except AttributeError: + module.config(commands) + + if save_config: + try: + module.config.save_config() + except AttributeError: + module.execute(['copy running-config startup-config']) + + result['changed'] = True + result['updates'] = commands + + return result +# END OF COMMON CODE def vlan_range_to_list(vlans): result = [] @@ -196,13 +354,17 @@ def get_vlan_config_commands(vlan, vid): 'name': 'name {0}', 'vlan_state': 'state {0}', 'admin_state': '{0}', - 'mode': 'mode {0}' + 'mode': 'mode {0}', + 'mapped_vni': 'vn-segment {0}' } commands = [] for param, value in vlan.iteritems(): - command = VLAN_ARGS.get(param).format(vlan.get(param)) + if param == 'mapped_vni' and value == 'default': + command = 'no vn-segment' + else: + command = VLAN_ARGS.get(param).format(vlan.get(param)) if command: commands.append(command) @@ -213,7 +375,6 @@ def get_vlan_config_commands(vlan, vid): def get_list_of_vlans(module): - command = 'show vlan' body = execute_show_command(command, module) vlan_list = [] @@ -228,6 +389,17 @@ def get_list_of_vlans(module): return vlan_list +def get_vni(vlanid, module): + command = 'show run all | section vlan.{0}'.format(vlanid) + body = execute_show_command(command, module, command_type='cli_show_ascii')[0] + value = '' + if body: + REGEX = re.compile(r'(?:vn-segment\s)(?P.*)$', re.M) + if 'vn-segment' in body: + value = REGEX.search(body).group('value') + return value + + def get_vlan(vlanid, module): """Get instance of VLAN as a dictionary """ @@ -258,7 +430,7 @@ def get_vlan(vlanid, module): } vlan = apply_value_map(value_map, vlan) - + vlan['mapped_vni'] = get_vni(vlanid, module) return vlan @@ -293,7 +465,9 @@ def get_cli_body_ssh(command, response, module): if | json returns an XML string, it is a valid command, but that the resource doesn't exist yet. """ - if 'xml' in response[0]: + if 'show run' in command or response[0] == '\n': + body = response + elif 'xml' in response[0]: body = [] else: try: @@ -305,6 +479,11 @@ def get_cli_body_ssh(command, response, module): def execute_show(cmds, module, command_type=None): + command_type_map = { + 'cli_show': 'json', + 'cli_show_ascii': 'text' + } + try: if command_type: response = module.execute(cmds, command_type=command_type) @@ -312,15 +491,28 @@ def execute_show(cmds, module, command_type=None): response = module.execute(cmds) except ShellError: clie = get_exception() - module.fail_json(msg='Error sending {0}'.format(command), + module.fail_json(msg='Error sending {0}'.format(cmds), error=str(clie)) + except AttributeError: + try: + if command_type: + command_type = command_type_map.get(command_type) + module.cli.add_commands(cmds, output=command_type) + response = module.cli.run_commands() + else: + module.cli.add_commands(cmds, output=command_type) + response = module.cli.run_commands() + except ShellError: + clie = get_exception() + module.fail_json(msg='Error sending {0}'.format(cmds), + error=str(clie)) return response def execute_show_command(command, module, command_type='cli_show'): - if module.params['transport'] == 'cli': - command += ' | json' + if 'show run' not in command: + command += ' | json' cmds = [command] response = execute_show(cmds, module) body = get_cli_body_ssh(command, response, module) @@ -337,20 +529,25 @@ def main(): vlan_range=dict(required=False), name=dict(required=False), vlan_state=dict(choices=['active', 'suspend'], required=False), + mapped_vni=dict(required=False, type='str'), state=dict(choices=['present', 'absent'], default='present', required=False), admin_state=dict(choices=['up', 'down'], required=False), + include_defaults=dict(default=False), + config=dict(), + save=dict(type='bool', default=False) ) - module = get_module(argument_spec=argument_spec, - mutually_exclusive=[['vlan_range', 'name'], - ['vlan_id', 'vlan_range']], - supports_check_mode=True) + module = get_network_module(argument_spec=argument_spec, + mutually_exclusive=[['vlan_range', 'name'], + ['vlan_id', 'vlan_range']], + supports_check_mode=True) vlan_range = module.params['vlan_range'] vlan_id = module.params['vlan_id'] name = module.params['name'] vlan_state = module.params['vlan_state'] admin_state = module.params['admin_state'] + mapped_vni = module.params['mapped_vni'] state = module.params['state'] changed = False @@ -360,7 +557,7 @@ def main(): module.fail_json(msg='vlan_id must be a valid VLAN ID') args = dict(name=name, vlan_state=vlan_state, - admin_state=admin_state) + admin_state=admin_state, mapped_vni=mapped_vni) proposed = dict((k, v) for k, v in args.iteritems() if v is not None) @@ -390,6 +587,9 @@ def main(): if existing: commands = ['no vlan ' + vlan_id] elif state == 'present': + if (existing.get('mapped_vni') == '0' and + proposed.get('mapped_vni') == 'default'): + proposed.pop('mapped_vni') delta = dict(set( proposed.iteritems()).difference(existing.iteritems())) if delta or not existing: @@ -399,6 +599,10 @@ def main(): end_state_vlans_list = existing_vlans_list if commands: + if existing: + if (existing.get('mapped_vni') != proposed.get('mapped_vni') and + existing.get('mapped_vni') != '0' and proposed.get('mapped_vni') != 'default'): + commands.insert(1, 'no vn-segment') if module.check_mode: module.exit_json(changed=True, commands=commands) @@ -416,17 +620,11 @@ def main(): results['existing'] = existing results['end_state'] = end_state results['end_state_vlans_list'] = end_state_vlans_list - results['state'] = state results['updates'] = commands results['changed'] = changed module.exit_json(**results) -from ansible.module_utils.basic import * -from ansible.module_utils.urls import * -from ansible.module_utils.shell import * -from ansible.module_utils.netcfg import * -from ansible.module_utils.nxos import * if __name__ == '__main__': main()