diff --git a/README.md b/README.md index 44454ac..5d4919f 100644 --- a/README.md +++ b/README.md @@ -45,6 +45,7 @@ MIT #### Version | Version | Build | Changes | |-----------| ----- |-----------------------------------------------| +| **6.3.2** | **b1** | Support for February 2023 Controller release. | | **6.3.1** | **b1** | Support for November 2023 Controller release. | | **6.2.3** | **b1** | Support for August 2023 Controller release. | | **6.2.2** | **b1** | Support for June 2023 Controller release. | diff --git a/docs/delete_api.m.html b/docs/delete_api.m.html index 8959d33..76efaae 100644 --- a/docs/delete_api.m.html +++ b/docs/delete_api.m.html @@ -2581,6 +2581,7 @@

Index

  • bgppeers
  • bulkconfigurations_sitetemplates
  • bulkconfigurations_sitetemplates_deployments
  • +
  • demsiteconfigs
  • deviceidconfigs_snmpdiscoverystartnodes
  • deviceidprofiles
  • dhcpservers
  • @@ -2926,6 +2927,28 @@

    prisma_sase.delete_api module

    api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") + def demsiteconfigs(self, site_id, demsiteconfig_id, api_version="v2.0"): + """ + DELETE Demsiteconfigs API Function + + **Parameters:**: + + - **site_id**: Site ID + - **demsiteconfig_id**: NO DESCRIPTION + - **api_version**: API version to use (default v2.0) + + **Returns:** requests.Response object extended with sdk_status and sdk_content properties. + """ + + cur_ctlr = self._parent_class.controller + + url = str(cur_ctlr) + "/sdwan/{}/api/sites/{}/demsiteconfigs/{}".format(api_version, + site_id, + demsiteconfig_id) + + api_logger.debug("URL = %s", url) + return self._parent_class.rest_call(url, "delete") + def deviceidconfigs_snmpdiscoverystartnodes(self, site_id, deviceidconfig_id, snmpdiscoverystartnode_id, api_version="v2.0"): """ DELETE Deviceidconfigs_Snmpdiscoverystartnodes API Function @@ -4692,14 +4715,14 @@

    prisma_sase.delete_api module

    api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") - def serviceendpoints(self, serviceendpoint_id, api_version="v2.3"): + def serviceendpoints(self, serviceendpoint_id, api_version="v2.4"): """ Delete a Service Endpoint (v2.3) **Parameters:**: - **serviceendpoint_id**: Service Endpoint ID - - **api_version**: API version to use (default v2.3) + - **api_version**: API version to use (default v2.4) **Returns:** requests.Response object extended with sdk_status and sdk_content properties. """ @@ -5651,6 +5674,28 @@

    Classes

    api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") + def demsiteconfigs(self, site_id, demsiteconfig_id, api_version="v2.0"): + """ + DELETE Demsiteconfigs API Function + + **Parameters:**: + + - **site_id**: Site ID + - **demsiteconfig_id**: NO DESCRIPTION + - **api_version**: API version to use (default v2.0) + + **Returns:** requests.Response object extended with sdk_status and sdk_content properties. + """ + + cur_ctlr = self._parent_class.controller + + url = str(cur_ctlr) + "/sdwan/{}/api/sites/{}/demsiteconfigs/{}".format(api_version, + site_id, + demsiteconfig_id) + + api_logger.debug("URL = %s", url) + return self._parent_class.rest_call(url, "delete") + def deviceidconfigs_snmpdiscoverystartnodes(self, site_id, deviceidconfig_id, snmpdiscoverystartnode_id, api_version="v2.0"): """ DELETE Deviceidconfigs_Snmpdiscoverystartnodes API Function @@ -7417,14 +7462,14 @@

    Classes

    api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") - def serviceendpoints(self, serviceendpoint_id, api_version="v2.3"): + def serviceendpoints(self, serviceendpoint_id, api_version="v2.4"): """ Delete a Service Endpoint (v2.3) **Parameters:**: - **serviceendpoint_id**: Service Endpoint ID - - **api_version**: API version to use (default v2.3) + - **api_version**: API version to use (default v2.4) **Returns:** requests.Response object extended with sdk_status and sdk_content properties. """ @@ -8830,6 +8875,48 @@

    Static methods

    +
    +
    +

    def demsiteconfigs(

    self, site_id, demsiteconfig_id, api_version='v2.0')

    +
    + + + + +

    DELETE Demsiteconfigs API Function

    +

    Parameters::

    + +

    Returns: requests.Response object extended with sdk_status and sdk_content properties.

    +
    + +
    +
    def demsiteconfigs(self, site_id, demsiteconfig_id, api_version="v2.0"):
    +    """
    +    DELETE Demsiteconfigs API Function
    +      **Parameters:**:
    +      - **site_id**: Site ID
    +      - **demsiteconfig_id**: NO DESCRIPTION
    +      - **api_version**: API version to use (default v2.0)
    +    **Returns:** requests.Response object extended with sdk_status and sdk_content properties.
    +    """
    +    cur_ctlr = self._parent_class.controller
    +    url = str(cur_ctlr) + "/sdwan/{}/api/sites/{}/demsiteconfigs/{}".format(api_version,
    +                                                                            site_id,
    +                                                                            demsiteconfig_id)
    +    api_logger.debug("URL = %s", url)
    +    return self._parent_class.rest_call(url, "delete")
    +
    + +
    +
    + +
    + +

    def deviceidconfigs_snmpdiscoverystartnodes(

    self, site_id, deviceidconfig_id, snmpdiscoverystartnode_id, api_version='v2.0')

    @@ -12228,7 +12315,7 @@

    Static methods

    -

    def serviceendpoints(

    self, serviceendpoint_id, api_version='v2.3')

    +

    def serviceendpoints(

    self, serviceendpoint_id, api_version='v2.4')

    @@ -12238,18 +12325,18 @@

    Static methods

    Parameters::

    • serviceendpoint_id: Service Endpoint ID
    • -
    • api_version: API version to use (default v2.3)
    • +
    • api_version: API version to use (default v2.4)

    Returns: requests.Response object extended with sdk_status and sdk_content properties.

    -
    def serviceendpoints(self, serviceendpoint_id, api_version="v2.3"):
    +    
    def serviceendpoints(self, serviceendpoint_id, api_version="v2.4"):
         """
         Delete a Service Endpoint (v2.3)
           **Parameters:**:
           - **serviceendpoint_id**: Service Endpoint ID
    -      - **api_version**: API version to use (default v2.3)
    +      - **api_version**: API version to use (default v2.4)
         **Returns:** requests.Response object extended with sdk_status and sdk_content properties.
         """
         cur_ctlr = self._parent_class.controller
    diff --git a/docs/get_api.m.html b/docs/get_api.m.html
    index 220028f..05857b1 100644
    --- a/docs/get_api.m.html
    +++ b/docs/get_api.m.html
    @@ -2601,6 +2601,7 @@ 

    Index

  • clients_base_roles
  • clients_machines
  • clients_roles
  • +
  • demsiteconfigs
  • demstatus
  • deviceidconfigs
  • deviceidconfigs_snmpdiscoverystartnodes
  • @@ -2633,6 +2634,7 @@

    Index

  • elements
  • elementsecurityzones
  • elementshells
  • +
  • elementshells_copy_element_configurations_status
  • elementusers
  • elementusers_access
  • elementusers_password
  • @@ -3536,6 +3538,32 @@

    prisma_sase.get_api module

    api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "get") + def demsiteconfigs(self, site_id, demsiteconfig_id=None, api_version="v2.0"): + """ + GET Demsiteconfigs API Function + + **Parameters:**: + + - **site_id**: Site ID + - **demsiteconfig_id**: (optional) NO DESCRIPTION + - **api_version**: API version to use (default v2.0) + + **Returns:** requests.Response object extended with sdk_status and sdk_content properties. + """ + + cur_ctlr = self._parent_class.controller + + if not demsiteconfig_id: + url = str(cur_ctlr) + "/sdwan/{}/api/sites/{}/demsiteconfigs".format(api_version, + site_id) + else: + url = str(cur_ctlr) + "/sdwan/{}/api/sites/{}/demsiteconfigs/{}".format(api_version, + site_id, + demsiteconfig_id) + + api_logger.debug("URL = %s", url) + return self._parent_class.rest_call(url, "get") + def demstatus(self, site_id, demstatus_id=None, api_version="v2.0"): """ Get all ADEM status for a site (v2.0) @@ -4298,6 +4326,28 @@

    prisma_sase.get_api module

    api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "get") + def elementshells_copy_element_configurations_status(self, site_id, elementshell_id, api_version="v2.0"): + """ + GET Elementshells_Copy_Element_Configurations_Status API Function + + **Parameters:**: + + - **site_id**: Site ID + - **elementshell_id**: Element Shell ID + - **api_version**: API version to use (default v2.0) + + **Returns:** requests.Response object extended with sdk_status and sdk_content properties. + """ + + cur_ctlr = self._parent_class.controller + + url = str(cur_ctlr) + "/sdwan/{}/api/sites/{}/elementshells/{}/copy_element_configurations/status".format(api_version, + site_id, + elementshell_id) + + api_logger.debug("URL = %s", url) + return self._parent_class.rest_call(url, "get") + def elementusers(self, elementuser_id=None, api_version="v2.1"): """ Get all element User (v2.1) @@ -5564,14 +5614,14 @@

    prisma_sase.get_api module

    api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "get") - def monitor_metrics(self, metric_id, api_version="v2.4"): + def monitor_metrics(self, metric_id, api_version="v2.5"): """ GET Monitor_Metrics API Function **Parameters:**: - **metric_id**: Metric ID - - **api_version**: API version to use (default v2.4) + - **api_version**: API version to use (default v2.5) **Returns:** requests.Response object extended with sdk_status and sdk_content properties. """ @@ -7486,14 +7536,14 @@

    prisma_sase.get_api module

    api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "get") - def serviceendpoints(self, serviceendpoint_id=None, api_version="v2.3"): + def serviceendpoints(self, serviceendpoint_id=None, api_version="v2.4"): """ Get ServiceEndpointList (v2.3) **Parameters:**: - **serviceendpoint_id**: (optional) Service Endpoint ID - - **api_version**: API version to use (default v2.3) + - **api_version**: API version to use (default v2.4) **Returns:** requests.Response object extended with sdk_status and sdk_content properties. """ @@ -8485,13 +8535,13 @@

    prisma_sase.get_api module

    api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "get") - def tenants(self, api_version="v2.7"): + def tenants(self, api_version="v2.8"): """ Get tenant details for tenant id (v2.3) **Parameters:**: - - **api_version**: API version to use (default v2.7) + - **api_version**: API version to use (default v2.8) **Returns:** requests.Response object extended with sdk_status and sdk_content properties. """ @@ -9213,6 +9263,9 @@

    prisma_sase.get_api module

    status_cellular_modules_m = machine_cellular_modules_status """ Backwards-compatibility alias of `status_cellular_modules_m` to `machine_cellular_modules_status`""" + status_copy_element_configurations_elementshells = elementshells_copy_element_configurations_status + """ Backwards-compatibility alias of `status_copy_element_configurations_elementshells` to `elementshells_copy_element_configurations_status`""" + status_directoryservices = directoryservices_status """ Backwards-compatibility alias of `status_directoryservices` to `directoryservices_status`""" @@ -9972,6 +10025,32 @@

    Classes

    api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "get") + def demsiteconfigs(self, site_id, demsiteconfig_id=None, api_version="v2.0"): + """ + GET Demsiteconfigs API Function + + **Parameters:**: + + - **site_id**: Site ID + - **demsiteconfig_id**: (optional) NO DESCRIPTION + - **api_version**: API version to use (default v2.0) + + **Returns:** requests.Response object extended with sdk_status and sdk_content properties. + """ + + cur_ctlr = self._parent_class.controller + + if not demsiteconfig_id: + url = str(cur_ctlr) + "/sdwan/{}/api/sites/{}/demsiteconfigs".format(api_version, + site_id) + else: + url = str(cur_ctlr) + "/sdwan/{}/api/sites/{}/demsiteconfigs/{}".format(api_version, + site_id, + demsiteconfig_id) + + api_logger.debug("URL = %s", url) + return self._parent_class.rest_call(url, "get") + def demstatus(self, site_id, demstatus_id=None, api_version="v2.0"): """ Get all ADEM status for a site (v2.0) @@ -10734,6 +10813,28 @@

    Classes

    api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "get") + def elementshells_copy_element_configurations_status(self, site_id, elementshell_id, api_version="v2.0"): + """ + GET Elementshells_Copy_Element_Configurations_Status API Function + + **Parameters:**: + + - **site_id**: Site ID + - **elementshell_id**: Element Shell ID + - **api_version**: API version to use (default v2.0) + + **Returns:** requests.Response object extended with sdk_status and sdk_content properties. + """ + + cur_ctlr = self._parent_class.controller + + url = str(cur_ctlr) + "/sdwan/{}/api/sites/{}/elementshells/{}/copy_element_configurations/status".format(api_version, + site_id, + elementshell_id) + + api_logger.debug("URL = %s", url) + return self._parent_class.rest_call(url, "get") + def elementusers(self, elementuser_id=None, api_version="v2.1"): """ Get all element User (v2.1) @@ -12000,14 +12101,14 @@

    Classes

    api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "get") - def monitor_metrics(self, metric_id, api_version="v2.4"): + def monitor_metrics(self, metric_id, api_version="v2.5"): """ GET Monitor_Metrics API Function **Parameters:**: - **metric_id**: Metric ID - - **api_version**: API version to use (default v2.4) + - **api_version**: API version to use (default v2.5) **Returns:** requests.Response object extended with sdk_status and sdk_content properties. """ @@ -13922,14 +14023,14 @@

    Classes

    api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "get") - def serviceendpoints(self, serviceendpoint_id=None, api_version="v2.3"): + def serviceendpoints(self, serviceendpoint_id=None, api_version="v2.4"): """ Get ServiceEndpointList (v2.3) **Parameters:**: - **serviceendpoint_id**: (optional) Service Endpoint ID - - **api_version**: API version to use (default v2.3) + - **api_version**: API version to use (default v2.4) **Returns:** requests.Response object extended with sdk_status and sdk_content properties. """ @@ -14921,13 +15022,13 @@

    Classes

    api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "get") - def tenants(self, api_version="v2.7"): + def tenants(self, api_version="v2.8"): """ Get tenant details for tenant id (v2.3) **Parameters:**: - - **api_version**: API version to use (default v2.7) + - **api_version**: API version to use (default v2.8) **Returns:** requests.Response object extended with sdk_status and sdk_content properties. """ @@ -15649,6 +15750,9 @@

    Classes

    status_cellular_modules_m = machine_cellular_modules_status """ Backwards-compatibility alias of `status_cellular_modules_m` to `machine_cellular_modules_status`""" + status_copy_element_configurations_elementshells = elementshells_copy_element_configurations_status + """ Backwards-compatibility alias of `status_copy_element_configurations_elementshells` to `elementshells_copy_element_configurations_status`""" + status_directoryservices = directoryservices_status """ Backwards-compatibility alias of `status_directoryservices` to `directoryservices_status`""" @@ -16741,6 +16845,17 @@

    Class variables

    +
    +
    +

    var status_copy_element_configurations_elementshells

    + + + + +

    Backwards-compatibility alias of status_copy_element_configurations_elementshells to elementshells_copy_element_configurations_status

    +
    +
    +

    var status_directoryservices

    @@ -18243,6 +18358,52 @@

    Static methods

    +
    +
    +

    def demsiteconfigs(

    self, site_id, demsiteconfig_id=None, api_version='v2.0')

    +
    + + + + +

    GET Demsiteconfigs API Function

    +

    Parameters::

    +
      +
    • site_id: Site ID
    • +
    • demsiteconfig_id: (optional) NO DESCRIPTION
    • +
    • api_version: API version to use (default v2.0)
    • +
    +

    Returns: requests.Response object extended with sdk_status and sdk_content properties.

    +
    + +
    +
    def demsiteconfigs(self, site_id, demsiteconfig_id=None, api_version="v2.0"):
    +    """
    +    GET Demsiteconfigs API Function
    +      **Parameters:**:
    +      - **site_id**: Site ID
    +      - **demsiteconfig_id**: (optional) NO DESCRIPTION
    +      - **api_version**: API version to use (default v2.0)
    +    **Returns:** requests.Response object extended with sdk_status and sdk_content properties.
    +    """
    +    cur_ctlr = self._parent_class.controller
    +    if not demsiteconfig_id:
    +        url = str(cur_ctlr) + "/sdwan/{}/api/sites/{}/demsiteconfigs".format(api_version,
    +                                                                             site_id)
    +    else:
    +        url = str(cur_ctlr) + "/sdwan/{}/api/sites/{}/demsiteconfigs/{}".format(api_version,
    +                                                                                site_id,
    +                                                                                demsiteconfig_id)
    +    api_logger.debug("URL = %s", url)
    +    return self._parent_class.rest_call(url, "get")
    +
    + +
    +
    + +
    + +

    def demstatus(

    self, site_id, demstatus_id=None, api_version='v2.0')

    @@ -19637,6 +19798,48 @@

    Static methods

    +
    +
    +

    def elementshells_copy_element_configurations_status(

    self, site_id, elementshell_id, api_version='v2.0')

    +
    + + + + +

    GET Elementshells_Copy_Element_Configurations_Status API Function

    +

    Parameters::

    +
      +
    • site_id: Site ID
    • +
    • elementshell_id: Element Shell ID
    • +
    • api_version: API version to use (default v2.0)
    • +
    +

    Returns: requests.Response object extended with sdk_status and sdk_content properties.

    +
    + +
    +
    def elementshells_copy_element_configurations_status(self, site_id, elementshell_id, api_version="v2.0"):
    +    """
    +    GET Elementshells_Copy_Element_Configurations_Status API Function
    +      **Parameters:**:
    +      - **site_id**: Site ID
    +      - **elementshell_id**: Element Shell ID
    +      - **api_version**: API version to use (default v2.0)
    +    **Returns:** requests.Response object extended with sdk_status and sdk_content properties.
    +    """
    +    cur_ctlr = self._parent_class.controller
    +    url = str(cur_ctlr) + "/sdwan/{}/api/sites/{}/elementshells/{}/copy_element_configurations/status".format(api_version,
    +                                                                                                              site_id,
    +                                                                                                              elementshell_id)
    +    api_logger.debug("URL = %s", url)
    +    return self._parent_class.rest_call(url, "get")
    +
    + +
    +
    + +
    + +

    def elementusers(

    self, elementuser_id=None, api_version='v2.1')

    @@ -22006,7 +22209,7 @@

    Static methods

    -

    def monitor_metrics(

    self, metric_id, api_version='v2.4')

    +

    def monitor_metrics(

    self, metric_id, api_version='v2.5')

    @@ -22016,18 +22219,18 @@

    Static methods

    Parameters::

    • metric_id: Metric ID
    • -
    • api_version: API version to use (default v2.4)
    • +
    • api_version: API version to use (default v2.5)

    Returns: requests.Response object extended with sdk_status and sdk_content properties.

    -
    def monitor_metrics(self, metric_id, api_version="v2.4"):
    +    
    def monitor_metrics(self, metric_id, api_version="v2.5"):
         """
         GET Monitor_Metrics API Function
           **Parameters:**:
           - **metric_id**: Metric ID
    -      - **api_version**: API version to use (default v2.4)
    +      - **api_version**: API version to use (default v2.5)
         **Returns:** requests.Response object extended with sdk_status and sdk_content properties.
         """
         cur_ctlr = self._parent_class.controller
    @@ -25538,7 +25741,7 @@ 

    Static methods

    -

    def serviceendpoints(

    self, serviceendpoint_id=None, api_version='v2.3')

    +

    def serviceendpoints(

    self, serviceendpoint_id=None, api_version='v2.4')

    @@ -25548,18 +25751,18 @@

    Static methods

    Parameters::

    • serviceendpoint_id: (optional) Service Endpoint ID
    • -
    • api_version: API version to use (default v2.3)
    • +
    • api_version: API version to use (default v2.4)

    Returns: requests.Response object extended with sdk_status and sdk_content properties.

    -
    def serviceendpoints(self, serviceendpoint_id=None, api_version="v2.3"):
    +    
    def serviceendpoints(self, serviceendpoint_id=None, api_version="v2.4"):
         """
         Get ServiceEndpointList (v2.3)
           **Parameters:**:
           - **serviceendpoint_id**: (optional) Service Endpoint ID
    -      - **api_version**: API version to use (default v2.3)
    +      - **api_version**: API version to use (default v2.4)
         **Returns:** requests.Response object extended with sdk_status and sdk_content properties.
         """
         cur_ctlr = self._parent_class.controller
    @@ -27388,7 +27591,7 @@ 

    Static methods

    -

    def tenants(

    self, api_version='v2.7')

    +

    def tenants(

    self, api_version='v2.8')

    @@ -27397,17 +27600,17 @@

    Static methods

    Get tenant details for tenant id (v2.3)

    Parameters::

      -
    • api_version: API version to use (default v2.7)
    • +
    • api_version: API version to use (default v2.8)

    Returns: requests.Response object extended with sdk_status and sdk_content properties.

    -
    def tenants(self, api_version="v2.7"):
    +    
    def tenants(self, api_version="v2.8"):
         """
         Get tenant details for tenant id (v2.3)
           **Parameters:**:
    -      - **api_version**: API version to use (default v2.7)
    +      - **api_version**: API version to use (default v2.8)
         **Returns:** requests.Response object extended with sdk_status and sdk_content properties.
         """
         cur_ctlr = self._parent_class.controller
    diff --git a/docs/index.html b/docs/index.html
    index e325595..e65274f 100644
    --- a/docs/index.html
    +++ b/docs/index.html
    @@ -8,7 +8,7 @@
         prisma_sase documentation
         
       

    prisma_sase module

    Python3 SDK for the Prisma SASE AppFabric

    -

    Version: v6.3.1b1

    +

    Version: v6.3.2b1

    Author: Palo Alto Networks

    Copyright: © 2023 Palo Alto Networks. All rights reserved

    License: MIT

    @@ -2725,7 +2725,7 @@

    For more info

    """
     Python3 SDK for the Prisma SASE AppFabric
     
    -**Version:** v6.3.1b1
    +**Version:** v6.3.2b1
     
     **Author:** Palo Alto Networks
     
    @@ -2885,7 +2885,7 @@ 

    For more info

    """websocket logger is handled slightly differently, so we will have a seperate handle.""" # Version of SDK -version = "6.3.1b1" +version = "6.3.2b1" """SDK Version string""" __version__ = version @@ -3205,6 +3205,12 @@

    For more info

    "eu": "europe"} """ static mapping of telemetry region to x_panw_region """ + client_secret = None + """ needed for login_secret func """ + + tsg_id = None + """ needed for login_secret func """ + def __init__(self, controller=controller, ssl_verify=verify, update_check=True): """ Create the API constructor object @@ -5060,6 +5066,12 @@

    Classes

    "eu": "europe"} """ static mapping of telemetry region to x_panw_region """ + client_secret = None + """ needed for login_secret func """ + + tsg_id = None + """ needed for login_secret func """ + def __init__(self, controller=controller, ssl_verify=verify, update_check=True): """ Create the API constructor object @@ -6506,6 +6518,17 @@

    Class variables

    +
    +
    +

    var client_secret

    + + + + +

    needed for login_secret func

    +
    +
    +

    var controller

    @@ -6715,6 +6738,17 @@

    Class variables

    +
    +
    +

    var tsg_id

    + + + + +

    needed for login_secret func

    +
    +
    +

    var update_check

    @@ -7081,7 +7115,7 @@

    Static methods

    -

    def modify_rest_retry(

    self, total=8, connect=None, read=None, redirect=None, status=None, other=0, allowed_methods=frozenset({'GET', 'TRACE', 'OPTIONS', 'DELETE', 'PUT', 'HEAD'}), status_forcelist=None, backoff_factor=0.705883, raise_on_redirect=True, raise_on_status=True, respect_retry_after_header=True, update_adapter=True)

    +

    def modify_rest_retry(

    self, total=8, connect=None, read=None, redirect=None, status=None, other=0, allowed_methods=frozenset({'GET', 'OPTIONS', 'DELETE', 'TRACE', 'PUT', 'HEAD'}), status_forcelist=None, backoff_factor=0.705883, raise_on_redirect=True, raise_on_status=True, respect_retry_after_header=True, update_adapter=True)

    diff --git a/docs/interactive.m.html b/docs/interactive.m.html index 66bfdec..4ac1958 100644 --- a/docs/interactive.m.html +++ b/docs/interactive.m.html @@ -2979,8 +2979,6 @@

    prisma_sase.interactive module

    # if tsg_id not given on function, or if first login fails, prompt. if self._parent_class.tsg_id: tsg_id = self._parent_class.tsg_id - else: - tsg_id = compat_input(tsg_id_prompt) if grant_type is None: # if grant_type not given. @@ -2988,7 +2986,10 @@

    prisma_sase.interactive module

    if scope is None: # if grant_type not given. - scope = 'tsg_id:{0} email profile'.format(tsg_id) + if tsg_id is None or tsg_id == '': + scope = 'email profile' + else: + scope = 'tsg_id:{0} email profile'.format(tsg_id) self._parent_class.client_id = client_id self._parent_class.client_secret = client_secret @@ -4150,8 +4151,6 @@

    Classes

    # if tsg_id not given on function, or if first login fails, prompt. if self._parent_class.tsg_id: tsg_id = self._parent_class.tsg_id - else: - tsg_id = compat_input(tsg_id_prompt) if grant_type is None: # if grant_type not given. @@ -4159,7 +4158,10 @@

    Classes

    if scope is None: # if grant_type not given. - scope = 'tsg_id:{0} email profile'.format(tsg_id) + if tsg_id is None or tsg_id == '': + scope = 'email profile' + else: + scope = 'tsg_id:{0} email profile'.format(tsg_id) self._parent_class.client_id = client_id self._parent_class.client_secret = client_secret @@ -5747,14 +5749,15 @@

    Static methods

    # if tsg_id not given on function, or if first login fails, prompt. if self._parent_class.tsg_id: tsg_id = self._parent_class.tsg_id - else: - tsg_id = compat_input(tsg_id_prompt) if grant_type is None: # if grant_type not given. grant_type = 'client_credentials' if scope is None: # if grant_type not given. - scope = 'tsg_id:{0} email profile'.format(tsg_id) + if tsg_id is None or tsg_id == '': + scope = 'email profile' + else: + scope = 'tsg_id:{0} email profile'.format(tsg_id) self._parent_class.client_id = client_id self._parent_class.client_secret = client_secret self._parent_class.tsg_id = tsg_id diff --git a/docs/patch_api.m.html b/docs/patch_api.m.html index 33cace4..2ef1830 100644 --- a/docs/patch_api.m.html +++ b/docs/patch_api.m.html @@ -2680,14 +2680,14 @@

    prisma_sase.patch_api module

    api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "patch", data=data) - def tenants(self, data, api_version="v2.7"): + def tenants(self, data, api_version="v2.8"): """ Patch tenant (v2.3) **Parameters:**: - **data**: Dictionary containing data to PATCH as JSON - - **api_version**: API version to use (default v2.7) + - **api_version**: API version to use (default v2.8) **Payload Attributes:** @@ -2771,14 +2771,14 @@

    Classes

    api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "patch", data=data) - def tenants(self, data, api_version="v2.7"): + def tenants(self, data, api_version="v2.8"): """ Patch tenant (v2.3) **Parameters:**: - **data**: Dictionary containing data to PATCH as JSON - - **api_version**: API version to use (default v2.7) + - **api_version**: API version to use (default v2.8) **Payload Attributes:** @@ -2869,7 +2869,7 @@

    Static methods

    -

    def tenants(

    self, data, api_version='v2.7')

    +

    def tenants(

    self, data, api_version='v2.8')

    @@ -2879,19 +2879,19 @@

    Static methods

    Parameters::

    • data: Dictionary containing data to PATCH as JSON
    • -
    • api_version: API version to use (default v2.7)
    • +
    • api_version: API version to use (default v2.8)

    Payload Attributes:

    Returns: requests.Response object extended with sdk_status and sdk_content properties.

    -
    def tenants(self, data, api_version="v2.7"):
    +    
    def tenants(self, data, api_version="v2.8"):
         """
         Patch tenant (v2.3)
           **Parameters:**:
           - **data**: Dictionary containing data to PATCH as JSON
    -      - **api_version**: API version to use (default v2.7)
    +      - **api_version**: API version to use (default v2.8)
           **Payload Attributes:** 
         **Returns:** requests.Response object extended with sdk_status and sdk_content properties.
         """
    diff --git a/docs/post_api.m.html b/docs/post_api.m.html
    index c57e0ce..2b59ef6 100644
    --- a/docs/post_api.m.html
    +++ b/docs/post_api.m.html
    @@ -2589,6 +2589,7 @@ 

    Index

  • bulkconfigurations_sitetemplates
  • bulkconfigurations_sitetemplates_deployments
  • bulkconfigurations_sitetemplates_query
  • +
  • bulkoperations
  • cellular_module_firmware_status_query
  • cellular_modules_query
  • certificate_operations
  • @@ -2597,6 +2598,8 @@

    Index

  • clients_machines_query
  • clients_query
  • clients_reallocate
  • +
  • demsiteconfigs
  • +
  • demsiteconfigs_query
  • demstatus_query
  • deviceidconfigs
  • deviceidconfigs_bulkdelete_snmpdiscoverystartnodes
  • @@ -2623,9 +2626,11 @@

    Index

  • element_extensions_query
  • element_query
  • elementaccessconfigs
  • +
  • elements_rquery
  • elementsecurityzones
  • elementsecurityzones_query
  • elementshells
  • +
  • elementshells_copy_element_configurations
  • elementshells_query
  • elementusers
  • elementusers_access
  • @@ -3315,6 +3320,28 @@

    prisma_sase.post_api module

    api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "post", data=data) + def bulkoperations(self, data, api_version="v2.0"): + """ + POST Bulkoperations API Function + + **Parameters:**: + + - **data**: Dictionary containing data to POST as JSON + - **api_version**: API version to use (default v2.0) + + **Payload Attributes:** + + + **Returns:** requests.Response object extended with sdk_status and sdk_content properties. + """ + + cur_ctlr = self._parent_class.controller + + url = str(cur_ctlr) + "/sdwan/{}/api/sites/bulkoperations".format(api_version) + + api_logger.debug("URL = %s", url) + return self._parent_class.rest_call(url, "post", data=data) + def cellular_module_firmware_status_query(self, data, api_version="v2.0"): """ Query the cellular module firmware upgrade status of all tenant elements (v2.0) @@ -3501,6 +3528,78 @@

    prisma_sase.post_api module

    api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "post", data=data) + def elementshells_copy_element_configurations(self, site_id, elementshell_id, data, api_version="v2.0"): + """ + POST Elementshells_Copy_Element_Configurations API Function + + **Parameters:**: + + - **site_id**: Site ID + - **elementshell_id**: Element Shell ID + - **data**: Dictionary containing data to POST as JSON + - **api_version**: API version to use (default v2.0) + + **Payload Attributes:** + + + **Returns:** requests.Response object extended with sdk_status and sdk_content properties. + """ + + cur_ctlr = self._parent_class.controller + + url = str(cur_ctlr) + "/sdwan/{}/api/sites/{}/elementshells/{}/copy_element_configurations".format(api_version, + site_id, + elementshell_id) + + api_logger.debug("URL = %s", url) + return self._parent_class.rest_call(url, "post", data=data) + + def demsiteconfigs(self, site_id, data, api_version="v2.0"): + """ + POST Demsiteconfigs API Function + + **Parameters:**: + + - **site_id**: Site ID + - **data**: Dictionary containing data to POST as JSON + - **api_version**: API version to use (default v2.0) + + **Payload Attributes:** + + + **Returns:** requests.Response object extended with sdk_status and sdk_content properties. + """ + + cur_ctlr = self._parent_class.controller + + url = str(cur_ctlr) + "/sdwan/{}/api/sites/{}/demsiteconfigs".format(api_version, + site_id) + + api_logger.debug("URL = %s", url) + return self._parent_class.rest_call(url, "post", data=data) + + def demsiteconfigs_query(self, data, api_version="v2.0"): + """ + POST Demsiteconfigs_Query API Function + + **Parameters:**: + + - **data**: Dictionary containing data to POST as JSON + - **api_version**: API version to use (default v2.0) + + **Payload Attributes:** + + + **Returns:** requests.Response object extended with sdk_status and sdk_content properties. + """ + + cur_ctlr = self._parent_class.controller + + url = str(cur_ctlr) + "/sdwan/{}/api/demsiteconfigs/query".format(api_version) + + api_logger.debug("URL = %s", url) + return self._parent_class.rest_call(url, "post", data=data) + def demstatus_query(self, data, api_version="v2.0"): """ Query ADEM status (v2.0) @@ -4105,6 +4204,28 @@

    prisma_sase.post_api module

    api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "post", data=data) + def elements_rquery(self, data, api_version="v3.0"): + """ + POST Elements_Rquery API Function + + **Parameters:**: + + - **data**: Dictionary containing data to POST as JSON + - **api_version**: API version to use (default v3.0) + + **Payload Attributes:** + + + **Returns:** requests.Response object extended with sdk_status and sdk_content properties. + """ + + cur_ctlr = self._parent_class.controller + + url = str(cur_ctlr) + "/sdwan/{}/api/elements/rquery".format(api_version) + + api_logger.debug("URL = %s", url) + return self._parent_class.rest_call(url, "post", data=data) + def elementsecurityzones(self, site_id, element_id, data, api_version="v2.0"): """ Create an association between element and security zone. (v2.0) @@ -4383,14 +4504,14 @@

    prisma_sase.post_api module

    api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "post", data=data) - def events_summary(self, data, api_version="v2.0"): + def events_summary(self, data, api_version="v2.1"): """ POST Events_Summary API Function **Parameters:**: - **data**: Dictionary containing data to POST as JSON - - **api_version**: API version to use (default v2.0) + - **api_version**: API version to use (default v2.1) **Payload Attributes:** @@ -5313,14 +5434,14 @@

    prisma_sase.post_api module

    api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "post", data=data) - def monitor_aggregates_healthscore(self, data, api_version="v2.0"): + def monitor_aggregates_healthscore(self, data, api_version="v2.1"): """ POST Monitor_Aggregates_Healthscore API Function **Parameters:**: - **data**: Dictionary containing data to POST as JSON - - **api_version**: API version to use (default v2.0) + - **api_version**: API version to use (default v2.1) **Payload Attributes:** @@ -5709,14 +5830,14 @@

    prisma_sase.post_api module

    api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "post", data=data) - def monitor_metrics(self, data, api_version="v2.4"): + def monitor_metrics(self, data, api_version="v2.5"): """ POST Monitor_Metrics API Function **Parameters:**: - **data**: Dictionary containing data to POST as JSON - - **api_version**: API version to use (default v2.4) + - **api_version**: API version to use (default v2.5) **Payload Attributes:** @@ -8359,14 +8480,14 @@

    prisma_sase.post_api module

    api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "post", data=data) - def serviceendpoints(self, data, api_version="v2.3"): + def serviceendpoints(self, data, api_version="v2.4"): """ Create a new Service Endpoint (v2.3) **Parameters:**: - **data**: Dictionary containing data to POST as JSON - - **api_version**: API version to use (default v2.3) + - **api_version**: API version to use (default v2.4) **Payload Attributes:** @@ -8381,14 +8502,14 @@

    prisma_sase.post_api module

    api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "post", data=data) - def serviceendpoints_query(self, data, api_version="v2.3"): + def serviceendpoints_query(self, data, api_version="v2.4"): """ Queries db for limit number of service bindings that match query params. (v2.3) **Parameters:**: - **data**: Dictionary containing data to POST as JSON - - **api_version**: API version to use (default v2.3) + - **api_version**: API version to use (default v2.4) **Payload Attributes:** @@ -10090,6 +10211,9 @@

    prisma_sase.post_api module

    configs_sdwanapps = sdwanapps_configs """ Backwards-compatibility alias of `configs_sdwanapps` to `sdwanapps_configs`""" + copy_element_configurations_elementshells = elementshells_copy_element_configurations + """ Backwards-compatibility alias of `copy_element_configurations_elementshells` to `elementshells_copy_element_configurations`""" + deltasync_directoryservices = directoryservices_deltasync """ Backwards-compatibility alias of `deltasync_directoryservices` to `directoryservices_deltasync`""" @@ -10288,6 +10412,9 @@

    prisma_sase.post_api module

    query_current_status_software = software_current_status_query """ Backwards-compatibility alias of `query_current_status_software` to `software_current_status_query`""" + query_demsiteconfigs = demsiteconfigs_query + """ Backwards-compatibility alias of `query_demsiteconfigs` to `demsiteconfigs_query`""" + query_demstatus = demstatus_query """ Backwards-compatibility alias of `query_demstatus` to `demstatus_query`""" @@ -10627,6 +10754,9 @@

    prisma_sase.post_api module

    reallocate_clients = clients_reallocate """ Backwards-compatibility alias of `reallocate_clients` to `clients_reallocate`""" + rquery_e = elements_rquery + """ Backwards-compatibility alias of `rquery_e` to `elements_rquery`""" + rquery_vfflicenses = vfflicenses_rquery """ Backwards-compatibility alias of `rquery_vfflicenses` to `vfflicenses_rquery`""" @@ -11076,6 +11206,28 @@

    Classes

    api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "post", data=data) + def bulkoperations(self, data, api_version="v2.0"): + """ + POST Bulkoperations API Function + + **Parameters:**: + + - **data**: Dictionary containing data to POST as JSON + - **api_version**: API version to use (default v2.0) + + **Payload Attributes:** + + + **Returns:** requests.Response object extended with sdk_status and sdk_content properties. + """ + + cur_ctlr = self._parent_class.controller + + url = str(cur_ctlr) + "/sdwan/{}/api/sites/bulkoperations".format(api_version) + + api_logger.debug("URL = %s", url) + return self._parent_class.rest_call(url, "post", data=data) + def cellular_module_firmware_status_query(self, data, api_version="v2.0"): """ Query the cellular module firmware upgrade status of all tenant elements (v2.0) @@ -11262,6 +11414,78 @@

    Classes

    api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "post", data=data) + def elementshells_copy_element_configurations(self, site_id, elementshell_id, data, api_version="v2.0"): + """ + POST Elementshells_Copy_Element_Configurations API Function + + **Parameters:**: + + - **site_id**: Site ID + - **elementshell_id**: Element Shell ID + - **data**: Dictionary containing data to POST as JSON + - **api_version**: API version to use (default v2.0) + + **Payload Attributes:** + + + **Returns:** requests.Response object extended with sdk_status and sdk_content properties. + """ + + cur_ctlr = self._parent_class.controller + + url = str(cur_ctlr) + "/sdwan/{}/api/sites/{}/elementshells/{}/copy_element_configurations".format(api_version, + site_id, + elementshell_id) + + api_logger.debug("URL = %s", url) + return self._parent_class.rest_call(url, "post", data=data) + + def demsiteconfigs(self, site_id, data, api_version="v2.0"): + """ + POST Demsiteconfigs API Function + + **Parameters:**: + + - **site_id**: Site ID + - **data**: Dictionary containing data to POST as JSON + - **api_version**: API version to use (default v2.0) + + **Payload Attributes:** + + + **Returns:** requests.Response object extended with sdk_status and sdk_content properties. + """ + + cur_ctlr = self._parent_class.controller + + url = str(cur_ctlr) + "/sdwan/{}/api/sites/{}/demsiteconfigs".format(api_version, + site_id) + + api_logger.debug("URL = %s", url) + return self._parent_class.rest_call(url, "post", data=data) + + def demsiteconfigs_query(self, data, api_version="v2.0"): + """ + POST Demsiteconfigs_Query API Function + + **Parameters:**: + + - **data**: Dictionary containing data to POST as JSON + - **api_version**: API version to use (default v2.0) + + **Payload Attributes:** + + + **Returns:** requests.Response object extended with sdk_status and sdk_content properties. + """ + + cur_ctlr = self._parent_class.controller + + url = str(cur_ctlr) + "/sdwan/{}/api/demsiteconfigs/query".format(api_version) + + api_logger.debug("URL = %s", url) + return self._parent_class.rest_call(url, "post", data=data) + def demstatus_query(self, data, api_version="v2.0"): """ Query ADEM status (v2.0) @@ -11866,6 +12090,28 @@

    Classes

    api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "post", data=data) + def elements_rquery(self, data, api_version="v3.0"): + """ + POST Elements_Rquery API Function + + **Parameters:**: + + - **data**: Dictionary containing data to POST as JSON + - **api_version**: API version to use (default v3.0) + + **Payload Attributes:** + + + **Returns:** requests.Response object extended with sdk_status and sdk_content properties. + """ + + cur_ctlr = self._parent_class.controller + + url = str(cur_ctlr) + "/sdwan/{}/api/elements/rquery".format(api_version) + + api_logger.debug("URL = %s", url) + return self._parent_class.rest_call(url, "post", data=data) + def elementsecurityzones(self, site_id, element_id, data, api_version="v2.0"): """ Create an association between element and security zone. (v2.0) @@ -12144,14 +12390,14 @@

    Classes

    api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "post", data=data) - def events_summary(self, data, api_version="v2.0"): + def events_summary(self, data, api_version="v2.1"): """ POST Events_Summary API Function **Parameters:**: - **data**: Dictionary containing data to POST as JSON - - **api_version**: API version to use (default v2.0) + - **api_version**: API version to use (default v2.1) **Payload Attributes:** @@ -13074,14 +13320,14 @@

    Classes

    api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "post", data=data) - def monitor_aggregates_healthscore(self, data, api_version="v2.0"): + def monitor_aggregates_healthscore(self, data, api_version="v2.1"): """ POST Monitor_Aggregates_Healthscore API Function **Parameters:**: - **data**: Dictionary containing data to POST as JSON - - **api_version**: API version to use (default v2.0) + - **api_version**: API version to use (default v2.1) **Payload Attributes:** @@ -13470,14 +13716,14 @@

    Classes

    api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "post", data=data) - def monitor_metrics(self, data, api_version="v2.4"): + def monitor_metrics(self, data, api_version="v2.5"): """ POST Monitor_Metrics API Function **Parameters:**: - **data**: Dictionary containing data to POST as JSON - - **api_version**: API version to use (default v2.4) + - **api_version**: API version to use (default v2.5) **Payload Attributes:** @@ -16120,14 +16366,14 @@

    Classes

    api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "post", data=data) - def serviceendpoints(self, data, api_version="v2.3"): + def serviceendpoints(self, data, api_version="v2.4"): """ Create a new Service Endpoint (v2.3) **Parameters:**: - **data**: Dictionary containing data to POST as JSON - - **api_version**: API version to use (default v2.3) + - **api_version**: API version to use (default v2.4) **Payload Attributes:** @@ -16142,14 +16388,14 @@

    Classes

    api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "post", data=data) - def serviceendpoints_query(self, data, api_version="v2.3"): + def serviceendpoints_query(self, data, api_version="v2.4"): """ Queries db for limit number of service bindings that match query params. (v2.3) **Parameters:**: - **data**: Dictionary containing data to POST as JSON - - **api_version**: API version to use (default v2.3) + - **api_version**: API version to use (default v2.4) **Payload Attributes:** @@ -17851,6 +18097,9 @@

    Classes

    configs_sdwanapps = sdwanapps_configs """ Backwards-compatibility alias of `configs_sdwanapps` to `sdwanapps_configs`""" + copy_element_configurations_elementshells = elementshells_copy_element_configurations + """ Backwards-compatibility alias of `copy_element_configurations_elementshells` to `elementshells_copy_element_configurations`""" + deltasync_directoryservices = directoryservices_deltasync """ Backwards-compatibility alias of `deltasync_directoryservices` to `directoryservices_deltasync`""" @@ -18049,6 +18298,9 @@

    Classes

    query_current_status_software = software_current_status_query """ Backwards-compatibility alias of `query_current_status_software` to `software_current_status_query`""" + query_demsiteconfigs = demsiteconfigs_query + """ Backwards-compatibility alias of `query_demsiteconfigs` to `demsiteconfigs_query`""" + query_demstatus = demstatus_query """ Backwards-compatibility alias of `query_demstatus` to `demstatus_query`""" @@ -18388,6 +18640,9 @@

    Classes

    reallocate_clients = clients_reallocate """ Backwards-compatibility alias of `reallocate_clients` to `clients_reallocate`""" + rquery_e = elements_rquery + """ Backwards-compatibility alias of `rquery_e` to `elements_rquery`""" + rquery_vfflicenses = vfflicenses_rquery """ Backwards-compatibility alias of `rquery_vfflicenses` to `vfflicenses_rquery`""" @@ -18613,6 +18868,17 @@

    Class variables

    +
    +
    +

    var copy_element_configurations_elementshells

    + + + + +

    Backwards-compatibility alias of copy_element_configurations_elementshells to elementshells_copy_element_configurations

    +
    +
    +

    var deltasync_directoryservices

    @@ -19361,6 +19627,17 @@

    Class variables

    +
    +
    +

    var query_demsiteconfigs

    + + + + +

    Backwards-compatibility alias of query_demsiteconfigs to demsiteconfigs_query

    +
    +
    +

    var query_demstatus

    @@ -20604,6 +20881,17 @@

    Class variables

    +
    +
    +

    var rquery_e

    + + + + +

    Backwards-compatibility alias of rquery_e to elements_rquery

    +
    +
    +

    var rquery_vfflicenses

    @@ -21435,6 +21723,46 @@

    Static methods

    +
    +
    +

    def bulkoperations(

    self, data, api_version='v2.0')

    +
    + + + + +

    POST Bulkoperations API Function

    +

    Parameters::

    +
      +
    • data: Dictionary containing data to POST as JSON
    • +
    • api_version: API version to use (default v2.0)
    • +
    +

    Payload Attributes:

    +

    Returns: requests.Response object extended with sdk_status and sdk_content properties.

    +
    + +
    +
    def bulkoperations(self, data, api_version="v2.0"):
    +    """
    +    POST Bulkoperations API Function
    +      **Parameters:**:
    +      - **data**: Dictionary containing data to POST as JSON
    +      - **api_version**: API version to use (default v2.0)
    +      **Payload Attributes:** 
    +    **Returns:** requests.Response object extended with sdk_status and sdk_content properties.
    +    """
    +    cur_ctlr = self._parent_class.controller
    +    url = str(cur_ctlr) + "/sdwan/{}/api/sites/bulkoperations".format(api_version)
    +    api_logger.debug("URL = %s", url)
    +    return self._parent_class.rest_call(url, "post", data=data)
    +
    + +
    +
    + +
    + +

    def cellular_module_firmware_status_query(

    self, data, api_version='v2.0')

    @@ -21770,6 +22098,89 @@

    Static methods

    +
    +
    +

    def demsiteconfigs(

    self, site_id, data, api_version='v2.0')

    +
    + + + + +

    POST Demsiteconfigs API Function

    +

    Parameters::

    +
      +
    • site_id: Site ID
    • +
    • data: Dictionary containing data to POST as JSON
    • +
    • api_version: API version to use (default v2.0)
    • +
    +

    Payload Attributes:

    +

    Returns: requests.Response object extended with sdk_status and sdk_content properties.

    +
    + +
    +
    def demsiteconfigs(self, site_id, data, api_version="v2.0"):
    +    """
    +    POST Demsiteconfigs API Function
    +      **Parameters:**:
    +      - **site_id**: Site ID
    +      - **data**: Dictionary containing data to POST as JSON
    +      - **api_version**: API version to use (default v2.0)
    +      **Payload Attributes:** 
    +    **Returns:** requests.Response object extended with sdk_status and sdk_content properties.
    +    """
    +    cur_ctlr = self._parent_class.controller
    +    url = str(cur_ctlr) + "/sdwan/{}/api/sites/{}/demsiteconfigs".format(api_version,
    +                                                                         site_id)
    +    api_logger.debug("URL = %s", url)
    +    return self._parent_class.rest_call(url, "post", data=data)
    +
    + +
    +
    + +
    + + +
    +
    +

    def demsiteconfigs_query(

    self, data, api_version='v2.0')

    +
    + + + + +

    POST Demsiteconfigs_Query API Function

    +

    Parameters::

    +
      +
    • data: Dictionary containing data to POST as JSON
    • +
    • api_version: API version to use (default v2.0)
    • +
    +

    Payload Attributes:

    +

    Returns: requests.Response object extended with sdk_status and sdk_content properties.

    +
    + +
    +
    def demsiteconfigs_query(self, data, api_version="v2.0"):
    +    """
    +    POST Demsiteconfigs_Query API Function
    +      **Parameters:**:
    +      - **data**: Dictionary containing data to POST as JSON
    +      - **api_version**: API version to use (default v2.0)
    +      **Payload Attributes:** 
    +    **Returns:** requests.Response object extended with sdk_status and sdk_content properties.
    +    """
    +    cur_ctlr = self._parent_class.controller
    +    url = str(cur_ctlr) + "/sdwan/{}/api/demsiteconfigs/query".format(api_version)
    +    api_logger.debug("URL = %s", url)
    +    return self._parent_class.rest_call(url, "post", data=data)
    +
    + +
    +
    + +
    + +

    def demstatus_query(

    self, data, api_version='v2.0')

    @@ -22858,6 +23269,46 @@

    Static methods

    +
    +
    +

    def elements_rquery(

    self, data, api_version='v3.0')

    +
    + + + + +

    POST Elements_Rquery API Function

    +

    Parameters::

    +
      +
    • data: Dictionary containing data to POST as JSON
    • +
    • api_version: API version to use (default v3.0)
    • +
    +

    Payload Attributes:

    +

    Returns: requests.Response object extended with sdk_status and sdk_content properties.

    +
    + +
    +
    def elements_rquery(self, data, api_version="v3.0"):
    +    """
    +    POST Elements_Rquery API Function
    +      **Parameters:**:
    +      - **data**: Dictionary containing data to POST as JSON
    +      - **api_version**: API version to use (default v3.0)
    +      **Payload Attributes:** 
    +    **Returns:** requests.Response object extended with sdk_status and sdk_content properties.
    +    """
    +    cur_ctlr = self._parent_class.controller
    +    url = str(cur_ctlr) + "/sdwan/{}/api/elements/rquery".format(api_version)
    +    api_logger.debug("URL = %s", url)
    +    return self._parent_class.rest_call(url, "post", data=data)
    +
    + +
    +
    + +
    + +

    def elementsecurityzones(

    self, site_id, element_id, data, api_version='v2.0')

    @@ -22987,6 +23438,52 @@

    Static methods

    +
    +
    +

    def elementshells_copy_element_configurations(

    self, site_id, elementshell_id, data, api_version='v2.0')

    +
    + + + + +

    POST Elementshells_Copy_Element_Configurations API Function

    +

    Parameters::

    +
      +
    • site_id: Site ID
    • +
    • elementshell_id: Element Shell ID
    • +
    • data: Dictionary containing data to POST as JSON
    • +
    • api_version: API version to use (default v2.0)
    • +
    +

    Payload Attributes:

    +

    Returns: requests.Response object extended with sdk_status and sdk_content properties.

    +
    + +
    +
    def elementshells_copy_element_configurations(self, site_id, elementshell_id, data, api_version="v2.0"):
    +    """
    +    POST Elementshells_Copy_Element_Configurations API Function
    +      **Parameters:**:
    +      - **site_id**: Site ID
    +      - **elementshell_id**: Element Shell ID
    +      - **data**: Dictionary containing data to POST as JSON
    +      - **api_version**: API version to use (default v2.0)
    +      **Payload Attributes:** 
    +    **Returns:** requests.Response object extended with sdk_status and sdk_content properties.
    +    """
    +    cur_ctlr = self._parent_class.controller
    +    url = str(cur_ctlr) + "/sdwan/{}/api/sites/{}/elementshells/{}/copy_element_configurations".format(api_version,
    +                                                                                                       site_id,
    +                                                                                                       elementshell_id)
    +    api_logger.debug("URL = %s", url)
    +    return self._parent_class.rest_call(url, "post", data=data)
    +
    + +
    +
    + +
    + +

    def elementshells_query(

    self, data, api_version='v2.0')

    @@ -23361,7 +23858,7 @@

    Static methods

    -

    def events_summary(

    self, data, api_version='v2.0')

    +

    def events_summary(

    self, data, api_version='v2.1')

    @@ -23371,19 +23868,19 @@

    Static methods

    Parameters::

    • data: Dictionary containing data to POST as JSON
    • -
    • api_version: API version to use (default v2.0)
    • +
    • api_version: API version to use (default v2.1)

    Payload Attributes:

    Returns: requests.Response object extended with sdk_status and sdk_content properties.

    -
    def events_summary(self, data, api_version="v2.0"):
    +    
    def events_summary(self, data, api_version="v2.1"):
         """
         POST Events_Summary API Function
           **Parameters:**:
           - **data**: Dictionary containing data to POST as JSON
    -      - **api_version**: API version to use (default v2.0)
    +      - **api_version**: API version to use (default v2.1)
           **Payload Attributes:** 
         **Returns:** requests.Response object extended with sdk_status and sdk_content properties.
         """
    @@ -25043,7 +25540,7 @@ 

    Static methods

    -

    def monitor_aggregates_healthscore(

    self, data, api_version='v2.0')

    +

    def monitor_aggregates_healthscore(

    self, data, api_version='v2.1')

    @@ -25053,19 +25550,19 @@

    Static methods

    Parameters::

    • data: Dictionary containing data to POST as JSON
    • -
    • api_version: API version to use (default v2.0)
    • +
    • api_version: API version to use (default v2.1)

    Payload Attributes:

    Returns: requests.Response object extended with sdk_status and sdk_content properties.

    -
    def monitor_aggregates_healthscore(self, data, api_version="v2.0"):
    +    
    def monitor_aggregates_healthscore(self, data, api_version="v2.1"):
         """
         POST Monitor_Aggregates_Healthscore API Function
           **Parameters:**:
           - **data**: Dictionary containing data to POST as JSON
    -      - **api_version**: API version to use (default v2.0)
    +      - **api_version**: API version to use (default v2.1)
           **Payload Attributes:** 
         **Returns:** requests.Response object extended with sdk_status and sdk_content properties.
         """
    @@ -25763,7 +26260,7 @@ 

    Static methods

    -

    def monitor_metrics(

    self, data, api_version='v2.4')

    +

    def monitor_metrics(

    self, data, api_version='v2.5')

    @@ -25773,19 +26270,19 @@

    Static methods

    Parameters::

    • data: Dictionary containing data to POST as JSON
    • -
    • api_version: API version to use (default v2.4)
    • +
    • api_version: API version to use (default v2.5)

    Payload Attributes:

    Returns: requests.Response object extended with sdk_status and sdk_content properties.

    -
    def monitor_metrics(self, data, api_version="v2.4"):
    +    
    def monitor_metrics(self, data, api_version="v2.5"):
         """
         POST Monitor_Metrics API Function
           **Parameters:**:
           - **data**: Dictionary containing data to POST as JSON
    -      - **api_version**: API version to use (default v2.4)
    +      - **api_version**: API version to use (default v2.5)
           **Payload Attributes:** 
         **Returns:** requests.Response object extended with sdk_status and sdk_content properties.
         """
    @@ -30557,7 +31054,7 @@ 

    Static methods

    -

    def serviceendpoints(

    self, data, api_version='v2.3')

    +

    def serviceendpoints(

    self, data, api_version='v2.4')

    @@ -30567,19 +31064,19 @@

    Static methods

    Parameters::

    • data: Dictionary containing data to POST as JSON
    • -
    • api_version: API version to use (default v2.3)
    • +
    • api_version: API version to use (default v2.4)

    Payload Attributes:

    Returns: requests.Response object extended with sdk_status and sdk_content properties.

    -
    def serviceendpoints(self, data, api_version="v2.3"):
    +    
    def serviceendpoints(self, data, api_version="v2.4"):
         """
         Create a new Service Endpoint (v2.3)
           **Parameters:**:
           - **data**: Dictionary containing data to POST as JSON
    -      - **api_version**: API version to use (default v2.3)
    +      - **api_version**: API version to use (default v2.4)
           **Payload Attributes:** 
         **Returns:** requests.Response object extended with sdk_status and sdk_content properties.
         """
    @@ -30597,7 +31094,7 @@ 

    Static methods

    -

    def serviceendpoints_query(

    self, data, api_version='v2.3')

    +

    def serviceendpoints_query(

    self, data, api_version='v2.4')

    @@ -30607,19 +31104,19 @@

    Static methods

    Parameters::

    • data: Dictionary containing data to POST as JSON
    • -
    • api_version: API version to use (default v2.3)
    • +
    • api_version: API version to use (default v2.4)

    Payload Attributes:

    Returns: requests.Response object extended with sdk_status and sdk_content properties.

    -
    def serviceendpoints_query(self, data, api_version="v2.3"):
    +    
    def serviceendpoints_query(self, data, api_version="v2.4"):
         """
         Queries db for limit number of service bindings that match query params. (v2.3)
           **Parameters:**:
           - **data**: Dictionary containing data to POST as JSON
    -      - **api_version**: API version to use (default v2.3)
    +      - **api_version**: API version to use (default v2.4)
           **Payload Attributes:** 
         **Returns:** requests.Response object extended with sdk_status and sdk_content properties.
         """
    diff --git a/docs/put_api.m.html b/docs/put_api.m.html
    index 2650cf4..1c015f9 100644
    --- a/docs/put_api.m.html
    +++ b/docs/put_api.m.html
    @@ -2583,6 +2583,7 @@ 

    Index

  • bgppeers
  • bulkconfigurations_sitetemplates
  • cellular_modules_sim_security
  • +
  • demsiteconfigs
  • deviceidconfigs
  • deviceidconfigs_snmpdiscoverystartnodes
  • deviceidprofiles
  • @@ -3027,6 +3028,32 @@

    prisma_sase.put_api module

    api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "put", data=data) + def demsiteconfigs(self, site_id, demsiteconfig_id, data, api_version="v2.0"): + """ + PUT Demsiteconfigs API Function + + **Parameters:**: + + - **site_id**: Site ID + - **demsiteconfig_id**: NO DESCRIPTION + - **data**: Dictionary containing data to PUT as JSON + - **api_version**: API version to use (default v2.0) + + **Payload Attributes:** + + + **Returns:** requests.Response object extended with sdk_status and sdk_content properties. + """ + + cur_ctlr = self._parent_class.controller + + url = str(cur_ctlr) + "/sdwan/{}/api/sites/{}/demsiteconfigs/{}".format(api_version, + site_id, + demsiteconfig_id) + + api_logger.debug("URL = %s", url) + return self._parent_class.rest_call(url, "put", data=data) + def deviceidconfigs(self, site_id, deviceidconfig_id, data, api_version="v2.1"): """ PUT Deviceidconfigs API Function @@ -5375,7 +5402,7 @@

    prisma_sase.put_api module

    api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "put", data=data) - def serviceendpoints(self, serviceendpoint_id, data, api_version="v2.3"): + def serviceendpoints(self, serviceendpoint_id, data, api_version="v2.4"): """ Update a ServiceEndpoint (v2.3) @@ -5383,7 +5410,7 @@

    prisma_sase.put_api module

    - **serviceendpoint_id**: Service Endpoint ID - **data**: Dictionary containing data to PUT as JSON - - **api_version**: API version to use (default v2.3) + - **api_version**: API version to use (default v2.4) **Payload Attributes:** @@ -6057,14 +6084,14 @@

    prisma_sase.put_api module

    api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "put", data=data) - def tenants(self, data, api_version="v2.7"): + def tenants(self, data, api_version="v2.8"): """ Update tenant (v2.3) **Parameters:**: - **data**: Dictionary containing data to PUT as JSON - - **api_version**: API version to use (default v2.7) + - **api_version**: API version to use (default v2.8) **Payload Attributes:** @@ -6729,6 +6756,32 @@

    Classes

    api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "put", data=data) + def demsiteconfigs(self, site_id, demsiteconfig_id, data, api_version="v2.0"): + """ + PUT Demsiteconfigs API Function + + **Parameters:**: + + - **site_id**: Site ID + - **demsiteconfig_id**: NO DESCRIPTION + - **data**: Dictionary containing data to PUT as JSON + - **api_version**: API version to use (default v2.0) + + **Payload Attributes:** + + + **Returns:** requests.Response object extended with sdk_status and sdk_content properties. + """ + + cur_ctlr = self._parent_class.controller + + url = str(cur_ctlr) + "/sdwan/{}/api/sites/{}/demsiteconfigs/{}".format(api_version, + site_id, + demsiteconfig_id) + + api_logger.debug("URL = %s", url) + return self._parent_class.rest_call(url, "put", data=data) + def deviceidconfigs(self, site_id, deviceidconfig_id, data, api_version="v2.1"): """ PUT Deviceidconfigs API Function @@ -9077,7 +9130,7 @@

    Classes

    api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "put", data=data) - def serviceendpoints(self, serviceendpoint_id, data, api_version="v2.3"): + def serviceendpoints(self, serviceendpoint_id, data, api_version="v2.4"): """ Update a ServiceEndpoint (v2.3) @@ -9085,7 +9138,7 @@

    Classes

    - **serviceendpoint_id**: Service Endpoint ID - **data**: Dictionary containing data to PUT as JSON - - **api_version**: API version to use (default v2.3) + - **api_version**: API version to use (default v2.4) **Payload Attributes:** @@ -9759,14 +9812,14 @@

    Classes

    api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "put", data=data) - def tenants(self, data, api_version="v2.7"): + def tenants(self, data, api_version="v2.8"): """ Update tenant (v2.3) **Parameters:**: - **data**: Dictionary containing data to PUT as JSON - - **api_version**: API version to use (default v2.7) + - **api_version**: API version to use (default v2.8) **Payload Attributes:** @@ -10981,6 +11034,52 @@

    Static methods

    +
    +
    +

    def demsiteconfigs(

    self, site_id, demsiteconfig_id, data, api_version='v2.0')

    +
    + + + + +

    PUT Demsiteconfigs API Function

    +

    Parameters::

    +
      +
    • site_id: Site ID
    • +
    • demsiteconfig_id: NO DESCRIPTION
    • +
    • data: Dictionary containing data to PUT as JSON
    • +
    • api_version: API version to use (default v2.0)
    • +
    +

    Payload Attributes:

    +

    Returns: requests.Response object extended with sdk_status and sdk_content properties.

    +
    + +
    +
    def demsiteconfigs(self, site_id, demsiteconfig_id, data, api_version="v2.0"):
    +    """
    +    PUT Demsiteconfigs API Function
    +      **Parameters:**:
    +      - **site_id**: Site ID
    +      - **demsiteconfig_id**: NO DESCRIPTION
    +      - **data**: Dictionary containing data to PUT as JSON
    +      - **api_version**: API version to use (default v2.0)
    +      **Payload Attributes:** 
    +    **Returns:** requests.Response object extended with sdk_status and sdk_content properties.
    +    """
    +    cur_ctlr = self._parent_class.controller
    +    url = str(cur_ctlr) + "/sdwan/{}/api/sites/{}/demsiteconfigs/{}".format(api_version,
    +                                                                            site_id,
    +                                                                            demsiteconfig_id)
    +    api_logger.debug("URL = %s", url)
    +    return self._parent_class.rest_call(url, "put", data=data)
    +
    + +
    +
    + +
    + +

    def deviceidconfigs(

    self, site_id, deviceidconfig_id, data, api_version='v2.1')

    @@ -15156,7 +15255,7 @@

    Static methods

    -

    def serviceendpoints(

    self, serviceendpoint_id, data, api_version='v2.3')

    +

    def serviceendpoints(

    self, serviceendpoint_id, data, api_version='v2.4')

    @@ -15167,20 +15266,20 @@

    Static methods

    • serviceendpoint_id: Service Endpoint ID
    • data: Dictionary containing data to PUT as JSON
    • -
    • api_version: API version to use (default v2.3)
    • +
    • api_version: API version to use (default v2.4)

    Payload Attributes:

    Returns: requests.Response object extended with sdk_status and sdk_content properties.

    -
    def serviceendpoints(self, serviceendpoint_id, data, api_version="v2.3"):
    +    
    def serviceendpoints(self, serviceendpoint_id, data, api_version="v2.4"):
         """
         Update a ServiceEndpoint (v2.3)
           **Parameters:**:
           - **serviceendpoint_id**: Service Endpoint ID
           - **data**: Dictionary containing data to PUT as JSON
    -      - **api_version**: API version to use (default v2.3)
    +      - **api_version**: API version to use (default v2.4)
           **Payload Attributes:** 
         **Returns:** requests.Response object extended with sdk_status and sdk_content properties.
         """
    @@ -16368,7 +16467,7 @@ 

    Static methods

    -

    def tenants(

    self, data, api_version='v2.7')

    +

    def tenants(

    self, data, api_version='v2.8')

    @@ -16378,19 +16477,19 @@

    Static methods

    Parameters::

    • data: Dictionary containing data to PUT as JSON
    • -
    • api_version: API version to use (default v2.7)
    • +
    • api_version: API version to use (default v2.8)

    Payload Attributes:

    Returns: requests.Response object extended with sdk_status and sdk_content properties.

    -
    def tenants(self, data, api_version="v2.7"):
    +    
    def tenants(self, data, api_version="v2.8"):
         """
         Update tenant (v2.3)
           **Parameters:**:
           - **data**: Dictionary containing data to PUT as JSON
    -      - **api_version**: API version to use (default v2.7)
    +      - **api_version**: API version to use (default v2.8)
           **Payload Attributes:** 
         **Returns:** requests.Response object extended with sdk_status and sdk_content properties.
         """
    diff --git a/docs/ws_api.m.html b/docs/ws_api.m.html
    index 0f35469..1d68d8d 100644
    --- a/docs/ws_api.m.html
    +++ b/docs/ws_api.m.html
    @@ -2675,14 +2675,12 @@ 

    prisma_sase.ws_api module

    if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id - elif not tenant_id: - # No value for tenant_id. - raise TypeError("tenant_id is required but not set or cached.") + # set controller, converting protocol to wss wss_ctlr = self._parent_class.controller.replace('https://', 'wss://', 1) url = str(wss_ctlr) + "/sdwan/{}/api/elements/{}/ws/toolkitsessions?cols={}&rows={}" \ - "".format(api_version, tenant_id, element_id, cols, rows) + "".format(api_version, element_id, cols, rows) api_logger.debug("URL = %s", url) return self._parent_class.websocket_call(url, **kwargs) @@ -2703,14 +2701,12 @@

    prisma_sase.ws_api module

    if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id - elif not tenant_id: - # No value for tenant_id. - raise TypeError("tenant_id is required but not set or cached.") + # set controller, converting protocol to wss wss_ctlr = self._parent_class.controller.replace('https://', 'wss://', 1) url = str(wss_ctlr) + "/sdwan/{}/api/ws" \ - "".format(api_version, tenant_id) + "".format(api_version) api_logger.debug("URL = %s", url) return self._parent_class.websocket_call(url) @@ -2773,14 +2769,12 @@

    Classes

    if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id - elif not tenant_id: - # No value for tenant_id. - raise TypeError("tenant_id is required but not set or cached.") + # set controller, converting protocol to wss wss_ctlr = self._parent_class.controller.replace('https://', 'wss://', 1) url = str(wss_ctlr) + "/sdwan/{}/api/elements/{}/ws/toolkitsessions?cols={}&rows={}" \ - "".format(api_version, tenant_id, element_id, cols, rows) + "".format(api_version, element_id, cols, rows) api_logger.debug("URL = %s", url) return self._parent_class.websocket_call(url, **kwargs) @@ -2801,14 +2795,12 @@

    Classes

    if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id - elif not tenant_id: - # No value for tenant_id. - raise TypeError("tenant_id is required but not set or cached.") + # set controller, converting protocol to wss wss_ctlr = self._parent_class.controller.replace('https://', 'wss://', 1) url = str(wss_ctlr) + "/sdwan/{}/api/ws" \ - "".format(api_version, tenant_id) + "".format(api_version) api_logger.debug("URL = %s", url) return self._parent_class.websocket_call(url) @@ -2857,13 +2849,10 @@

    Static methods

    if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id - elif not tenant_id: - # No value for tenant_id. - raise TypeError("tenant_id is required but not set or cached.") # set controller, converting protocol to wss wss_ctlr = self._parent_class.controller.replace('https://', 'wss://', 1) url = str(wss_ctlr) + "/sdwan/{}/api/ws" \ - "".format(api_version, tenant_id) + "".format(api_version) api_logger.debug("URL = %s", url) return self._parent_class.websocket_call(url)
    @@ -2911,13 +2900,10 @@

    Static methods

    if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id - elif not tenant_id: - # No value for tenant_id. - raise TypeError("tenant_id is required but not set or cached.") # set controller, converting protocol to wss wss_ctlr = self._parent_class.controller.replace('https://', 'wss://', 1) url = str(wss_ctlr) + "/sdwan/{}/api/elements/{}/ws/toolkitsessions?cols={}&rows={}" \ - "".format(api_version, tenant_id, element_id, cols, rows) + "".format(api_version, element_id, cols, rows) api_logger.debug("URL = %s", url) return self._parent_class.websocket_call(url, **kwargs)
    diff --git a/prisma_sase/__init__.py b/prisma_sase/__init__.py index 8bf886d..994f65a 100644 --- a/prisma_sase/__init__.py +++ b/prisma_sase/__init__.py @@ -1,7 +1,7 @@ """ Python3 SDK for the Prisma SASE AppFabric -**Version:** v6.3.1b1 +**Version:** v6.3.2b1 **Author:** Palo Alto Networks @@ -161,7 +161,7 @@ """websocket logger is handled slightly differently, so we will have a seperate handle.""" # Version of SDK -version = "6.3.1b1" +version = "6.3.2b1" """SDK Version string""" __version__ = version @@ -481,6 +481,12 @@ class API(object): "eu": "europe"} """ static mapping of telemetry region to x_panw_region """ + client_secret = None + """ needed for login_secret func """ + + tsg_id = None + """ needed for login_secret func """ + def __init__(self, controller=controller, ssl_verify=verify, update_check=True): """ Create the API constructor object diff --git a/prisma_sase/delete_api.py b/prisma_sase/delete_api.py index af8ed03..632c34e 100644 --- a/prisma_sase/delete_api.py +++ b/prisma_sase/delete_api.py @@ -202,6 +202,28 @@ def bulkconfigurations_sitetemplates_deployments(self, sitetemplate_id, deployme api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") + def demsiteconfigs(self, site_id, demsiteconfig_id, api_version="v2.0"): + """ + DELETE Demsiteconfigs API Function + + **Parameters:**: + + - **site_id**: Site ID + - **demsiteconfig_id**: NO DESCRIPTION + - **api_version**: API version to use (default v2.0) + + **Returns:** requests.Response object extended with sdk_status and sdk_content properties. + """ + + cur_ctlr = self._parent_class.controller + + url = str(cur_ctlr) + "/sdwan/{}/api/sites/{}/demsiteconfigs/{}".format(api_version, + site_id, + demsiteconfig_id) + + api_logger.debug("URL = %s", url) + return self._parent_class.rest_call(url, "delete") + def deviceidconfigs_snmpdiscoverystartnodes(self, site_id, deviceidconfig_id, snmpdiscoverystartnode_id, api_version="v2.0"): """ DELETE Deviceidconfigs_Snmpdiscoverystartnodes API Function @@ -1968,14 +1990,14 @@ def servicebindingmaps(self, servicebindingmap_id, api_version="v2.1"): api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") - def serviceendpoints(self, serviceendpoint_id, api_version="v2.3"): + def serviceendpoints(self, serviceendpoint_id, api_version="v2.4"): """ Delete a Service Endpoint (v2.3) **Parameters:**: - **serviceendpoint_id**: Service Endpoint ID - - **api_version**: API version to use (default v2.3) + - **api_version**: API version to use (default v2.4) **Returns:** requests.Response object extended with sdk_status and sdk_content properties. """ diff --git a/prisma_sase/get_api.py b/prisma_sase/get_api.py index 3af00f3..8b35056 100644 --- a/prisma_sase/get_api.py +++ b/prisma_sase/get_api.py @@ -670,6 +670,32 @@ def clients_roles(self, client_id, role_id=None, api_version="v2.1"): api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "get") + def demsiteconfigs(self, site_id, demsiteconfig_id=None, api_version="v2.0"): + """ + GET Demsiteconfigs API Function + + **Parameters:**: + + - **site_id**: Site ID + - **demsiteconfig_id**: (optional) NO DESCRIPTION + - **api_version**: API version to use (default v2.0) + + **Returns:** requests.Response object extended with sdk_status and sdk_content properties. + """ + + cur_ctlr = self._parent_class.controller + + if not demsiteconfig_id: + url = str(cur_ctlr) + "/sdwan/{}/api/sites/{}/demsiteconfigs".format(api_version, + site_id) + else: + url = str(cur_ctlr) + "/sdwan/{}/api/sites/{}/demsiteconfigs/{}".format(api_version, + site_id, + demsiteconfig_id) + + api_logger.debug("URL = %s", url) + return self._parent_class.rest_call(url, "get") + def demstatus(self, site_id, demstatus_id=None, api_version="v2.0"): """ Get all ADEM status for a site (v2.0) @@ -1432,6 +1458,28 @@ def elementshells(self, site_id, elementshell_id=None, api_version="v2.0"): api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "get") + def elementshells_copy_element_configurations_status(self, site_id, elementshell_id, api_version="v2.0"): + """ + GET Elementshells_Copy_Element_Configurations_Status API Function + + **Parameters:**: + + - **site_id**: Site ID + - **elementshell_id**: Element Shell ID + - **api_version**: API version to use (default v2.0) + + **Returns:** requests.Response object extended with sdk_status and sdk_content properties. + """ + + cur_ctlr = self._parent_class.controller + + url = str(cur_ctlr) + "/sdwan/{}/api/sites/{}/elementshells/{}/copy_element_configurations/status".format(api_version, + site_id, + elementshell_id) + + api_logger.debug("URL = %s", url) + return self._parent_class.rest_call(url, "get") + def elementusers(self, elementuser_id=None, api_version="v2.1"): """ Get all element User (v2.1) @@ -2698,14 +2746,14 @@ def monitor_cellular_metrics(self, api_version="v2.0"): api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "get") - def monitor_metrics(self, metric_id, api_version="v2.4"): + def monitor_metrics(self, metric_id, api_version="v2.5"): """ GET Monitor_Metrics API Function **Parameters:**: - **metric_id**: Metric ID - - **api_version**: API version to use (default v2.4) + - **api_version**: API version to use (default v2.5) **Returns:** requests.Response object extended with sdk_status and sdk_content properties. """ @@ -4620,14 +4668,14 @@ def servicebindingmaps(self, servicebindingmap_id=None, api_version="v2.1"): api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "get") - def serviceendpoints(self, serviceendpoint_id=None, api_version="v2.3"): + def serviceendpoints(self, serviceendpoint_id=None, api_version="v2.4"): """ Get ServiceEndpointList (v2.3) **Parameters:**: - **serviceendpoint_id**: (optional) Service Endpoint ID - - **api_version**: API version to use (default v2.3) + - **api_version**: API version to use (default v2.4) **Returns:** requests.Response object extended with sdk_status and sdk_content properties. """ @@ -5619,13 +5667,13 @@ def tenantpassageconfigs(self, api_version="v2.0"): api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "get") - def tenants(self, api_version="v2.7"): + def tenants(self, api_version="v2.8"): """ Get tenant details for tenant id (v2.3) **Parameters:**: - - **api_version**: API version to use (default v2.7) + - **api_version**: API version to use (default v2.8) **Returns:** requests.Response object extended with sdk_status and sdk_content properties. """ @@ -6347,6 +6395,9 @@ def ws_extensions(self, extension_id=None, api_version="v2.0"): status_cellular_modules_m = machine_cellular_modules_status """ Backwards-compatibility alias of `status_cellular_modules_m` to `machine_cellular_modules_status`""" + status_copy_element_configurations_elementshells = elementshells_copy_element_configurations_status + """ Backwards-compatibility alias of `status_copy_element_configurations_elementshells` to `elementshells_copy_element_configurations_status`""" + status_directoryservices = directoryservices_status """ Backwards-compatibility alias of `status_directoryservices` to `directoryservices_status`""" diff --git a/prisma_sase/interactive.py b/prisma_sase/interactive.py index 22c9a99..45604cb 100644 --- a/prisma_sase/interactive.py +++ b/prisma_sase/interactive.py @@ -360,8 +360,6 @@ def login_secret(self, client_id=None, client_secret=None, tsg_id=None, grant_ty # if tsg_id not given on function, or if first login fails, prompt. if self._parent_class.tsg_id: tsg_id = self._parent_class.tsg_id - else: - tsg_id = compat_input(tsg_id_prompt) if grant_type is None: # if grant_type not given. @@ -369,7 +367,10 @@ def login_secret(self, client_id=None, client_secret=None, tsg_id=None, grant_ty if scope is None: # if grant_type not given. - scope = 'tsg_id:{0} email profile'.format(tsg_id) + if tsg_id is None or tsg_id == '': + scope = 'email profile' + else: + scope = 'tsg_id:{0} email profile'.format(tsg_id) self._parent_class.client_id = client_id self._parent_class.client_secret = client_secret diff --git a/prisma_sase/patch_api.py b/prisma_sase/patch_api.py index f44c0c6..976db2f 100644 --- a/prisma_sase/patch_api.py +++ b/prisma_sase/patch_api.py @@ -76,14 +76,14 @@ def tenant_operators(self, operator_id, data, api_version="v2.2"): api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "patch", data=data) - def tenants(self, data, api_version="v2.7"): + def tenants(self, data, api_version="v2.8"): """ Patch tenant (v2.3) **Parameters:**: - **data**: Dictionary containing data to PATCH as JSON - - **api_version**: API version to use (default v2.7) + - **api_version**: API version to use (default v2.8) **Payload Attributes:** diff --git a/prisma_sase/post_api.py b/prisma_sase/post_api.py index be829fc..cc1c418 100644 --- a/prisma_sase/post_api.py +++ b/prisma_sase/post_api.py @@ -402,6 +402,28 @@ def bulkconfigurations_sitetemplates_query(self, data, api_version="v2.0"): api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "post", data=data) + def bulkoperations(self, data, api_version="v2.0"): + """ + POST Bulkoperations API Function + + **Parameters:**: + + - **data**: Dictionary containing data to POST as JSON + - **api_version**: API version to use (default v2.0) + + **Payload Attributes:** + + + **Returns:** requests.Response object extended with sdk_status and sdk_content properties. + """ + + cur_ctlr = self._parent_class.controller + + url = str(cur_ctlr) + "/sdwan/{}/api/sites/bulkoperations".format(api_version) + + api_logger.debug("URL = %s", url) + return self._parent_class.rest_call(url, "post", data=data) + def cellular_module_firmware_status_query(self, data, api_version="v2.0"): """ Query the cellular module firmware upgrade status of all tenant elements (v2.0) @@ -588,6 +610,78 @@ def clients_reallocate(self, client_id, machine_id, data, api_version="v2.5"): api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "post", data=data) + def elementshells_copy_element_configurations(self, site_id, elementshell_id, data, api_version="v2.0"): + """ + POST Elementshells_Copy_Element_Configurations API Function + + **Parameters:**: + + - **site_id**: Site ID + - **elementshell_id**: Element Shell ID + - **data**: Dictionary containing data to POST as JSON + - **api_version**: API version to use (default v2.0) + + **Payload Attributes:** + + + **Returns:** requests.Response object extended with sdk_status and sdk_content properties. + """ + + cur_ctlr = self._parent_class.controller + + url = str(cur_ctlr) + "/sdwan/{}/api/sites/{}/elementshells/{}/copy_element_configurations".format(api_version, + site_id, + elementshell_id) + + api_logger.debug("URL = %s", url) + return self._parent_class.rest_call(url, "post", data=data) + + def demsiteconfigs(self, site_id, data, api_version="v2.0"): + """ + POST Demsiteconfigs API Function + + **Parameters:**: + + - **site_id**: Site ID + - **data**: Dictionary containing data to POST as JSON + - **api_version**: API version to use (default v2.0) + + **Payload Attributes:** + + + **Returns:** requests.Response object extended with sdk_status and sdk_content properties. + """ + + cur_ctlr = self._parent_class.controller + + url = str(cur_ctlr) + "/sdwan/{}/api/sites/{}/demsiteconfigs".format(api_version, + site_id) + + api_logger.debug("URL = %s", url) + return self._parent_class.rest_call(url, "post", data=data) + + def demsiteconfigs_query(self, data, api_version="v2.0"): + """ + POST Demsiteconfigs_Query API Function + + **Parameters:**: + + - **data**: Dictionary containing data to POST as JSON + - **api_version**: API version to use (default v2.0) + + **Payload Attributes:** + + + **Returns:** requests.Response object extended with sdk_status and sdk_content properties. + """ + + cur_ctlr = self._parent_class.controller + + url = str(cur_ctlr) + "/sdwan/{}/api/demsiteconfigs/query".format(api_version) + + api_logger.debug("URL = %s", url) + return self._parent_class.rest_call(url, "post", data=data) + def demstatus_query(self, data, api_version="v2.0"): """ Query ADEM status (v2.0) @@ -1192,6 +1286,28 @@ def elementaccessconfigs(self, element_id, data, api_version="v2.2"): api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "post", data=data) + def elements_rquery(self, data, api_version="v3.0"): + """ + POST Elements_Rquery API Function + + **Parameters:**: + + - **data**: Dictionary containing data to POST as JSON + - **api_version**: API version to use (default v3.0) + + **Payload Attributes:** + + + **Returns:** requests.Response object extended with sdk_status and sdk_content properties. + """ + + cur_ctlr = self._parent_class.controller + + url = str(cur_ctlr) + "/sdwan/{}/api/elements/rquery".format(api_version) + + api_logger.debug("URL = %s", url) + return self._parent_class.rest_call(url, "post", data=data) + def elementsecurityzones(self, site_id, element_id, data, api_version="v2.0"): """ Create an association between element and security zone. (v2.0) @@ -1470,14 +1586,14 @@ def events_query(self, data, api_version="v3.6"): api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "post", data=data) - def events_summary(self, data, api_version="v2.0"): + def events_summary(self, data, api_version="v2.1"): """ POST Events_Summary API Function **Parameters:**: - **data**: Dictionary containing data to POST as JSON - - **api_version**: API version to use (default v2.0) + - **api_version**: API version to use (default v2.1) **Payload Attributes:** @@ -2400,14 +2516,14 @@ def monitor_aggregates_application_qos(self, data, api_version="v2.0"): api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "post", data=data) - def monitor_aggregates_healthscore(self, data, api_version="v2.0"): + def monitor_aggregates_healthscore(self, data, api_version="v2.1"): """ POST Monitor_Aggregates_Healthscore API Function **Parameters:**: - **data**: Dictionary containing data to POST as JSON - - **api_version**: API version to use (default v2.0) + - **api_version**: API version to use (default v2.1) **Payload Attributes:** @@ -2796,14 +2912,14 @@ def monitor_lqm_point_metrics(self, data, api_version="v2.0"): api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "post", data=data) - def monitor_metrics(self, data, api_version="v2.4"): + def monitor_metrics(self, data, api_version="v2.5"): """ POST Monitor_Metrics API Function **Parameters:**: - **data**: Dictionary containing data to POST as JSON - - **api_version**: API version to use (default v2.4) + - **api_version**: API version to use (default v2.5) **Payload Attributes:** @@ -5446,14 +5562,14 @@ def servicebindingmaps_query(self, data, api_version="v2.1"): api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "post", data=data) - def serviceendpoints(self, data, api_version="v2.3"): + def serviceendpoints(self, data, api_version="v2.4"): """ Create a new Service Endpoint (v2.3) **Parameters:**: - **data**: Dictionary containing data to POST as JSON - - **api_version**: API version to use (default v2.3) + - **api_version**: API version to use (default v2.4) **Payload Attributes:** @@ -5468,14 +5584,14 @@ def serviceendpoints(self, data, api_version="v2.3"): api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "post", data=data) - def serviceendpoints_query(self, data, api_version="v2.3"): + def serviceendpoints_query(self, data, api_version="v2.4"): """ Queries db for limit number of service bindings that match query params. (v2.3) **Parameters:**: - **data**: Dictionary containing data to POST as JSON - - **api_version**: API version to use (default v2.3) + - **api_version**: API version to use (default v2.4) **Payload Attributes:** @@ -7177,6 +7293,9 @@ def ws_extensions_query(self, data, api_version="v2.0"): configs_sdwanapps = sdwanapps_configs """ Backwards-compatibility alias of `configs_sdwanapps` to `sdwanapps_configs`""" + copy_element_configurations_elementshells = elementshells_copy_element_configurations + """ Backwards-compatibility alias of `copy_element_configurations_elementshells` to `elementshells_copy_element_configurations`""" + deltasync_directoryservices = directoryservices_deltasync """ Backwards-compatibility alias of `deltasync_directoryservices` to `directoryservices_deltasync`""" @@ -7375,6 +7494,9 @@ def ws_extensions_query(self, data, api_version="v2.0"): query_current_status_software = software_current_status_query """ Backwards-compatibility alias of `query_current_status_software` to `software_current_status_query`""" + query_demsiteconfigs = demsiteconfigs_query + """ Backwards-compatibility alias of `query_demsiteconfigs` to `demsiteconfigs_query`""" + query_demstatus = demstatus_query """ Backwards-compatibility alias of `query_demstatus` to `demstatus_query`""" @@ -7714,6 +7836,9 @@ def ws_extensions_query(self, data, api_version="v2.0"): reallocate_clients = clients_reallocate """ Backwards-compatibility alias of `reallocate_clients` to `clients_reallocate`""" + rquery_e = elements_rquery + """ Backwards-compatibility alias of `rquery_e` to `elements_rquery`""" + rquery_vfflicenses = vfflicenses_rquery """ Backwards-compatibility alias of `rquery_vfflicenses` to `vfflicenses_rquery`""" diff --git a/prisma_sase/put_api.py b/prisma_sase/put_api.py index 266faf2..7923e99 100644 --- a/prisma_sase/put_api.py +++ b/prisma_sase/put_api.py @@ -284,6 +284,32 @@ def cellular_modules_sim_security(self, element_id, cellular_module_id, sim_secu api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "put", data=data) + def demsiteconfigs(self, site_id, demsiteconfig_id, data, api_version="v2.0"): + """ + PUT Demsiteconfigs API Function + + **Parameters:**: + + - **site_id**: Site ID + - **demsiteconfig_id**: NO DESCRIPTION + - **data**: Dictionary containing data to PUT as JSON + - **api_version**: API version to use (default v2.0) + + **Payload Attributes:** + + + **Returns:** requests.Response object extended with sdk_status and sdk_content properties. + """ + + cur_ctlr = self._parent_class.controller + + url = str(cur_ctlr) + "/sdwan/{}/api/sites/{}/demsiteconfigs/{}".format(api_version, + site_id, + demsiteconfig_id) + + api_logger.debug("URL = %s", url) + return self._parent_class.rest_call(url, "put", data=data) + def deviceidconfigs(self, site_id, deviceidconfig_id, data, api_version="v2.1"): """ PUT Deviceidconfigs API Function @@ -2632,7 +2658,7 @@ def servicebindingmaps(self, servicebindingmap_id, data, api_version="v2.1"): api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "put", data=data) - def serviceendpoints(self, serviceendpoint_id, data, api_version="v2.3"): + def serviceendpoints(self, serviceendpoint_id, data, api_version="v2.4"): """ Update a ServiceEndpoint (v2.3) @@ -2640,7 +2666,7 @@ def serviceendpoints(self, serviceendpoint_id, data, api_version="v2.3"): - **serviceendpoint_id**: Service Endpoint ID - **data**: Dictionary containing data to PUT as JSON - - **api_version**: API version to use (default v2.3) + - **api_version**: API version to use (default v2.4) **Payload Attributes:** @@ -3314,14 +3340,14 @@ def tenant_prioritypolicylocalprefixes(self, prioritypolicylocalprefix_id, data, api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "put", data=data) - def tenants(self, data, api_version="v2.7"): + def tenants(self, data, api_version="v2.8"): """ Update tenant (v2.3) **Parameters:**: - **data**: Dictionary containing data to PUT as JSON - - **api_version**: API version to use (default v2.7) + - **api_version**: API version to use (default v2.8) **Payload Attributes:** diff --git a/prisma_sase/ws_api.py b/prisma_sase/ws_api.py index 0d532ab..5834bf2 100644 --- a/prisma_sase/ws_api.py +++ b/prisma_sase/ws_api.py @@ -71,14 +71,12 @@ def toolkit_session(self, element_id, tenant_id=None, api_version="v2.0", cols=2 if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id - elif not tenant_id: - # No value for tenant_id. - raise TypeError("tenant_id is required but not set or cached.") + # set controller, converting protocol to wss wss_ctlr = self._parent_class.controller.replace('https://', 'wss://', 1) url = str(wss_ctlr) + "/sdwan/{}/api/elements/{}/ws/toolkitsessions?cols={}&rows={}" \ - "".format(api_version, tenant_id, element_id, cols, rows) + "".format(api_version, element_id, cols, rows) api_logger.debug("URL = %s", url) return self._parent_class.websocket_call(url, **kwargs) @@ -99,14 +97,12 @@ def default(self, tenant_id=None, api_version="v2.0", **kwargs): if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id - elif not tenant_id: - # No value for tenant_id. - raise TypeError("tenant_id is required but not set or cached.") + # set controller, converting protocol to wss wss_ctlr = self._parent_class.controller.replace('https://', 'wss://', 1) url = str(wss_ctlr) + "/sdwan/{}/api/ws" \ - "".format(api_version, tenant_id) + "".format(api_version) api_logger.debug("URL = %s", url) return self._parent_class.websocket_call(url) diff --git a/setup.cfg b/setup.cfg index 8a9bfb1..a7101cf 100644 --- a/setup.cfg +++ b/setup.cfg @@ -1,7 +1,7 @@ [metadata] name = prisma-sase description = Python3 SDK for the Prisma SASE AppFabric -version = v6.3.1b1 +version = v6.3.2b1 author = Prisma SASE Developer Support author-email = prisma-sase-developers@paloaltonetworks.com description-file = README.md diff --git a/setup.py b/setup.py index 58c4b67..b94f56d 100644 --- a/setup.py +++ b/setup.py @@ -4,7 +4,7 @@ long_description = f.read() setup(name='prisma-sase', - version='6.3.1b1', + version='6.3.2b1', description='Python3 SDK for the Prisma SASE AppFabric', long_description=long_description, long_description_content_type='text/markdown',