Merge branch 'release/0.12.0'

Author: shinmog

HISTORY.rst

@@ -3,6 +3,25 @@
 History
 =======
 
+0.12.0
+------
+
+Released: 2019-09-24
+
+Status: Alpha
+
+New Classes:
+
+- `panorama.TemplateVariable`
+
+Other updates:
+
+- New params added to ethernet interfaces
+- Fixed `show_system_resources()` for PAN-OS 9.0+
+- Added `.rename()` to rename objects.
+- Documentation fixes
+- Various bug fixes
+
 0.11.1
 ------
 

docs/conf.py

@@ -68,8 +68,8 @@
 master_doc = 'index'
 
 # General information about the project.
-project = u'Palo Alto Networks Device Framework'
-copyright = u'2014, Brian Torres-Gil'
+project = 'Palo Alto Networks Device Framework'
+copyright = '2014, Brian Torres-Gil'
 
 # The version info for the project you're documenting, acts as replacement
 # for |version| and |release|, also used in various other places throughout
@@ -226,8 +226,8 @@
 # [howto/manual]).
 latex_documents = [
     ('index', 'pandevice.tex',
-     u'Palo Alto Networks Device Framework Documentation',
-     u'Brian Torres-Gil', 'manual'),
+     'Palo Alto Networks Device Framework Documentation',
+     'Brian Torres-Gil', 'manual'),
 ]
 
 # The name of an image file (relative to this directory) to place at
@@ -257,8 +257,8 @@
 # (source start file, name, description, authors, manual section).
 man_pages = [
     ('index', 'pandevice',
-     u'Palo Alto Networks Device Framework Documentation',
-     [u'Brian Torres-Gil'], 1)
+     'Palo Alto Networks Device Framework Documentation',
+     ['Brian Torres-Gil'], 1)
 ]
 
 # If true, show URL addresses after external links.
@@ -272,8 +272,8 @@
 #  dir menu entry, description, category)
 texinfo_documents = [
     ('index', 'pandevice',
-     u'Palo Alto Networks Device Framework Documentation',
-     u'Brian Torres-Gil',
+     'Palo Alto Networks Device Framework Documentation',
+     'Brian Torres-Gil',
      'pandevice',
      'One line description of project.',
      'Miscellaneous'),

docs/configtree.py

@@ -34,15 +34,15 @@
 
 
 nodestyle = {
-    #'Firewall':  '',
-    #'Panorama':  '',
+    # 'Firewall':  '',
+    # 'Panorama':  '',
     'device':    'fillcolor=lightpink',
     'firewall':  'fillcolor=lightblue',
     'ha':        'fillcolor=lavender',
     'network':   'fillcolor=lightcyan',
     'objects':   'fillcolor=lemonchiffon',
     'policies':  'fillcolor=lightsalmon',
-    'panorama':  'fillcolor=lightgreen',
+    'panorama':  'fillcolor=darkseagreen2',
 }
 
 
@@ -145,7 +145,7 @@ def create_object_diagram(directory=None):
     if directory is not None:
         mkdir_p(directory)
         path = directory + "/"
-    for module, lines in output.iteritems():
+    for module, lines in output.items():
         if not lines:
             continue
         moduleout = "".join(lines)

pandevice/__init__.py

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

pandevice/base.py

@@ -69,6 +69,7 @@ class PanObject(object):
     CHILDTYPES = ()
     CHILDMETHODS = ()
     HA_SYNC = True
+    TEMPLATE_NATIVE = False
 
     def __init__(self, *args, **kwargs):
         # Set the 'name' variable
@@ -315,12 +316,13 @@ def xpath(self, root=None):
                 label = p.VSYS_LABEL
                 vsys = p.vsys
             elif p.__class__.__name__ in ('Template', 'TemplateStack'):
-                # Hit a template, make sure that the appropriate /config/...
-                # xpath has been saved.
-                if not path[0].startswith('/config/'):
-                    path.insert(0, self.xpath_root(root, vsys, label))
-                vsys = p.vsys
-                root = p.ROOT
+                if not self.TEMPLATE_NATIVE:
+                    # Hit a template, make sure that the appropriate /config/...
+                    # xpath has been saved.
+                    if not path[0].startswith('/config/'):
+                        path.insert(0, self.xpath_root(root, vsys, label))
+                    vsys = p.vsys
+                    root = p.ROOT
 
         return ''.join(path)
 
@@ -630,6 +632,26 @@ def update(self, variable):
             device.xapi.edit(xpath, ET.tostring(element, encoding='utf-8'),
                              retry_on_peer=self.HA_SYNC)
 
+    def rename(self, new_name):
+        """Change the name of this object.
+
+        **Modifies the live device**
+
+        NOTE:  This does not change any references that may exist in your
+        pandevice object hierarchy, but it does update the name of the
+        object itself.
+
+        Args:
+            new_name (str): The new UID for this object.
+
+        """
+        dev = self.nearest_pandevice()
+        logger.debug('{0}: rename called on {1} object "{2}"'.format(
+                dev.id, type(self), self.uid))
+        dev.set_config_changed()
+        dev.xapi.rename(self.xpath(), new_name)
+        setattr(self, self.NAME, new_name)
+
     def move(self, location, ref=None, update=True):
         """Moves the current object.
 
@@ -4204,29 +4226,34 @@ def config_synced(self):
 
     # Commit methods
 
-    def commit(self, sync=False, exception=False, cmd=None):
+    def commit(self, sync=False, exception=False, cmd=None, admins=None):
         """Trigger a commit
 
         Args:
             sync (bool): Block until the commit is finished (Default: False)
             exception (bool): Create an exception on commit errors (Default: False)
             cmd (str): Commit options in XML format
+            admins (str/list): name or list of admins whose changes need to be committed 
 
         Returns:
             dict: Commit results
 
         """
         self._logger.debug("Commit initiated on device: %s" % (self.id,))
-        return self._commit(sync=sync, exception=exception, cmd=cmd)
+        return self._commit(sync=sync, exception=exception, cmd=cmd, admins=admins)
 
     def _commit(self, cmd=None, exclude=None, commit_all=False,
-                sync=False, sync_all=False, exception=False):
+                sync=False, sync_all=False, exception=False, admins=None):
         """Internal use commit helper method.
 
         :param exclude:
             Can be:
                 device-and-network
                 policy-and-objects
+
+        :param admins:
+            string or list containing specific admin user(s) whose changes need to be committed
+
         :param sync:
             Synchronous commit, ie. wait for job to finish
         :return:
@@ -4247,10 +4274,18 @@ def _commit(self, cmd=None, exclude=None, commit_all=False,
             pass
         else:
             cmd = ET.Element("commit")
-            if exclude is not None:
-                excluded = ET.SubElement(cmd, "partial")
-                excluded = ET.SubElement(excluded, exclude)
+            if exclude is not None or admins is not None:
+                partial = ET.SubElement(cmd,"partial")
+                if admins is not None:
+                    partial_admin = ET.SubElement(partial, "admin")
+                    admins = pandevice.string_or_list(admins)
+                    for admin in admins:
+                        admin_xml = ET.SubElement(partial_admin, "member")
+                        admin_xml.text = admin
+                if exclude is not None:
+                    excluded = ET.SubElement(partial, exclude)
             cmd = ET.tostring(cmd, encoding='utf-8')
+          
         logger.debug(self.id + ": commit requested: commit_all:%s sync:%s sync_all:%s cmd:%s" % (str(commit_all),
                                                                                                        str(sync),
                                                                                                        str(sync_all),
@@ -4268,6 +4303,7 @@ def _commit(self, cmd=None, exclude=None, commit_all=False,
                                            timeout=self.timeout,
                                            retry_on_peer=True,
                                            )
+
         # Set locks off
         self.config_changed = []
         self.config_locked = False

pandevice/firewall.py

@@ -347,7 +347,10 @@ def refreshall_from_xml(self, xml, refresh_children=False, variables=None):
     def show_system_resources(self):
         self.xapi.op(cmd="show system resources", cmd_xml=True)
         result = self.xapi.xml_root()
-        regex = re.compile(r"load average: ([\d.]+).* ([\d.]+)%id.*Mem:.*?([\d.]+)k total.*?([\d]+)k free", re.DOTALL)
+        if self._version_info >= (9, 0, 0):
+            regex = re.compile(r'load average: ([\d\.]+).*? ([\d\.]+) id,.*KiB Mem : (\d+) total,.*? (\d+) free', re.DOTALL)
+        else:
+            regex = re.compile(r"load average: ([\d.]+).* ([\d.]+)%id.*Mem:.*?([\d.]+)k total.*?([\d]+)k free", re.DOTALL)
         match = regex.search(result)
         if match:
             """

pandevice/network.py

@@ -352,6 +352,10 @@ def set_virtual_router(self, virtual_router_name, refresh=False,
             Zone: The zone for this interface after the operation completes
 
         """
+        # Don't add HA or aggregate-group interfaces to virtual router.
+        if getattr(self, 'mode', '') in ('ha', 'aggregate-group'):
+            return False
+
         return self._set_reference(
             virtual_router_name, VirtualRouter, "interface", 'list',
             True, refresh, update, running_config, return_type, False)
@@ -739,6 +743,7 @@ class Layer3Subinterface(Subinterface):
         enable_dhcp (bool): Enable DHCP on this interface
         create_dhcp_default_route (bool): Create default route pointing to default gateway provided by server
         dhcp_default_route_metric (int): Metric for the DHCP default route
+        decrypt_forward (bool): (PAN-OS 8.1+) Decrypt forward.
 
     """
     DEFAULT_MODE = 'layer3'
@@ -805,6 +810,11 @@ def _setup(self):
         params.append(VersionedParamPath(
             'dhcp_default_route_metric',
             path='dhcp-client/default-route-metric', vartype='int'))
+        params.append(VersionedParamPath(
+            'decrypt_forward', vartype='yesno', exclude=True))
+        params[-1].add_profile(
+            '8.1.0',
+            vartype='yesno', path='decrypt-forward')
 
         self._params = tuple(params)
 
@@ -933,11 +943,19 @@ class EthernetInterface(PhysicalInterface):
         link_state (str): Link state: eg. auto, up, down
         aggregate_group (str): Aggregate interface (eg. ae1)
         comment (str): The interface's comment
-        ipv4_mss_adjust(int): TCP MSS adjustment for ipv4
-        ipv6_mss_adjust(int): TCP MSS adjustment for ipv6
+        ipv4_mss_adjust(int): (PAN-OS 7.1+) TCP MSS adjustment for ipv4
+        ipv6_mss_adjust(int): (PAN-OS 7.1+) TCP MSS adjustment for ipv6
         enable_dhcp (bool): Enable DHCP on this interface
         create_dhcp_default_route (bool): Create default route pointing to default gateway provided by server
         dhcp_default_route_metric (int): Metric for the DHCP default route
+        enable_untagged_subinterface (bool): (PAN-OS 7.1+) Enable untagged
+            subinterface
+        decrypt_forward (bool): (PAN-OS 8.1+) Decrypt forward.
+        rx_policing_rate (int): (PAN-OS 8.1+) Receive policing rate
+        tx_policing_rate (int): (PAN-OS 8.1+) Transmit policing rate
+        dhcp_send_hostname_enable (bool): Enable send firewall or custom hostname
+            to DHCP server
+        dhcp_send_hostname_value (string): Set interface hostname
 
     """
     ALLOW_SET_VLAN = True
@@ -991,10 +1009,10 @@ def _setup(self):
             condition={'mode': 'layer3'}))
         params.append(VersionedParamPath(
             'lldp_enabled', path='{mode}/lldp/enable', vartype='yesno',
-            condition={'mode': 'layer2'}))
+            condition={'mode': ['layer2', 'layer3', 'virtual-wire']}))
         params.append(VersionedParamPath(
             'lldp_profile', path='{mode}/lldp/profile',
-            condition={'mode': 'layer2'}))
+            condition={'mode': ['layer2', 'layer3', 'virtual-wire']}))
         params.append(VersionedParamPath(
             'netflow_profile_l2', path='{mode}/netflow-profile',
             condition={'mode': 'layer2'}))
@@ -1032,6 +1050,42 @@ def _setup(self):
             'dhcp_default_route_metric',
             path='{mode}/dhcp-client/default-route-metric',
             vartype='int', condition={'mode': 'layer3'}))
+        params.append(VersionedParamPath(
+            'enable_untagged_subinterface', exclude=True))
+        params[-1].add_profile(
+            '7.1.0',
+            vartype='yesno', condition={'mode': 'layer3'},
+            path='{mode}/untagged-sub-interface')
+        params.append(VersionedParamPath(
+            'decrypt_forward', exclude=True))
+        params[-1].add_profile(
+            '8.1.0',
+            vartype='yesno', condition={'mode': 'layer3'},
+            path='{mode}/decrypt-forward')
+        params.append(VersionedParamPath(
+            'rx_policing_rate', exclude=True))
+        params[-1].add_profile(
+            '8.1.0',
+            vartype='int', condition={'mode': 'layer3'},
+            path='{mode}/policing/rx-rate')
+        params.append(VersionedParamPath(
+            'tx_policing_rate', exclude=True))
+        params[-1].add_profile(
+            '8.1.0',
+            vartype='int', condition={'mode': 'layer3'},
+            path='{mode}/policing/tx-rate')
+        params.append(VersionedParamPath(
+            'dhcp_send_hostname_enable', exclude=True))
+        params[-1].add_profile(
+            '9.0.0',
+            vartype='yesno', condition={'mode': 'layer3'},
+            path='{mode}/dhcp-client/send-hostname/enable')
+        params.append(VersionedParamPath(
+            'dhcp_send_hostname_value', exclude=True))
+        params[-1].add_profile(
+            '9.0.0',
+            condition={'mode': 'layer3'},
+            path='{mode}/dhcp-client/send-hostname/hostname')
 
         self._params = tuple(params)
 

pandevice/objects.py

@@ -75,6 +75,7 @@ class AddressGroup(VersionedPanObject):
     """Address Group
 
     Args:
+        name (str): Name of the address group
         static_value (list): Values for a static address group
         dynamic_value (str): Registered-ip tags for a dynamic address group
         description (str): Description of this object