Merge branch 'release/0.9.0'

Author: shinmog

HISTORY.rst

@@ -3,13 +3,23 @@
 History
 =======
 
-0.8.1
+0.9.1
 -----
 
 Released: Pending
 
 Status: Alpha
 
+0.9.0
+-----
+
+Released: 2019-04-22
+
+Status: Alpha
+
+- Added `VlanInterface.set_vlan_interface()`
+- Minor bug fix
+
 0.8.0
 -----
 

pandevice/__init__.py

@@ -23,7 +23,7 @@
 
 __author__ = 'Palo Alto Networks'
 __email__ = '[email protected]'
-__version__ = '0.8.0'
+__version__ = '0.9.0'
 
 
 import logging

pandevice/base.py

@@ -1368,7 +1368,7 @@ def _convert_var(cls, value, vartype):
             return yesno(value)
 
     def _set_reference(self, reference_name, reference_type, reference_var,
-                       exclusive, refresh, update, running_config,
+                       var_type, exclusive, refresh, update, running_config,
                        return_type, name_only, **kwargs):
         """Used by helper methods to set references between objects
 
@@ -1468,46 +1468,52 @@ def _set_reference(self, reference_name, reference_type, reference_var,
         if exclusive:
             for obj in allobjects:
                 references = getattr(obj, reference_var)
-                if references is None:
+                if not references:
                     continue
-                elif hasattr(references, "__iter__") and self in references:
-                    if reference_name is not None and str(getattr(obj, reference_type.NAME)) == reference_name:
-                        continue
+                elif reference_name is not None and obj.uid == reference_name:
+                    continue
+                elif isinstance(references, list) and self in references:
                     update_needed = True
                     references.remove(self)
-                    if update: obj.update(reference_var)
-                elif hasattr(references, "__iter__") and str(self) in references:
-                    if reference_name is not None and str(getattr(obj, reference_type.NAME)) == reference_name:
-                        continue
+                    if update:
+                        obj.update(reference_var)
+                elif isinstance(references, list) and str(self) in references:
                     update_needed = True
                     references.remove(str(self))
-                    if update: obj.update(reference_var)
+                    if update:
+                        obj.update(reference_var)
                 elif references == self or references == str(self):
-                    if reference_name is not None and str(getattr(obj, reference_type.NAME)) == reference_name:
-                        continue
                     update_needed = True
-                    references = None
-                    if update: obj.update(reference_var)
+                    setattr(obj, reference_var, None)
+                    if update:
+                        obj.update(reference_var)
 
         # Add new reference to self in requested object
         if reference_name is not None:
             obj = parent.find_or_create(reference_name, reference_type, **kwargs)
             var = getattr(obj, reference_var)
-            if var is None:
-                update_needed = True
-                setattr(obj, reference_var, [self])
-                if update: obj.update(reference_var)
-            elif hasattr(var, "__iter__") and self not in var and str(self) not in var:
-                update_needed = True
-                var.append(self)
-                if update: obj.update(reference_var)
-            elif hasattr(var, "__iter__"):
-                # The reference already exists so do nothing
-                pass
+            if var_type == 'list':
+                if var is None:
+                    update_needed = True
+                    setattr(obj, reference_var, [self, ])
+                    if update:
+                        obj.update(reference_var)
+                elif not isinstance(var, list):
+                    if var != self and var != str(self):
+                        update_needed = True
+                        setattr(obj, reference_var, [var, self])
+                        if update:
+                            obj.update(reference_var)
+                elif self not in var and str(self) not in var:
+                    update_needed = True
+                    var.append(self)
+                    if update:
+                        obj.update(reference_var)
             elif var != self and var != str(self):
                 update_needed = True
                 setattr(obj, reference_var, self)
-                if update: obj.update(reference_var)
+                if update:
+                    obj.update(reference_var)
             if return_type == 'object':
                 return obj
 
@@ -3088,8 +3094,8 @@ def set_vsys(self, vsys_id, refresh=False, update=False,
                 self.XPATH_IMPORT))
 
         from pandevice.device import Vsys
-        return self._set_reference(vsys_id, Vsys, param_name, True, refresh,
-            update, running_config, return_type, True)
+        return self._set_reference(vsys_id, Vsys, param_name, 'list',
+            True, refresh, update, running_config, return_type, True)
 
     @classmethod
     def refreshall(cls, parent, running_config=False, add=True,

pandevice/network.py

@@ -321,7 +321,7 @@ def set_zone(self, zone_name, mode=None, refresh=False, update=False,
             return False
 
         return self._set_reference(
-            zone_name, Zone, "interface", True, refresh,
+            zone_name, Zone, "interface", 'list', True, refresh,
             update, running_config, return_type, False, mode=mode)
 
     def set_virtual_router(self, virtual_router_name, refresh=False,
@@ -353,8 +353,8 @@ def set_virtual_router(self, virtual_router_name, refresh=False,
 
         """
         return self._set_reference(
-            virtual_router_name, VirtualRouter, "interface", True, refresh,
-            update, running_config, return_type, False)
+            virtual_router_name, VirtualRouter, "interface", 'list',
+            True, refresh, update, running_config, return_type, False)
 
     def set_vlan(self, vlan_name, refresh=False,
                  update=False, running_config=False, return_type='object'):
@@ -391,7 +391,7 @@ def set_vlan(self, vlan_name, refresh=False,
             raise AttributeError(msg.format(self.__class__))
 
         return self._set_reference(
-            vlan_name, Vlan, "interface", True,
+            vlan_name, Vlan, "interface", 'list', True,
             refresh, update, running_config, return_type, False)
 
     def get_counters(self):
@@ -674,7 +674,7 @@ def set_virtual_router(self, virtual_router_name, refresh=False, update=False, r
         interface = Layer3Subinterface(self.name, self.tag)
         interface.parent = self.parent
         return interface._set_reference(
-            virtual_router_name, VirtualRouter, "interface", True,
+            virtual_router_name, VirtualRouter, "interface", 'list', True,
             refresh=False, update=update, running_config=running_config,
             return_type='object', name_only=False)
 
@@ -1220,6 +1220,37 @@ def _setup(self):
 
         self._params = tuple(params)
 
+    def set_vlan_interface(self, vlan_name, refresh=False,
+                update=False, running_config=False, return_type='object'):
+        """Sets the VLAN's VLAN interface to this VLAN interface
+
+        Creates a reference to this interface in the specified vlan and removes
+        references to this interface from all other VLANs.  The vlan will
+        be created if it doesn't exist.
+
+        Args:
+            vlan_name (str): The name of the vlan or
+                a :class:`pandevice.network.Vlan` instance
+            refresh (bool): Refresh the relevant current state of the device
+                before taking action (Default: False)
+            update (bool): Apply the changes to the device (Default: False)
+            running_config: If refresh is True, refresh from the running
+                configuration (Default: False)
+            return_type (str): Specify what this function returns, can be
+                either 'object' (the default) or 'bool'.  If this is 'object',
+                then the return value is the Vlan in question.  If
+                this is 'bool', then the return value is a boolean that tells
+                you about if the live device needs updates (update=False) or
+                was updated (update=True).
+
+        Returns:
+            Vlan: The VLAN for this interface after the operation completes
+
+        """
+        return self._set_reference(
+            vlan_name, Vlan, 'virtual_interface', 'string', True,
+            refresh, update, running_config, return_type, False)
+
 
 class LoopbackInterface(Interface):
     """Loopback interface

setup.py

@@ -23,7 +23,7 @@
 
 setup(
     name='pandevice',
-    version='0.8.0',
+    version='0.9.0',
     description='Framework for interacting with Palo Alto Networks devices via API',
     long_description='The Palo Alto Networks Device Framework is a way to interact with Palo Alto Networks devices (including Next-generation Firewalls and Panorama) using the device API that is object oriented and conceptually similar to interaction with the device via the GUI or CLI.',
     author='Palo Alto Networks',