pyegeria 0.8.4.30__py3-none-any.whl → 0.8.4.32__py3-none-any.whl

pyegeria/runtime_manager_omvs.py

@@ -9,7 +9,13 @@ import asyncio
 
 from requests import Response
 
-from pyegeria import Client, max_paging_size, body_slimmer
+from pyegeria import (
+    Client,
+    max_paging_size,
+    body_slimmer,
+    InvalidParameterException,
+    default_time_out,
+)
 
 
 class RuntimeManager(Client):
@@ -41,8 +47,10 @@ class RuntimeManager(Client):
         user_id: str,
         user_pwd: str = None,
         token: str = None,
+        time_out: int = default_time_out,
     ):
         self.view_server = view_server
+        self.time_out = time_out
         Client.__init__(self, view_server, platform_url, user_id, user_pwd, token=token)
         self.cur_command_root = f"{self.platform_url}/servers/{self.view_server}/api/open-metadata/runtime-manager"
         self.platform_guid = "44bf319f-1e41-4da1-b771-2753b92b631a"  # this is platform @ 9443 from the core content archive
@@ -50,13 +58,60 @@ class RuntimeManager(Client):
             "Default Local OMAG Server Platform"  # this from the core content archive
         )
 
+    async def __async__get_guid__(
+        self, guid: str = None, name: str = None, property_name: str = "name"
+    ) -> str:
+        """Helper function to return a server_guid - one of server_guid or server_name should
+        contain information. If both are None, an exception will be thrown. If both contain
+        values, server_guid will be used. Async version.
+        """
+        if guid:
+            return guid
+        if name:
+            body = {
+                "class": "NameRequestBody",
+                "name": name,
+                "namePropertyName": property_name,
+                "forLineage": False,
+                "forDuplicateProcessing": False,
+                "effectiveTime": None,
+            }
+            url = (
+                f"{self.platform_url}/servers/{self.view_server}/api/open-metadata/classification-manager/"
+                f"elements/guid-by-unique-name?forLineage=false&forDuplicateProcessing=false"
+            )
+
+            response: Response = await self._async_make_request(
+                "POST", url, body_slimmer(body), time_out=self.time_out
+            )
+
+            return response.json().get("guid", "No elements found")
+        else:
+            raise InvalidParameterException(
+                "Neither server_guid nor server_name were provided - please provide."
+            )
+
+    def __get_guid__(
+        self, guid: str = None, name: str = None, property_name: str = "name"
+    ) -> str:
+        """Helper function to return a server_guid - one of server_guid or server_name should
+        contain information. If both are None, an exception will be thrown. If both contain
+        values, server_guid will be used.
+        """
+        loop = asyncio.get_event_loop()
+        result = loop.run_until_complete(
+            self.__async__get_guid__(guid, name, property_name)
+        )
+        return result
+
     #
     #   Cohorts
     #
     async def _async_connect_to_cohort(
         self,
-        server_guid: str,
         cohort_name: str,
+        server_guid: str = None,
+        server_name: str = None,
     ) -> None:
         """A new server needs to register the metadataCollectionId for its metadata repository with the other servers
             in the open metadata repository. It only needs to do this once and uses a timestamp to record that the
@@ -67,8 +122,10 @@ class RuntimeManager(Client):
 
         Parameters
         ----------
-        server_guid : str
-            Identity of the server to act on.
+        server_guid : str, default = None
+            Identity of the server to act on. If not specified, server_name must be.
+        server_name: str, default = None
+            Name of server to act on. If not specified, server_guid must be.
         cohort_name : str
             Name of the cohort to join
 
@@ -83,7 +140,7 @@ class RuntimeManager(Client):
         UserNotAuthorizedException
 
         """
-
+        server_guid = self.__get_guid__(server_guid, server_name)
         url = (
             f"{self.cur_command_root}/cohort-members/"
             f"{server_guid}/cohorts/{cohort_name}/connect"
@@ -92,9 +149,7 @@ class RuntimeManager(Client):
         return
 
     def connect_to_cohort(
-        self,
-        server_guid: str,
-        cohort_name: str,
+        self, cohort_name: str, server_guid: str = None, server_name: str = None
     ) -> None:
         """A new server needs to register the metadataCollectionId for its metadata repository with the other servers
             in the open metadata repository. It only needs to do this once and uses a timestamp to record that the
@@ -105,8 +160,10 @@ class RuntimeManager(Client):
 
         Parameters
         ----------
-        server_guid: str
-           Identity of the server to act on.
+        server_guid : str, default = None
+            Identity of the server to act on. If not specified, server_name must be.
+        server_name: str, default = None
+            Name of server to act on. If not specified, server_guid must be.
         cohort_name: str
             Name of the cohort to join
 
@@ -122,13 +179,13 @@ class RuntimeManager(Client):
 
         """
         loop = asyncio.get_event_loop()
-        loop.run_until_complete(self._async_connect_to_cohort(server_guid, cohort_name))
+        loop.run_until_complete(
+            self._async_connect_to_cohort(cohort_name, server_guid, server_name)
+        )
         return
 
     async def _async_disconnect_from_cohort(
-        self,
-        server_guid: str,
-        cohort_name: str,
+        self, cohort_name: str, server_guid: str = None, server_name: str = None
     ) -> None:
         """Disconnect communications from a specific cohort.  Async version.
 
@@ -136,8 +193,10 @@ class RuntimeManager(Client):
 
         Parameters
         ----------
-        server_guid : str
-            Identity of the server to act on.
+        server_guid : str, default = None
+            Identity of the server to act on. If not specified, server_name must be.
+        server_name: str, default = None
+            Name of server to act on. If not specified, server_guid must be.
         cohort_name : str
             Name of the cohort to join
 
@@ -152,7 +211,7 @@ class RuntimeManager(Client):
         UserNotAuthorizedException
 
         """
-
+        server_guid = self.__get_guid__(server_guid, server_name)
         url = (
             f"{self.cur_command_root}/cohort-members/"
             f"{server_guid}/cohorts/{cohort_name}/disconnect"
@@ -161,9 +220,7 @@ class RuntimeManager(Client):
         return
 
     def disconnect_from_cohort(
-        self,
-        server_guid: str,
-        cohort_name: str,
+        self, cohort_name: str, server_guid: str = None, server_name: str = None
     ) -> None:
         """Disconnect communications from a specific cohort.
 
@@ -171,8 +228,10 @@ class RuntimeManager(Client):
 
         Parameters
         ----------
-        server_guid: str
-           Identity of the server to act on.
+        server_guid : str, default = None
+            Identity of the server to act on. If not specified, server_name must be.
+        server_name: str, default = None
+            Name of server to act on. If not specified, server_guid must be.
         cohort_name: str
             Name of the cohort to join
 
@@ -189,14 +248,12 @@ class RuntimeManager(Client):
         """
         loop = asyncio.get_event_loop()
         loop.run_until_complete(
-            self._async_disconnect_from_cohort(server_guid, cohort_name)
+            self._async_disconnect_from_cohort(cohort_name, server_guid, server_name)
         )
         return
 
     async def _async_unregister_from_cohort(
-        self,
-        server_guid: str,
-        cohort_name: str,
+        self, cohort_name: str, server_guid: str = None, server_name: str = None
     ) -> None:
         """Unregister from a specific cohort and disconnect from cohort communications.  Async version.
 
@@ -204,8 +261,10 @@ class RuntimeManager(Client):
 
         Parameters
         ----------
-        server_guid : str
-            Identity of the server to act on.
+         server_guid : str, default = None
+            Identity of the server to act on. If not specified, server_name must be.
+        server_name: str, default = None
+            Name of server to act on. If not specified, server_guid must be.
         cohort_name : str
             Name of the cohort to join
 
@@ -220,7 +279,7 @@ class RuntimeManager(Client):
         UserNotAuthorizedException
 
         """
-
+        server_guid = self.__get_guid__(server_guid, server_name)
         url = (
             f"{self.cur_command_root}/cohort-members/"
             f"{server_guid}/cohorts/{cohort_name}/unregister"
@@ -229,17 +288,17 @@ class RuntimeManager(Client):
         return
 
     def unregister_from_cohort(
-        self,
-        server_guid: str,
-        cohort_name: str,
+        self, cohort_name: str, server_guid: str = None, server_name: str = None
     ) -> None:
         """Unregister from a specific cohort and disconnect from cohort communications.
             https://egeria-project.org/concepts/cohort-member/
 
         Parameters
         ----------
-        server_guid: str
-           Identity of the server to act on.
+        server_guid : str, default = None
+            Identity of the server to act on. If not specified, server_name must be.
+        server_name: str, default = None
+            Name of server to act on. If not specified, server_guid must be.
         cohort_name: str
             Name of the cohort to join
 
@@ -256,7 +315,7 @@ class RuntimeManager(Client):
         """
         loop = asyncio.get_event_loop()
         loop.run_until_complete(
-            self._async_disconnect_from_cohort(server_guid, cohort_name)
+            self._async_disconnect_from_cohort(cohort_name, server_guid, server_name)
         )
         return
 
@@ -266,8 +325,9 @@ class RuntimeManager(Client):
 
     async def _async_refresh_gov_eng_config(
         self,
-        server_guid: str,
         gov_engine_name: str = None,
+        server_guid: str = None,
+        server_name: str = None,
     ) -> None:
         """Request that the governance engine refresh its configuration by calling the metadata server. This request is
             useful if the metadata server has an outage, particularly while the governance server is initializing.
@@ -277,8 +337,12 @@ class RuntimeManager(Client):
 
         Parameters
         ----------
-        server_guid : str
-            Identity of the server to act on.
+        server_guid : str, default = None
+            Identity of the server to act on. If not specified, server_name must be.
+        server_name: str, default = None
+            Name of server to act on. If not specified, server_guid must be.
+        server_name: str, opt, default is None.
+                        Identity of the server to act on. Either the server_guid or server_name must be provided.
         gov_engine_name : str, Opt
             Name of the governance engine to refresh. If None, then all governance engines will be refreshed.
 
@@ -293,7 +357,7 @@ class RuntimeManager(Client):
         UserNotAuthorizedException
 
         """
-
+        server_guid = self.__get_guid__(server_guid, server_name)
         url = (
             f"{self.cur_command_root}/engine-hosts/"
             f"{server_guid}/governance_engines/{gov_engine_name}/refresh-config"
@@ -303,8 +367,9 @@ class RuntimeManager(Client):
 
     def refresh_gov_eng_config(
         self,
-        server_guid: str,
         gov_engine_name: str = None,
+        server_guid: str = None,
+        server_name: str = None,
     ) -> None:
         """Request that the governance engine refresh its configuration by calling the metadata server. This request is
             useful if the metadata server has an outage, particularly while the governance server is initializing.
@@ -314,8 +379,10 @@ class RuntimeManager(Client):
 
         Parameters
         ----------
-        server_guid : str
-            Identity of the server to act on.
+        server_guid : str, default = None
+            Identity of the server to act on. If not specified, server_name must be.
+        server_name: str, default = None
+            Name of server to act on. If not specified, server_guid must be.
         gov_engine_name : str
             Name of the governance engine to refresh. If None, then all governance engines will be refreshed.
 
@@ -332,7 +399,9 @@ class RuntimeManager(Client):
         """
         loop = asyncio.get_event_loop()
         loop.run_until_complete(
-            self._async_refresh_gov_eng_config(server_guid, gov_engine_name)
+            self._async_refresh_gov_eng_config(
+                gov_engine_name, server_guid, server_name
+            )
         )
         return
 
@@ -340,9 +409,7 @@ class RuntimeManager(Client):
     #   Integration Connector Methods
     #
     async def _async_get_integ_connector_config_properties(
-        self,
-        server_guid: str,
-        connector_name: str,
+        self, connector_name: str, server_guid: str = None, server_name: str = None
     ) -> dict | str:
         """Retrieve the configuration properties of the named integration connector running in the integration daemon.
             Async version.
@@ -351,8 +418,10 @@ class RuntimeManager(Client):
 
         Parameters
         ----------
-        server_guid : str
-            Identity of the server to act on.
+        server_guid : str, default = None
+            Identity of the server to act on. If not specified, server_name must be.
+        server_name: str, default = None
+            Name of server to act on. If not specified, server_guid must be.
         connector_name : str
             Name of the integration connector to retrieve properties for.
 
@@ -367,7 +436,7 @@ class RuntimeManager(Client):
         UserNotAuthorizedException
 
         """
-
+        server_guid = self.__get_guid__(server_guid, server_name)
         url = (
             f"{self.cur_command_root}/integration-daemons/"
             f"{server_guid}/integration-connectors/{connector_name}/configuration-properties"
@@ -376,9 +445,7 @@ class RuntimeManager(Client):
         return response.json().get("properties", "No pproperties found")
 
     def get_integ_connector_config_properties(
-        self,
-        server_guid: str,
-        connector_name: str,
+        self, connector_name: str, server_guid: str = None, server_name: str = None
     ) -> dict | str:
         """Retrieve the configuration properties of the named integration connector running in the integration daemon.
             Async version.
@@ -387,8 +454,10 @@ class RuntimeManager(Client):
 
         Parameters
         ----------
-        server_guid : str
-            Identity of the server to act on.
+        server_guid : str, default = None
+            Identity of the server to act on. If not specified, server_name must be.
+        server_name: str, default = None
+            Name of server to act on. If not specified, server_guid must be.
         connector_name : str
             Name of the integration connector to retrieve properties for.
         Returns
@@ -405,15 +474,16 @@ class RuntimeManager(Client):
         loop = asyncio.get_event_loop()
         response = loop.run_until_complete(
             self._async_get_integ_connector_config_properties(
-                server_guid, connector_name
+                connector_name, server_guid, server_name
             )
         )
         return response
 
     async def _async_update_connector_connection(
         self,
-        server_guid: str,
         connector_name: str,
+        server_guid: str = None,
+        server_name: str = None,
         merge_update: bool = False,
         config_properties: dict = None,
     ) -> None:
@@ -425,8 +495,10 @@ class RuntimeManager(Client):
 
         Parameters
         ----------
-        server_guid : str
-            Identity of the server to act on.
+        server_guid : str, default = None
+            Identity of the server to act on. If not specified, server_name must be.
+        server_name: str, default = None
+            Name of server to act on. If not specified, server_guid must be.
         connector_name : str
             Name of the integration connector to retrieve properties for.
         merge_update : bool, optional, default = False
@@ -446,7 +518,7 @@ class RuntimeManager(Client):
         UserNotAuthorizedException
 
         """
-
+        server_guid = self.__get_guid__(server_guid, server_name)
         url = (
             f"{self.cur_command_root}/integration-daemons/"
             f"{server_guid}/integration-connectors/{connector_name}/configuration-properties"
@@ -463,8 +535,9 @@ class RuntimeManager(Client):
 
     def update_connector_connection(
         self,
-        server_guid: str,
         connector_name: str,
+        server_guid: str = None,
+        server_name: str = None,
         merge_update: bool = False,
         config_properties: dict = None,
     ) -> None:
@@ -475,8 +548,10 @@ class RuntimeManager(Client):
 
         Parameters
         ----------
-        server_guid : str
-            Identity of the server to act on.
+        server_guid : str, default = None
+            Identity of the server to act on. If not specified, server_name must be.
+        server_name: str, default = None
+            Name of server to act on. If not specified, server_guid must be.
         connector_name : str
             Name of the integration connector to retrieve properties for.
         merge_update : bool, optional, default = False
@@ -499,13 +574,21 @@ class RuntimeManager(Client):
         loop = asyncio.get_event_loop()
         loop.run_until_complete(
             self._async_update_connector_connection(
-                server_guid, connector_name, merge_update, config_properties
+                connector_name,
+                server_guid,
+                server_name,
+                merge_update,
+                config_properties,
             )
         )
         return
 
     async def _async_update_endpoint_address(
-        self, server_guid: str, connector_name: str, endpoint_address: str
+        self,
+        connector_name: str,
+        endpoint_address: str,
+        server_guid: str = None,
+        server_name: str = None,
     ) -> None:
         """Update the endpoint network address for a specific integration connector.  Typically used for discovery.
             This update is in memory and will not persist over a server restart. Async version.
@@ -514,8 +597,10 @@ class RuntimeManager(Client):
 
         Parameters
         ----------
-        server_guid : str
-            Identity of the server to act on.
+        server_guid : str, default = None
+            Identity of the server to act on. If not specified, server_name must be.
+        server_name: str, default = None
+            Name of server to act on. If not specified, server_guid must be.
         connector_name : str
             Name of the integration connector to retrieve properties for.
         endpoint_address : str
@@ -533,7 +618,7 @@ class RuntimeManager(Client):
         UserNotAuthorizedException
 
         """
-
+        server_guid = self.__get_guid__(server_guid, server_name)
         url = (
             f"{self.cur_command_root}/integration-daemons/"
             f"{server_guid}/integration-connectors/{connector_name}/endpoint-network-address"
@@ -547,7 +632,11 @@ class RuntimeManager(Client):
         return
 
     def update_endpoint_address(
-        self, server_guid: str, connector_name: str, endpoint_address: str
+        self,
+        connector_name: str,
+        endpoint_address: str,
+        server_guid: str = None,
+        server_name: str = None,
     ) -> None:
         """Update the endpoint network address for a specific integration connector.  Typically used for discovery.
             This update is in memory and will not persist over a server restart. Async version.
@@ -556,8 +645,10 @@ class RuntimeManager(Client):
 
         Parameters
         ----------
-        server_guid : str
-            Identity of the server to act on.
+        server_guid : str, default = None
+            Identity of the server to act on. If not specified, server_name must be.
+        server_name: str, default = None
+            Name of server to act on. If not specified, server_guid must be.
         connector_name : str
             Name of the integration connector to retrieve properties for.
         endpoint_address : str
@@ -578,13 +669,16 @@ class RuntimeManager(Client):
         loop = asyncio.get_event_loop()
         loop.run_until_complete(
             self._async_update_endpoint_address(
-                server_guid, connector_name, endpoint_address
+                connector_name, endpoint_address, server_guid, server_name
             )
         )
         return
 
     async def _async_refresh_integration_connectors(
-        self, server_guid: str, connector_name: str = None
+        self,
+        connector_name: str = None,
+        server_guid: str = None,
+        server_name: str = None,
     ) -> None:
         """Issue a refresh() request on all connectors running in the integration daemon, or a specific connector if
             the connector name is specified. Async version.
@@ -593,8 +687,10 @@ class RuntimeManager(Client):
 
         Parameters
         ----------
-        server_guid : str
-            Identity of the server to act on.
+        server_guid : str, default = None
+            Identity of the server to act on. If not specified, server_name must be.
+        server_name: str, default = None
+            Name of server to act on. If not specified, server_guid must be.
         connector_name : str, opt
             Name of the integration connector to retrieve properties for. If None, all connectors refreshed.
 
@@ -609,7 +705,7 @@ class RuntimeManager(Client):
         UserNotAuthorizedException
 
         """
-
+        server_guid = self.__get_guid__(server_guid, server_name)
         url = (
             f"{self.cur_command_root}/integration-daemons/"
             f"{server_guid}/integration-connectors/refresh"
@@ -623,7 +719,10 @@ class RuntimeManager(Client):
         return
 
     def refresh_integration_connectors(
-        self, server_guid: str, connector_name: str = None
+        self,
+        connector_name: str = None,
+        server_guid: str = None,
+        server_name: str = None,
     ) -> None:
         """Issue a refresh() request on all connectors running in the integration daemon, or a specific connector if
             the connector name is specified.
@@ -632,8 +731,10 @@ class RuntimeManager(Client):
 
         Parameters
         ----------
-        server_guid : str
-            Identity of the server to act on.
+        server_guid : str, default = None
+            Identity of the server to act on. If not specified, server_name must be.
+        server_name: str, default = None
+            Name of server to act on. If not specified, server_guid must be.
         connector_name : str, opt
             Name of the integration connector to retrieve properties for. If None, all connectors refreshed.
 
@@ -650,12 +751,17 @@ class RuntimeManager(Client):
         """
         loop = asyncio.get_event_loop()
         loop.run_until_complete(
-            self._async_refresh_integration_connectors(server_guid, connector_name)
+            self._async_refresh_integration_connectors(
+                connector_name, server_guid, server_name
+            )
         )
         return
 
     async def _async_restart_integration_connectors(
-        self, server_guid: str, connector_name: str = None
+        self,
+        connector_name: str = None,
+        server_guid: str = None,
+        server_name: str = None,
     ) -> None:
         """Issue a restart() request on all connectors running in the integration daemon, or a specific connector if
             the connector name is specified. Async version.
@@ -664,8 +770,10 @@ class RuntimeManager(Client):
 
         Parameters
         ----------
-        server_guid : str
-            Identity of the server to act on.
+        server_guid : str, default = None
+            Identity of the server to act on. If not specified, server_name must be.
+        server_name: str, default = None
+            Name of server to act on. If not specified, server_guid must be.
         connector_name : str, opt
             Name of the integration connector to retrieve properties for. If None, all connectors restarted.
 
@@ -680,7 +788,7 @@ class RuntimeManager(Client):
         UserNotAuthorizedException
 
         """
-
+        server_guid = self.__get_guid__(server_guid, server_name)
         url = (
             f"{self.cur_command_root}/integration-daemons/"
             f"{server_guid}/integration-connectors/restart"
@@ -694,7 +802,10 @@ class RuntimeManager(Client):
         return
 
     def restart_integration_connectors(
-        self, server_guid: str, connector_name: str = None
+        self,
+        connector_name: str = None,
+        server_guid: str = None,
+        server_name: str = None,
     ) -> None:
         """Issue a restart() request on all connectors running in the integration daemon, or a specific connector if
             the connector name is specified.
@@ -703,8 +814,10 @@ class RuntimeManager(Client):
 
         Parameters
         ----------
-        server_guid : str
-            Identity of the server to act on.
+        server_guid : str, default = None
+            Identity of the server to act on. If not specified, server_name must be.
+        server_name: str, default = None
+            Name of server to act on. If not specified, server_guid must be.
         connector_name : str, opt
             Name of the integration connector to retrieve properties for. If None, all connectors restarted.
 
@@ -721,12 +834,17 @@ class RuntimeManager(Client):
         """
         loop = asyncio.get_event_loop()
         loop.run_until_complete(
-            self._async_restart_integration_connectors(server_guid, connector_name)
+            self._async_restart_integration_connectors(
+                connector_name, server_guid, server_name
+            )
         )
         return
 
     async def _async_refresh_integ_group_config(
-        self, server_guid: str, integ_group_name: str = None
+        self,
+        integ_group_name: str = None,
+        server_guid: str = None,
+        server_name: str = None,
     ) -> None:
         """Request that the integration group refresh its configuration by calling the metadata access server.
             Changes to the connector configuration will result in the affected connectors being restarted.
@@ -737,8 +855,10 @@ class RuntimeManager(Client):
 
         Parameters
         ----------
-        server_guid : str
-            Identity of the server to act on.
+        server_guid : str, default = None
+            Identity of the server to act on. If not specified, server_name must be.
+        server_name: str, default = None
+            Name of server to act on. If not specified, server_guid must be.
         integ_group_name : str, opt, default = None
             Name of the integration group to refresh. If None, all groups are refreshed.
 
@@ -753,7 +873,7 @@ class RuntimeManager(Client):
         UserNotAuthorizedException
 
         """
-
+        server_guid = self.__get_guid__(server_guid, server_name)
         url = (
             f"{self.cur_command_root}/integration-daemons/"
             f"{server_guid}/integration-groups/{integ_group_name}/refresh-config"
@@ -763,7 +883,10 @@ class RuntimeManager(Client):
         return
 
     def refresh_integ_group_config(
-        self, server_guid: str, integ_group_name: str = None
+        self,
+        integ_group_name: str = None,
+        server_guid: str = None,
+        server_name: str = None,
     ) -> None:
         """Request that the integration group refresh its configuration by calling the metadata access server.
             Changes to the connector configuration will result in the affected connectors being restarted.
@@ -774,8 +897,10 @@ class RuntimeManager(Client):
 
         Parameters
         ----------
-        server_guid : str
-            Identity of the server to act on.
+        server_guid : str, default = None
+            Identity of the server to act on. If not specified, server_name must be.
+        server_name: str, default = None
+            Name of server to act on. If not specified, server_guid must be.
         integ_group_name : str, opt, default = None
             Name of the integration group to refresh. If None, all groups are refreshed.
 
@@ -792,7 +917,9 @@ class RuntimeManager(Client):
         """
         loop = asyncio.get_event_loop()
         loop.run_until_complete(
-            self._async_refresh_integ_group_config(server_guid, integ_group_name)
+            self._async_refresh_integ_group_config(
+                integ_group_name, server_guid, server_name
+            )
         )
         return
 
@@ -800,7 +927,10 @@ class RuntimeManager(Client):
     # Open Lineage & Archives
     #
     async def _async_publish_open_lineage_event(
-        self, server_guid: str, ol_event: dict
+        self,
+        ol_event: dict,
+        server_guid: str = None,
+        server_name: str = None,
     ) -> None:
         """Send an Open Lineage event to the integration daemon. It will pass it on to the integration connectors that
             have registered a listener for open lineage events. Async version.
@@ -809,8 +939,10 @@ class RuntimeManager(Client):
 
         Parameters
         ----------
-        server_guid : str
-            Identity of the server to act on.
+        server_guid : str, default = None
+            Identity of the server to act on. If not specified, server_name must be.
+        server_name: str, default = None
+            Name of server to act on. If not specified, server_guid must be.
         ol_event : dict
             Dict containing the user specified Open Lineage event.
 
@@ -825,7 +957,7 @@ class RuntimeManager(Client):
         UserNotAuthorizedException
 
         """
-
+        server_guid = self.__get_guid__(server_guid, server_name)
         url = (
             f"{self.cur_command_root}/integration-daemons/"
             f"{server_guid}/integration-daemons/{server_guid}/open-lineage-events/publish"
@@ -834,7 +966,12 @@ class RuntimeManager(Client):
         await self._async_make_request("POST", url, ol_event)
         return
 
-    def publish_open_lineage_event(self, server_guid: str, ol_event: dict) -> None:
+    def publish_open_lineage_event(
+        self,
+        ol_event: dict,
+        server_guid: str = None,
+        server_name: str = None,
+    ) -> None:
         """Send an Open Lineage event to the integration daemon. It will pass it on to the integration connectors that
             have registered a listener for open lineage events.
 
@@ -842,8 +979,10 @@ class RuntimeManager(Client):
 
         Parameters
         ----------
-        server_guid : str
-            Identity of the server to act on.
+        server_guid : str, default = None
+            Identity of the server to act on. If not specified, server_name must be.
+        server_name: str, default = None
+            Name of server to act on. If not specified, server_guid must be.
         ol_event : dict
             Dict containing the user specified Open Lineage event.
 
@@ -860,12 +999,16 @@ class RuntimeManager(Client):
         """
         loop = asyncio.get_event_loop()
         loop.run_until_complete(
-            self._async_publish_open_lineage_event(server_guid, ol_event)
+            self._async_publish_open_lineage_event(ol_event, server_guid, server_name)
         )
         return
 
     async def _async_add_archive_content(
-        self, server_guid: str, archive_content: dict, time_out: int = 60
+        self,
+        archive_content: dict,
+        server_guid: str = None,
+        server_name: str = None,
+        time_out: int = 60,
     ) -> None:
         """An open metadata archive contains metadata types and instances.
             This operation loads the supplied open metadata archive into the local repository. It can be used with OMAG
@@ -875,8 +1018,10 @@ class RuntimeManager(Client):
 
         Parameters
         ----------
-        server_guid : str
-            Identity of the server to act on.
+        server_guid : str, default = None
+            Identity of the server to act on. If not specified, server_name must be.
+        server_name: str, default = None
+            Name of server to act on. If not specified, server_guid must be.
         archive_content : dict
             A dict containing the content of the archive to load.
         time_out : int, optional, default = 60 seconds
@@ -893,7 +1038,7 @@ class RuntimeManager(Client):
         UserNotAuthorizedException
 
         """
-
+        server_guid = self.__get_guid__(server_guid, server_name)
         url = (
             f"{self.cur_command_root}/metadata-access-stores/{server_guid}/instance/load/open-metadata-archives/"
             f"archive-content"
@@ -903,7 +1048,11 @@ class RuntimeManager(Client):
         return
 
     def add_archive_content(
-        self, server_guid: str, archive_content: dict, time_out: int = 60
+        self,
+        archive_content: dict,
+        server_guid: str = None,
+        server_name: str = None,
+        time_out: int = 60,
     ) -> None:
         """An open metadata archive contains metadata types and instances.
             This operation loads the supplied open metadata archive into the local repository. It can be used with OMAG
@@ -913,10 +1062,13 @@ class RuntimeManager(Client):
 
         Parameters
         ----------
-        server_guid : str
-            Identity of the server to act on.
         archive_content : dict
             A dict containing the content of the archive to load.
+        server_guid : str, default = None
+            Identity of the server to act on. If not specified, server_name must be.
+        server_name: str, default = None
+            Name of server to act on. If not specified, server_guid must be.
+
         time_out : int, optional, default = 60 seconds
             Timeout for the REST call.
 
@@ -934,7 +1086,7 @@ class RuntimeManager(Client):
         loop = asyncio.get_event_loop()
         loop.run_until_complete(
             self._async_add_archive_content(
-                server_guid, archive_content, time_out=time_out
+                archive_content, server_guid, server_name, time_out=time_out
             )
         )
         return
@@ -942,7 +1094,8 @@ class RuntimeManager(Client):
     async def _async_add_archive_file(
         self,
         archive_file: str,
-        server_guid: str,
+        server_guid: str = None,
+        server_name: str = None,
         time_out: int = 60,
     ) -> None:
         """Add a new open metadata archive to running OMAG Server's repository.
@@ -956,8 +1109,10 @@ class RuntimeManager(Client):
         ----------
         archive_file: str
             Open metadata archive file to load.
-        server_guid: str
-            GUID of the server to load the file into.
+        server_guid : str, default = None
+            Identity of the server to act on. If not specified, server_name must be.
+        server_name: str, default = None
+            Name of server to act on. If not specified, server_guid must be.
         time_out: int, optional
            Time out for the rest call.
 
@@ -973,7 +1128,7 @@ class RuntimeManager(Client):
         UserNotAuthorizedException
 
         """
-
+        server_guid = self.__get_guid__(server_guid, server_name)
         url = f"{self.cur_command_root}/metadata-access-stores/{server_guid}/instance/load/open-metadata-archives/file"
 
         await self._async_make_request(
@@ -984,7 +1139,8 @@ class RuntimeManager(Client):
     def add_archive_file(
         self,
         archive_file: str,
-        server_guid: str,
+        server_guid: str = None,
+        server_name: str = None,
         time_out: int = 60,
     ) -> None:
         """Add a new open metadata archive to running OMAG Server's repository.
@@ -997,8 +1153,10 @@ class RuntimeManager(Client):
         ----------
         archive_file: str
             Open metadata archive file to load.
-        server_guid: str
-            GUID of the server to load the file into.
+        server_guid : str, default = None
+            Identity of the server to act on. If not specified, server_name must be.
+        server_name: str, default = None
+            Name of server to act on. If not specified, server_guid must be.
         time_out: int, optional, default = 60 seconds
 
         Returns
@@ -1016,21 +1174,27 @@ class RuntimeManager(Client):
 
         loop = asyncio.get_event_loop()
         loop.run_until_complete(
-            self._async_add_archive_file(archive_file, server_guid, time_out)
+            self._async_add_archive_file(
+                archive_file, server_guid, server_name, time_out
+            )
         )
         return
 
     #
     # Server & Platform admin
     #
-    async def _async_shutdown_and_unregister_server(self, server_guid: str) -> None:
+    async def _async_shutdown_and_unregister_server(
+        self, server_guid: str = None, server_name: str = None
+    ) -> None:
         """Shutdown the named OMAG server. The server will also be removed from any open metadata repository cohorts
             it has registered with.  Async version.
 
         Parameters
         ----------
-        server_guid : str
-            Identity of the server to act on.
+        server_guid : str, default = None
+            Identity of the server to act on. If not specified, server_name must be.
+        server_name: str, default = None
+            Name of server to act on. If not specified, server_guid must be.
 
         Returns
         -------
@@ -1044,21 +1208,25 @@ class RuntimeManager(Client):
         UserNotAuthorizedException
 
         """
-
+        server_guid = self.__get_guid__(server_guid, server_name)
         url = f"{self.cur_command_root}/omag-servers/{server_guid}"
 
         await self._async_make_request("DELETE", url)
 
         return
 
-    def shutdown_and_unregister_server(self, server_guid: str) -> None:
+    def shutdown_and_unregister_server(
+        self, server_guid: str = None, server_name: str = None
+    ) -> None:
         """Shutdown the named OMAG server. The server will also be removed from any open metadata repository cohorts
             it has registered with.
 
         Parameters
         ----------
-        server_guid : str
-            Identity of the server to act on.
+        server_guid : str, default = None
+            Identity of the server to act on. If not specified, server_name must be.
+        server_name: str, default = None
+            Name of server to act on. If not specified, server_guid must be.
 
         Returns
         -------
@@ -1073,10 +1241,14 @@ class RuntimeManager(Client):
 
         """
         loop = asyncio.get_event_loop()
-        loop.run_until_complete(self._async_shutdown_and_unregister_server(server_guid))
+        loop.run_until_complete(
+            self._async_shutdown_and_unregister_server(server_guid, server_name)
+        )
         return
 
-    async def _async_activate_server_with_stored_config(self, server_guid: str) -> None:
+    async def _async_activate_server_with_stored_config(
+        self, server_guid: str = None, server_name: str = None
+    ) -> None:
         """Activate the named OMAG server using the appropriate configuration document found in the
             configuration store. Async version.
 
@@ -1084,8 +1256,10 @@ class RuntimeManager(Client):
 
         Parameters
         ----------
-        server_guid : str
-            Identity of the server to act on.
+        server_guid : str, default = None
+            Identity of the server to act on. If not specified, server_name must be.
+        server_name: str, default = None
+            Name of server to act on. If not specified, server_guid must be.
 
         Returns
         -------
@@ -1098,13 +1272,15 @@ class RuntimeManager(Client):
         UserNotAuthorizedException
 
         """
-
+        server_guid = self.__get_guid__(server_guid, server_name)
         url = f"{self.cur_command_root}/omag-servers/{server_guid}/instance"
 
         await self._async_make_request("POST", url)
         return
 
-    def activate_server_with_stored_config(self, server_guid: str) -> None:
+    def activate_server_with_stored_config(
+        self, server_guid: str = None, server_name: str = None
+    ) -> None:
         """Activate the named OMAG server using the appropriate configuration document found in the
             configuration store.
 
@@ -1112,8 +1288,10 @@ class RuntimeManager(Client):
 
         Parameters
         ----------
-        server_guid : str
-            Identity of the server to act on.
+        server_guid : str, default = None
+            Identity of the server to act on. If not specified, server_name must be.
+        server_name: str, default = None
+            Name of server to act on. If not specified, server_guid must be.
 
         Returns
         -------
@@ -1128,17 +1306,21 @@ class RuntimeManager(Client):
         """
         loop = asyncio.get_event_loop()
         loop.run_until_complete(
-            self._async_activate_server_with_stored_config(server_guid)
+            self._async_activate_server_with_stored_config(server_guid, server_name)
         )
         return
 
-    async def _async_shutdown_server(self, server_guid: str) -> None:
+    async def _async_shutdown_server(
+        self, server_guid: str = None, server_name: str = None
+    ) -> None:
         """Temporarily shutdown the named OMAG server. This server can be restarted as a later time.  Async version.
 
         Parameters
         ----------
-        server_guid : str
-            Identity of the server to act on.
+        server_guid : str, default = None
+            Identity of the server to act on. If not specified, server_name must be.
+        server_name: str, default = None
+            Name of server to act on. If not specified, server_guid must be.
 
         Returns
         -------
@@ -1152,20 +1334,22 @@ class RuntimeManager(Client):
         UserNotAuthorizedException
 
         """
-
+        server_guid = self.__get_guid__(server_guid, server_name)
         url = f"{self.cur_command_root}/omag-servers/{server_guid}/instance"
 
         await self._async_make_request("DELETE", url)
 
         return
 
-    def shutdown_server(self, server_guid: str) -> None:
+    def shutdown_server(self, server_guid: str = None, server_name: str = None) -> None:
         """Temporarily shutdown the named OMAG server. This server can be restarted as a later time.
 
         Parameters
         ----------
-        server_guid : str
-            Identity of the server to act on.
+        server_guid : str, default = None
+            Identity of the server to act on. If not specified, server_name must be.
+        server_name: str, default = None
+            Name of server to act on. If not specified, server_guid must be.
 
         Returns
         -------
@@ -1180,7 +1364,7 @@ class RuntimeManager(Client):
 
         """
         loop = asyncio.get_event_loop()
-        loop.run_until_complete(self._async_shutdown_server(server_guid))
+        loop.run_until_complete(self._async_shutdown_server(server_guid, server_name))
         return
 
     def get_platforms_by_name(
@@ -1461,13 +1645,17 @@ class RuntimeManager(Client):
         )
         return response
 
-    async def _async_get_platform_report(self, platform_guid: str = None) -> str | list:
+    async def _async_get_platform_report(
+        self, platform_guid: str = None, platform_name: str = None
+    ) -> str | list:
         """Returns details about the running platform. Async version.
 
         Parameters
         ----------
         platform_guid : str
-            The unique identifier for the platform.
+            The unique identifier for the platform. If not specified, platform_name must be.
+        platform_name: str, default = None
+            Name of server to act on. If not specified, platform_guid must be.
 
         Returns
         -------
@@ -1481,21 +1669,24 @@ class RuntimeManager(Client):
         UserNotAuthorizedException
 
         """
-
+        platform_guid = self.__get_guid__(platform_guid, platform_name)
         url = f"{self.cur_command_root}/platforms/{platform_guid}/report"
 
         response = await self._async_make_request("GET", url)
 
         return response.json().get("element", "No platforms found")
 
-    def get_platform_report(self, platform_guid: str = None) -> str | list:
+    def get_platform_report(
+        self, platform_guid: str = None, platform_name: str = None
+    ) -> str | list:
         """Returns details about the running platform.
 
         Parameters
         ----------
         platform_guid : str
-            The unique identifier for the platform.
-
+            The unique identifier for the platform. If not specified, platform_name must be.
+        platform_name: str, default = None
+            Name of server to act on. If not specified, platform_guid must be.
         Returns
         -------
         Response
@@ -1510,7 +1701,7 @@ class RuntimeManager(Client):
         """
         loop = asyncio.get_event_loop()
         response = loop.run_until_complete(
-            self._async_get_platform_report(platform_guid)
+            self._async_get_platform_report(platform_guid, platform_name)
         )
         return response
 
@@ -1580,7 +1771,10 @@ class RuntimeManager(Client):
         return response
 
     async def _async_get_server_by_guid(
-        self, server_guid: str, effective_time: str = None
+        self,
+        server_guid: str = None,
+        server_name: str = None,
+        effective_time: str = None,
     ) -> str | dict:
         """Returns details about the server's catalog entry (asset). Async version.
 
@@ -1603,7 +1797,7 @@ class RuntimeManager(Client):
         UserNotAuthorizedException
 
         """
-
+        server_guid = self.__get_guid__(server_guid, server_name)
         url = f"{self.cur_command_root}/software-servers/{server_guid}"
 
         if effective_time is not None:
@@ -1616,7 +1810,10 @@ class RuntimeManager(Client):
         return response.json().get("elements", "No server found")
 
     def get_server_by_guid(
-        self, server_guid: str, effective_time: str = None
+        self,
+        server_guid: str = None,
+        server_name: str = None,
+        effective_time: str = None,
     ) -> str | dict:
         """Returns details about the platform's catalog entry (asset).
 
@@ -1641,7 +1838,7 @@ class RuntimeManager(Client):
         """
         loop = asyncio.get_event_loop()
         response = loop.run_until_complete(
-            self._async_get_server_by_guid(server_guid, effective_time)
+            self._async_get_server_by_guid(server_guid, server_name, effective_time)
         )
         return response
 
@@ -1690,7 +1887,7 @@ class RuntimeManager(Client):
             body = {"filter": filter, "effective_time": effective_time}
         response = await self._async_make_request("POST", url, body)
 
-        return response.json().get("elements", "No platforms found")
+        return response.json().get("elements", "No servers found")
 
     def get_servers_by_name(
         self, filter: str, effective_time: str = None
@@ -1909,13 +2106,17 @@ class RuntimeManager(Client):
         )
         return response
 
-    async def _async_get_server_report(self, server_guid: str = None) -> str | list:
+    async def _async_get_server_report(
+        self, server_guid: str = None, server_name: str = None
+    ) -> str | list:
         """Returns details about the running server. Async version.
 
         Parameters
         ----------
-        server_guid: str
-            Identity of the server to report on.
+        server_guid : str, default = None
+            Identity of the server to act on. If not specified, server_name must be.
+        server_name: str, default = None
+            Name of server to act on. If not specified, server_guid must be.
 
         Returns
         -------
@@ -1929,20 +2130,24 @@ class RuntimeManager(Client):
         UserNotAuthorizedException
 
         """
-
+        server_guid = self.__get_guid__(server_guid, server_name)
         url = f"{self.cur_command_root}/omag-servers/{server_guid}/instance/report"
 
         response = await self._async_make_request("GET", url)
 
         return response.json().get("element", "No server found")
 
-    def get_server_report(self, server_guid: str = None) -> str | list:
+    def get_server_report(
+        self, server_guid: str = None, server_name: str = None
+    ) -> str | list:
         """Returns details about the running server.
 
         Parameters
         ----------
-        server_guid: str
-            Identity of the server to report on.
+        server_guid : str, default = None
+            Identity of the server to act on. If not specified, server_name must be.
+        server_name: str, default = None
+            Name of server to act on. If not specified, server_guid must be.
 
         Returns
         -------
@@ -1957,7 +2162,9 @@ class RuntimeManager(Client):
 
         """
         loop = asyncio.get_event_loop()
-        response = loop.run_until_complete(self._async_get_server_report(server_guid))
+        response = loop.run_until_complete(
+            self._async_get_server_report(server_guid, server_name)
+        )
         return response