syneto_api 0.3.76__tar.gz → 0.3.78__tar.gz

{syneto_api-0.3.76 → syneto_api-0.3.78}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: syneto_api
-Version: 0.3.76
+Version: 0.3.78
 Summary: Syneto Client API library
 License: Proprietary
 Author: Syneto

{syneto_api-0.3.76 → syneto_api-0.3.78}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "syneto_api"
-version = "0.3.76"
+version = "0.3.78"
 description = "Syneto Client API library"
 authors = ["Syneto <developers@syneto.eu>"]
 license = "Proprietary"

syneto_api-0.3.78/src/syneto_api/apollo_api.py

@@ -0,0 +1,181 @@
+import os
+
+from .api_client import APIClientBase, InvalidInputException
+
+# Sentinel used by update_identity to distinguish "field not provided"
+# (omit from the JSON body) from "explicit null" (include as JSON null).
+_UNSET = object()
+
+
+class Apollo(APIClientBase):
+    """Client for the Apollo networking service.
+
+    Apollo is a host-local service providing network management (vSwitches, port groups, NICs,
+    hostname, service address resolution).
+
+    By default, connects directly to Apollo at the APOLLO_SERVICE env var (e.g. http://172.16.254.2:6000).
+
+    TODO: Add Minerva proxy support. When Minerva proxy is available, Apollo endpoints will be
+    accessed via /api/virtualization/v1/computeHosts/{id}/network/v1/... through Minerva.
+    """
+
+    def __init__(self, url_base=None, custom_retry_config=None, **kwargs):
+        super().__init__(url_base or os.environ.get("APOLLO_SERVICE", ""), **kwargs)
+        self._custom_retry_config = custom_retry_config
+
+    @property
+    def _retry_config(self):
+        return self._custom_retry_config or super()._retry_config
+
+    # --- vSwitches ---
+
+    def get_vswitches(self):
+        """List all vSwitches."""
+        return self.get_request("/v1/vswitches")
+
+    def get_vswitch(self, vswitch_id: str):
+        """Get a single vSwitch by ID."""
+        if not vswitch_id:
+            raise InvalidInputException(f"Expected a valid vswitch id, received: `{vswitch_id}`")
+        return self.get_request("/v1/vswitches/{id}", id=vswitch_id)
+
+    # --- Port Groups ---
+
+    def get_port_groups(self, tag: str = None):
+        """List all port groups, with optional tag filter."""
+        query_args = {}
+        if tag:
+            query_args["tag"] = tag
+        return self.get_request("/v1/port-groups", query_args=query_args or None)
+
+    def get_port_group(self, port_group_id: str):
+        """Get a single port group by ID."""
+        if not port_group_id:
+            raise InvalidInputException(f"Expected a valid port group id, received: `{port_group_id}`")
+        return self.get_request("/v1/port-groups/{id}", id=port_group_id)
+
+    def patch_port_group(self, vswitch_id: str, port_group_id: str, body: dict):
+        """PATCH a port group's configuration.
+
+        The body is passed through to Apollo unchanged. For a vmkernel PG's
+        ``networkConfig``, the request shape is flat:
+
+        .. code-block:: python
+
+            {
+                "networkConfig": {
+                    "method": "dhcp",                       # "dhcp" / "static" / "none"
+                    "dnsServers": ["8.8.8.8"],              # configured override
+                    "searchDomains": ["override.lan"],      # configured override
+                    "ignoreAutoDns": True,                  # only on dhcp; replace lease DNS
+                }
+            }
+
+        Response shape carries DHCP-pushed values for read-only inspection:
+
+        .. code-block:: python
+
+            "networkConfig": {
+                "dnsServers":    {"configured": [...], "fromLease": [...]},
+                "searchDomains": {"configured": [...], "fromLease": [...]},
+                "ignoreAutoDns": True | False | None,
+            }
+
+        Other fields the request accepts: ``name``, ``tags``, ``vlanConfig``.
+        Apollo enforces strict validation (extra keys rejected with 422).
+        """
+        if not vswitch_id:
+            raise InvalidInputException(f"Expected a valid vswitch id, received: `{vswitch_id}`")
+        if not port_group_id:
+            raise InvalidInputException(f"Expected a valid port group id, received: `{port_group_id}`")
+        if not isinstance(body, dict) or not body:
+            raise InvalidInputException("Expected a non-empty body dict for port-group PATCH")
+        return self.patch_request(
+            "/v1/vswitches/{id}/port-groups/{pg_id}",
+            body=body,
+            id=vswitch_id,
+            pg_id=port_group_id,
+        )
+
+    # --- NICs ---
+
+    def get_nics(self):
+        """List all NICs."""
+        return self.get_request("/v1/nics")
+
+    def get_nic(self, name: str):
+        """Get a single NIC by name."""
+        if not name:
+            raise InvalidInputException(f"Expected a valid NIC name, received: `{name}`")
+        return self.get_request("/v1/nics/{name}", name=name)
+
+    def enable_nic(self, name: str):
+        """Enable a NIC."""
+        if not name:
+            raise InvalidInputException(f"Expected a valid NIC name, received: `{name}`")
+        return self.post_request("/v1/nics/{name}:enable", name=name)
+
+    def disable_nic(self, name: str):
+        """Disable a NIC."""
+        if not name:
+            raise InvalidInputException(f"Expected a valid NIC name, received: `{name}`")
+        return self.post_request("/v1/nics/{name}:disable", name=name)
+
+    # --- System ---
+
+    def get_service_addresses(self, tag: str):
+        """Resolve service addresses for a given tag."""
+        if not tag:
+            raise InvalidInputException(f"Expected a valid tag, received: `{tag}`")
+        return self.get_request("/v1/system/service-addresses/{tag}", tag=tag)
+
+    def get_identity(self):
+        """Get the system identity (short hostname + primary domain + derived FQDN).
+
+        Response keys:
+          - ``shortHostname``: the short RFC 1123 label
+          - ``primaryDomain``: the configured primary domain, or ``None`` when the
+            FQDN collapses to the short hostname
+          - ``fqdn``: the derived fully-qualified name (read from ``hostname -f``)
+          - ``orphaned``: ``True`` when the configured primary no longer appears
+            in the management-PG candidate union
+          - ``primaryDomainCandidates``: deduplicated, lexicographically ordered
+            list of ``{"domain": str, "origin": list[str]}`` entries from
+            management-tagged PG ``ipv4.dns-search`` values (and DHCP-supplied
+            search domains for DHCP-method connections)
+        """
+        return self.get_request("/v1/system/identity")
+
+    def update_identity(self, short_hostname=_UNSET, primary_domain=_UNSET):
+        """Update the system identity.
+
+        Each field is independently optional. Two distinct signals exist for
+        ``primary_domain``:
+
+          - omitted (default sentinel) -- "do not touch the primary domain";
+            the field is left out of the JSON body entirely
+          - ``None`` -- "clear the primary domain"; the field is sent as JSON
+            ``null`` so the FQDN collapses to the short hostname
+          - a string -- set the primary domain to that value (must be one of
+            the candidates returned by :py:meth:`get_identity`)
+
+        ``short_hostname`` follows the same shape: omit to leave unchanged, or
+        pass a single RFC 1123 label (no dots) to update it. At least one of
+        the two fields must be provided; passing neither sends an empty body
+        and is rejected by the server.
+
+        Response keys:
+          - ``shortHostname``, ``primaryDomain``, ``fqdn``: the new state
+          - ``rebootRecommended``: ``True`` after any identity change
+          - ``sideEffects``: ``{"hostsFileUpdated": bool, "certificateRenewed": bool}``
+        """
+        body: dict = {}
+        if short_hostname is not _UNSET:
+            if not short_hostname:
+                raise InvalidInputException(f"Expected a valid short hostname, received: `{short_hostname}`")
+            body["shortHostname"] = short_hostname
+        if primary_domain is not _UNSET:
+            body["primaryDomain"] = primary_domain
+        if not body:
+            raise InvalidInputException("Expected at least one of short_hostname or primary_domain to be provided")
+        return self.patch_request("/v1/system/identity", body=body)

{syneto_api-0.3.76 → syneto_api-0.3.78}/src/syneto_api/storage_api.py

@@ -9,8 +9,9 @@ class Storage(APIClientBase):
     def __init__(self, url_base=None, **kwargs):
         super().__init__(url_base or os.environ.get("STORAGE_SERVICE", ""), **kwargs)
 
-    def get_pools(self):
-        return self.get_request("/pools")
+    def get_pools(self, fields: list = None):
+        fields = {"fields": ",".join(fields)} if fields else None
+        return self.get_request("/pools", query_args=fields)
 
     def get_importable_pools(self):
         return self.get_request("/pools/importable")

syneto_api-0.3.76/src/syneto_api/apollo_api.py

@@ -1,94 +0,0 @@
-import os
-
-from .api_client import APIClientBase, InvalidInputException
-
-
-class Apollo(APIClientBase):
-    """Client for the Apollo networking service.
-
-    Apollo is a host-local service providing network management (vSwitches, port groups, NICs,
-    hostname, service address resolution).
-
-    By default, connects directly to Apollo at the APOLLO_SERVICE env var (e.g. http://172.16.254.2:6000).
-
-    TODO: Add Minerva proxy support. When Minerva proxy is available, Apollo endpoints will be
-    accessed via /api/virtualization/v1/computeHosts/{id}/network/v1/... through Minerva.
-    """
-
-    def __init__(self, url_base=None, custom_retry_config=None, **kwargs):
-        super().__init__(url_base or os.environ.get("APOLLO_SERVICE", ""), **kwargs)
-        self._custom_retry_config = custom_retry_config
-
-    @property
-    def _retry_config(self):
-        return self._custom_retry_config or super()._retry_config
-
-    # --- vSwitches ---
-
-    def get_vswitches(self):
-        """List all vSwitches."""
-        return self.get_request("/v1/vswitches")
-
-    def get_vswitch(self, vswitch_id: str):
-        """Get a single vSwitch by ID."""
-        if not vswitch_id:
-            raise InvalidInputException(f"Expected a valid vswitch id, received: `{vswitch_id}`")
-        return self.get_request("/v1/vswitches/{id}", id=vswitch_id)
-
-    # --- Port Groups ---
-
-    def get_port_groups(self, tag: str = None):
-        """List all port groups, with optional tag filter."""
-        query_args = {}
-        if tag:
-            query_args["tag"] = tag
-        return self.get_request("/v1/port-groups", query_args=query_args or None)
-
-    def get_port_group(self, port_group_id: str):
-        """Get a single port group by ID."""
-        if not port_group_id:
-            raise InvalidInputException(f"Expected a valid port group id, received: `{port_group_id}`")
-        return self.get_request("/v1/port-groups/{id}", id=port_group_id)
-
-    # --- NICs ---
-
-    def get_nics(self):
-        """List all NICs."""
-        return self.get_request("/v1/nics")
-
-    def get_nic(self, name: str):
-        """Get a single NIC by name."""
-        if not name:
-            raise InvalidInputException(f"Expected a valid NIC name, received: `{name}`")
-        return self.get_request("/v1/nics/{name}", name=name)
-
-    def enable_nic(self, name: str):
-        """Enable a NIC."""
-        if not name:
-            raise InvalidInputException(f"Expected a valid NIC name, received: `{name}`")
-        return self.post_request("/v1/nics/{name}:enable", name=name)
-
-    def disable_nic(self, name: str):
-        """Disable a NIC."""
-        if not name:
-            raise InvalidInputException(f"Expected a valid NIC name, received: `{name}`")
-        return self.post_request("/v1/nics/{name}:disable", name=name)
-
-    # --- System ---
-
-    def get_service_addresses(self, tag: str):
-        """Resolve service addresses for a given tag."""
-        if not tag:
-            raise InvalidInputException(f"Expected a valid tag, received: `{tag}`")
-        return self.get_request("/v1/system/service-addresses/{tag}", tag=tag)
-
-    def get_hostname(self):
-        """Get the system hostname."""
-        return self.get_request("/v1/system/hostname")
-
-    def update_hostname(self, hostname: str):
-        """Update the system hostname."""
-        if not hostname:
-            raise InvalidInputException(f"Expected a valid hostname, received: `{hostname}`")
-        body = {"hostname": hostname}
-        return self.patch_request("/v1/system/hostname", body=body)