SDK Improvements for Ansible Plays (#134)

Author: saimonation

cterasdk/core/directoryservice.py

@@ -168,6 +168,12 @@ def _configure_access_control(self, acl, default=None):
 
         return response
 
+    def get_default_role(self):
+        """
+        Retrieve the default role assigned when no access control entry match was found
+        """
+        return self._portal.get('/directoryConnector/noMatchRole')
+
     def get_connected_domain(self):
         """
         Get the connected domain information. Returns `None` if the Portal tenant is not connected to a domain

cterasdk/core/syslog.py

@@ -13,7 +13,27 @@ class Syslog(BaseCommand):
     # TODO: upload_ca_certificate  # pylint: disable=W0511
     # TODO: upload_client_certificate  # pylint: disable=W0511
 
+    def is_enabled(self):
+        """
+        Check if forwarding log messages over syslog is enabled
+        """
+        return self._portal.get('/settings/logsSettings/syslogConfig/mode') == Mode.Enabled
+
+    def get_configuration(self):
+        """
+        Retrieve the syslog server configuration
+        """
+        return self._portal.get('/settings/logsSettings/syslogConfig')
+
     def enable(self, server, port=514, proto=IPProtocol.UDP, min_severity=Severity.INFO):
+        """
+        Enable Syslog
+
+        :param str server: Syslog server address
+        :param int,optional port: Syslog server port
+        :param cterasdk.core.enum.IPProtocol,optional proto: Syslog server IP protocol
+        :param cterasdk.core.enum.Severity,optional min_severity: Minimum log severity to forward
+        """
         param = Object()
         param._classname = 'PortalSyslogConfig'  # pylint: disable=protected-access
         param.mode = Mode.Enabled

docs/source/user_guides/Portal/GlobalAdmin.rst

@@ -770,6 +770,12 @@ Directory Services
    )
    admin.directoryservice.set_access_control([rw_admin_group, ro_admin_user], portal_enum.Role.Disabled)
 
+.. automethod:: cterasdk.core.directoryservice.DirectoryService.get_default_role
+
+.. code-block:: python
+
+   print(admin.directoryservice.get_default_role())
+
 .. automethod:: cterasdk.core.directoryservice.DirectoryService.disconnect
    :noindex:
 
@@ -1149,6 +1155,12 @@ Logs
 Syslog
 ------
 
+.. automethod:: cterasdk.core.syslog.Syslog.is_enabled
+   :noindex:
+
+.. automethod:: cterasdk.core.syslog.Syslog.get_configuration
+   :noindex:
+
 .. automethod:: cterasdk.core.syslog.Syslog.enable
    :noindex: