tunnel summary support

Author: Zachery Lantz

fmcapi/api_objects/__init__.py

@@ -112,6 +112,7 @@
 from .object_services import TimeRanges
 from .health import TunnelStatuses
 from .health import TunnelDetails
+from .health import TunnelSummaries
 
 logging.debug("In the api_objects __init__.py file.")
 
@@ -222,4 +223,5 @@
     "TimeRanges",
     "TunnelStatuses",
     "TunnelDetails",
+    "TunnelSummaries",
 ]

fmcapi/api_objects/health/__init__.py

@@ -4,6 +4,7 @@
 from .terminateravpnsessions import TerminateRAVPNSessions
 from .tunnelstatuses import TunnelStatuses
 from .tunneldetails import TunnelDetails
+from .tunnelsummaries import TunnelSummaries
 
 logging.debug("In the health __init__.py file.")
 

fmcapi/api_objects/health/tunnelsummaries.py

@@ -0,0 +1,50 @@
+from fmcapi.api_objects.apiclasstemplate import APIClassTemplate
+import logging
+
+
+class TunnelSummaries(APIClassTemplate):
+    """The TunnelSummaries Object in the FMC."""
+
+    FIRST_SUPPORTED_FMC_VERSION = "7.3"
+    VALID_JSON_DATA = [
+        "tunnelCount",
+        "tunnelUpCount",
+        "tunnelDownCount",
+        "tunnelUnknownCount",
+        "type",
+    ]
+    VALID_GET_FILTERS = [
+        "vpnTopologyId", # vpnTopologyId: uuid of vpn topo
+        "deviceId", # deviceId: uuid of device
+        "groupBy", # Topology|Device
+    ]
+    VALID_FOR_KWARGS = VALID_JSON_DATA + VALID_GET_FILTERS + []
+
+    URL_SUFFIX = "/health/tunnelsummaries"
+
+    def __init__(self, fmc, **kwargs):
+        """
+        Initialize TunnelSummaries object.
+
+        :param fmc (object): FMC object
+        :param **kwargs: Any other values passed during instantiation.
+        :return: requests response
+        """
+        super().__init__(fmc, **kwargs)
+        logging.debug("In __init__() for TunnelSummaries class.")
+        self.parse_kwargs(**kwargs)
+
+    def delete(self, **kwargs):
+        """DELETE method for API for TunnelSummaries not supported."""
+        logging.info("DELETE method for API for TunnelSummaries not supported.")
+        pass
+
+    def put(self):
+        """PUT method for API for TunnelSummaries not supported."""
+        logging.info("PUT method for API for TunnelSummaries not supported.")
+        pass
+
+    def post(self, **kwargs):
+        """POST method for API for TunnelSummaries not supported."""
+        logging.info("POST method for API for TunnelSummaries not supported.")
+        pass

unit_tests/__init__.py

@@ -81,6 +81,7 @@
 from .fqdns import test__fqdns
 from .tunnelstatuses import test__tunnelstatuses
 from .tunneldetails import test__tunneldetails
+from .tunnelsummaries import test__tunnelsummaries
 
 logging.debug("In the unit-tests __init__.py file.")
 
@@ -166,4 +167,5 @@
     "test__fqdns",
     "test__tunnelstatuses",
     "test__tunneldetails",
+    "test__tunnelsummaries",
 ]

unit_tests/tunnelsummaries.py

@@ -0,0 +1,12 @@
+import logging
+import fmcapi
+
+
+def test__tunnelsummaries(fmc):
+    logging.info("Test TunnelSummaries.  Get TunnelSummaries.")
+
+    obj1 = fmcapi.TunnelSummaries(fmc=fmc)
+    tunnel_summaries = obj1.get()
+    del obj1
+
+    logging.info("Test TunnelSummaries done.\n")