zscaler-sdk-python 1.0.0__py2.py3-none-any.whl

zscaler/zpa/segment_groups.py

@@ -0,0 +1,191 @@
+# -*- coding: utf-8 -*-
+
+# Copyright (c) 2023, Zscaler Inc.
+#
+# Permission to use, copy, modify, and/or distribute this software for any
+# purpose with or without fee is hereby granted, provided that the above
+# copyright notice and this permission notice appear in all copies.
+#
+# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
+
+from box import Box, BoxList
+from requests import Response
+
+from zscaler.utils import snake_to_camel
+
+from . import ZPAClient
+
+
+class SegmentGroupsAPI:
+    def __init__(self, client: ZPAClient):
+        self.rest = client
+
+    def list_groups(self, **kwargs) -> BoxList:
+        """
+        Returns a list of all configured segment groups.
+
+        Returns:
+            :obj:`BoxList`: A list of all configured segment groups.
+
+        Examples:
+            >>> for segment_group in zpa.segment_groups.list_groups():
+            ...    pprint(segment_group)
+
+        """
+        list, _ = self.rest.get_paginated_data(
+            path="/segmentGroup", **kwargs, api_version="v1"
+        )
+        return list
+
+    def get_group(self, group_id: str) -> Box:
+        """
+        Returns information on the specified segment group.
+
+        Args:
+            group_id (str):
+                The unique identifier for the segment group.
+
+        Returns:
+            :obj:`Box`: The resource record for the segment group.
+
+        Examples:
+            >>> pprint(zpa.segment_groups.get_group('99999'))
+
+        """
+        return self.rest.get(f"segmentGroup/{group_id}")
+
+    def get_segment_group_by_name(self, name):
+        apps = self.list_groups()
+        for app in apps:
+            if app.get("name") == name:
+                return app
+        return None
+
+    def add_group(self, name: str, enabled: bool = True, **kwargs) -> Box:
+        """
+        Adds a new segment group.
+
+        Args:
+            name (str):
+                The name of the new segment group.
+            enabled (bool):
+                Enable the segment group. Defaults to True.
+            **kwargs:
+
+        Keyword Args:
+            application_ids (:obj:`list` of :obj:`dict`):
+                Unique application IDs to associate with the segment group.
+            config_space (str):
+                The config space for the segment group. Can either be DEFAULT or SIEM.
+            description (str):
+                A description for the segment group.
+            policy_migrated (bool):
+
+        Returns:
+            :obj:`Box`: The resource record for the newly created segment group.
+
+        Examples:
+            Creating a segment group with the minimum required parameters:
+
+            >>> zpa.segment_groups.add_group('new_segment_group',
+            ...    True)
+
+        """
+
+        payload = {
+            "name": name,
+            "enabled": enabled,
+        }
+
+        if kwargs.get("application_ids"):
+            payload["applications"] = [
+                {"id": app_id} for app_id in kwargs.pop("application_ids")
+            ]
+
+        # Add optional parameters to payload
+        for key, value in kwargs.items():
+            payload[snake_to_camel(key)] = value
+
+        response = self.rest.post("segmentGroup", json=payload)
+        if isinstance(response, Response):
+            # this is only true when the creation failed (status code is not 2xx)
+            status_code = response.status_code
+            # Handle error response
+            raise Exception(
+                f"API call failed with status {status_code}: {response.json()}"
+            )
+        return response
+
+    def update_group(self, group_id: str, **kwargs) -> Box:
+        """
+        Updates an existing segment group.
+
+        Args:
+            group_id (str):
+                The unique identifier for the segment group to be updated.
+            **kwargs: Optional keyword args.
+
+        Keyword Args:
+            name (str):
+                The name of the new segment group.
+            enabled (bool):
+                Enable the segment group.
+            application_ids (:obj:`list` of :obj:`dict`):
+                Unique application IDs to associate with the segment group.
+            config_space (str):
+                The config space for the segment group. Can either be DEFAULT or SIEM.
+            description (str):
+                A description for the segment group.
+            policy_migrated (bool):
+
+        Returns:
+            :obj:`Box`: The resource record for the updated segment group.
+
+        Examples:
+            Updating the name of a segment group:
+
+            >>> zpa.segment_groups.update_group('99999',
+            ...    name='updated_name')
+
+        """
+        # Set payload to value of existing record
+        payload = {snake_to_camel(k): v for k, v in self.get_group(group_id).items()}
+
+        if kwargs.get("application_ids"):
+            payload["applications"] = [
+                {"id": app_id} for app_id in kwargs.pop("application_ids")
+            ]
+
+        # Add optional parameters to payload
+        for key, value in kwargs.items():
+            payload[snake_to_camel(key)] = value
+
+        resp = self.rest.put(f"segmentGroup/{group_id}", json=payload).status_code
+
+        # Return the object if it was updated successfully
+        if not isinstance(resp, Response):
+            return self.get_group(group_id)
+
+    def delete_group(self, group_id: str) -> int:
+        """
+        Deletes the specified segment group.
+
+        Args:
+            group_id (str):
+                The unique identifier for the segment group to be deleted.
+
+        Returns:
+            :obj:`int`: The response code for the operation.
+
+        Examples:
+            >>> zpa.segment_groups.delete_group('99999')
+
+        """
+        return self.rest.delete(f"segmentGroup/{group_id}").status_code

zscaler/zpa/server_groups.py

@@ -0,0 +1,217 @@
+# -*- coding: utf-8 -*-
+
+# Copyright (c) 2023, Zscaler Inc.
+#
+# Permission to use, copy, modify, and/or distribute this software for any
+# purpose with or without fee is hereby granted, provided that the above
+# copyright notice and this permission notice appear in all copies.
+#
+# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
+from box import Box, BoxList
+from requests import Response
+
+from zscaler.utils import add_id_groups, snake_to_camel
+from zscaler.zpa.client import ZPAClient
+
+
+class ServerGroupsAPI:
+    reformat_params = [
+        ("application_ids", "applications"),
+        ("server_ids", "servers"),
+        ("app_connector_group_ids", "appConnectorGroups"),
+    ]
+
+    def __init__(self, client: ZPAClient):
+        self.rest = client
+
+    def list_groups(self, **kwargs) -> BoxList:
+        """
+        Returns a list of all configured server groups.
+
+        Keyword Args:
+            **max_items (int):
+                The maximum number of items to request before stopping iteration.
+            **max_pages (int):
+                The maximum number of pages to request before stopping iteration.
+            **pagesize (int):
+                Specifies the page size. The default size is 20, but the maximum size is 500.
+            **search (str, optional):
+                The search string used to match against features and fields.
+
+        Returns:
+            :obj:`BoxList`: A list of all configured server groups.
+
+        Examples:
+            >>> for server_group in zpa.server_groups.list_groups():
+            ...    pprint(server_group)
+
+        """
+        list, _ = self.rest.get_paginated_data(
+            path="/serverGroup", **kwargs, api_version="v1"
+        )
+        return list
+
+    def get_group(self, group_id: str) -> Box:
+        """
+        Provides information on the specified server group.
+
+        Args:
+            group_id (str):
+                The unique id for the server group.
+
+        Returns:
+            :obj:`Box`: The resource record for the server group.
+
+        Examples:
+            >>> pprint(zpa.server_groups.get_group('99999'))
+
+        """
+
+        return self.rest.get(f"serverGroup/{group_id}")
+
+    def get_server_group_by_name(self, name):
+        groups = self.list_groups()
+        for group in groups:
+            if group.get("name") == name:
+                return group
+        return None
+
+    def add_group(self, app_connector_group_ids: list, name: str, **kwargs) -> Box:
+        """
+        Adds a server group.
+
+        Args:
+            name (str):
+                The name for the server group.
+            app_connector_group_ids (:obj:`list` of :obj:`str`):
+                A list of application connector IDs that will be attached to the server group.
+            **kwargs:
+                Optional params.
+
+        Keyword Args:
+            application_ids (:obj:`list` of :obj:`str`):
+                A list of unique IDs of applications to associate with this server group.
+            config_space (str): The configuration space. Accepted values are `DEFAULT` or `SIEM`.
+            description (str): Additional information about the server group.
+            enabled (bool): Enable the server group.
+            ip_anchored (bool): Enable IP Anchoring.
+            dynamic_discovery (bool): Enable Dynamic Discovery.
+            server_ids (:obj:`list` of :obj:`str`):
+                A list of unique IDs of servers to associate with this server group.
+
+        Returns:
+            :obj:`Box`: The resource record for the newly created server group.
+
+        Examples:
+            Create a server group with the minimum params:
+
+            >>> zpa.server_groups.add_group('new_server_group'
+            ...    app_connector_group_ids['99999'])
+
+            Create a server group and define a new server on the fly:
+
+            >>> zpa.server_groups.add_group('new_server_group',
+            ...    app_connector_group_ids=['99999'],
+            ...    enabled=True,
+            ...    servers=[{
+            ...      'name': 'new_server',
+            ...      'address': '10.0.0.30',
+            ...      'enabled': True}])
+
+        """
+        # Initialise payload
+        payload = {
+            "name": name,
+            "appConnectorGroups": [
+                {"id": group_id} for group_id in app_connector_group_ids
+            ],
+        }
+
+        add_id_groups(self.reformat_params, kwargs, payload)
+
+        # Add optional parameters to payload
+        for key, value in kwargs.items():
+            payload[snake_to_camel(key)] = value
+
+        response = self.rest.post("serverGroup", json=payload)
+        if isinstance(response, Response):
+            # this is only true when the creation failed (status code is not 2xx)
+            status_code = response.status_code
+            # Handle error response
+            raise Exception(
+                f"API call failed with status {status_code}: {response.json()}"
+            )
+        return response
+
+    def update_group(self, group_id: str, **kwargs) -> Box:
+        """
+        Updates a server group.
+
+        Args:
+            group_id (str, required):
+                The unique identifier for the server group.
+            **kwargs: Optional keyword args.
+
+        Keyword Args:
+            app_connector_group_ids (:obj:`list` of :obj:`str`):
+                A list of application connector IDs that will be attached to the server group.
+            application_ids (:obj:`list` of :obj:`str`):
+                A list of unique IDs of applications to associate with this server group.
+            config_space (str): The configuration space. Accepted values are `DEFAULT` or `SIEM`.
+            description (str): Additional information about the server group.
+            enabled (bool): Enable the server group.
+            ip_anchored (bool): Enable IP Anchoring.
+            dynamic_discovery (bool): Enable Dynamic Discovery.
+            server_ids (:obj:`list` of :obj:`str`):
+                A list of unique IDs of servers to associate with this server group
+
+        Returns:
+            :obj:`Box`: The resource record for the updated server group.
+
+        Examples:
+            Update the name of a server group:
+
+            >>> zpa.server_groups.update_group(name='Updated Name')
+
+            Enable IP anchoring and Dynamic Discovery:
+
+            >>> zpa.server_groups.update_group(ip_anchored=True,
+            ...    dynamic_discovery=True)
+
+        """
+        # Set payload to value of existing record
+        payload = {snake_to_camel(k): v for k, v in self.get_group(group_id).items()}
+
+        add_id_groups(self.reformat_params, kwargs, payload)
+
+        # Add optional parameters to payload
+        for key, value in kwargs.items():
+            payload[snake_to_camel(key)] = value
+
+        resp = self.rest.put(f"serverGroup/{group_id}", json=payload).status_code
+        if not isinstance(resp, Response):
+            return self.get_group(group_id)
+
+    def delete_group(self, group_id: str) -> int:
+        """
+        Deletes the specified server group.
+
+        Args:
+            group_id (str):
+                The unique id for the server group to be deleted.
+
+        Returns:
+            :obj:`int`: The response code for the operation.
+
+        Examples:
+            >>> zpa.server_groups.delete_group('99999')
+
+        """
+        return self.rest.delete(f"serverGroup/{group_id}").status_code

zscaler/zpa/servers.py

@@ -0,0 +1,202 @@
+# -*- coding: utf-8 -*-
+
+# Copyright (c) 2023, Zscaler Inc.
+#
+# Permission to use, copy, modify, and/or distribute this software for any
+# purpose with or without fee is hereby granted, provided that the above
+# copyright notice and this permission notice appear in all copies.
+#
+# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
+
+from box import Box, BoxList
+from requests import Response
+
+from zscaler.utils import snake_to_camel
+from zscaler.zpa.client import ZPAClient
+
+
+class AppServersAPI:
+    def __init__(self, client: ZPAClient):
+        self.rest = client
+
+    def list_servers(self, **kwargs) -> BoxList:
+        """
+        Returns all configured servers.
+
+        Keyword Args:
+            **max_items (int):
+                The maximum number of items to request before stopping iteration.
+            **max_pages (int):
+                The maximum number of pages to request before stopping iteration.
+            **pagesize (int):
+                Specifies the page size. The default size is 20, but the maximum size is 500.
+            **search (str, optional):
+                The search string used to match against features and fields.
+
+        Returns:
+            :obj:`BoxList`: List of all configured servers.
+
+        Examples:
+            >>> servers = zpa.servers.list_servers()
+        """
+        list, _ = self.rest.get_paginated_data(
+            path="/server", **kwargs, api_version="v1"
+        )
+        return list
+
+    def get_server(self, server_id: str) -> Box:
+        """
+        Gets information on the specified server.
+
+        Args:
+            server_id (str):
+                The unique identifier for the server.
+
+        Returns:
+            :obj:`Box`: The resource record for the server.
+
+        Examples:
+            >>> server = zpa.servers.get_server('99999')
+
+        """
+        response = self.rest.get("/server/%s" % (server_id))
+        if isinstance(response, Response):
+            status_code = response.status_code
+            if status_code != 200:
+                return None
+        return response
+
+    def get_server_by_name(self, name):
+        apps = self.list_servers()
+        for app in apps:
+            if app.get("name") == name:
+                return app
+        return None
+
+    def add_server(
+        self, name: str, address: str, enabled: bool = True, **kwargs
+    ) -> Box:
+        """
+        Add a new application server.
+
+        Args:
+            name (str):
+                The name of the server.
+            address (str):
+                The IP address of the server.
+            enabled (bool):
+                 Enable the server. Defaults to True.
+            **kwargs:
+                Optional keyword args.
+
+        Keyword Args:
+            description (str):
+                A description for the server.
+            app_server_group_ids (list):
+                Unique identifiers for the server groups the server belongs to.
+            config_space (str):
+                The configuration space for the server. Defaults to DEFAULT.
+
+        Returns:
+            :obj:`Box`: The resource record for the newly created server.
+
+        Examples:
+            Create a server with the minimum required parameters:
+
+            >>> zpa.servers.add_server(
+            ...   name='myserver.example',
+            ...   address='192.0.2.10',
+            ...   enabled=True)
+
+        """
+        payload = {"name": name, "address": address, "enabled": enabled}
+
+        # Add optional parameters to payload
+        for key, value in kwargs.items():
+            payload[snake_to_camel(key)] = value
+
+        response = self.rest.post("/server", json=payload)
+        if isinstance(response, Response):
+            status_code = response.status_code
+            if status_code > 299:
+                return None
+        return self.get_server(response.get("id"))
+
+    def update_server(self, server_id: str, **kwargs) -> Box:
+        """
+        Updates the specified server.
+
+        Args:
+            server_id (str):
+                The unique identifier for the server being updated.
+            **kwargs:
+                Optional keyword args.
+
+        Keyword Args:
+            name (str):
+                The name of the server.
+            address (str):
+                The IP address of the server.
+            enabled (bool):
+                 Enable the server.
+            description (str):
+                A description for the server.
+            app_server_group_ids (list):
+                Unique identifiers for the server groups the server belongs to.
+            config_space (str):
+                The configuration space for the server.
+
+        Returns:
+            :obj:`Box`: The resource record for the updated server.
+
+        Examples:
+            Update the name of a server:
+
+            >>> zpa.servers.update_server(
+            ...   '99999',
+            ...   name='newname.example')
+
+            Update the address and enable a server:
+
+            >>> zpa.servers.update_server(
+            ...    '99999',
+            ...    address='192.0.2.20',
+            ...    enabled=True)
+
+        """
+        # Set payload to value of existing record
+        payload = {snake_to_camel(k): v for k, v in self.get_server(server_id).items()}
+
+        # Add optional parameters to payload
+        for key, value in kwargs.items():
+            payload[snake_to_camel(key)] = value
+
+        resp = self.rest.put(f"server/{server_id}", json=payload).status_code
+
+        if resp == 204:
+            return self.get_server(server_id)
+
+    def delete_server(self, server_id: str) -> int:
+        """
+        Delete the specified server.
+
+        The server must not be assigned to any Server Groups or the operation will fail.
+
+        Args:
+            server_id (str): The unique identifier for the server to be deleted.
+
+        Returns:
+            :obj:`int`: The response code for the operation.
+
+        Examples:
+            >>> zpa.servers.delete_server('99999')
+
+        """
+        return self.rest.delete(f"server/{server_id}").status_code