Fixing nxos_interface

lib/ansible/modules/network/nxos/nxos_interface.py

@@ -18,12 +18,11 @@
 
 DOCUMENTATION = '''
 ---
-
 module: nxos_interface
 version_added: "2.1"
-short_description: Manages physical attributes of interfaces
+short_description: Manages physical attributes of interfaces.
 description:
-    - Manages physical attributes of interfaces of NX-OS switches
+    - Manages physical attributes of interfaces of NX-OS switches.
 author: Jason Edelman (@jedelman8)
 notes:
     - This module is also used to create logical interfaces such as
@@ -31,12 +30,21 @@ notes:
     - Be cautious of platform specific idiosyncrasies. For example,
       when you default a loopback interface, the admin state toggles
       on certain versions of NX-OS.
+    - The M(nxos_overlay_global) C(anycast_gateway_mac) attribute must be
+      set before setting the C(fabric_forwarding_anycast_gateway) property.
 options:
     interface:
         description:
             - Full name of interface, i.e. Ethernet1/1, port-channel10.
         required: true
         default: null
+    interface_type:
+        description:
+            - Interface type to be unconfigured from the device.
+        required: false
+        default: null
+        choices: ['loopback', 'portchannel', 'svi', 'nve']
+        version_added: "2.2"
     admin_state:
         description:
             - Administrative state of the interface.
@@ -50,10 +58,24 @@ options:
         default: null
     mode:
         description:
-            - Manage I(Layer2) or I(Layer3) state of the interface.
+            - Manage Layer 2 or Layer 3 state of the interface.
         required: false
         default: null
         choices: ['layer2','layer3']
+    ip_forward:
+        description:
+            - Enable/Disable ip forward feature on SVIs.
+        required: false
+        default: null
+        choices: ['enable','disable']
+        version_added: "2.2"
+    fabric_forwarding_anycast_gateway:
+        description:
+            - Associate SVI with anycast gateway under VLAN configuration mode.
+        required: false
+        default: null
+        choices: ['true','false']
+        version_added: "2.2"
     state:
         description:
             - Specify desired state of the resource.
@@ -64,30 +86,24 @@ options:
 
 EXAMPLES = '''
 # Ensure an interface is a Layer 3 port and that it has the proper description
-- nxos_interface: interface=Ethernet1/1 description='Configured by Ansible' mode=layer3 host={{ inventory_hostname }}
-
+- nxos_interface: interface=Ethernet1/1 description='Configured by Ansible' mode=layer3 host=68.170.147.165
 # Admin down an interface
-- nxos_interface: interface=Ethernet2/1 host={{ inventory_hostname }} admin_state=down
-
+- nxos_interface: interface=Ethernet2/1 host=68.170.147.165 admin_state=down
 # Remove all loopback interfaces
-- nxos_interface: interface=loopback state=absent host={{ inventory_hostname }}
-
+- nxos_interface: interface=loopback state=absent host=68.170.147.165
 # Remove all logical interfaces
-- nxos_interface: interface={{ item }} state=absent host={{ inventory_hostname }}
+- nxos_interface: interface_type={{ item }} state=absent host={{ inventory_hostname }}
   with_items:
     - loopback
     - portchannel
     - svi
-
+    - nve
 # Admin up all ethernet interfaces
-- nxos_interface: interface=ethernet host={{ inventory_hostname }} admin_state=up
-
+- nxos_interface: interface=ethernet host=68.170.147.165 admin_state=up
 # Admin down ALL interfaces (physical and logical)
-- nxos_interface: interface=all host={{ inventory_hostname }} admin_state=down
-
+- nxos_interface: interface=all host=68.170.147.165 admin_state=down
 '''
 RETURN = '''
-
 proposed:
     description: k/v pairs of parameters passed into module
     returned: always
@@ -96,17 +112,16 @@ proposed:
 existing:
     description: k/v pairs of existing switchport
     type: dict
-    sample:  {"admin_state": "up", "description": "None", "interface": "port-channel101", "mode": "layer2", "type": "portchannel"}
+    sample:  {"admin_state": "up", "description": "None",
+              "interface": "port-channel101", "mode": "layer2",
+              "type": "portchannel", "ip_forward": "enable"}
 end_state:
     description: k/v pairs of switchport after module execution
     returned: always
     type: dict or null
-    sample:  {"admin_state": "down", "description": "None", "interface": "port-channel101", "mode": "layer2", "type": "portchannel"}
-state:
-    description: state as sent in from the playbook
-    returned: always
-    type: string
-    sample: "present"
+    sample:  {"admin_state": "down", "description": "None",
+              "interface": "port-channel101", "mode": "layer2",
+              "type": "portchannel", "ip_forward": "enable"}
 updates:
     description: command list sent to the device
     returned: always
@@ -117,29 +132,184 @@ changed:
     returned: always
     type: boolean
     sample: true
-
 '''
 
+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
+
+BOOLEANS_TRUE = ['yes', 'on', '1', 'true', 'True', 1, True]
+BOOLEANS_FALSE = ['no', 'off', '0', 'false', 'False', 0, False]
+ACCEPTED = BOOLEANS_TRUE + BOOLEANS_FALSE
 
 def is_default_interface(interface, module):
     """Checks to see if interface exists and if it is a default config
-
     Args:
         interface (str): full name of interface, i.e. vlan10,
             Ethernet1/1, loopback10
-
     Returns:
         True: if interface has default config
         False: if it does not have a default config
         DNE (str): if the interface does not exist - loopbacks, SVIs, etc.
-
     """
     command = 'show run interface ' + interface
 
     try:
         body = execute_show_command(command, module,
                                     command_type='cli_show_ascii')[0]
-        # module.exit_json(abcd='asdasdfasdf', body=body, c=command)
     except IndexError:
         body = []
 
@@ -159,15 +329,12 @@ def is_default_interface(interface, module):
 
 def get_interface_type(interface):
     """Gets the type of interface
-
     Args:
         interface (str): full name of interface, i.e. Ethernet1/1, loopback10,
             port-channel20, vlan20
-
     Returns:
         type of interface: ethernet, svi, loopback, management, portchannel,
          or unknown
-
     """
     if interface.upper().startswith('ET'):
         return 'ethernet'
@@ -181,20 +348,19 @@ def get_interface_type(interface):
         return 'management'
     elif interface.upper().startswith('PO'):
         return 'portchannel'
+    elif interface.upper().startswith('NV'):
+        return 'nve'
     else:
         return 'unknown'
 
 
 def get_manual_interface_attributes(interface, module):
     """Gets admin state and description of a SVI interface. Hack due to API.
-
     Args:
         interface (str): full name of SVI interface, i.e. vlan10
-
     Returns:
         dictionary that has two k/v pairs: admin_state & description
             if not an svi, returns None
-
     """
 
     if get_interface_type(interface) == 'svi':
@@ -221,15 +387,12 @@ def get_manual_interface_attributes(interface, module):
 
 def get_interface(intf, module):
     """Gets current config/state of interface
-
     Args:
         intf (string): full name of interface, i.e. Ethernet1/1, loopback10,
             port-channel20, vlan20
-
     Returns:
       dictionary that has relevant config/state data about the given
           interface based on the type of interface it is
-
     """
     base_key_map = {
         'interface': 'interface',
@@ -266,7 +429,6 @@ def get_interface(intf, module):
 
     if body:
         interface_table = body['TABLE_interface']['ROW_interface']
-
         intf_type = get_interface_type(intf)
         if intf_type in ['portchannel', 'ethernet']:
             if not interface_table.get('eth_mode'):
@@ -288,6 +450,18 @@ def get_interface(intf, module):
                                                           'nxapibug'))
             interface['description'] = str(attributes.get('description',
                                                           'nxapi_bug'))
+            command = 'show run interface ' + intf
+            body = execute_show_command(command, module,
+                                        command_type='cli_show_ascii')[0]
+            if 'ip forward' in body:
+                interface['ip_forward'] = 'enable'
+            else:
+                interface['ip_forward'] = 'disable'
+            if 'fabric forwarding mode anycast-gateway' in body:
+                interface['fabric_forwarding_anycast_gateway'] = True
+            else:
+                interface['fabric_forwarding_anycast_gateway'] = False
+
         elif intf_type == 'loopback':
             key_map.update(base_key_map)
             key_map.pop('admin_state')
@@ -311,6 +485,13 @@ def get_interface(intf, module):
                 temp_dict['description'] = "None"
             interface.update(temp_dict)
 
+        elif intf_type == 'nve':
+            key_map.update(base_key_map)
+            temp_dict = apply_key_map(key_map, interface_table)
+            if not temp_dict.get('description'):
+                temp_dict['description'] = "None"
+            interface.update(temp_dict)
+
     interface['type'] = intf_type
 
     return interface
@@ -323,18 +504,18 @@ def get_intf_args(interface):
 
     if intf_type in ['ethernet', 'portchannel']:
         arguments.extend(['mode'])
+    if intf_type == 'svi':
+        arguments.extend(['ip_forward', 'fabric_forwarding_anycast_gateway'])
 
     return arguments
 
 
 def get_interfaces_dict(module):
     """Gets all active interfaces on a given switch
-
     Returns:
         dictionary with interface type (ethernet,svi,loop,portchannel) as the
             keys.  Each value is a list of interfaces of given interface (key)
             type.
-
     """
     command = 'show interface status'
     try:
@@ -348,12 +529,13 @@ def get_interfaces_dict(module):
         'loopback': [],
         'management': [],
         'portchannel': [],
+        'nve': [],
         'unknown': []
         }
 
     interface_list = body.get('TABLE_interface')['ROW_interface']
-    for i in interface_list:
-        intf = i['interface']
+    for index  in interface_list:
+        intf = index ['interface']
         intf_type = get_interface_type(intf)
 
         interfaces[intf_type].append(intf)
@@ -379,6 +561,8 @@ def normalize_interface(if_name):
         if_type = 'loopback'
     elif if_name.lower().startswith('po'):
         if_type = 'port-channel'
+    elif if_name.lower().startswith('nv'):
+        if_type = 'nve'
     else:
         if_type = None
 
@@ -417,19 +601,15 @@ def apply_value_map(value_map, resource):
 
 def get_interface_config_commands(interface, intf, existing):
     """Generates list of commands to configure on device
-
     Args:
         interface (str): k/v pairs in the form of a set that should
             be configured on the device
         intf (str): full name of interface, i.e. Ethernet1/1
-
     Returns:
       list: ordered list of commands to be sent to device
-
     """
 
     commands = []
-
     desc = interface.get('description')
     if desc:
         commands.append('description {0}'.format(desc))
@@ -447,6 +627,21 @@ def get_interface_config_commands(interface, intf, existing):
         command = get_admin_state(interface, intf, admin_state)
         commands.append(command)
 
+    ip_forward = interface.get('ip_forward')
+    if ip_forward:
+        if ip_forward == 'enable':
+            commands.append('ip forward')
+        else:
+            commands.append('no ip forward')
+
+    fabric_forwarding_anycast_gateway = interface.get(
+                                    'fabric_forwarding_anycast_gateway')
+    if fabric_forwarding_anycast_gateway is not None:
+        if fabric_forwarding_anycast_gateway is True:
+            commands.append('fabric forwarding mode anycast-gateway')
+        elif fabric_forwarding_anycast_gateway is False:
+            commands.append('no fabric forwarding mode anycast-gateway')
+
     if commands:
         commands.insert(0, 'interface ' + intf)
 
@@ -471,7 +666,7 @@ def get_proposed(existing, normalized_interface, args):
     # retrieves proper interface params from args (user defined params)
     for param in allowed_params:
         temp = args.get(param)
-        if temp:
+        if temp is not None:
             proposed[param] = temp
 
     return proposed
@@ -489,7 +684,7 @@ def smart_existing(module, intf_type, normalized_interface):
         if intf_type == 'ethernet':
             module.fail_json(msg='Invalid Ethernet interface provided.',
                              interface=normalized_interface)
-        elif intf_type in ['loopback', 'portchannel', 'svi']:
+        elif intf_type in ['loopback', 'portchannel', 'svi', 'nve']:
             existing = {}
             is_default = 'DNE'
     return existing, is_default
@@ -525,6 +720,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)
@@ -532,7 +732,20 @@ 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
 
@@ -553,7 +766,10 @@ def execute_show_command(command, module, command_type='cli_show'):
 
 def execute_modified_show_for_cli_text(command, module):
     cmds = [command]
+    if module.params['transport'] == 'cli':
         response = execute_show(cmds, module)
+    else:
+        response = execute_show(cmds, module, command_type='cli_show_ascii')
     body = response
     return body
 
@@ -568,37 +784,69 @@ def flatten_list(command_lists):
     return flat_command_list
 
 
+def get_interface_type_removed_cmds(interfaces):
+    commands = []
+
+    for interface in interfaces:
+        if interface != 'Vlan1':
+            commands.append('no interface {0}'.format(interface))
+
+    return commands
+
+
 def main():
 
     argument_spec = dict(
-        interface=dict(required=True,),
+        interface=dict(required=False,),
         admin_state=dict(default='up', choices=['up', 'down'], required=False),
         description=dict(required=False, default=None),
         mode=dict(choices=['layer2', 'layer3'], required=False),
+        interface_type=dict(required=False,
+                            choices=['loopback', 'portchannel', 'svi', 'nve']),
+        ip_forward=dict(required=False, choices=['enable', 'disable']),
+        fabric_forwarding_anycast_gateway=dict(required=False, type='bool',
+                                               choices=ACCEPTED),
         state=dict(choices=['absent', 'present', 'default'],
-                   default='present', required=False)
+                   default='present', required=False),
+        include_defaults=dict(default=True),
+        config=dict(),
+        save=dict(type='bool', default=False)
     )
-    module = get_module(argument_spec=argument_spec,
+    module = get_network_module(argument_spec=argument_spec,
+                                mutually_exclusive=[['interface', 'interface_type']],
                                 supports_check_mode=True)
 
-    interface = module.params['interface'].lower()
+    interface = module.params['interface']
+    interface_type = module.params['interface_type']
     admin_state = module.params['admin_state']
     description = module.params['description']
     mode = module.params['mode']
+    ip_forward = module.params['ip_forward']
+    fabric_forwarding_anycast_gateway = module.params['fabric_forwarding_anycast_gateway']
     state = module.params['state']
 
-    changed = False
-
-    args = dict(interface=interface, admin_state=admin_state,
-                description=description, mode=mode)
-
+    if interface:
+        interface = interface.lower()
         intf_type = get_interface_type(interface)
-
         normalized_interface = normalize_interface(interface)
 
         if normalized_interface == 'Vlan1' and state == 'absent':
             module.fail_json(msg='ERROR: CANNOT REMOVE VLAN 1!')
 
+        if intf_type == 'nve':
+            if description or mode:
+                module.fail_json(msg='description and mode params are not '
+                                     'supported in this module. Use '
+                                     'nxos_vxlan_vtep instead.')
+        if ((ip_forward or fabric_forwarding_anycast_gateway) and
+             intf_type != 'svi'):
+            module.fail_json(msg='The ip_forward and '
+                                 'fabric_forwarding_anycast_gateway features '
+                                 ' are only available for SVIs.')
+        args = dict(interface=interface, admin_state=admin_state,
+                    description=description, mode=mode, ip_forward=ip_forward,
+                    fabric_forwarding_anycast_gateway=fabric_forwarding_anycast_gateway)
+
         if intf_type == 'unknown':
             module.fail_json(
                 msg='unknown interface type found-1',
@@ -606,12 +854,17 @@ def main():
 
         existing, is_default = smart_existing(module, intf_type, normalized_interface)
         proposed = get_proposed(existing, normalized_interface, args)
+    else:
+        intf_type = normalized_interface = interface_type
+        proposed = dict(interface_type=interface_type)
 
-    delta = dict()
+    changed = False
     commands = []
+    if interface:
+        delta = dict()
 
         if state == 'absent':
-        if intf_type in ['svi', 'loopback', 'portchannel']:
+            if intf_type in ['svi', 'loopback', 'portchannel', 'nve']:
                 if is_default != 'DNE':
                     cmds = ['no interface {0}'.format(normalized_interface)]
                     commands.append(cmds)
@@ -640,9 +893,16 @@ def main():
             elif is_default == 'DNE':
                 module.exit_json(msg='interface you are trying to default does'
                                      ' not exist')
+    elif interface_type:
+        if state == 'present':
+            module.fail_json(msg='The interface_type param can be used '
+                                 'only with state absent.')
+
+        existing = get_interfaces_dict(module)[interface_type]
+        cmds = get_interface_type_removed_cmds(existing)
+        commands.append(cmds)
 
     cmds = flatten_list(commands)
-
     end_state = existing
 
     if cmds:
@@ -650,6 +910,8 @@ def main():
             module.exit_json(changed=True, commands=cmds)
         else:
             execute_config_command(cmds, module)
+            changed = True
+            if module.params['interface']:
                 if delta.get('mode'): # or delta.get('admin_state'):
                     # if the mode changes from L2 to L3, the admin state
                     # seems to change after the API call, so adding a second API
@@ -660,25 +922,20 @@ def main():
                     cmds2 = [c1, c2]
                     execute_config_command(cmds2, module)
                     cmds.extend(cmds2)
-            changed = True
                 end_state, is_default = smart_existing(module, intf_type,
                                                        normalized_interface)
+            else:
+                end_state = get_interfaces_dict(module)[interface_type]
 
     results = {}
     results['proposed'] = proposed
     results['existing'] = existing
     results['end_state'] = end_state
-    results['state'] = state
     results['updates'] = cmds
     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()