support for tunneldetails

Author: Zachery Lantz

fmcapi/api_objects/__init__.py

@@ -111,6 +111,7 @@
 from .policy_services import DynamicAccessPolicies
 from .object_services import TimeRanges
 from .health import TunnelStatuses
+from .health import TunnelDetails
 
 logging.debug("In the api_objects __init__.py file.")
 
@@ -220,4 +221,5 @@
     "DynamicAccessPolicies",
     "TimeRanges",
     "TunnelStatuses",
+    "TunnelDetails",
 ]

fmcapi/api_objects/health/__init__.py

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

fmcapi/api_objects/health/tunneldetails.py

@@ -0,0 +1,47 @@
+from fmcapi.api_objects.apiclasstemplate import APIClassTemplate
+import logging
+
+
+class TunnelDetails(APIClassTemplate):
+    """The TunnelDetails Object in the FMC."""
+
+    FIRST_SUPPORTED_FMC_VERSION = "7.3"
+    REQUIRED_FOR_GET = ["container_uuid"]
+    VALID_JSON_DATA = [
+        "type",
+        "peerA",
+        "peerB",
+    ]
+
+    VALID_FOR_KWARGS = VALID_JSON_DATA + ["container_uuid"]
+
+    URL_SUFFIX = f"/health/tunnelstatuses"
+
+    def __init__(self, fmc, **kwargs):
+        """
+        Initialize TunnelDetails 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 TunnelDetails class.")
+        self.parse_kwargs(**kwargs)
+        URL_CONTAINER_SUFFIX = f"/{self.container_uuid}/tunneldetails"
+        self.URL = self.URL + URL_CONTAINER_SUFFIX
+
+    def delete(self, **kwargs):
+        """DELETE method for API for TunnelDetails not supported."""
+        logging.info("DELETE method for API for TunnelDetails not supported.")
+        pass
+
+    def put(self):
+        """PUT method for API for TunnelDetails not supported."""
+        logging.info("PUT method for API for TunnelDetails not supported.")
+        pass
+
+    def post(self, **kwargs):
+        """POST method for API for TunnelDetails not supported."""
+        logging.info("POST method for API for TunnelDetails not supported.")
+        pass

unit_tests/__init__.py

@@ -80,6 +80,7 @@
 from .timeranges import test__timeranges
 from .fqdns import test__fqdns
 from .tunnelstatuses import test__tunnelstatuses
+from .tunneldetails import test__tunneldetails
 
 logging.debug("In the unit-tests __init__.py file.")
 
@@ -164,4 +165,5 @@
     "test__timeranges",
     "test__fqdns",
     "test__tunnelstatuses",
+    "test__tunneldetails",
 ]

unit_tests/tunneldetails.py

@@ -0,0 +1,12 @@
+import logging
+import fmcapi
+
+
+def test__tunneldetails(fmc):
+    logging.info("Test TunnelDetails.  Get TunnelDetails.")
+
+    obj1 = fmcapi.TunnelDetails(fmc=fmc, container_uuid="40A6B737-FDDC-0ed3-0000-000000000297") # Tunnel uuid not topology uuid
+    tunnel_details = obj1.get()
+    del obj1
+
+    logging.info("Test TunnelDetails done.\n")