Merge branch 'release/0.5.2'

Author: shinmog

HISTORY.rst

@@ -3,6 +3,17 @@
 History
 =======
 
+0.5.2
+-----
+
+Released: 2017-11-30
+
+Status: Alpha
+
+- Adding DHCP management interface options to `device.SystemSettings`
+- Various bug fixes
+
+
 0.5.1
 -----
 

pandevice/__init__.py

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

pandevice/base.py

@@ -1493,6 +1493,8 @@ def _gather_bulk_info(self, func=None):
             if node._requires_import_consideration():
                 vsys = node.vsys
                 if vsys is None and node.ALWAYS_IMPORT:
+                    if getattr(node, 'mode', None) in ('ha', 'aggregate-group'):
+                        continue
                     vsys = 'vsys1'
                 vsys_dict.setdefault(vsys, {})
                 vsys_dict[vsys].setdefault(node.xpath_import_base(), [])
@@ -1623,7 +1625,9 @@ def delete_similar(self):
 
     def _perform_vsys_dict_import_set(self, dev, vsys_dict):
         """Iterates of a vsys_dict, doing imports for all instances."""
-        for vsys_spec in vsys_dict.values():
+        for vsys, vsys_spec in vsys_dict.items():
+            if vsys is None:
+                continue
             for xpath_import_base, objs in vsys_spec.items():
                 xpath_tokens = xpath_import_base.split('/')
                 new_root = xpath_tokens.pop()
@@ -3736,7 +3740,7 @@ def map_ha(self, method_name, *args, **kwargs):
         return result1, result2
 
     def show_highavailability_state(self):
-        ha_state = self.active().op("show high-availability state")
+        ha_state = self.op("show high-availability state")
         enabled = ha_state.findtext("result/enabled")
         if enabled is None or enabled == "no":
             return "disabled", None
@@ -3756,17 +3760,15 @@ def refresh_ha_active(self):
         self_state = self.show_highavailability_state()[0]
         peer_state = self.ha_peer.show_highavailability_state()[0]
         states = (self_state, peer_state)
-        if "disabled" not in states:
-            if "initial" in states:
-                logger.debug("HA is initializing on one or both devices, try again soon")
-                return "initial"
-            elif self_state == "active":
-                logger.debug("Current firewall is active, no change made")
-                return "active"
-            else:
-                logger.debug("Current firewall state is %s, switching to use other firewall" % self_state)
-                self.toggle_ha_active()
-                return self_state
+        if 'disabled' in states:
+            return
+        elif 'initial' in states:
+            logger.debug("HA is initializing on one or both devices, try again soon")
+            return 'initial'
+        else:
+            for fw, state in ((self, self_state), (self.ha_peer, peer_state)):
+                fw._ha_active = state == 'active'
+            return self_state
 
     def synchronize_config(self):
         """Force configuration synchronization from this device to its HA peer"""

pandevice/device.py

@@ -197,11 +197,14 @@ class NTPServerSecondary(NTPServer):
     XPATH = "/ntp-servers/secondary-ntp-server"
 
 
-class SystemSettings(PanObject):
+class SystemSettings(VersionedPanObject):
     """Firewall or Panorama device system settings
 
     Add only one of these to a parent object.
 
+    If you want to configure DHCP on the management interface, you should
+    specify settings for `dhcp_send_hostname` and `dhcp_send_client_id`.
+
     Args:
         hostname (str): The hostname of the device
         domain (str): The domain of the device
@@ -217,35 +220,73 @@ class SystemSettings(PanObject):
         panorama2 (str):  IP address of secondary Panorama
         login_banner (str): Login banner text
         update_server (str): IP or hostname of the update server
+        verify_update_server (bool): Verify the update server identity
+        dhcp_send_hostname (bool): (DHCP Mngt) Send Hostname
+        dhcp_send_client_id (bool): (DHCP Mngt) Send Client ID
+        accept_dhcp_hostname (bool): (DHCP Mngt) Accept DHCP hostname
+        accept_dhcp_domain (bool): (DHCP Mngt) Accept DHCP domain name
 
     """
     NAME = None
     ROOT = Root.DEVICE
-    XPATH = "/deviceconfig/system"
     HA_SYNC = False
     CHILDTYPES = (
         "device.NTPServerPrimary",
         "device.NTPServerSecondary",
     )
 
-    @classmethod
-    def variables(cls):
-        return (
-            Var("hostname"),
-            Var("domain"),
-            Var("ip-address"),
-            Var("netmask"),
-            Var("default-gateway"),
-            Var("ipv6-address"),
-            Var("ipv6-default-gateway"),
-            Var("dns-setting/servers/primary", "dns_primary"),
-            Var("dns-setting/servers/secondary", "dns_secondary"),
-            Var("timezone"),
-            Var("panorama-server", "panorama"),
-            Var("panorama-server-2", "panorama2"),
-            Var("login-banner"),
-            Var("update-server"),
-        )
+    def _setup(self):
+        # xpaths
+        self._xpaths.add_profile(value='/deviceconfig/system')
+
+        # params
+        params = []
+
+        params.append(VersionedParamPath(
+            'hostname', path='hostname'))
+        params.append(VersionedParamPath(
+            'domain', path='domain'))
+        params.append(VersionedParamPath(
+            'ip_address', path='ip-address'))
+        params.append(VersionedParamPath(
+            'netmask', path='netmask'))
+        params.append(VersionedParamPath(
+            'default_gateway', path='default-gateway'))
+        params.append(VersionedParamPath(
+            'ipv6_address', path='ipv6-address'))
+        params.append(VersionedParamPath(
+            'ipv6_default_gateway', path='ipv6-default-gateway'))
+        params.append(VersionedParamPath(
+            'dns_primary', path='dns-setting/servers/primary'))
+        params.append(VersionedParamPath(
+            'dns_secondary', path='dns-setting/servers/secondary'))
+        params.append(VersionedParamPath(
+            'timezone', path='timezone'))
+        params.append(VersionedParamPath(
+            'panorama', path='panorama-server'))
+        params.append(VersionedParamPath(
+            'panorama2', path='panorama-server-2'))
+        params.append(VersionedParamPath(
+            'login_banner', path='login-banner'))
+        params.append(VersionedParamPath(
+            'update_server', path='update-server'))
+        params.append(VersionedParamPath(
+            'verify_update_server', vartype='yesno',
+            path='server-verification'))
+        params.append(VersionedParamPath(
+            'dhcp_send_hostname', vartype='yesno',
+            path='type/dhcp-client/send-hostname'))
+        params.append(VersionedParamPath(
+            'dhcp_send_client_id', vartype='yesno',
+            path='type/dhcp-client/send-client-id'))
+        params.append(VersionedParamPath(
+            'accept_dhcp_hostname', vartype='yesno',
+            path='type/dhcp-client/accept-dhcp-hostname'))
+        params.append(VersionedParamPath(
+            'accept_dhcp_domain', vartype='yesno',
+            path='type/dhcp-client/accept-dhcp-domain'))
+
+        self._params = tuple(params)
 
 
 class PasswordProfile(VersionedPanObject):

pandevice/network.py

@@ -553,6 +553,7 @@ class Subinterface(Interface):
 
     """
     _BASE_INTERFACE_NAME = 'entry BASE_INTERFACE_NAME'
+    _BASE_INTERFACE_TYPE = 'var BASE_INTERFACE_TYPE'
 
     def set_name(self):
         """Create a name appropriate for a subinterface if it isn't already"""
@@ -563,6 +564,13 @@ def set_name(self):
     def XPATH(self):
         path = super(Subinterface, self).XPATH
 
+        if self._BASE_INTERFACE_TYPE in path:
+            if self.uid.startswith('ae'):
+                rep = 'aggregate-ethernet'
+            else:
+                rep = 'ethernet'
+            path = path.replace(self._BASE_INTERFACE_TYPE, rep)
+
         if self._BASE_INTERFACE_NAME in path:
             base = self.uid.split('.')[0]
             path = path.replace(self._BASE_INTERFACE_NAME,
@@ -710,8 +718,8 @@ def _setup(self):
         # xpaths for parents: firewall.Firewall, device.Vsys
         self._xpaths.add_profile(
             parents=('Firewall', 'Vsys'),
-            value=('/network/interface/ethernet/{0}/layer3/units'.format(
-                self._BASE_INTERFACE_NAME)))
+            value=('/network/interface/{0}/{1}/layer3/units'.format(
+                self._BASE_INTERFACE_TYPE, self._BASE_INTERFACE_NAME)))
 
         # xpath imports
         self._xpath_imports.add_profile(value='/network/interface')
@@ -785,8 +793,8 @@ def _setup(self):
         # xpaths for parents: firewall.Firewall, device.Vsys
         self._xpaths.add_profile(
             parents=('Firewall', 'Vsys'),
-            value=('/network/interface/ethernet/{0}/layer2/units'.format(
-                self._BASE_INTERFACE_NAME)))
+            value=('/network/interface/{0}/{1}/layer2/units'.format(
+                self._BASE_INTERFACE_TYPE, self._BASE_INTERFACE_NAME)))
 
         # xpath imports
         self._xpath_imports.add_profile(value='/network/interface')

pandevice/panorama.py

@@ -333,6 +333,8 @@ def refresh_devices(self, devices=(), only_connected=False, expand_vsys=True, in
         # of the device groups
         if devicegroup_configxml is not None:
             for dg_entry in devicegroup_configxml:
+                if dg_entry.find('devices') is None:
+                    continue
                 for fw_entry in dg_entry.find('devices'):
                     fw_entry_op = devicegroup_opxml.find("entry/devices/entry[@name='%s']" % fw_entry.get("name"))
                     if fw_entry_op is not None:

setup.py

@@ -23,7 +23,7 @@
 
 setup(
     name='pandevice',
-    version='0.5.1',
+    version='0.5.2',
     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',

tests/test_versioning.py

@@ -9,11 +9,13 @@
 import pandevice.network
 import pandevice.objects
 import pandevice.policies
+import pandevice.device
 
 
 class TestObject(unittest.TestCase):
     OLD_CLS = None
     NEW_CLS = None
+    # This is a tuple of two-element tuples.
     PARAMS = ()
 
     def setUp(self):
@@ -23,8 +25,13 @@ def setUp(self):
             raise unittest.SkipTest('NEW_CLS not defined')
 
     def test_empty_objects_are_equal(self):
-        old = self.OLD_CLS('foo')
-        new = self.NEW_CLS('foo')
+        if self.OLD_CLS.SUFFIX is not None:
+            old = self.OLD_CLS('foo')
+            new = self.NEW_CLS('foo')
+        else:
+            old = self.OLD_CLS()
+            new = self.NEW_CLS()
+
         new.retrieve_panos_version = mock.Mock(return_value=(7, 0, 0))
 
         if not hasattr(old, 'element_str'):
@@ -37,9 +44,13 @@ def test_empty_objects_are_equal(self):
 
     def test_positionally_populated_objects_are_equal(self):
         args = tuple(y for x, y in self.PARAMS)
-        new = self.NEW_CLS('jack', *args)
+        if self.OLD_CLS.SUFFIX is not None:
+            new = self.NEW_CLS('jack', *args)
+            old = self.OLD_CLS('jack', *args)
+        else:
+            new = self.NEW_CLS(*args)
+            old = self.OLD_CLS(*args)
         new.retrieve_panos_version = mock.Mock(return_value=(7, 0, 0))
-        old = self.OLD_CLS('jack', *args)
 
         if not hasattr(old, 'element_str'):
             raise unittest.SkipTest('OLD_CLS does not have element_str()')
@@ -51,8 +62,12 @@ def test_positionally_populated_objects_are_equal(self):
 
     def test_keyword_populated_objects_are_equal(self):
         kwargs = dict(self.PARAMS)
-        old = self.OLD_CLS('burton', **kwargs)
-        new = self.NEW_CLS('burton', **kwargs)
+        if self.OLD_CLS.SUFFIX is not None:
+            old = self.OLD_CLS('burton', **kwargs)
+            new = self.NEW_CLS('burton', **kwargs)
+        else:
+            old = self.OLD_CLS(**kwargs)
+            new = self.NEW_CLS(**kwargs)
         new.retrieve_panos_version = mock.Mock(return_value=(7, 0, 0))
 
         if not hasattr(old, 'element_str'):