syneto_api 0.2.4__tar.gz → 0.2.6__tar.gz

{syneto_api-0.2.4 → syneto_api-0.2.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: syneto-api
-Version: 0.2.4
+Version: 0.2.6
 Summary: Syneto Client API library
 Home-page: https://github.com/SynetoNet/syneto-api
 License: Proprietary
@@ -33,15 +33,15 @@ $ pip install syneto-api
 ```
 from syneto_api import Authentication, Virtualization, Storage, Protection
 
-auth_api = Authentication(base_url="https://syneto-instance-ip-address/api/auth", insecure_ssl=True)
+auth_api = Authentication(url_base="https://syneto-instance-ip-address/api/auth", insecure_ssl=True)
 response = auth_api.login(username="admin", password="admin")
 jwt = response['jwt']
 
-virt_api = Virtualization(base_url="https://syneto-instance-ip-address/api/virtualization", insecure_ssl=True)
+virt_api = Virtualization(url_base="https://syneto-instance-ip-address/api/virtualization", insecure_ssl=True)
 virt_api.set_auth_jwt(jwt)
 print(virt_api.get_vms())
 
-storage_api = Storage(base_url="https://syneto-instance-ip-address/api/storage", insecure_ssl=True)
+storage_api = Storage(url_base="https://syneto-instance-ip-address/api/storage", insecure_ssl=True)
 storage_api.set_auth_jwt(jwt)
 print(storage_api.get_pools())
 ```

{syneto_api-0.2.4 → syneto_api-0.2.6}/README.md

@@ -13,15 +13,15 @@ $ pip install syneto-api
 ```
 from syneto_api import Authentication, Virtualization, Storage, Protection
 
-auth_api = Authentication(base_url="https://syneto-instance-ip-address/api/auth", insecure_ssl=True)
+auth_api = Authentication(url_base="https://syneto-instance-ip-address/api/auth", insecure_ssl=True)
 response = auth_api.login(username="admin", password="admin")
 jwt = response['jwt']
 
-virt_api = Virtualization(base_url="https://syneto-instance-ip-address/api/virtualization", insecure_ssl=True)
+virt_api = Virtualization(url_base="https://syneto-instance-ip-address/api/virtualization", insecure_ssl=True)
 virt_api.set_auth_jwt(jwt)
 print(virt_api.get_vms())
 
-storage_api = Storage(base_url="https://syneto-instance-ip-address/api/storage", insecure_ssl=True)
+storage_api = Storage(url_base="https://syneto-instance-ip-address/api/storage", insecure_ssl=True)
 storage_api.set_auth_jwt(jwt)
 print(storage_api.get_pools())
 ```

{syneto_api-0.2.4 → syneto_api-0.2.6}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "syneto_api"
-version = "0.2.4"
+version = "0.2.6"
 description = "Syneto Client API library"
 authors = ["Your Name <you@example.com>"]
 license = "Proprietary"

{syneto_api-0.2.4 → syneto_api-0.2.6}/setup.py

@@ -15,9 +15,9 @@ install_requires = \
 
 setup_kwargs = {
     'name': 'syneto-api',
-    'version': '0.2.4',
+    'version': '0.2.6',
     'description': 'Syneto Client API library',
-    'long_description': '# Syneto API\n\nSyneto Client API library: authentication, storage, virtualization and protection\n\n# Installation\n\n```\n$ pip install syneto-api\n```\n\n# Basic Usage\n\n```\nfrom syneto_api import Authentication, Virtualization, Storage, Protection\n\nauth_api = Authentication(base_url="https://syneto-instance-ip-address/api/auth", insecure_ssl=True)\nresponse = auth_api.login(username="admin", password="admin")\njwt = response[\'jwt\']\n\nvirt_api = Virtualization(base_url="https://syneto-instance-ip-address/api/virtualization", insecure_ssl=True)\nvirt_api.set_auth_jwt(jwt)\nprint(virt_api.get_vms())\n\nstorage_api = Storage(base_url="https://syneto-instance-ip-address/api/storage", insecure_ssl=True)\nstorage_api.set_auth_jwt(jwt)\nprint(storage_api.get_pools())\n```\n\n# Environment Variables\n\nFor conveninence, the base urls for the api endpoints are also accepted as environment variables, please see below.\n\n```\nAUTH_SERVICE=https://syneto-instance-ip-address/api/auth\nVIRTUALIZATION_SERVICE=https://syneto-instance-ip-address/api/virtualization\nSTORAGE_SERVICE=https://syneto-instance-ip-address/api/storage\nPROTECTION_SERVICE=https://syneto-instance-ip-address/api/protection\n```\n\nIf you are using self-signed SSL certificates, set the following env. so that the http request library does not perform ssl verification. \n\n```\nALLOW_INSECURE_SSL=True\n```\n',
+    'long_description': '# Syneto API\n\nSyneto Client API library: authentication, storage, virtualization and protection\n\n# Installation\n\n```\n$ pip install syneto-api\n```\n\n# Basic Usage\n\n```\nfrom syneto_api import Authentication, Virtualization, Storage, Protection\n\nauth_api = Authentication(url_base="https://syneto-instance-ip-address/api/auth", insecure_ssl=True)\nresponse = auth_api.login(username="admin", password="admin")\njwt = response[\'jwt\']\n\nvirt_api = Virtualization(url_base="https://syneto-instance-ip-address/api/virtualization", insecure_ssl=True)\nvirt_api.set_auth_jwt(jwt)\nprint(virt_api.get_vms())\n\nstorage_api = Storage(url_base="https://syneto-instance-ip-address/api/storage", insecure_ssl=True)\nstorage_api.set_auth_jwt(jwt)\nprint(storage_api.get_pools())\n```\n\n# Environment Variables\n\nFor conveninence, the base urls for the api endpoints are also accepted as environment variables, please see below.\n\n```\nAUTH_SERVICE=https://syneto-instance-ip-address/api/auth\nVIRTUALIZATION_SERVICE=https://syneto-instance-ip-address/api/virtualization\nSTORAGE_SERVICE=https://syneto-instance-ip-address/api/storage\nPROTECTION_SERVICE=https://syneto-instance-ip-address/api/protection\n```\n\nIf you are using self-signed SSL certificates, set the following env. so that the http request library does not perform ssl verification. \n\n```\nALLOW_INSECURE_SSL=True\n```\n',
     'author': 'Your Name',
     'author_email': 'you@example.com',
     'maintainer': None,

{syneto_api-0.2.4 → syneto_api-0.2.6}/src/syneto_api/__init__.py

@@ -1,4 +1,6 @@
+from .api_client import APIException
 from .auth_api import Authentication
 from .virt_api import Virtualization
 from .storage_api import Storage
 from .protection_api import Protection
+from .jobs_api import Jobs

{syneto_api-0.2.4 → syneto_api-0.2.6}/src/syneto_api/api_client.py

@@ -43,7 +43,7 @@ class APIClientBase:
         "POST": [200, 201, 202],
         "PUT": [200, 202],
         "PATCH": [200, 202],
-        "DELETE": [200, 204],
+        "DELETE": [200, 202, 204],
     }
 
     def __init__(self, url_base=None, default_protocol="http", insecure_ssl=None):
@@ -91,10 +91,10 @@ class APIClientBase:
         try:
             response = method_func(url, timeout=20, **method_args)
             if response.status_code in success_codes:
-                logger.debug("Received {response.status_code} from {method} {url}")
+                logger.debug(f"Received {response.status_code} from {method} {url}")
                 return response.json()
 
-            logger.info("Received {response.status_code} from {method} {url}")
+            logger.info(f"Received {response.status_code} from {method} {url}")
             raise APIException(
                 url=url,
                 status_code=response.status_code,

syneto_api-0.2.6/src/syneto_api/jobs_api.py

@@ -0,0 +1,23 @@
+import os
+from .api_client import APIClientBase
+
+
+class Jobs(APIClientBase):
+    def __init__(self, url_base=None, **kwargs):
+        super().__init__(url_base or os.environ.get("PROTECTION_SERVICE", ""), **kwargs)
+
+    def get_jobs(self):
+        return self.get_request("/jobs")
+
+    def get_job(self, id: str):
+        return self.get_request("/jobs/{}", id)
+
+    def create_job(self, config: dict, job_type: str):
+        body = {"config": config, "type": job_type}
+        return self.post_request("/jobs", body=body)
+
+    def patch_job(self, id: str, body: dict):
+        return self.patch_request("/jobs", query_args={"id": id}, body=body)
+
+    def remove_job(self, id: str):
+        return self.delete_request("/jobs", query_args={"id": id})

{syneto_api-0.2.4 → syneto_api-0.2.6}/src/syneto_api/protection_api.py

@@ -18,8 +18,8 @@ class Protection(APIClientBase):
     def get_job(self, id):
         return self.get_request("/jobs/{}", id)
 
-    def patch_job(self, id, payload):
-        return self.patch_request("/jobs", query_args={"id": id}, body=payload)
+    def patch_job(self, id, body):
+        return self.patch_request("/jobs", query_args={"id": id}, body=body)
 
     def remove_job(self, id):
         return self.delete_request("/jobs", query_args={"id": id})
@@ -50,3 +50,11 @@ class Protection(APIClientBase):
 
     def patch_replication_host(self, id, payload):
         return self.patch_request("/hosts", query_args={"id": id}, body=payload)
+
+    def get_protected_vm(self, vm_syn_id: str):
+        return self.get_request("/vms/{vm_syn_id}", vm_syn_id=vm_syn_id)
+
+    def post_vm_recovery_point(self, vm_syn_id: str, job_id: str):
+        return self.post_request(
+            "/vms/recovery-points", body={"synId": vm_syn_id, "jobId": job_id}
+        )

{syneto_api-0.2.4 → syneto_api-0.2.6}/src/syneto_api/storage_api.py

@@ -66,9 +66,7 @@ class Storage(APIClientBase):
         return self.get_request("/volumes/{volume_id}", volume_id=volume_id,)
 
     def delete_volume(self, volume_id: str):
-        return self.delete_request(
-            "/volumes/{volume_id}", query_args={"volume_id": volume_id},
-        )
+        return self.delete_request("/volumes", query_args={"volume_id": volume_id},)
 
     def promote_volume(self, volume_id: str):
         return self.put_request("/volumes/{volume_id}/promote", volume_id=volume_id)
@@ -130,23 +128,22 @@ class Storage(APIClientBase):
         )
 
     def get_volume_files(self, volume_id: str):
-        return self.get_request(
-            "/volumes/{volume_id}/files",
-            volume_id=volume_id
-        )
+        return self.get_request("/volumes/{volume_id}/files", volume_id=volume_id)
 
-    def delete_volume_files(self, volume_id: str, file_path: str = None, pattern: str = None):
+    def delete_volume_files(
+        self, volume_id: str, file_path: str = None, pattern: str = None
+    ):
         return self.delete_request(
             "/volumes/{volume_id}/files",
             volume_id=volume_id,
-            query_args={"file_path": file_path, "pattern": pattern}
+            query_args={"file_path": file_path, "pattern": pattern},
         )
 
     def get_volume_file_content(self, volume_id: str, file_path: str):
         return self.get_request(
             "/volumes/{volume_id}/files/content",
             volume_id=volume_id,
-            query_args={"file_path": file_path}
+            query_args={"file_path": file_path},
         )
 
     def set_volume_file_content(self, volume_id: str, file_path: str, content: str):
@@ -154,19 +151,19 @@ class Storage(APIClientBase):
             "/volumes/{volume_id}/files/content",
             volume_id=volume_id,
             query_args={"file_path": file_path},
-            body={'content': content}
+            body={"content": content},
         )
 
     def create_directory_in_volume(self, volume_id: str, dir_path: str):
         return self.post_request(
             "/volumes/{volume_id}/folder",
             volume_id=volume_id,
-            query_args={"dir_path": dir_path}
+            query_args={"dir_path": dir_path},
         )
 
     def delete_directory_in_volume(self, volume_id: str, dir_path: str):
         return self.delete_request(
             "/volumes/{volume_id}/folder",
             volume_id=volume_id,
-            query_args={"dir_path": dir_path}
+            query_args={"dir_path": dir_path},
         )

syneto_api-0.2.6/src/syneto_api/virt_api.py

@@ -0,0 +1,86 @@
+import os
+from .api_client import APIClientBase
+
+
+class Virtualization(APIClientBase):
+    def __init__(self, url_base=None, **kwargs):
+        super().__init__(
+            url_base or os.environ.get("VIRTUALIZATION_SERVICE", ""), **kwargs
+        )
+
+    def wait_for_task(self, task_syn_id):
+        while True:
+            try:
+                result = self.get_request(
+                    "/vmware/tasks/{task_syn_id}", task_syn_id=task_syn_id
+                )
+                if result["state"] in ["success"]:
+                    return
+            except APIException as e:
+                raise
+
+    def get_hypervisors(self):
+        return self.get_request("/hypervisors")
+
+    def get_vms(self):
+        return self.get_request("/vms")
+
+    def get_vmware_hosts(self):
+        return self.get_request("/vmware/hosts")
+
+    def get_vmware_datastores(self):
+        return self.get_request("/vmware/datastores")
+
+    def get_vm_snapshot(self, vm_syn_id: str, snapshot_name: str):
+        snapshots = self.get_request("/vms/{vm_syn_id}/snapshots", vm_syn_id=vm_syn_id)
+        return next((snap for snap in snapshots if snap["name"] == snapshot_name), None)
+
+    def create_vm_snapshot(
+        self,
+        vm_syn_id: str,
+        snapshot_name: str,
+        quiesce: bool = True,
+        dumpmem: bool = False,
+    ):
+        body = {
+            "name": snapshot_name,
+            "description": snapshot_name,
+            "quiesce": quiesce,
+            "dumpmem": dumpmem,
+        }
+        task = self.post_request(
+            "/vms/{vm_syn_id}/snapshots",
+            vm_syn_id=vm_syn_id,
+            query_args={"wait_for_task": "false"},
+            body=body,
+        )
+        self.wait_for_task(task["synId"])
+        return self.get_vm_snapshot(vm_syn_id, snapshot_name)
+
+    def delete_vm_snapshot(self, vm_syn_id, snapshot_ref_id):
+        task = self.delete_request(
+            "/vms/{vm_syn_id}/snapshots",
+            vm_syn_id=vm_syn_id,
+            query_args={"snapshot_ref_id": snapshot_ref_id, "wait_for_task": "true"},
+            success_codes=[200, 202, 204],
+        )
+        self.wait_for_task(task["synId"])
+
+    def get_image_repository(self):
+        return self.get_request("/image-repository")
+
+    def create_nas_datastore(self, server: str, mountpoint: str, hosts_syn_ids=None):
+        return self.post_request(
+            "/vmware/datastores",
+            body={
+                "server": server,
+                "mountpoint": mountpoint,
+                "hosts_syn_ids": hosts_syn_ids if hosts_syn_ids else [],
+            },
+        )
+
+    def delete_nas_datastore(self, syn_id: str = None, mountpoint: str = None):
+        return self.delete_request(
+            "/vmware/datastores",
+            query_args={"datastore_syn_id": syn_id, "datastore_mountpoint": mountpoint},
+        )

syneto_api-0.2.4/src/syneto_api/virt_api.py

@@ -1,40 +0,0 @@
-import os
-from .api_client import APIClientBase
-
-
-class Virtualization(APIClientBase):
-    def __init__(self, url_base=None, **kwargs):
-        super().__init__(
-            url_base or os.environ.get("VIRTUALIZATION_SERVICE", ""), **kwargs
-        )
-
-    def get_hypervisors(self):
-        return self.get_request("/hypervisors")
-
-    def get_vms(self):
-        return self.get_request("/vms")
-
-    def get_vmware_hosts(self):
-        return self.get_request("/vmware/hosts")
-
-    def get_vmware_datastores(self):
-        return self.get_request("/vmware/datastores")
-
-    def get_image_repository(self):
-        return self.get_request("/image-repository")
-
-    def create_nas_datastore(self, server: str, mountpoint: str, hosts_syn_ids=None):
-        return self.post_request(
-            "/vmware/datastores",
-            body={
-                "server": server,
-                "mountpoint": mountpoint,
-                "hosts_syn_ids": hosts_syn_ids if hosts_syn_ids else [],
-            },
-        )
-
-    def delete_nas_datastore(self, syn_id: str = None, mountpoint: str = None):
-        return self.delete_request(
-            "/vmware/datastores",
-            query_args={"datastore_syn_id": syn_id, "datastore_mountpoint": mountpoint},
-        )