Connector reachability

Author: ofiriluz

ark_sdk_python/models/actions/services/ark_sia_exec_action_consts.py

@@ -14,7 +14,12 @@
 )
 from ark_sdk_python.models.cli_services.sia.policies_editor.db import ArkSIADBGeneratePolicy
 from ark_sdk_python.models.cli_services.sia.policies_editor.vm import ArkSIAVMGeneratePolicy
-from ark_sdk_python.models.services.sia.access import ArkSIAGetConnectorSetupScript, ArkSIAInstallConnector, ArkSIAUninstallConnector
+from ark_sdk_python.models.services.sia.access import (
+    ArkSIAGetConnectorSetupScript,
+    ArkSIAInstallConnector,
+    ArkSIATestConnectorReachability,
+    ArkSIAUninstallConnector,
+)
 from ark_sdk_python.models.services.sia.certificates import (
     ArkSIACertificatesFilter,
     ArkSIACreateCertificate,
@@ -249,6 +254,7 @@
     'connector-setup-script': ArkSIAGetConnectorSetupScript,
     'install-connector': ArkSIAInstallConnector,
     'uninstall-connector': ArkSIAUninstallConnector,
+    'test-connector-reachability': ArkSIATestConnectorReachability,
 }
 ACCESS_ACTION: Final[ArkServiceActionDefinition] = ArkServiceActionDefinition(
     action_name='access',

ark_sdk_python/models/services/sia/access/__init__.py

@@ -2,12 +2,14 @@
 from ark_sdk_python.models.services.sia.access.ark_sia_connector_setup_script import ArkSIAConnectorSetupScript
 from ark_sdk_python.models.services.sia.access.ark_sia_get_connector_setup_script import ArkSIAGetConnectorSetupScript
 from ark_sdk_python.models.services.sia.access.ark_sia_install_connector import ArkSIAInstallConnector
+from ark_sdk_python.models.services.sia.access.ark_sia_test_connector_reachability import ArkSIATestConnectorReachability
 from ark_sdk_python.models.services.sia.access.ark_sia_uninstall_connector import ArkSIAUninstallConnector
 
 __all__ = [
     'ArkSIAGetConnectorSetupScript',
     'ArkSIAConnectorSetupScript',
     'ArkSIAInstallConnector',
     'ArkSIAUninstallConnector',
+    'ArkSIATestConnectorReachability',
     'serialize_access_workspace_type',
 ]

ark_sdk_python/services/sia/access/ark_sia_access_service.py

@@ -22,15 +22,18 @@
     ArkSIAConnectorSetupScript,
     ArkSIAGetConnectorSetupScript,
     ArkSIAInstallConnector,
+    ArkSIATestConnectorReachability,
     ArkSIAUninstallConnector,
     serialize_access_workspace_type,
 )
+from ark_sdk_python.models.services.sia.access.ark_sia_test_connector_reachability import ArkSIATestConnectorReachabilityResponse
 from ark_sdk_python.services.ark_service import ArkService
 
 SERVICE_CONFIG: Final[ArkServiceConfig] = ArkServiceConfig(
     service_name='sia-access', required_authenticator_names=['isp'], optional_authenticator_names=[]
 )
 CONNECTORS_SETUP_SCRIPT_API: Final[str] = 'api/connectors/setup-script'
+TEST_CONNECTOR_REACHABILITY_API: Final[str] = 'api/connectors/{connector_id}/reachability'
 
 # Linux / Darwin Commands
 UNIX_STOP_CONNECTOR_SERVICE_CMD: Final[str] = 'sudo systemctl stop cyberark-dpa-connector'
@@ -177,6 +180,34 @@ def __uninstall_connector_on_machine(
         connection.run_command(ArkConnectionCommand(command=cmdset['remove-connector-service']))
         connection.run_command(ArkConnectionCommand(command=cmdset['remove-connector-files']))
 
+    def test_connector_reachability(
+        self, test_connector_reachability: ArkSIATestConnectorReachability
+    ) -> ArkSIATestConnectorReachabilityResponse:
+        """
+        Tests reachability to backend endpoints and target hostname/port from specified connector
+
+        Args:
+            test_connector_reachability (ArkSIATestConnectorReachability): _description_
+
+        Raises:
+            ArkServiceException: _description_
+
+        Returns:
+            Reachability test result: _description_
+        """
+        body = {
+            'checkBackendEndpoints': test_connector_reachability.check_backend_endpoints,
+        }
+        if test_connector_reachability.target_hostname and test_connector_reachability.target_port:
+            body['targets'] = [{'hostname': test_connector_reachability.target_hostname, 'port': test_connector_reachability.target_port}]
+        resp: Response = self.__client.post(
+            TEST_CONNECTOR_REACHABILITY_API.format(connector_id=test_connector_reachability.connector_id),
+            json=body,
+        )
+        if resp.status_code == HTTPStatus.OK:
+            return ArkSIATestConnectorReachabilityResponse(**resp.json())
+        raise ArkServiceException(f'Failed to test connector reachability [{resp.text}] - [{resp.status_code}]')
+
     def connector_setup_script(self, get_connector_setup_script: ArkSIAGetConnectorSetupScript) -> ArkSIAConnectorSetupScript:
         """
         Retrieves a new connector installation setup script

docs/examples/commands_examples.md

@@ -130,17 +130,17 @@ ark_public exec sia secrets vm add-secret --secret-type ProvisionerUser --provis
 ark exec sia access connector-setup-script -ct onprem -co windows -cpi 588741d5-e059-479d-b4c4-3d821a87f012
 ```
 
-### Install a DPA Windows Connector Remotely
+### Install a SIA Windows Connector Remotely
 ```shell
 ark exec sia access install-connector --connector-pool-id abcd --connector-type onprem --connector-os windows --target-machine 1.2.3.4 --username myuser --password mypassword
 ```
 
-### Install a DPA Linux Connector Remotely
+### Install a SIA Linux Connector Remotely
 ```shell
 ark exec sia access install-connector --connector-pool-id abcd --connector-type aws --connector-os linux --target-machine 1.2.3.4 --username ec2-user --private-key-path /path/to/key.pem
 ```
 
-### Delete and uninstall a DPA Connector
+### Delete and uninstall a SIA Connector
 ```shell
 ark exec sia access delete-connector --connector-id=CMSConnector_e9685e0d-a92e-4097-ad4d-b54eadb69bcb_81fa03c5-d0d3-4157-95f8-6a1903900fa0 --uninstall-connector --target-machine 1.2.3.4 --username ec2-user --private-key-path /path/to/key.pem
 ```
@@ -294,3 +294,8 @@ ark exec cmgr add-network --name mynetwork
 ```shell
 ark exec cmgr add-pool --name mypool --assigned-network-ids mynetwork_id
 ```
+
+### Test SIA Connector Reachability
+```shell
+ark exec sia access test-connector-reachability --connector-id CMSConnector_588741d5-e059-479d-b4c4-3d821a87f012_66e0646d-4702-4b9c-81c3-b5b9b4ee2955 --check-backend-endpoints --target-hostname myhost.com --target-port 22
+```

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "ark-sdk-python"
-version = "2.1.1"
+version = "2.1.2"
 description='Official Ark SDK / CLI for CyberArk Identity Security Platform'
 authors = ["CyberArk <[email protected]>", "Ofir Iluz <[email protected]"]
 readme = "README.md"