Adding nxos_ospf_vrf module

network/nxos/nxos_ospf_vrf.py

@@ -0,0 +1,855 @@
+#!/usr/bin/python
+#
+# This file is part of Ansible
+#
+# Ansible is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Ansible is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Ansible.  If not, see <http://www.gnu.org/licenses/>.
+#
+
+DOCUMENTATION = '''
+---
+module: nxos_ospf_vrf
+version_added: "2.2"
+short_description: Manages a VRF for an OSPF router.
+description:
+    - Manages a VRF for an OSPF router.
+author: Gabriele Gerbino (@GGabriele)
+extends_documentation_fragment: nxos
+notes:
+    - 'default' restores params default value, if any. Otherwise it removes
+      the existing param configuration.
+options:
+    vrf:
+        description:
+            - Name of the resource instance. Valid value is a string.
+              The name 'default' is a valid VRF representing the global OSPF.
+        required: false
+        default: default
+    ospf:
+        description:
+            - Name of the OSPF instance.
+        required: true
+        default: null
+    router_id:
+        description:
+            - Router Identifier (ID) of the OSPF router VRF instance.
+        required: false
+        default: null
+    default_metric:
+        description:
+            - Specify the default Metric value. Valid values are an integer
+              or the keyword 'default'.
+        required: false
+        default: null
+    log_adjacency:
+        description:
+            - Controls the level of log messages generated whenever a
+              neighbor changes state. Valid values are 'log', 'detail',
+              and 'default'.
+        required: false
+        choices: ['log','detail','default']
+        default: null
+    timer_throttle_lsa_start:
+        description:
+            - Specify the start interval for rate-limiting Link-State
+              Advertisement (LSA) generation. Valid values are an integer,
+              in milliseconds, or the keyword 'default'.
+        required: false
+        default: null
+    timer_throttle_lsa_hold:
+        description:
+            - Specify the hold interval for rate-limiting Link-State
+              Advertisement (LSA) generation. Valid values are an integer,
+              in milliseconds, or the keyword 'default'.
+        required: false
+        default: null
+    timer_throttle_lsa_max:
+        description:
+            - Specify the max interval for rate-limiting Link-State
+              Advertisement (LSA) generation. Valid values are an integer,
+              in milliseconds, or the keyword 'default'.
+        required: false
+        default: null
+    timer_throttle_spf_start:
+        description:
+            - Specify initial Shortest Path First (SPF) schedule delay.
+              Valid values are an integer, in milliseconds, or
+              the keyword 'default'.
+        required: false
+        default: null
+    timer_throttle_spf_hold:
+        description:
+            - Specify minimum hold time between Shortest Path First (SPF)
+              calculations. Valid values are an integer, in milliseconds,
+              or the keyword 'default'.
+        required: false
+        default: null
+    timer_throttle_spf_max:
+        description:
+            - Specify the maximum wait time between Shortest Path First (SPF)
+              calculations. Valid values are an integer, in milliseconds,
+              or the keyword 'default'.
+        required: false
+        default: null
+    auto_cost:
+        description:
+            - Specifies the reference bandwidth used to assign OSPF cost.
+              Valid values are an integer, in Mbps, or the keyword 'default'.
+        required: false
+        default: null
+    m_facts:
+        description:
+            - Used to print module facts
+        required: false
+        default: false
+        choices: ['true','false']
+'''
+
+EXAMPLES = '''
+- nxos_ospf_vrf:
+    ospf: 1
+    timer_throttle_spf_start: 50
+    timer_throttle_spf_hold: 1000
+    timer_throttle_spf_max: 2000
+    timer_throttle_lsa_start: 60
+    timer_throttle_lsa_hold: 1100
+    timer_throttle_lsa_max: 3000
+    vrf: test
+    m_facts: true
+    state: present
+    username: "{{ un }}"
+    password: "{{ pwd }}"
+    host: "{{ inventory_hostname }}"
+'''
+
+RETURN = '''
+proposed:
+    description: k/v pairs of parameters passed into module
+    returned: when I(m_facts)=true
+    type: dict
+    sample: {"ospf": "1", "timer_throttle_lsa_hold": "1100",
+            "timer_throttle_lsa_max": "3000", "timer_throttle_lsa_start": "60",
+            "timer_throttle_spf_hold": "1000",
+            "timer_throttle_spf_max": "2000", "timer_throttle_spf_start": "50",
+            "vrf": "test"}
+existing:
+    description: k/v pairs of existing configuration
+    returned: when I(m_facts)=true
+    type: dict
+    sample: {"auto_cost": "40000", "default_metric": "", "log_adjacency": "",
+            "ospf": "1", "router_id": "", "timer_throttle_lsa_hold": "5000",
+            "timer_throttle_lsa_max": "5000", "timer_throttle_lsa_start": "0",
+            "timer_throttle_spf_hold": "1000",
+            "timer_throttle_spf_max": "5000",
+            "timer_throttle_spf_start": "200", "vrf": "test"}
+end_state:
+    description: k/v pairs of configuration after module execution
+    returned: when I(m_facts)=true
+    type: dict
+    sample: {"auto_cost": "40000", "default_metric": "", "log_adjacency": "",
+            "ospf": "1", "router_id": "", "timer_throttle_lsa_hold": "1100",
+            "timer_throttle_lsa_max": "3000", "timer_throttle_lsa_start": "60",
+            "timer_throttle_spf_hold": "1000",
+            "timer_throttle_spf_max": "2000", "timer_throttle_spf_start": "50",
+            "vrf": "test"}
+updates:
+    description: commands sent to the device
+    returned: always
+    type: list
+    sample: ["router ospf 1", "vrf test", "timers throttle lsa 60 1100 3000",
+             "timers throttle spf 50 1000 2000"]
+changed:
+    description: check to see if a change was made on the device
+    returned: always
+    type: boolean
+    sample: true
+'''
+
+# COMMON CODE FOR MIGRATION
+
+import re
+import time
+import collections
+import itertools
+import shlex
+import itertools
+
+from ansible.module_utils.basic import BOOLEANS_TRUE, BOOLEANS_FALSE
+
+DEFAULT_COMMENT_TOKENS = ['#', '!']
+
+class ConfigLine(object):
+
+    def __init__(self, text):
+        self.text = text
+        self.children = list()
+        self.parents = list()
+        self.raw = None
+
+    @property
+    def line(self):
+        line = ['set']
+        line.extend([p.text for p in self.parents])
+        line.append(self.text)
+        return ' '.join(line)
+
+    def __str__(self):
+        return self.raw
+
+    def __eq__(self, other):
+        if self.text == other.text:
+            return self.parents == other.parents
+
+    def __ne__(self, other):
+        return not self.__eq__(other)
+
+def ignore_line(text, tokens=None):
+    for item in (tokens or DEFAULT_COMMENT_TOKENS):
+        if text.startswith(item):
+            return True
+
+def get_next(iterable):
+    item, next_item = itertools.tee(iterable, 2)
+    next_item = itertools.islice(next_item, 1, None)
+    return itertools.izip_longest(item, next_item)
+
+def parse(lines, indent, comment_tokens=None):
+    toplevel = re.compile(r'\S')
+    childline = re.compile(r'^\s*(.+)$')
+
+    ancestors = list()
+    config = list()
+
+    for line in str(lines).split('\n'):
+        text = str(re.sub(r'([{};])', '', line)).strip()
+
+        cfg = ConfigLine(text)
+        cfg.raw = line
+
+        if not text or ignore_line(text, comment_tokens):
+            continue
+
+        # handle top level commands
+        if toplevel.match(line):
+            ancestors = [cfg]
+
+        # handle sub level commands
+        else:
+            match = childline.match(line)
+            line_indent = match.start(1)
+            level = int(line_indent / indent)
+            parent_level = level - 1
+
+            cfg.parents = ancestors[:level]
+
+            if level > len(ancestors):
+                config.append(cfg)
+                continue
+
+            for i in range(level, len(ancestors)):
+                ancestors.pop()
+
+            ancestors.append(cfg)
+            ancestors[parent_level].children.append(cfg)
+
+        config.append(cfg)
+
+    return config
+
+
+class CustomNetworkConfig(object):
+
+    def __init__(self, indent=None, contents=None, device_os=None):
+        self.indent = indent or 1
+        self._config = list()
+        self._device_os = device_os
+
+        if contents:
+            self.load(contents)
+
+    @property
+    def items(self):
+        return self._config
+
+    @property
+    def lines(self):
+        lines = list()
+        for item, next_item in get_next(self.items):
+            if next_item is None:
+                lines.append(item.line)
+            elif not next_item.line.startswith(item.line):
+                lines.append(item.line)
+        return lines
+
+    def __str__(self):
+        text = ''
+        for item in self.items:
+            if not item.parents:
+                expand = self.get_section(item.text)
+                text += '%s\n' % self.get_section(item.text)
+        return str(text).strip()
+
+    def load(self, contents):
+        self._config = parse(contents, indent=self.indent)
+
+    def load_from_file(self, filename):
+        self.load(open(filename).read())
+
+    def get(self, path):
+        if isinstance(path, basestring):
+            path = [path]
+        for item in self._config:
+            if item.text == path[-1]:
+                parents = [p.text for p in item.parents]
+                if parents == path[:-1]:
+                    return item
+
+    def search(self, regexp, path=None):
+        regex = re.compile(r'^%s' % regexp, re.M)
+
+        if path:
+            parent = self.get(path)
+            if not parent or not parent.children:
+                return
+            children = [c.text for c in parent.children]
+            data = '\n'.join(children)
+        else:
+            data = str(self)
+
+        match = regex.search(data)
+        if match:
+            if match.groups():
+                values = match.groupdict().values()
+                groups = list(set(match.groups()).difference(values))
+                return (groups, match.groupdict())
+            else:
+                return match.group()
+
+    def findall(self, regexp):
+        regexp = r'%s' % regexp
+        return re.findall(regexp, str(self))
+
+    def expand(self, obj, items):
+        block = [item.raw for item in obj.parents]
+        block.append(obj.raw)
+
+        current_level = items
+        for b in block:
+            if b not in current_level:
+                current_level[b] = collections.OrderedDict()
+            current_level = current_level[b]
+        for c in obj.children:
+            if c.raw not in current_level:
+                current_level[c.raw] = collections.OrderedDict()
+
+    def to_lines(self, section):
+        lines = list()
+        for entry in section[1:]:
+            line = ['set']
+            line.extend([p.text for p in entry.parents])
+            line.append(entry.text)
+            lines.append(' '.join(line))
+        return lines
+
+    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)
+            if self._device_os == 'junos':
+                return self.to_lines(section)
+            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 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 flatten(self, data, obj=None):
+        if obj is None:
+            obj = list()
+        for k, v in data.items():
+            obj.append(k)
+            self.flatten(v, obj)
+        return obj
+
+    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 get_children(self, path):
+        obj = self.get_object(path)
+        if obj:
+            return obj.children
+
+    def difference(self, other, path=None, match='line', replace='line'):
+        updates = list()
+
+        config = self.items
+        if path:
+            config = self.get_children(path) or list()
+
+        if match == 'line':
+            for item in config:
+                if item not in other.items:
+                    updates.append(item)
+
+        elif match == 'strict':
+            if path:
+                current = other.get_children(path) or list()
+            else:
+                current = other.items
+
+            for index, item in enumerate(config):
+                try:
+                    if item != current[index]:
+                        updates.append(item)
+                except IndexError:
+                    updates.append(item)
+
+        elif match == 'exact':
+            if path:
+                current = other.get_children(path) or list()
+            else:
+                current = other.items
+
+            if len(current) != len(config):
+                updates.extend(config)
+            else:
+                for ours, theirs in itertools.izip(config, current):
+                    if ours != theirs:
+                        updates.extend(config)
+                        break
+
+        if self._device_os == 'junos':
+            return updates
+
+        diffs = collections.OrderedDict()
+        for update in updates:
+            if replace == 'block' and update.parents:
+                update = update.parents[-1]
+            self.expand(update, diffs)
+
+        return self.flatten(diffs)
+
+    def replace(self, replace, text=None, regex=None, parents=None,
+            add_if_missing=False, ignore_whitespace=False):
+        match = None
+
+        parents = parents or list()
+        if text is None and regex is None:
+            raise ValueError('missing required arguments')
+
+        if not regex:
+            regex = ['^%s$' % text]
+
+        patterns = [re.compile(r, re.I) for r in to_list(regex)]
+
+        for item in self.items:
+            for regexp in patterns:
+                if ignore_whitespace is True:
+                    string = item.text
+                else:
+                    string = item.raw
+                if regexp.search(item.text):
+                    if item.text != replace:
+                        if parents == [p.text for p in item.parents]:
+                            match = item
+                            break
+
+        if match:
+            match.text = replace
+            indent = len(match.raw) - len(match.raw.lstrip())
+            match.raw = replace.rjust(len(replace) + indent)
+
+        elif add_if_missing:
+            self.add(replace, parents=parents)
+
+
+    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 argument_spec():
+    return dict(
+        # config options
+        running_config=dict(aliases=['config']),
+        save_config=dict(type='bool', default=False, aliases=['save'])
+    )
+nxos_argument_spec = argument_spec()
+
+def get_config(module):
+    config = module.params['running_config']
+    if not config:
+        config = module.get_config()
+    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_config']
+
+    result = dict(changed=False)
+
+    if commands:
+        if not module.check_mode:
+            module.configure(commands)
+            if save_config:
+                module.config.save_config()
+
+        result['changed'] = True
+        result['updates'] = commands
+
+    return result
+# END OF COMMON CODE
+
+PARAM_TO_COMMAND_KEYMAP = {
+    'router_id': 'router-id',
+    'default_metric': 'default-metric',
+    'log_adjacency': 'log-adjacency-changes',
+    'timer_throttle_lsa_start': 'timers throttle lsa',
+    'timer_throttle_lsa_max': 'timers throttle lsa',
+    'timer_throttle_lsa_hold': 'timers throttle lsa',
+    'timer_throttle_spf_max': 'timers throttle spf',
+    'timer_throttle_spf_start': 'timers throttle spf',
+    'timer_throttle_spf_hold': 'timers throttle spf',
+    'auto_cost': 'auto-cost reference-bandwidth'
+}
+PARAM_TO_DEFAULT_KEYMAP = {
+    'timer_throttle_lsa_start': '0',
+    'timer_throttle_lsa_max': '5000',
+    'timer_throttle_lsa_hold': '5000',
+    'timer_throttle_spf_start': '200',
+    'timer_throttle_spf_max': '5000',
+    'timer_throttle_spf_hold': '1000',
+    'auto_cost': '40000'
+}
+
+
+def invoke(name, *args, **kwargs):
+    func = globals().get(name)
+    if func:
+        return func(*args, **kwargs)
+
+
+def get_value(arg, config, module):
+    REGEX = re.compile(r'(?:{0}\s)(?P<value>.*)$'.format(PARAM_TO_COMMAND_KEYMAP[arg]), re.M)
+    value = ''
+
+    if PARAM_TO_COMMAND_KEYMAP[arg] in config:
+        if arg == 'log_adjacency':
+            if 'log-adjacency-changes detail' in config:
+                value = 'detail'
+            else:
+                value = 'log'
+        else:
+            value_list = REGEX.search(config).group('value').split()
+            if 'hold' in arg:
+                value = value_list[1]
+            elif 'max' in arg:
+                value = value_list[2]
+            elif 'auto' in arg:
+                if 'Gbps' in value_list:
+                    value = str(int(value_list[0]) * 1000)
+                else:
+                    value = value_list[0]
+            else:
+                value = value_list[0]
+    return value
+
+
+def get_existing(module, args):
+    existing = {}
+    netcfg = get_config(module)
+    parents = ['router ospf {0}'.format(module.params['ospf'])]
+
+    if module.params['vrf'] != 'default':
+        parents.append('vrf {0}'.format(module.params['vrf']))
+
+    config = netcfg.get_section(parents)
+    if config:
+        if module.params['vrf'] == 'default':
+            splitted_config = config.splitlines()
+            vrf_index = False
+            for index in range(0, len(splitted_config) - 1):
+                if 'vrf' in splitted_config[index].strip():
+                        vrf_index = index
+                        break
+            if vrf_index:
+                config = '\n'.join(splitted_config[0:vrf_index])
+
+        for arg in args:
+            if arg not in ['ospf', 'vrf']:
+                existing[arg] = get_value(arg, config, module)
+
+        existing['vrf'] = module.params['vrf']
+        existing['ospf'] = module.params['ospf']
+
+    return existing
+
+
+def apply_key_map(key_map, table):
+    new_dict = {}
+    for key, value in table.items():
+        new_key = key_map.get(key)
+        if new_key:
+            value = table.get(key)
+            if value:
+                new_dict[new_key] = value
+            else:
+                new_dict[new_key] = value
+    return new_dict
+
+
+def state_present(module, existing, proposed, candidate):
+    commands = list()
+    proposed_commands = apply_key_map(PARAM_TO_COMMAND_KEYMAP, proposed)
+    existing_commands = apply_key_map(PARAM_TO_COMMAND_KEYMAP, existing)
+
+    for key, value in proposed_commands.iteritems():
+        if value is True:
+            commands.append(key)
+
+        elif value is False:
+            commands.append('no {0}'.format(key))
+
+        elif value == 'default':
+            if existing_commands.get(key):
+                existing_value = existing_commands.get(key)
+                commands.append('no {0} {1}'.format(key, existing_value))
+        else:
+            if key == 'timers throttle lsa':
+                command = '{0} {1} {2} {3}'.format(
+                                        key,
+                                        proposed['timer_throttle_lsa_start'],
+                                        proposed['timer_throttle_lsa_hold'],
+                                        proposed['timer_throttle_lsa_max'])
+            elif key == 'timers throttle spf':
+                command = '{0} {1} {2} {3}'.format(
+                                        key,
+                                        proposed['timer_throttle_spf_start'],
+                                        proposed['timer_throttle_spf_hold'],
+                                        proposed['timer_throttle_spf_max'])
+            elif key == 'log-adjacency-changes':
+                if value == 'log':
+                    command = key
+                elif value == 'detail':
+                    command = '{0} {1}'.format(key, value)
+            elif key == 'auto-cost reference-bandwidth':
+                if len(value) < 5:
+                    command = '{0} {1} Mbps'.format(key, value)
+                else:
+                    value = str(int(value) / 1000)
+                    command = '{0} {1} Gbps'.format(key, value)
+            else:
+                command = '{0} {1}'.format(key, value.lower())
+
+            if command not in commands:
+                commands.append(command)
+
+    if commands:
+        parents = ['router ospf {0}'.format(module.params['ospf'])]
+        if module.params['vrf'] != 'default':
+            parents.append('vrf {0}'.format(module.params['vrf']))
+
+        candidate.add(commands, parents=parents)
+
+
+def state_absent(module, existing, proposed, candidate):
+    commands = []
+    parents = ['router ospf {0}'.format(module.params['ospf'])]
+    if module.params['vrf'] == 'default':
+        existing_commands = apply_key_map(PARAM_TO_COMMAND_KEYMAP, existing)
+        for key, value in existing_commands.iteritems():
+            if value:
+                if key == 'timers throttle lsa':
+                    command = 'no {0} {1} {2} {3}'.format(
+                                        key,
+                                        existing['timer_throttle_lsa_start'],
+                                        existing['timer_throttle_lsa_hold'],
+                                        existing['timer_throttle_lsa_max'])
+                elif key == 'timers throttle spf':
+                    command = 'no {0} {1} {2} {3}'.format(
+                                        key,
+                                        existing['timer_throttle_spf_start'],
+                                        existing['timer_throttle_spf_hold'],
+                                        existing['timer_throttle_spf_max'])
+                else:
+                    existing_value = existing_commands.get(key)
+                    command = 'no {0} {1}'.format(key, existing_value)
+
+                if command not in commands:
+                    commands.append(command)
+    else:
+        commands = ['no vrf {0}'.format(module.params['vrf'])]
+    candidate.add(commands, parents=parents)
+
+
+def main():
+    argument_spec = dict(
+            vrf=dict(required=False, type='str', default='default'),
+            ospf=dict(required=True, type='str'),
+            router_id=dict(required=False, type='str'),
+            default_metric=dict(required=False, type='str'),
+            log_adjacency=dict(required=False, type='str',
+                               choices=['log', 'detail', 'default']),
+            timer_throttle_lsa_start=dict(required=False, type='str'),
+            timer_throttle_lsa_hold=dict(required=False, type='str'),
+            timer_throttle_lsa_max=dict(required=False, type='str'),
+            timer_throttle_spf_start=dict(required=False, type='str'),
+            timer_throttle_spf_hold=dict(required=False, type='str'),
+            timer_throttle_spf_max=dict(required=False, type='str'),
+            auto_cost=dict(required=False, type='str'),
+            m_facts=dict(required=False, default=False, type='bool'),
+            state=dict(choices=['present', 'absent'], default='present',
+                       required=False),
+            include_defaults=dict(default=True)
+    )
+    argument_spec.update(nxos_argument_spec)
+    module = get_module(argument_spec=argument_spec,
+                        supports_check_mode=True)
+
+    state = module.params['state']
+    args =  [
+            'vrf',
+            'ospf',
+            'router_id',
+            'default_metric',
+            'log_adjacency',
+            'timer_throttle_lsa_start',
+            'timer_throttle_lsa_hold',
+            'timer_throttle_lsa_max',
+            'timer_throttle_spf_start',
+            'timer_throttle_spf_hold',
+            'timer_throttle_spf_max',
+            'auto_cost'
+        ]
+
+    existing = invoke('get_existing', module, args)
+    end_state = existing
+    proposed_args = dict((k, v) for k, v in module.params.iteritems()
+                    if v is not None and k in args)
+
+    proposed = {}
+    for key, value in proposed_args.iteritems():
+        if key != 'interface':
+            if str(value).lower() == 'true':
+                value = True
+            elif str(value).lower() == 'false':
+                value = False
+            elif str(value).lower() == 'default':
+                value = PARAM_TO_DEFAULT_KEYMAP.get(key)
+                if value is None:
+                    value = 'default'
+            if existing.get(key) or (not existing.get(key) and value):
+                proposed[key] = value
+
+    result = {}
+    if state == 'present' or (state == 'absent' and existing):
+        candidate = CustomNetworkConfig(indent=3)
+        invoke('state_%s' % state, module, existing, proposed, candidate)
+
+        try:
+            response = load_config(module, candidate)
+            result.update(response)
+        except ShellError:
+            exc = get_exception()
+            module.fail_json(msg=str(exc))
+    else:
+        result['updates'] = []
+
+    result['connected'] = module.connected
+    if module.params['m_facts']:
+        end_state = invoke('get_existing', module, args)
+        result['end_state'] = end_state
+        result['existing'] = existing
+        result['proposed'] = proposed_args
+
+    module.exit_json(**result)
+
+
+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()