Ronerez/edge proxy support (#216)

Author: saimonation

cterasdk/edge/network.py

@@ -9,7 +9,13 @@
 
 
 class Network(BaseCommand):
-    """ Gateway Network configuration APIs """
+    """ Edge Filer Network configuration APIs """
+
+    def __init__(self, portal):
+        super().__init__(portal)
+        self.proxy = Proxy(self._gateway)
+        self.mtu = MTU(self._gateway)
+        self.routes = StaticRoutes(self._gateway)
 
     def get_status(self):
         """
@@ -79,26 +85,6 @@ def set_static_nameserver(self, primary_dns_server, secondary_dns_server=None):
 
         logging.getLogger().info('Nameserver settings updated. %s', {'DNS1': primary_dns_server, 'DNS2': secondary_dns_server})
 
-    def reset_mtu(self):
-        """
-        Set the default maximum transmission unit (MTU) settings
-        """
-        self._set_mtu(False, 1500)
-
-    def set_mtu(self, mtu):
-        """
-        Set a custom network maximum transmission unit (MTU)
-
-        :param int mtu: Maximum transmission unit
-        """
-        self._set_mtu(True, mtu)
-
-    def _set_mtu(self, jumbo, mtu):
-        settings = self._gateway.get('/config/network/ports/0/ethernet')
-        settings.jumbo = jumbo
-        settings.mtu = mtu
-        return self._gateway.put('/config/network/ports/0/ethernet', settings)
-
     def enable_dhcp(self):
         """
         Enable DHCP
@@ -178,15 +164,103 @@ def iperf(self, address, port=5201, threads=1, protocol=IPProtocol.TCP, directio
         except TaskError as error:
             return error.task.result.res
 
-    def get_static_routes(self):
+
+class Proxy(BaseCommand):
+    """Edge Filer Proxy Configuration APIs"""
+
+    def get_configuration(self):
+        """
+        Get Proxy Configuration
+        """
+        return self._gateway.get('/config/network/proxy')
+
+    def is_enabled(self):
+        """
+        Check if Proxy Configuration is Enabled
+
+        :returns: ``True`` if a proxy server was configured and ``False`` otherwise.
+        :rtype: bool
+        """
+        return self._gateway.get('/config/network/proxy/configurationMode') != 'NoProxy'
+
+    def modify(self, address, port=None, username=None, password=None):
+        """
+        Modify Proxy Configuration
+
+        :param str address: Proxy address
+        :param int,optional port: Proxy port, defaults to ``8080``
+        :param str,optional username: Username
+        :param str,optional password: Password
+        :returns: Proxy settings
+        :rtype: cterasdk.common.object.Object
+        """
+        return self._configure(True, address, port, username, password)
+
+    def _configure(self, enabled, address=None, port=None, username=None, password=None):
+        param = Object()
+        param._classname = 'ProxySettings'  # pylint: disable=protected-access
+        param.configurationMode = 'Manual' if enabled else 'NoProxy'
+        if enabled:
+            param.port = port if port else 8080
+            if address:
+                param.address = address
+            if username:
+                param.username = username
+            if password:
+                param.password = password
+        logging.getLogger().info('Updating Proxy Server Configuration.')
+        response = self._gateway.put('/config/network/proxy', param)
+        logging.getLogger().info('Updated Proxy Server Configuration.')
+        return response
+
+    def disable(self):
+        """
+        Disable Proxy
+
+        :returns: Proxy settings
+        :rtype: cterasdk.common.object.Object
+        """
+        logging.getLogger().info('Disabling Proxy.')
+        return self._configure(False)
+
+
+class MTU(BaseCommand):
+    """Edge Filer MTU Configuration APIs"""
+
+    def reset(self):
+        """
+        Set the default maximum transmission unit (MTU) settings
+        """
+        return self._configure(False, 1500)
+
+    def modify(self, mtu):
+        """
+        Set a custom network maximum transmission unit (MTU)
+
+        :param int mtu: Maximum transmission unit
+        """
+        return self._configure(True, mtu)
+
+    def _configure(self, jumbo, mtu):
+        settings = self._gateway.get('/config/network/ports/0/ethernet')
+        settings.jumbo = jumbo
+        settings.mtu = mtu
+        logging.getLogger().info('Configuring MTU. %s', {'MTU': mtu})
+        return self._gateway.put('/config/network/ports/0/ethernet', settings)
+
+
+class StaticRoutes(BaseCommand):
+    """Edge Filer Static Route Configuration APIs"""
+
+    def get(self):
         """
-        Get all Static Routes
+        Get All Static Routes
         """
         return self._gateway.get('/config/network/static_routes')
 
-    def add_static_route(self, source_ip, destination_ip_mask):
+    def add(self, source_ip, destination_ip_mask):
         """
-        Set a Static Route
+        Add a Static Route
 
         :param str source_ip: The source IP (192.168.15.55)
         :param str destination_ip_mask: The destination IP and CIDR block (10.5.0.1/32)
@@ -203,9 +277,9 @@ def add_static_route(self, source_ip, destination_ip_mask):
             logging.getLogger().error("Static route creation failed.")
             raise CTERAException('Static route creation failed', error)
 
-    def remove_static_route(self, destination_ip_mask):
+    def remove(self, destination_ip_mask):
         """
-        Delete a Static Route
+        Remove a Static Route
 
         :param str destination_ip_mask: The destination IP and CIDR block (10.5.0.1/32)
         """
@@ -219,13 +293,13 @@ def remove_static_route(self, destination_ip_mask):
             logging.getLogger().error("Static route deletion failed.")
             raise CTERAException('Static route deletion failed', error)
 
-    def clean_all_static_routes(self):
+    def clear(self):
         """
-        Clean all Static routes
+        Clear All Static routes
         """
         try:
             self._gateway.execute('/config/network', 'cleanStaticRoutes')
             logging.getLogger().info('Static routes were deleted successfully')
         except CTERAException as error:
-            logging.getLogger().error("Failed to clean Static routes")
-            raise CTERAException('Failed to delete Static routes', error)
+            logging.getLogger().error("Failed to clear static routes")
+            raise CTERAException('Failed to clear static routes', error)

cterasdk/edge/services.py

@@ -46,20 +46,27 @@ def connected(self):
         """
         return self._gateway.get('/status/services/CTERAPortal/connectionState') == enum.ServicesConnectionState.Connected
 
+    def _before_connect_to_services(self, ctera_license, server):
+        Services._validate_license(ctera_license)
+        if self._gateway.network.proxy.is_enabled():
+            logging.getLogger().debug('Skipping TCP connection verification over port 995.')
+        else:
+            self._check_cttp_traffic(address=server)
+
     def connect(self, server, user, password, ctera_license=enum.License.EV16):
         """
         Connect to a Portal.\n
         The connect method will first validate the `license` argument,
-         ensure the Gateway can establish a TCP connection over port 995 to `server` using :py:func:`Gateway.tcp_connect()` and
-         verify the Portal does not require device activation via code
+         ensure the Edge Filer can establish a TCP connection over port 995 to `server` using :py:func:`Gateway.tcp_connect()` and
+         verify the Portal does not require device activation via code.
+         TCP connection verification over port 995 is skipped when the Edge Filer is configured to use a proxy.
 
         :param str server: Address of the Portal
         :param str user: User for the Portal connection
         :param str password: Password for the Portal connection
         :param cterasdk.edge.enum.License,optional ctera_license: CTERA License, defaults to cterasdk.edge.enum.License.EV16
         """
-        Services._validate_license(ctera_license)
-        self._check_cttp_traffic(address=server)
+        self._before_connect_to_services(ctera_license, server)
         self._check_connection(server)
 
         param = Object()
@@ -78,8 +85,7 @@ def activate(self, server, user, code, ctera_license=enum.License.EV16):
         :param str code: Activation code for the Portal connection
         :param cterasdk.edge.enum.License,optional ctera_license: CTERA License, defaults to cterasdk.edge.enum.License.EV16
         """
-        Services._validate_license(ctera_license)
-        self._check_cttp_traffic(address=server)
+        self._before_connect_to_services(ctera_license, server)
 
         param = Object()
         param.server = server

docs/source/user_guides/Gateway/Gateway.rst

@@ -982,56 +982,95 @@ Network
 
    filer.network.enable_dhcp()
 
-.. automethod:: cterasdk.edge.network.Network.set_mtu
+Proxy Server
+^^^^^^^^^^^^
+
+.. automethod:: cterasdk.edge.network.Proxy.get_configuration
+   :noindex:
+
+.. code-block:: python
+
+   configuration = filer.network.proxy.get_configuration()
+   print(configuration)
+
+.. automethod:: cterasdk.edge.network.Proxy.is_enabled
+   :noindex:
+
+.. code-block:: python
+
+   if filer.network.proxy.is_enabled():
+       print('Proxy Server is Enabled')
+
+.. automethod:: cterasdk.edge.network.Proxy.modify
+   :noindex:
+
+.. code-block:: python
+
+   filer.network.proxy.modify('192.168.11.11', 8081, 'proxy-user', 'proxy-user-password')
+
+.. automethod:: cterasdk.edge.network.Proxy.disable
+   :noindex:
+
+.. code-block:: python
+
+   filer.network.proxy.disable()
+
+MTU
+^^^
+
+.. automethod:: cterasdk.edge.network.MTU.modify
    :noindex:
 
 .. code-block:: python
 
-   filer.network.set_mtu(1320)  # set the maximum transmission unit (MTU) to 1320
+   filer.network.mtu.modify(1320)  # set the maximum transmission unit (MTU) to 1320
 
-   filer.network.set_mtu(9000)  # configure 'jumbo' frames (MTU: 9000)
+   filer.network.mtu.modify(9000)  # configure 'jumbo' frames (MTU: 9000)
 
-.. automethod:: cterasdk.edge.network.Network.reset_mtu
+.. automethod:: cterasdk.edge.network.MTU.reset
    :noindex:
 
 .. code-block:: python
 
-   filer.network.reset_mtu()  # disable custom mtu configuration and restore default setting (1500)
+   filer.network.mtu.reset()  # disable custom mtu configuration and restore default setting (1500)
+
+Static Routes
+^^^^^^^^^^^^^
 
-.. automethod:: cterasdk.edge.network.Network.get_static_routes
+.. automethod:: cterasdk.edge.network.StaticRoutes.get
    :noindex:
 
 .. code-block:: python
 
    # get static routes
-   filer.network.get_static_routes()
+   filer.network.routes.get()
 
-.. automethod:: cterasdk.edge.network.Network.add_static_route
+.. automethod:: cterasdk.edge.network.StaticRoutes.add
    :noindex:
 
 .. code-block:: python
 
    # add static route from 10.10.12.1 to 192.168.55.7/32
-   filer.network.add_static_route('10.10.12.1', '192.168.55.7/32')
+   filer.network.routes.add('10.10.12.1', '192.168.55.7/32')
 
    # add static route from 10.100.102.4 to 172.18.100.0/24
-   filer.network.add_static_route('10.100.102.4', '172.18.100.0/24')
+   filer.network.routes.add('10.100.102.4', '172.18.100.0/24')
 
-.. automethod:: cterasdk.edge.network.Network.remove_static_route
+.. automethod:: cterasdk.edge.network.StaticRoutes.remove
    :noindex:
 
 .. code-block:: python
 
    # remove static route 192.168.55.7/32
-   filer.network.remove_static_route('192.168.55.7/32')
+   filer.network.routes.remove('192.168.55.7/32')
 
-.. automethod:: cterasdk.edge.network.Network.clean_all_static_routes
+.. automethod:: cterasdk.edge.network.StaticRoutes.clear
    :noindex:
 
 .. code-block:: python
 
    # remove all static routes -  (clean)
-   filer.network.clean_all_static_routes()
+   filer.network.routes.clear()
 
 
 Network Diagnostics