ark-sdk-python 2.1.4__py3-none-any.whl → 2.2.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (212) hide show
  1. ark_sdk_python/actions/ark_exec_action.py +1 -0
  2. ark_sdk_python/ark_api.py +60 -0
  3. ark_sdk_python/auth/ark_auth.py +6 -1
  4. ark_sdk_python/auth/identity/ark_identity_fqdn_resolver.py +4 -4
  5. ark_sdk_python/common/ark_version.py +1 -1
  6. ark_sdk_python/common/isp/ark_isp_service_client.py +3 -1
  7. ark_sdk_python/examples/license_consumption_analytics.py +1342 -0
  8. ark_sdk_python/examples/validate_ssh_connection.py +11 -4
  9. ark_sdk_python/models/actions/services/__init__.py +6 -0
  10. ark_sdk_python/models/actions/services/ark_access_exec_action_consts.py +20 -0
  11. ark_sdk_python/models/actions/services/ark_ars_exec_action_consts.py +40 -0
  12. ark_sdk_python/models/actions/services/ark_cmgr_exec_action_consts.py +45 -1
  13. ark_sdk_python/models/actions/services/ark_identity_exec_action_consts.py +17 -0
  14. ark_sdk_python/models/actions/services/ark_pcloud_exec_action_consts.py +45 -0
  15. ark_sdk_python/models/actions/services/ark_sia_exec_action_consts.py +80 -4
  16. ark_sdk_python/models/common/ark_application_code.py +5 -0
  17. ark_sdk_python/models/common/ark_os_type.py +1 -0
  18. ark_sdk_python/models/common/ark_region.py +2 -1
  19. ark_sdk_python/models/common/identity/ark_identity_directory_schemas.py +2 -0
  20. ark_sdk_python/models/services/access/__init__.py +15 -0
  21. ark_sdk_python/models/services/access/assets/__init__.py +13 -0
  22. ark_sdk_python/models/services/access/assets/ark_access_assets_asset.py +61 -0
  23. ark_sdk_python/models/services/access/assets/ark_access_assets_assets.py +15 -0
  24. ark_sdk_python/models/services/access/assets/ark_access_assets_list_assets.py +32 -0
  25. ark_sdk_python/models/services/access/assets/ark_access_assets_secret.py +15 -0
  26. ark_sdk_python/models/services/ars/__init__.py +0 -0
  27. ark_sdk_python/models/services/ars/common/__init__.py +9 -0
  28. ark_sdk_python/models/services/ars/common/ark_ars_filter.py +14 -0
  29. ark_sdk_python/models/services/ars/common/ark_ars_query.py +22 -0
  30. ark_sdk_python/models/services/ars/requests/__init__.py +31 -0
  31. ark_sdk_python/models/services/ars/requests/ark_ars_access_request.py +82 -0
  32. ark_sdk_python/models/services/ars/requests/ark_ars_access_request_async_task.py +44 -0
  33. ark_sdk_python/models/services/ars/requests/ark_ars_access_request_form.py +67 -0
  34. ark_sdk_python/models/services/ars/requests/ark_ars_access_request_info.py +23 -0
  35. ark_sdk_python/models/services/ars/requests/ark_ars_access_requests_stats.py +17 -0
  36. ark_sdk_python/models/services/ars/requests/ark_ars_cancel_access_request.py +8 -0
  37. ark_sdk_python/models/services/ars/requests/ark_ars_finalize_access_request.py +20 -0
  38. ark_sdk_python/models/services/ars/requests/ark_ars_get_access_request.py +7 -0
  39. ark_sdk_python/models/services/ars/requests/ark_ars_list_access_request_forms.py +12 -0
  40. ark_sdk_python/models/services/ars/requests/ark_ars_request_type.py +6 -0
  41. ark_sdk_python/models/services/ars/requests/ark_ars_submit_access_request.py +18 -0
  42. ark_sdk_python/models/services/ars/requests/ark_target_category.py +32 -0
  43. ark_sdk_python/models/services/cmgr/__init__.py +59 -3
  44. ark_sdk_python/models/services/cmgr/ark_cmgr_component.py +82 -0
  45. ark_sdk_python/models/services/cmgr/ark_cmgr_component_operation_async_task.py +31 -0
  46. ark_sdk_python/models/services/cmgr/ark_cmgr_components_filter.py +16 -0
  47. ark_sdk_python/models/services/cmgr/ark_cmgr_components_stats.py +15 -0
  48. ark_sdk_python/models/services/cmgr/ark_cmgr_connector.py +52 -0
  49. ark_sdk_python/models/services/cmgr/ark_cmgr_connector_components_filter.py +7 -0
  50. ark_sdk_python/models/services/cmgr/ark_cmgr_connector_setup_script.py +8 -0
  51. ark_sdk_python/models/services/cmgr/ark_cmgr_connectors_filter.py +34 -0
  52. ark_sdk_python/models/services/cmgr/ark_cmgr_connectors_stats.py +31 -0
  53. ark_sdk_python/models/services/cmgr/ark_cmgr_delete_connector.py +24 -0
  54. ark_sdk_python/models/services/cmgr/ark_cmgr_get_connector.py +7 -0
  55. ark_sdk_python/models/services/cmgr/ark_cmgr_get_connector_component.py +8 -0
  56. ark_sdk_python/models/services/cmgr/ark_cmgr_get_connector_setup_script.py +23 -0
  57. ark_sdk_python/models/services/cmgr/ark_cmgr_install_component.py +12 -0
  58. ark_sdk_python/models/services/cmgr/ark_cmgr_install_connector.py +28 -0
  59. ark_sdk_python/models/services/cmgr/ark_cmgr_list_connector_components.py +7 -0
  60. ark_sdk_python/models/services/cmgr/ark_cmgr_reinstall_component.py +8 -0
  61. ark_sdk_python/models/services/cmgr/ark_cmgr_rescan_components.py +7 -0
  62. ark_sdk_python/models/services/cmgr/ark_cmgr_uninstall_component.py +16 -0
  63. ark_sdk_python/models/services/cmgr/ark_cmgr_uninstall_connector.py +21 -0
  64. ark_sdk_python/models/services/cmgr/ark_cmgr_upgrade_component.py +9 -0
  65. ark_sdk_python/models/services/cmgr/ark_cmgr_upgrade_connector.py +7 -0
  66. ark_sdk_python/models/services/cmgr/ark_cmgr_workspace_type_serializer.py +18 -0
  67. ark_sdk_python/models/services/identity/directories/ark_identity_directory.py +4 -0
  68. ark_sdk_python/models/services/identity/federations/__init__.py +15 -0
  69. ark_sdk_python/models/services/identity/federations/ark_identity_federation.py +75 -0
  70. ark_sdk_python/models/services/identity/federations/ark_identity_federations_filter.py +10 -0
  71. ark_sdk_python/models/services/identity/federations/ark_identity_get_federation.py +7 -0
  72. ark_sdk_python/models/services/identity/users/__init__.py +8 -0
  73. ark_sdk_python/models/services/identity/users/ark_identity_get_user_state.py +17 -0
  74. ark_sdk_python/models/services/identity/users/ark_identity_list_user_roles.py +16 -0
  75. ark_sdk_python/models/services/identity/users/ark_identity_user_role.py +12 -0
  76. ark_sdk_python/models/services/identity/users/ark_identity_user_state.py +20 -0
  77. ark_sdk_python/models/services/pcloud/usermgmt/__init__.py +65 -0
  78. ark_sdk_python/models/services/pcloud/usermgmt/ark_pcloud_activate_vault_user.py +7 -0
  79. ark_sdk_python/models/services/pcloud/usermgmt/ark_pcloud_add_vault_group.py +5 -0
  80. ark_sdk_python/models/services/pcloud/usermgmt/ark_pcloud_add_vault_member_to_group.py +15 -0
  81. ark_sdk_python/models/services/pcloud/usermgmt/ark_pcloud_add_vault_user.py +18 -0
  82. ark_sdk_python/models/services/pcloud/usermgmt/ark_pcloud_delete_vault_group.py +7 -0
  83. ark_sdk_python/models/services/pcloud/usermgmt/ark_pcloud_delete_vault_user.py +7 -0
  84. ark_sdk_python/models/services/pcloud/usermgmt/ark_pcloud_disable_vault_user.py +7 -0
  85. ark_sdk_python/models/services/pcloud/usermgmt/ark_pcloud_enable_vault_user.py +7 -0
  86. ark_sdk_python/models/services/pcloud/usermgmt/ark_pcloud_get_vault_group.py +7 -0
  87. ark_sdk_python/models/services/pcloud/usermgmt/ark_pcloud_get_vault_user.py +7 -0
  88. ark_sdk_python/models/services/pcloud/usermgmt/ark_pcloud_remove_vault_member_from_group.py +10 -0
  89. ark_sdk_python/models/services/pcloud/usermgmt/ark_pcloud_update_vault_group.py +10 -0
  90. ark_sdk_python/models/services/pcloud/usermgmt/ark_pcloud_update_vault_user.py +18 -0
  91. ark_sdk_python/models/services/pcloud/usermgmt/ark_pcloud_vault_group.py +22 -0
  92. ark_sdk_python/models/services/pcloud/usermgmt/ark_pcloud_vault_groups_filter.py +12 -0
  93. ark_sdk_python/models/services/pcloud/usermgmt/ark_pcloud_vault_groups_stats.py +10 -0
  94. ark_sdk_python/models/services/pcloud/usermgmt/ark_pcloud_vault_user.py +96 -0
  95. ark_sdk_python/models/services/pcloud/usermgmt/ark_pcloud_vault_users_filter.py +22 -0
  96. ark_sdk_python/models/services/pcloud/usermgmt/ark_pcloud_vault_users_stats.py +12 -0
  97. ark_sdk_python/models/services/sia/access/__init__.py +54 -0
  98. ark_sdk_python/models/services/sia/access/ark_sia_connector.py +119 -0
  99. ark_sdk_python/models/services/sia/access/ark_sia_connectors_filter.py +39 -0
  100. ark_sdk_python/models/services/sia/access/ark_sia_connectors_stats.py +33 -0
  101. ark_sdk_python/models/services/sia/access/ark_sia_delete_connector.py +25 -0
  102. ark_sdk_python/models/services/sia/access/ark_sia_delete_https_relay.py +31 -0
  103. ark_sdk_python/models/services/sia/access/ark_sia_get_connector.py +7 -0
  104. ark_sdk_python/models/services/sia/access/ark_sia_get_connector_setup_script.py +4 -0
  105. ark_sdk_python/models/services/sia/access/ark_sia_get_https_relay.py +7 -0
  106. ark_sdk_python/models/services/sia/access/ark_sia_get_https_relay_setup_script.py +19 -0
  107. ark_sdk_python/models/services/sia/access/ark_sia_https_relay.py +34 -0
  108. ark_sdk_python/models/services/sia/access/ark_sia_https_relay_setup_script.py +8 -0
  109. ark_sdk_python/models/services/sia/access/ark_sia_https_relay_status_codes.py +14 -0
  110. ark_sdk_python/models/services/sia/access/ark_sia_https_relays_filter.py +13 -0
  111. ark_sdk_python/models/services/sia/access/ark_sia_install_connector.py +13 -2
  112. ark_sdk_python/models/services/sia/access/ark_sia_install_relay.py +32 -0
  113. ark_sdk_python/models/services/sia/access/ark_sia_k8s_details.py +36 -0
  114. ark_sdk_python/models/services/sia/access/ark_sia_rotate_connector.py +7 -0
  115. ark_sdk_python/models/services/sia/access/ark_sia_rotate_https_relay.py +7 -0
  116. ark_sdk_python/models/services/sia/access/ark_sia_uninstall_connector.py +15 -3
  117. ark_sdk_python/models/services/sia/access/ark_sia_uninstall_relay.py +23 -0
  118. ark_sdk_python/models/services/sia/access/ark_sia_update_connector_maintenance_mode.py +23 -0
  119. ark_sdk_python/models/services/sia/access/ark_sia_upgrade_connector.py +7 -0
  120. ark_sdk_python/models/services/sia/access/ark_sia_upgrade_connector_async_task.py +32 -0
  121. ark_sdk_python/models/services/sia/access/ark_sia_upgrade_https_relay.py +7 -0
  122. ark_sdk_python/models/services/sia/k8s/__init__.py +11 -1
  123. ark_sdk_python/models/services/sia/k8s/ark_sia_k8s_cluster.py +22 -0
  124. ark_sdk_python/models/services/sia/k8s/ark_sia_k8s_clusters.py +10 -0
  125. ark_sdk_python/models/services/sia/k8s/ark_sia_k8s_generate_cluster_config.py +13 -0
  126. ark_sdk_python/models/services/sia/k8s/ark_sia_k8s_list_clusters.py +9 -0
  127. ark_sdk_python/models/services/sia/secrets/db/__init__.py +22 -6
  128. ark_sdk_python/models/services/sia/secrets/db/ark_sia_db_add_secret.py +54 -3
  129. ark_sdk_python/models/services/sia/secrets/db/ark_sia_db_delete_secret.py +4 -0
  130. ark_sdk_python/models/services/sia/secrets/db/ark_sia_db_get_secret.py +4 -0
  131. ark_sdk_python/models/services/sia/secrets/db/ark_sia_db_list_strong_accounts_response.py +16 -0
  132. ark_sdk_python/models/services/sia/secrets/db/ark_sia_db_secret_metadata.py +27 -2
  133. ark_sdk_python/models/services/sia/secrets/db/ark_sia_db_secrets_filter.py +7 -0
  134. ark_sdk_python/models/services/sia/secrets/db/ark_sia_db_strong_accounts_filter.py +29 -0
  135. ark_sdk_python/models/services/sia/secrets/db/ark_sia_db_update_secret.py +51 -3
  136. ark_sdk_python/models/services/sia/settings/__init__.py +2 -0
  137. ark_sdk_python/models/services/sia/settings/ark_sia_settings_feature_name.py +1 -0
  138. ark_sdk_python/models/services/sia/settings/ark_sia_settings_https_relay.py +11 -0
  139. ark_sdk_python/models/services/sia/settings/ark_sia_settings_list_settings.py +4 -1
  140. ark_sdk_python/models/services/sia/settings/ark_sia_settings_set_settings.py +2 -0
  141. ark_sdk_python/models/services/sia/settings/ark_sia_settings_setting_types.py +2 -0
  142. ark_sdk_python/models/services/sia/settings/ark_sia_settings_settings.py +2 -0
  143. ark_sdk_python/models/services/sia/shortened_connection_string/__init__.py +11 -0
  144. ark_sdk_python/models/services/sia/shortened_connection_string/ark_sia_generate_shortened_connection_string.py +7 -0
  145. ark_sdk_python/models/services/sia/shortened_connection_string/ark_sia_generate_shortened_connection_string_response.py +8 -0
  146. ark_sdk_python/models/services/sia/sso/ark_sia_sso_get_short_lived_rdp_file.py +16 -2
  147. ark_sdk_python/models/services/sia/sso/ark_sia_sso_get_ssh_key.py +1 -0
  148. ark_sdk_python/models/services/sia/workspaces/db/__init__.py +27 -8
  149. ark_sdk_python/models/services/sia/workspaces/db/ark_sia_db_add_database.py +152 -0
  150. ark_sdk_python/models/services/sia/workspaces/db/ark_sia_db_database.py +101 -2
  151. ark_sdk_python/models/services/sia/workspaces/db/ark_sia_db_database_info.py +47 -1
  152. ark_sdk_python/models/services/sia/workspaces/db/ark_sia_db_databases_filter.py +13 -0
  153. ark_sdk_python/models/services/sia/workspaces/db/ark_sia_db_databases_stats.py +12 -0
  154. ark_sdk_python/models/services/sia/workspaces/db/ark_sia_db_delete_database.py +13 -0
  155. ark_sdk_python/models/services/sia/workspaces/db/ark_sia_db_get_database.py +13 -0
  156. ark_sdk_python/models/services/sia/workspaces/db/ark_sia_db_provider.py +25 -1
  157. ark_sdk_python/models/services/sia/workspaces/db/ark_sia_db_target_constraints.py +39 -0
  158. ark_sdk_python/models/services/sia/workspaces/db/ark_sia_db_update_database.py +166 -0
  159. ark_sdk_python/models/services/sm/ark_sm_session.py +1 -0
  160. ark_sdk_python/models/services/sm/ark_sm_sessions_filter.py +7 -0
  161. ark_sdk_python/models/services/uap/common/__init__.py +2 -0
  162. ark_sdk_python/models/services/uap/common/ark_uap_access_approval.py +24 -0
  163. ark_sdk_python/models/services/uap/common/ark_uap_change_info.py +1 -1
  164. ark_sdk_python/models/services/uap/common/ark_uap_conditions.py +15 -1
  165. ark_sdk_python/models/services/uap/common/ark_uap_metadata.py +1 -1
  166. ark_sdk_python/models/services/uap/common/ark_uap_principal.py +2 -2
  167. ark_sdk_python/models/services/uap/sia/common/ark_uap_sia_common_conditions.py +14 -0
  168. ark_sdk_python/models/services/uap/sia/vm/__init__.py +2 -0
  169. ark_sdk_python/models/services/uap/sia/vm/ark_uap_sia_vm_access_policy.py +11 -0
  170. ark_sdk_python/models/services/uap/sia/vm/ark_uap_sia_vm_conditions.py +28 -0
  171. ark_sdk_python/services/access/__init__.py +3 -0
  172. ark_sdk_python/services/access/ark_access_api.py +17 -0
  173. ark_sdk_python/services/access/assets/__init__.py +3 -0
  174. ark_sdk_python/services/access/assets/ark_access_assets_service.py +91 -0
  175. ark_sdk_python/services/ars/__init__.py +0 -0
  176. ark_sdk_python/services/ars/requests/__init__.py +7 -0
  177. ark_sdk_python/services/ars/requests/ark_ars_requests_async_request.py +145 -0
  178. ark_sdk_python/services/ars/requests/ark_ars_requests_service.py +377 -0
  179. ark_sdk_python/services/cmgr/__init__.py +2 -1
  180. ark_sdk_python/services/cmgr/ark_cmgr_component_operation_async_request.py +139 -0
  181. ark_sdk_python/services/cmgr/ark_cmgr_service.py +754 -3
  182. ark_sdk_python/services/identity/ark_identity_api.py +12 -0
  183. ark_sdk_python/services/identity/common/ark_identity_base_service.py +1 -1
  184. ark_sdk_python/services/identity/directories/ark_identity_directories_service.py +4 -1
  185. ark_sdk_python/services/identity/federations/__init__.py +3 -0
  186. ark_sdk_python/services/identity/federations/ark_identity_federations_service.py +218 -0
  187. ark_sdk_python/services/identity/users/ark_identity_users_service.py +76 -1
  188. ark_sdk_python/services/pcloud/ark_pcloud_api.py +12 -0
  189. ark_sdk_python/services/pcloud/common/ark_pcloud_base_service.py +1 -1
  190. ark_sdk_python/services/pcloud/usermgmt/__init__.py +3 -0
  191. ark_sdk_python/services/pcloud/usermgmt/ark_pcloud_usermgmt_service.py +513 -0
  192. ark_sdk_python/services/sia/access/__init__.py +2 -1
  193. ark_sdk_python/services/sia/access/ark_sia_access_service.py +693 -17
  194. ark_sdk_python/services/sia/access/ark_sia_upgrade_connector_async_request.py +136 -0
  195. ark_sdk_python/services/sia/ark_sia_api.py +12 -0
  196. ark_sdk_python/services/sia/k8s/ark_sia_k8s_service.py +77 -1
  197. ark_sdk_python/services/sia/secrets/db/ark_sia_db_secrets_service.py +354 -1
  198. ark_sdk_python/services/sia/settings/ark_sia_settings_service.py +60 -2
  199. ark_sdk_python/services/sia/shortened_connection_string/__init__.py +7 -0
  200. ark_sdk_python/services/sia/shortened_connection_string/ark_sia_shortened_connection_string_service.py +75 -0
  201. ark_sdk_python/services/sia/sso/ark_sia_sso_service.py +12 -2
  202. ark_sdk_python/services/sia/sso/consts.py +9 -0
  203. ark_sdk_python/services/sia/workspaces/db/ark_sia_db_workspace_service.py +346 -7
  204. ark_sdk_python/services/sm/ark_sm_service.py +4 -1
  205. ark_sdk_python/services/uap/common/ark_uap_base_service.py +13 -6
  206. ark_sdk_python/services/uap/sca/ark_uap_sca_service.py +4 -4
  207. {ark_sdk_python-2.1.4.dist-info → ark_sdk_python-2.2.0.dist-info}/METADATA +6 -1
  208. {ark_sdk_python-2.1.4.dist-info → ark_sdk_python-2.2.0.dist-info}/RECORD +212 -84
  209. {ark_sdk_python-2.1.4.dist-info → ark_sdk_python-2.2.0.dist-info}/WHEEL +1 -1
  210. {ark_sdk_python-2.1.4.dist-info → ark_sdk_python-2.2.0.dist-info}/licenses/NOTICES.md +371 -0
  211. {ark_sdk_python-2.1.4.dist-info → ark_sdk_python-2.2.0.dist-info}/entry_points.txt +0 -0
  212. {ark_sdk_python-2.1.4.dist-info → ark_sdk_python-2.2.0.dist-info}/licenses/LICENSE.txt +0 -0
@@ -1,15 +1,69 @@
1
1
  from ark_sdk_python.models.services.sia.access.ark_sia_access_workspace_type_serializer import serialize_access_workspace_type
2
+ from ark_sdk_python.models.services.sia.access.ark_sia_connector import (
3
+ ArkSIAConnector,
4
+ ArkSIAConnectorHealth,
5
+ ArkSIAConnectorModeCodes,
6
+ ArkSIAConnectorStatusCodes,
7
+ )
2
8
  from ark_sdk_python.models.services.sia.access.ark_sia_connector_setup_script import ArkSIAConnectorSetupScript
9
+ from ark_sdk_python.models.services.sia.access.ark_sia_connectors_filter import ArkSIAConnectorsFilter
10
+ from ark_sdk_python.models.services.sia.access.ark_sia_connectors_stats import ArkSIAConnectorsStats
11
+ from ark_sdk_python.models.services.sia.access.ark_sia_delete_connector import ArkSIADeleteConnector
12
+ from ark_sdk_python.models.services.sia.access.ark_sia_delete_https_relay import ArkSIADeleteHttpsRelay
13
+ from ark_sdk_python.models.services.sia.access.ark_sia_get_connector import ArkSIAGetConnector
3
14
  from ark_sdk_python.models.services.sia.access.ark_sia_get_connector_setup_script import ArkSIAGetConnectorSetupScript
15
+ from ark_sdk_python.models.services.sia.access.ark_sia_get_https_relay import ArkSIAGetHttpsRelay
16
+ from ark_sdk_python.models.services.sia.access.ark_sia_get_https_relay_setup_script import ArkSIAGetHttpsRelaySetupScript
17
+ from ark_sdk_python.models.services.sia.access.ark_sia_https_relay import ArkSIAHttpsRelay
18
+ from ark_sdk_python.models.services.sia.access.ark_sia_https_relay_setup_script import ArkSIAHttpsRelaySetupScript
19
+ from ark_sdk_python.models.services.sia.access.ark_sia_https_relay_status_codes import (
20
+ ArkSIAHttpsRelayModeCodes,
21
+ ArkSIAHttpsRelayStatusCodes,
22
+ )
23
+ from ark_sdk_python.models.services.sia.access.ark_sia_https_relays_filter import ArkSIAHttpsRelaysFilter
4
24
  from ark_sdk_python.models.services.sia.access.ark_sia_install_connector import ArkSIAInstallConnector
25
+ from ark_sdk_python.models.services.sia.access.ark_sia_install_relay import ArkSIAInstallRelay
26
+ from ark_sdk_python.models.services.sia.access.ark_sia_k8s_details import ArkSIAK8sDetails
27
+ from ark_sdk_python.models.services.sia.access.ark_sia_rotate_connector import ArkSIARotateConnector
28
+ from ark_sdk_python.models.services.sia.access.ark_sia_rotate_https_relay import ArkSIARotateHttpsRelay
5
29
  from ark_sdk_python.models.services.sia.access.ark_sia_test_connector_reachability import ArkSIATestConnectorReachability
6
30
  from ark_sdk_python.models.services.sia.access.ark_sia_uninstall_connector import ArkSIAUninstallConnector
31
+ from ark_sdk_python.models.services.sia.access.ark_sia_uninstall_relay import ArkSIAUninstallRelay
32
+ from ark_sdk_python.models.services.sia.access.ark_sia_update_connector_maintenance_mode import ArkSIAUpdateMaintenanceMode
33
+ from ark_sdk_python.models.services.sia.access.ark_sia_upgrade_connector import ArkSIAUpgradeConnector
34
+ from ark_sdk_python.models.services.sia.access.ark_sia_upgrade_connector_async_task import ArkSIAUpgradeConnectorAsyncTask
35
+ from ark_sdk_python.models.services.sia.access.ark_sia_upgrade_https_relay import ArkSIAUpgradeHttpsRelay
7
36
 
8
37
  __all__ = [
38
+ 'ArkSIAConnector',
39
+ 'ArkSIAConnectorHealth',
40
+ 'ArkSIAConnectorModeCodes',
41
+ 'ArkSIAConnectorStatusCodes',
42
+ 'ArkSIAConnectorsFilter',
43
+ 'ArkSIAConnectorsStats',
44
+ 'ArkSIADeleteConnector',
9
45
  'ArkSIAGetConnectorSetupScript',
46
+ 'ArkSIAGetConnector',
47
+ 'ArkSIAUpdateMaintenanceMode',
48
+ 'ArkSIAUpgradeConnector',
10
49
  'ArkSIAConnectorSetupScript',
50
+ 'ArkSIAUpgradeConnectorAsyncTask',
11
51
  'ArkSIAInstallConnector',
52
+ 'ArkSIAInstallRelay',
53
+ 'ArkSIAK8sDetails',
12
54
  'ArkSIAUninstallConnector',
55
+ 'ArkSIAUninstallRelay',
13
56
  'ArkSIATestConnectorReachability',
14
57
  'serialize_access_workspace_type',
58
+ 'ArkSIADeleteHttpsRelay',
59
+ 'ArkSIAGetHttpsRelay',
60
+ 'ArkSIAGetHttpsRelaySetupScript',
61
+ 'ArkSIAHttpsRelay',
62
+ 'ArkSIAHttpsRelayModeCodes',
63
+ 'ArkSIAHttpsRelaySetupScript',
64
+ 'ArkSIAHttpsRelayStatusCodes',
65
+ 'ArkSIAHttpsRelaysFilter',
66
+ 'ArkSIAUpgradeHttpsRelay',
67
+ 'ArkSIARotateConnector',
68
+ 'ArkSIARotateHttpsRelay',
15
69
  ]
@@ -0,0 +1,119 @@
1
+ from datetime import datetime
2
+ from enum import Enum, IntEnum
3
+ from typing import Optional
4
+
5
+ from pydantic import Field, field_validator
6
+
7
+ from ark_sdk_python.models import ArkCamelizedModel, ArkModel
8
+ from ark_sdk_python.models.common import ArkOsType, ArkWorkspaceType
9
+
10
+
11
+ class ArkSIAConnectorStatusCodes(IntEnum):
12
+ INACTIVE = 0
13
+ ACTIVE = 1
14
+ DOWNLOADED = 2
15
+
16
+
17
+ class ArkSIAExtendedConnectorStatus(IntEnum):
18
+ INACTIVE = 0
19
+ ACTIVE = 1
20
+ SUSPENDED = 2
21
+ PREPARING_FOR_MAINTENANCE = 3
22
+ READY_FOR_MAINTENANCE = 4
23
+
24
+
25
+ class ArkSIAConnectorModeCodes(IntEnum):
26
+ AVAILABLE = 0
27
+ JOB_IN_PROGRESS = 1
28
+ SUSPENDED = 2
29
+
30
+
31
+ class Status(str, Enum):
32
+ ACTIVE = 'Active'
33
+ INACTIVE = 'Inactive'
34
+ WARNING = 'Warning'
35
+ SUSPENDED = 'Suspended'
36
+
37
+
38
+ class ArkSIAConnectorHealth(ArkCamelizedModel):
39
+ id: str = Field(min_length=2, description='The connector Id')
40
+ workspace_id: Optional[str] = Field(
41
+ description='The workspace ID where the connector host is in, '
42
+ 'relevant only for the following connector_host_type: AWS (the AWS Account ID) and AZURE (the subscription ID).',
43
+ default=None,
44
+ )
45
+ host_instance_id: Optional[str] = Field(
46
+ description='The host ID. For AWS this is the Instance ID, for Azure this is the VM resource ID', default=None
47
+ )
48
+ region: Optional[str] = Field(description='The region where the connector host is in.', default=None)
49
+ host_ip: Optional[str] = Field(description='The host machine.', default=None)
50
+ host_name: Optional[str] = Field(description='The host name.', default=None)
51
+ host_type: Optional[str] = Field(
52
+ description='The platform type where the host is in. Valid values: AWS, AZURE or ON-PREMISE.', default=None
53
+ )
54
+ host_network: Optional[str] = Field(
55
+ description='The virtual network where the host is in. For AWS this is the VPC, for AZURE this is the Vnet.', default=None
56
+ )
57
+ host_subnet: Optional[str] = Field(description='The subnet where the host is in.', default=None)
58
+ version: Optional[str] = Field(description='The connector version', default=None)
59
+ active_sessions_count: int = Field(description='How many active sessions currently running on this connector.', ge=0)
60
+ status: str = Field(description='The current connector status', default=Status.INACTIVE.value)
61
+ os: Optional[str] = Field(description='The operating system of the connector host.', default=None)
62
+ proxy_settings: Optional[str] = Field(description='The HTTP Proxy details if configured.', default=None)
63
+ is_latest_version: bool = Field(description='Whether the connector is updated with the latest version.')
64
+
65
+
66
+ class ArkSIAConnector(ArkModel):
67
+ tenant_id: Optional[str] = Field(description='The tenant where the connector resides on', default=None)
68
+ connector_id: str = Field(description='The connector id')
69
+ account: Optional[str] = Field(default=None, description='The account which the connector resides on', alias='aws_account')
70
+ host_instance_id: Optional[str] = Field(
71
+ default=None, description='The instance identifier which the connector resides in', alias='aws_host_instance_id'
72
+ )
73
+ region: Optional[str] = Field(default=None, description='The region which the connector resides in', alias='aws_region')
74
+ connector_host_ip: str = Field(description='The ip of the connector machine')
75
+ connector_host_name: str = Field(description='The hostname of the connector machine')
76
+ connector_host_type: ArkWorkspaceType = Field(description='The host type of the connector machine')
77
+ connector_host_os_version: Optional[str] = Field(default=None, description='OS version of the machine which the connector resides in')
78
+ connector_host_outbound_ip: Optional[str] = Field(default=None, description='Outbound ip of the connector host machine')
79
+ connector_host_vpc: Optional[str] = Field(default=None, description='The connector vpc network which the connector resides in')
80
+ connector_host_subnet: Optional[str] = Field(
81
+ default=None, description='The connector subnet within the vpc which the connector resides in'
82
+ )
83
+ connector_host_subnet_cidr: Optional[str] = Field(default=None, description='The connector cidr of the subnet')
84
+ connector_version: str = Field(description='Version of the connector')
85
+ total_memory: Optional[int] = Field(default=None, description='Total memory metric of the connector')
86
+ cpu_count: Optional[int] = Field(default=None, description='CPU count metric of the connector')
87
+ cpu_type: Optional[str] = Field(default=None, description='CPU type metric of the connector')
88
+ created_time: Optional[datetime] = Field(default=None, description='When the connector was created')
89
+ active_sessions_count: int = Field(description='Current active sessions count on the connector')
90
+ update_time: Optional[datetime] = Field(default=None, description='Last update time of the connector')
91
+ status_code: ArkSIAExtendedConnectorStatus = Field(description='Current status of the connector')
92
+ connector_build_date: Optional[str] = Field(default=None, description='Build date of the connector binaries')
93
+ connector_os: ArkOsType = Field(description='OS type of which the connector resides in')
94
+ sha512_checksum: Optional[str] = Field(default=None, description='Sha signaute of the connector binaries')
95
+ connector_mode: Optional[ArkSIAConnectorModeCodes] = Field(default=None, description='Current connector mode')
96
+ last_job_info_update_date: Optional[str] = Field(default=None, description='Connector last job update date')
97
+ last_job_status: Optional[str] = Field(default=None, description='Connector job status')
98
+ last_job_error_code: Optional[str] = Field(default=None, description='Connector job error code')
99
+ last_job_status_description: Optional[str] = Field(default=None, description='Connector job status description')
100
+ proxy_settings: Optional[str] = Field(default=None, description='Info about proxy settings of the connector if exists')
101
+ is_upgradable: Optional[bool] = Field(default=None, description='Whether the connector is upgradable and not at latest version')
102
+ is_latest_version: bool = Field(description='Whether the connector is at the latest version and not upgradable')
103
+ maintenance: Optional[bool] = Field(default=None, description='Whether the connector is in maintenance mode')
104
+
105
+ # pylint: disable=no-self-use,no-self-argument
106
+ @field_validator('connector_host_type', mode="before")
107
+ @classmethod
108
+ def validate_connector_host_type(cls, val):
109
+ if val is not None:
110
+ if ArkWorkspaceType(val) not in [
111
+ ArkWorkspaceType.AWS,
112
+ ArkWorkspaceType.AZURE,
113
+ ArkWorkspaceType.GCP,
114
+ ArkWorkspaceType.ONPREM,
115
+ ArkWorkspaceType.FAULT,
116
+ ]:
117
+ raise ValueError('Invalid Platform / Workspace Type')
118
+ return ArkWorkspaceType(val)
119
+ return val
@@ -0,0 +1,39 @@
1
+ from typing import List, Optional
2
+
3
+ from pydantic import Field, field_validator
4
+ from typing_extensions import Literal
5
+
6
+ from ark_sdk_python.models import ArkModel
7
+ from ark_sdk_python.models.common import ArkOsType, ArkWorkspaceType
8
+
9
+
10
+ class ArkSIAConnectorsFilter(ArkModel):
11
+ accounts: Optional[List[str]] = Field(default=None, description='Filter by list of accounts')
12
+ regions: Optional[List[str]] = Field(default=None, description='Filter by list of regions')
13
+ host_types: Optional[List[ArkWorkspaceType]] = Field(default=None, description='Filter by platform types')
14
+ only_upgradable_connectors: Optional[bool] = Field(default=None, description='Filter only upgradable connectors')
15
+ only_latest_version_connectors: Optional[bool] = Field(default=None, description='Filter only latest versions connectors')
16
+ only_connectors_with_sessions: Optional[bool] = Field(default=None, description='Filter only connectors with active sessions')
17
+ status_codes: Optional[List[Literal['INACTIVE', 'ACTIVE', 'DOWNLOADED', 'READY FOR MAINTENANCE', 'PREPARING FOR MAINTENANCE']]] = Field(
18
+ default=None, description='Filter by list of status codes'
19
+ )
20
+ os_types: Optional[List[ArkOsType]] = Field(default=None, description='Filter by list of operating system types')
21
+
22
+ # pylint: disable=no-self-use,no-self-argument
23
+ @field_validator('host_types', mode="before")
24
+ @classmethod
25
+ def validate_host_types(cls, val):
26
+ if val is not None:
27
+ new_val = []
28
+ for workspace in val:
29
+ if ArkWorkspaceType(workspace) not in [
30
+ ArkWorkspaceType.AWS,
31
+ ArkWorkspaceType.AZURE,
32
+ ArkWorkspaceType.GCP,
33
+ ArkWorkspaceType.ONPREM,
34
+ ArkWorkspaceType.FAULT,
35
+ ]:
36
+ raise ValueError('Invalid Platform / Workspace Type')
37
+ new_val.append(ArkWorkspaceType(workspace))
38
+ return new_val
39
+ return val
@@ -0,0 +1,33 @@
1
+ from typing import Dict
2
+
3
+ from pydantic import Field, field_validator
4
+
5
+ from ark_sdk_python.models import ArkModel
6
+ from ark_sdk_python.models.common import ArkOsType, ArkWorkspaceType
7
+
8
+
9
+ class ArkSIAConnectorsStats(ArkModel):
10
+ connectors_count: int = Field(description='Total connectors count')
11
+ upgradable_connectors_count: int = Field(description='Total upgradable connectors count')
12
+ connectors_count_by_os: Dict[ArkOsType, int] = Field(description='Connectors count by os')
13
+ connectors_count_by_platform: Dict[ArkWorkspaceType, int] = Field(description='Connectors count by platform')
14
+ connectors_count_by_status_codes: Dict[str, int] = Field(description='Connectors count by status codes')
15
+
16
+ # pylint: disable=no-self-use,no-self-argument
17
+ @field_validator('connectors_count_by_platform', mode="before")
18
+ @classmethod
19
+ def validate_connectors_count_by_platform(cls, val):
20
+ if val is not None:
21
+ new_val = []
22
+ for workspace in val:
23
+ if ArkWorkspaceType(workspace) not in [
24
+ ArkWorkspaceType.AWS,
25
+ ArkWorkspaceType.AZURE,
26
+ ArkWorkspaceType.GCP,
27
+ ArkWorkspaceType.ONPREM,
28
+ ArkWorkspaceType.FAULT,
29
+ ]:
30
+ raise ValueError('Invalid Platform / Workspace Type')
31
+ new_val.append(ArkWorkspaceType(workspace))
32
+ return new_val
33
+ return val
@@ -0,0 +1,25 @@
1
+ from typing import Optional
2
+
3
+ from pydantic import Field
4
+
5
+ from ark_sdk_python.models import ArkModel, ArkSecretStr
6
+
7
+
8
+ class ArkSIADeleteConnector(ArkModel):
9
+ connector_id: str = Field(description='The id of the connector to delete')
10
+ force_delete: Optional[bool] = Field(default=None, description='When true, forces deletion of the connector even if it is active')
11
+ uninstall_connector: Optional[bool] = Field(
12
+ description='Whether to try and uninstall the connector from the target machine as well', default=False
13
+ )
14
+ username: Optional[str] = Field(default=None, description='Username to connect with to the target machine')
15
+ target_machine: Optional[str] = Field(
16
+ default=None,
17
+ description='Target machine on which to uninstall the connector from, if not given, uses the connector_host_ip from the connector information',
18
+ )
19
+ password: Optional[ArkSecretStr] = Field(default=None, description='Password to connect with to the target machine')
20
+ private_key_path: Optional[str] = Field(
21
+ default=None, description='Private key file path to use for connecting to the target machine via ssh'
22
+ )
23
+ private_key_contents: Optional[ArkSecretStr] = Field(
24
+ default=None, description='Private key contents to use for connecting to the target machine via ssh'
25
+ )
@@ -0,0 +1,31 @@
1
+ from typing import Optional
2
+
3
+ from pydantic import Field
4
+
5
+ from ark_sdk_python.models import ArkModel, ArkSecretStr
6
+ from ark_sdk_python.models.common.ark_os_type import ArkOsType
7
+
8
+
9
+ class ArkSIADeleteHttpsRelay(ArkModel):
10
+ https_relay_id: str = Field(description='Https relay id we would like to delete')
11
+ force_delete: Optional[bool] = Field(
12
+ default=None, description='When true, forces deletion of the HTTPS relay even if it has active sessions'
13
+ )
14
+ uninstall_relay: Optional[bool] = Field(
15
+ description='Whether to try and uninstall the HTTPS relay from the target machine as well', default=False
16
+ )
17
+ https_relay_os: Optional[ArkOsType] = Field(
18
+ default=None, description='OS type of the target machine, required when uninstall_relay is True'
19
+ )
20
+ username: Optional[str] = Field(default=None, description='Username to connect with to the target machine')
21
+ target_machine: Optional[str] = Field(
22
+ default=None,
23
+ description='Target machine on which to uninstall the relay from, if not given, uses the host_ip from the relay information',
24
+ )
25
+ password: Optional[ArkSecretStr] = Field(default=None, description='Password to connect with to the target machine')
26
+ private_key_path: Optional[str] = Field(
27
+ default=None, description='Private key file path to use for connecting to the target machine via ssh'
28
+ )
29
+ private_key_contents: Optional[ArkSecretStr] = Field(
30
+ default=None, description='Private key contents to use for connecting to the target machine via ssh'
31
+ )
@@ -0,0 +1,7 @@
1
+ from pydantic import Field
2
+
3
+ from ark_sdk_python.models import ArkModel
4
+
5
+
6
+ class ArkSIAGetConnector(ArkModel):
7
+ connector_id: str = Field(description='The id of the connector to get')
@@ -4,6 +4,7 @@ from pydantic import Field, field_validator
4
4
 
5
5
  from ark_sdk_python.models import ArkModel
6
6
  from ark_sdk_python.models.common import ArkOsType, ArkWorkspaceType
7
+ from ark_sdk_python.models.services.sia.access.ark_sia_k8s_details import ArkSIAK8sDetails
7
8
 
8
9
  HTTP_PREFIX: Final[str] = 'http://'
9
10
  HTTPS_PREFIX: Final[str] = 'https://'
@@ -31,6 +32,9 @@ class ArkSIAGetConnectorSetupScript(ArkModel):
31
32
  proxy_host: Optional[str] = Field(default='', description='The proxy host to use in this connector.')
32
33
  proxy_port: Optional[int] = Field(default=443, description='The proxy port to use in this connector.')
33
34
  windows_installation_path: Optional[str] = Field(default='', description='The installation path for the connector on Windows machines')
35
+ k8s_details: Optional[ArkSIAK8sDetails] = Field(
36
+ default=None, description='Kubernetes configuration used when connector_os is k8s-ephemeral'
37
+ )
34
38
 
35
39
  # pylint: disable=no-self-use,no-self-argument
36
40
  @field_validator('connector_type', mode="before")
@@ -0,0 +1,7 @@
1
+ from pydantic import Field
2
+
3
+ from ark_sdk_python.models import ArkModel
4
+
5
+
6
+ class ArkSIAGetHttpsRelay(ArkModel):
7
+ https_relay_id: str = Field(description='Https relay id we would like to get information about')
@@ -0,0 +1,19 @@
1
+ from typing import Dict, Optional
2
+
3
+ from pydantic import Field
4
+
5
+ from ark_sdk_python.models import ArkModel
6
+ from ark_sdk_python.models.common import ArkOsType
7
+
8
+
9
+ class ArkSIAGetHttpsRelaySetupScript(ArkModel):
10
+ https_relay_os: ArkOsType = Field(description='The type of the operating system for the HTTPS relay to be installed on')
11
+ protocol_port_map: Dict[str, int] = Field(description='Map between protocol and port for the HTTPS relay')
12
+ expiration_minutes: Optional[int] = Field(
13
+ default=15, ge=15, le=240, description='Expiration time in minutes for the generated setup script, between 15 and 240 minutes'
14
+ )
15
+ proxy_host: Optional[str] = Field(default='', description='Optional proxy host to be configured for the HTTPS relay')
16
+ proxy_port: Optional[int] = Field(default=443, description='Optional proxy port to be configured for the HTTPS relay')
17
+ windows_installation_path: Optional[str] = Field(
18
+ default='', description='Optional custom installation path for the HTTPS relay on Windows'
19
+ )
@@ -0,0 +1,34 @@
1
+ from typing import Optional
2
+
3
+ from pydantic import Field, NonNegativeInt
4
+
5
+ from ark_sdk_python.models import ArkCamelizedModel
6
+ from ark_sdk_python.models.services.sia.access.ark_sia_https_relay_status_codes import ArkSIAHttpsRelayStatusCodes
7
+
8
+
9
+ class ArkSIAHttpsRelay(ArkCamelizedModel):
10
+ id: str = Field(min_length=2, description='The HTTPS relay ID')
11
+ host_ip: Optional[str] = Field(default=None, description='The host machine.')
12
+ host_name: Optional[str] = Field(default=None, description='The host name.')
13
+ version: Optional[str] = Field(default=None, description='The https relay version')
14
+ active_sessions_count: NonNegativeInt = Field(default=0, description='How many active sessions currently running on this https relay.')
15
+ status_code: ArkSIAHttpsRelayStatusCodes = Field(
16
+ default=ArkSIAHttpsRelayStatusCodes.INACTIVE,
17
+ description='The status of the https relay. 0 - The https relay is inactive and not communicating with the service, '
18
+ '1 - The https relay is active, 2 - The https relay is inactive and blocked and cannot support any sessions'
19
+ ' (this https relay should be deleted from SIA and the host machine).',
20
+ )
21
+ status: str = Field(default='INACTIVE', description='The human-readable status of the HTTPS relay')
22
+ os: Optional[str] = Field(default=None, description='The operating system of the https relay host.')
23
+ proxy_settings: Optional[str] = Field(default=None, description='The HTTP Proxy details if configured.')
24
+ is_latest_version: bool = Field(default=True, description='Whether the https relay is updated with the latest version.')
25
+ version_to_upgrade: Optional[str] = Field(default=None, description='The version to upgrade to if the https relay is not updated.')
26
+ is_upgradable: bool = Field(description='Whether the https relay can be upgraded to the latest version.')
27
+ last_job_status: Optional[str] = Field(default=None, description='The status of the last job executed on the https relay, if exists.')
28
+ last_job_error_code: Optional[str] = Field(
29
+ default=None, description='The error code of the last job executed on the https relay, if exists.'
30
+ )
31
+ last_job_status_description: Optional[str] = Field(
32
+ default=None, description='The description of the last job executed on the https relay, if exists.'
33
+ )
34
+ last_job_info_update_date: Optional[str] = Field(description='The last time the last job status was updated, if exists.', default=None)
@@ -0,0 +1,8 @@
1
+ from pydantic import Field
2
+
3
+ from ark_sdk_python.models import ArkModel
4
+
5
+
6
+ class ArkSIAHttpsRelaySetupScript(ArkModel):
7
+ script_url: str = Field(description='URL to download the HTTPS relay setup script from')
8
+ bash_cmd: str = Field(description='Bash command to execute for installing the HTTPS relay')
@@ -0,0 +1,14 @@
1
+ from enum import IntEnum
2
+
3
+
4
+ class ArkSIAHttpsRelayStatusCodes(IntEnum):
5
+ INACTIVE = 0
6
+ ACTIVE = 1
7
+ DOWNLOADED = 2
8
+
9
+
10
+ class ArkSIAHttpsRelayModeCodes(IntEnum):
11
+ AVAILABLE = 0
12
+ JOB_IN_PROGRESS = 1
13
+ SUSPENDED = 2
14
+ ROTATION_JOB_IN_PROGRESS = 3
@@ -0,0 +1,13 @@
1
+ from typing import List, Literal, Optional
2
+
3
+ from pydantic import Field
4
+
5
+ from ark_sdk_python.models import ArkModel
6
+
7
+
8
+ class ArkSIAHttpsRelaysFilter(ArkModel):
9
+ only_latest_version_relays: Optional[bool] = Field(default=None, description='Filter only relays running the latest version')
10
+ only_relays_with_sessions: Optional[bool] = Field(default=None, description='Filter only relays with active sessions')
11
+ status_codes: Optional[List[Literal['INACTIVE', 'ACTIVE', 'DOWNLOADED']]] = Field(
12
+ default=None, description='Filter by list of status codes'
13
+ )
@@ -4,6 +4,7 @@ from pydantic import Field, field_validator
4
4
 
5
5
  from ark_sdk_python.models import ArkModel, ArkSecretStr
6
6
  from ark_sdk_python.models.common import ArkOsType, ArkWorkspaceType
7
+ from ark_sdk_python.models.services.sia.access.ark_sia_k8s_details import ArkSIAK8sDetails
7
8
 
8
9
 
9
10
  class ArkSIAInstallConnector(ArkModel):
@@ -14,8 +15,18 @@ class ArkSIAInstallConnector(ArkModel):
14
15
  description='The connector pool which the connector will be part of, '
15
16
  'if not given, the connector will be assigned to the default one',
16
17
  )
17
- target_machine: str = Field(description='Target machine on which to install the connector on')
18
- username: str = Field(description='Username to connect with to the target machine')
18
+ k8s_details: Optional[ArkSIAK8sDetails] = Field(
19
+ default=None,
20
+ description='Kubernetes configuration used when connector_os is k8s-ephemeral. Forwarded to the setup-script API so the '
21
+ 'returned script is pre-configured with these values; the script is then run locally instead of over a target machine '
22
+ 'connection',
23
+ )
24
+ target_machine: Optional[str] = Field(
25
+ default=None, description='Target machine on which to install the connector on. Required unless connector_os is k8s-ephemeral'
26
+ )
27
+ username: Optional[str] = Field(
28
+ default=None, description='Username to connect with to the target machine. Required unless connector_os is k8s-ephemeral'
29
+ )
19
30
  password: Optional[ArkSecretStr] = Field(default=None, description='Password to connect with to the target machine')
20
31
  private_key_path: Optional[str] = Field(
21
32
  default=None, description='Private key file path to use for connecting to the target machine via ssh'
@@ -0,0 +1,32 @@
1
+ from typing import Dict, Optional
2
+
3
+ from pydantic import Field
4
+
5
+ from ark_sdk_python.models import ArkModel, ArkSecretStr
6
+ from ark_sdk_python.models.common import ArkOsType
7
+
8
+
9
+ class ArkSIAInstallRelay(ArkModel):
10
+ https_relay_os: ArkOsType = Field(description='The type of the operating system for the HTTPS relay to be installed on')
11
+ protocol_port_map: Dict[str, int] = Field(description='Map between protocol and port for the HTTPS relay')
12
+ expiration_minutes: Optional[int] = Field(
13
+ default=15,
14
+ ge=15,
15
+ le=240,
16
+ description='The number of minutes the setup script will be valid for (15-240)',
17
+ )
18
+ proxy_host: Optional[str] = Field(default=None, description='Proxy host address for the HTTPS relay')
19
+ proxy_port: Optional[int] = Field(default=443, description='Proxy port for the HTTPS relay')
20
+ windows_installation_path: Optional[str] = Field(
21
+ default=None,
22
+ description='Custom installation path for the HTTPS relay on Windows machines',
23
+ )
24
+ target_machine: str = Field(description='Target machine on which to install the HTTPS relay on')
25
+ username: str = Field(description='Username to connect with to the target machine')
26
+ password: Optional[ArkSecretStr] = Field(default=None, description='Password to connect with to the target machine')
27
+ private_key_path: Optional[str] = Field(
28
+ default=None, description='Private key file path to use for connecting to the target machine via ssh'
29
+ )
30
+ private_key_contents: Optional[ArkSecretStr] = Field(
31
+ default=None, description='Private key contents to use for connecting to the target machine via ssh'
32
+ )
@@ -0,0 +1,36 @@
1
+ from typing import Optional
2
+
3
+ from pydantic import Field
4
+
5
+ from ark_sdk_python.models import ArkModel, ArkSecretStr
6
+
7
+
8
+ class ArkSIAK8sDetails(ArkModel):
9
+ """
10
+ Kubernetes-specific configuration for a k8s-ephemeral connector.
11
+ All fields are optional; when supplied they skip the corresponding interactive prompt in the setup script.
12
+ """
13
+
14
+ upgrade: Optional[bool] = Field(
15
+ default=False, description='When true, passes --upgrade to the K8s setup script to upgrade an existing installation'
16
+ )
17
+ k8s_namespace: Optional[str] = Field(
18
+ default=None, description='Kubernetes namespace to install into. When supplied, skips the interactive namespace prompt'
19
+ )
20
+ k8s_image_uri: Optional[str] = Field(
21
+ default=None,
22
+ description='Full URI of the connector image (registry/repo:tag). When supplied, skips the interactive image-URI prompt',
23
+ )
24
+ k8s_username: Optional[str] = Field(
25
+ default=None, description='Service user username for the K8s connector. When supplied, skips the interactive username prompt'
26
+ )
27
+ k8s_password: Optional[ArkSecretStr] = Field(
28
+ default=None, description='Service user password for the K8s connector. When supplied, skips the interactive password prompt'
29
+ )
30
+ k8s_replicas: Optional[int] = Field(
31
+ default=None, description='Number of connector replicas (1-10). When supplied, skips the interactive replicas prompt'
32
+ )
33
+ k8s_image_pull_secret: Optional[str] = Field(
34
+ default=None,
35
+ description='Name of an existing Kubernetes pull-secret in the connector namespace. When supplied, skips the interactive prompt',
36
+ )
@@ -0,0 +1,7 @@
1
+ from pydantic import Field
2
+
3
+ from ark_sdk_python.models import ArkModel
4
+
5
+
6
+ class ArkSIARotateConnector(ArkModel):
7
+ connector_id: str = Field(description='The id of the connector to rotate certificate')
@@ -0,0 +1,7 @@
1
+ from pydantic import Field
2
+
3
+ from ark_sdk_python.models import ArkModel
4
+
5
+
6
+ class ArkSIARotateHttpsRelay(ArkModel):
7
+ https_relay_id: str = Field(description='HTTPS relay to rotate certificate')
@@ -8,11 +8,23 @@ from ark_sdk_python.models.common.ark_os_type import ArkOsType
8
8
 
9
9
  class ArkSIAUninstallConnector(ArkModel):
10
10
  connector_os: ArkOsType = Field(description='The type of the operating system for the connector is installed on')
11
- connector_id: str = Field(description='Connector id to get information for uninstallation')
12
- username: str = Field(description='Username to connect with to the target machine')
11
+ connector_id: Optional[str] = Field(
12
+ default=None,
13
+ description='Connector id to get information for uninstallation. Required unless connector_os is k8s-ephemeral, where a '
14
+ 'helm release may back multiple replica connectors with no single ID',
15
+ )
16
+ k8s_namespace: Optional[str] = Field(
17
+ default=None,
18
+ description='The Kubernetes namespace the connector was installed into. Required when connector_os is k8s-ephemeral; the '
19
+ 'connector is uninstalled by running `helm uninstall sia-connector --namespace <k8s_namespace>` locally',
20
+ )
21
+ username: Optional[str] = Field(
22
+ default=None, description='Username to connect with to the target machine. Required unless connector_os is k8s-ephemeral'
23
+ )
13
24
  target_machine: Optional[str] = Field(
14
25
  default=None,
15
- description='Target machine on which to uninstall the connector from, if not given, uses the connector_host_ip from the connector information',
26
+ description='Target machine on which to uninstall the connector from, if not given, uses the connector_host_ip from the '
27
+ 'connector information. Not applicable when connector_os is k8s-ephemeral',
16
28
  )
17
29
  password: Optional[ArkSecretStr] = Field(default=None, description='Password to connect with to the target machine')
18
30
  private_key_path: Optional[str] = Field(
@@ -0,0 +1,23 @@
1
+ from typing import Optional
2
+
3
+ from pydantic import Field
4
+
5
+ from ark_sdk_python.models import ArkModel, ArkSecretStr
6
+ from ark_sdk_python.models.common.ark_os_type import ArkOsType
7
+
8
+
9
+ class ArkSIAUninstallRelay(ArkModel):
10
+ https_relay_os: ArkOsType = Field(description='The type of the operating system the HTTPS relay is installed on')
11
+ https_relay_id: str = Field(description='HTTPS relay id to get information for uninstallation')
12
+ username: str = Field(description='Username to connect with to the target machine')
13
+ target_machine: Optional[str] = Field(
14
+ default=None,
15
+ description='Target machine on which to uninstall the HTTPS relay from, if not given, uses the host_ip from the relay information',
16
+ )
17
+ password: Optional[ArkSecretStr] = Field(default=None, description='Password to connect with to the target machine')
18
+ private_key_path: Optional[str] = Field(
19
+ default=None, description='Private key file path to use for connecting to the target machine via ssh'
20
+ )
21
+ private_key_contents: Optional[ArkSecretStr] = Field(
22
+ default=None, description='Private key contents to use for connecting to the target machine via ssh'
23
+ )