cloudgenix.delete_api module
CloudGenix Python SDK - DELETE
Author: CloudGenix
Copyright: (c) 2017-2024 CloudGenix, Inc
License: MIT
#!/usr/bin/env python """ CloudGenix Python SDK - DELETE **Author:** CloudGenix **Copyright:** (c) 2017-2024 CloudGenix, Inc **License:** MIT """ import logging __author__ = "CloudGenix Developer Support <developers@cloudgenix.com>" __email__ = "developers@cloudgenix.com" __copyright__ = "Copyright (c) 2017-2024 CloudGenix, Inc" __license__ = """ MIT License Copyright (c) 2017-2024 CloudGenix, Inc Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. """ # Set logging to function name api_logger = logging.getLogger(__name__) """logging.getlogger object to enable debug printing via `cloudgenix.API.set_debug`""" class Delete(object): """ CloudGenix API - DELETE requests Object to handle making Delete requests via shared Requests Session. """ # placeholder for parent class namespace _parent_class = None def apnprofiles(self, apnprofile_id, tenant_id=None, api_version="v2.0"): """ Delete an APN Profile (v2.0) **Parameters:**: - **apnprofile_id**: APN Profile ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/apnprofiles/{}".format(api_version, tenant_id, apnprofile_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def appdefs(self, appdef_id, tenant_id=None, api_version="v2.6"): """ Delete an application definition (v2.6) **Parameters:**: - **appdef_id**: Application Definition ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.6) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/appdefs/{}".format(api_version, tenant_id, appdef_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def appdefs_overrides(self, appdef_id, override_id, tenant_id=None, api_version="v2.3"): """ Delete application definition overrides for system appdef (v2.3) **Parameters:**: - **appdef_id**: Application Definition ID - **override_id**: AppDef Override ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.3) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/appdefs/{}/overrides/{}".format(api_version, tenant_id, appdef_id, override_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def authtokens(self, operator_id, authtoken_id, tenant_id=None, api_version="v2.1"): """ Delete an auth token (v2.1) **Parameters:**: - **operator_id**: Operator ID - **authtoken_id**: Static AUTH_TOKEN ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/operators/{}/authtokens/{}".format(api_version, tenant_id, operator_id, authtoken_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def bgppeers(self, site_id, element_id, bgppeer_id, tenant_id=None, api_version="v2.5"): """ Delete BGP Peer config (v2.5) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **bgppeer_id**: BGP Peer ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.5) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/elements/{}/bgppeers/{}".format(api_version, tenant_id, site_id, element_id, bgppeer_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def bulkconfigurations_sitetemplates(self, sitetemplate_id, tenant_id=None, api_version="v2.0"): """ DELETE Bulkconfigurations_Sitetemplates API Function **Parameters:**: - **sitetemplate_id**: Site Template ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/bulkconfigurations/sitetemplates/{}".format(api_version, tenant_id, sitetemplate_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def bulkconfigurations_sitetemplates_deployments(self, sitetemplate_id, deployment_id, tenant_id=None, api_version="v2.0"): """ DELETE Bulkconfigurations_Sitetemplates_Deployments API Function **Parameters:**: - **sitetemplate_id**: Site Template ID - **deployment_id**: Deployment ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/bulkconfigurations/sitetemplates/{}/deployments/{}".format(api_version, tenant_id, sitetemplate_id, deployment_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def demsiteconfigs(self, site_id, demsiteconfig_id, tenant_id=None, api_version="v2.0"): """ DELETE Demsiteconfigs API Function **Parameters:**: - **site_id**: Site ID - **demsiteconfig_id**: - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/demsiteconfigs/{}".format(api_version, tenant_id, 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, tenant_id=None, api_version="v2.0"): """ DELETE Deviceidconfigs_Snmpdiscoverystartnodes API Function **Parameters:**: - **site_id**: Site ID - **deviceidconfig_id**: Device Id Config ID - **snmpdiscoverystartnode_id**: SNMP Discovery Start Node ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/deviceidconfigs/{}/snmpdiscoverystartnodes/{}".format(api_version, tenant_id, site_id, deviceidconfig_id, snmpdiscoverystartnode_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def deviceidprofiles(self, deviceidprofile_id, tenant_id=None, api_version="v2.0"): """ DELETE Deviceidprofiles API Function **Parameters:**: - **deviceidprofile_id**: Device Id Profile ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/deviceidprofiles/{}".format(api_version, tenant_id, deviceidprofile_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def dhcpservers(self, site_id, dhcpserver_id, tenant_id=None, api_version="v2.3"): """ Delete DHCPServer for a Tenant on a site (v2.3) **Parameters:**: - **site_id**: Site ID - **dhcpserver_id**: DHCP Server ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.3) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/dhcpservers/{}".format(api_version, tenant_id, site_id, dhcpserver_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def directoryservices(self, directoryservice_id, tenant_id=None, api_version="v2.0"): """ DELETE Directoryservices API Function **Parameters:**: - **directoryservice_id**: Directory Service ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/directoryservices/{}".format(api_version, tenant_id, directoryservice_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def dnsserviceprofiles(self, dnsserviceprofile_id, tenant_id=None, api_version="v2.1"): """ Delete a DNS service profile (v2.1) **Parameters:**: - **dnsserviceprofile_id**: DNS Service Profile ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/dnsserviceprofiles/{}".format(api_version, tenant_id, dnsserviceprofile_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def dnsserviceroles(self, dnsservicerole_id, tenant_id=None, api_version="v2.0"): """ Delete a DNS service role (v2.0) **Parameters:**: - **dnsservicerole_id**: DNS Service Role ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/dnsserviceroles/{}".format(api_version, tenant_id, dnsservicerole_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def dnsservices(self, site_id, element_id, dnsservice_id, tenant_id=None, api_version="v2.0"): """ Delete a DNS service config (v2.0) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **dnsservice_id**: DNS Service ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/elements/{}/dnsservices/{}".format(api_version, tenant_id, site_id, element_id, dnsservice_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def element_deviceidconfigs(self, site_id, element_id, deviceidconfig_id, tenant_id=None, api_version="v2.0"): """ DELETE Element_Deviceidconfigs API Function **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **deviceidconfig_id**: Device Id Config ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/elements/{}/deviceidconfigs/{}".format(api_version, tenant_id, site_id, element_id, deviceidconfig_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def element_extensions(self, site_id, element_id, extension_id, tenant_id=None, api_version="v2.0"): """ Delete a specific extension associated with an element (v2.0) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **extension_id**: Extension ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/elements/{}/extensions/{}".format(api_version, tenant_id, site_id, element_id, extension_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def element_passages(self, element_id, passage_id, tenant_id=None, api_version="v2.0"): """ DELETE Element_Passages API Function **Parameters:**: - **element_id**: Element (Device) ID - **passage_id**: Passage Configuration ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/elements/{}/passages/{}".format(api_version, tenant_id, element_id, passage_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def element_toolkitsessions(self, element_id, toolkitsession_id, tenant_id=None, api_version="v2.0"): """ DELETE Element_Toolkitsessions API Function **Parameters:**: - **element_id**: Element (Device) ID - **toolkitsession_id**: Toolkit Session ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/elements/{}/toolkitsessions/{}".format(api_version, tenant_id, element_id, toolkitsession_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def elementpassageconfigs(self, element_id, elementpassageconfig_id, tenant_id=None, api_version="v2.0"): """ DELETE Elementpassageconfigs API Function **Parameters:**: - **element_id**: Element (Device) ID - **elementpassageconfig_id**: Element Passage Configuration ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/elements/{}/elementpassageconfigs/{}".format(api_version, tenant_id, element_id, elementpassageconfig_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def elementsecurityzones(self, site_id, element_id, securityzone_id, tenant_id=None, api_version="v2.0"): """ Delete an existing security zone (v2.0) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **securityzone_id**: Security Zone (ZBFW) ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/elements/{}/securityzones/{}".format(api_version, tenant_id, site_id, element_id, securityzone_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def elementshells(self, site_id, elementshell_id, tenant_id=None, api_version="v2.0"): """ DELETE Elementshells API Function **Parameters:**: - **site_id**: Site ID - **elementshell_id**: Element Shell ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/elementshells/{}".format(api_version, tenant_id, site_id, elementshell_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def elementshells_interfaces(self, site_id, elementshell_id, interface_id, tenant_id=None, api_version="v2.1"): """ DELETE Elementshells_Interfaces API Function **Parameters:**: - **site_id**: Site ID - **elementshell_id**: Element Shell ID - **interface_id**: Interface ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/elementshells/{}/interfaces/{}".format(api_version, tenant_id, site_id, elementshell_id, interface_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def elementusers(self, elementuser_id, tenant_id=None, api_version="v2.1"): """ Delete element user (v2.1) **Parameters:**: - **elementuser_id**: Element User ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/elementusers/{}".format(api_version, tenant_id, elementuser_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def elementusers_access(self, elementuser_id, access_id, tenant_id=None, api_version="v2.1"): """ Delete element user Access (v2.1) **Parameters:**: - **elementuser_id**: Element User ID - **access_id**: Access ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/elementusers/{}/access/{}".format(api_version, tenant_id, elementuser_id, access_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def esp_operator_permissions_client(self, operator_id, client_id, tenant_id=None, api_version="v2.1"): """ Delete esp operator permissions assigned under a client (v2.1) **Parameters:**: - **operator_id**: Operator ID - **client_id**: ESP/MSP Client ID (typically their tenant_id) - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/operators/{}/clients/{}/permissions".format(api_version, tenant_id, operator_id, client_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def eventcorrelationpolicyrules(self, eventcorrelationpolicyset_id, eventcorrelationpolicyrule_id, tenant_id=None, api_version="v2.1"): """ Delete specific event correlation policy rule (v2.1) **Parameters:**: - **eventcorrelationpolicyset_id**: Event Correlation Policy Set ID - **eventcorrelationpolicyrule_id**: Event Correlation Policy Rule ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/eventcorrelationpolicysets/{}/eventcorrelationpolicyrules/{}".format(api_version, tenant_id, eventcorrelationpolicyset_id, eventcorrelationpolicyrule_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def eventcorrelationpolicysets(self, eventcorrelationpolicyset_id, tenant_id=None, api_version="v2.0"): """ Delete specific event correlation policyset (v2.0) **Parameters:**: - **eventcorrelationpolicyset_id**: Event Correlation Policy Set ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/eventcorrelationpolicysets/{}".format(api_version, tenant_id, eventcorrelationpolicyset_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def externalcaconfigs(self, externalcaconfig_id, tenant_id=None, api_version="v2.0"): """ DELETE Externalcaconfigs API Function **Parameters:**: - **externalcaconfig_id**: External CA Config ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/externalcaconfigs/{}".format(api_version, tenant_id, externalcaconfig_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def globalprefixfilters(self, globalprefixfilter_id, tenant_id=None, api_version="v2.0"): """ Delete a global prefix filter. (v2.0) **Parameters:**: - **globalprefixfilter_id**: Global Prefix Filter ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/globalprefixfilters/{}".format(api_version, tenant_id, globalprefixfilter_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def hubclustermembers(self, site_id, hubcluster_id, hubclustermember_id, tenant_id=None, api_version="v3.0"): """ Deletes specific hub cluster member. (v3.0) **Parameters:**: - **site_id**: Site ID - **hubcluster_id**: Hub (DC) Cluster ID - **hubclustermember_id**: Hub Cluster Member ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v3.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/hubclusters/{}/hubclustermembers/{}".format(api_version, tenant_id, site_id, hubcluster_id, hubclustermember_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def hubclusters(self, site_id, hubcluster_id, tenant_id=None, api_version="v4.0"): """ Delete hub cluster (v4.0) **Parameters:**: - **site_id**: Site ID - **hubcluster_id**: Hub (DC) Cluster ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v4.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/hubclusters/{}".format(api_version, tenant_id, site_id, hubcluster_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def idps(self, idp_id, tenant_id=None, api_version="v3.3"): """ Delete idp (v3.3) **Parameters:**: - **idp_id**: SAML IDentity provider configuration ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v3.3) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/idps/{}".format(api_version, tenant_id, idp_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def interfaces(self, site_id, element_id, interface_id, tenant_id=None, api_version="v4.18"): """ Delete a Interface (v4.18) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **interface_id**: Interface ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v4.18) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/elements/{}/interfaces/{}".format(api_version, tenant_id, site_id, element_id, interface_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def ipfix(self, site_id, element_id, ipfix_id, tenant_id=None, api_version="v2.0"): """ Delete IPFix config (v2.0) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **ipfix_id**: IPFix ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/elements/{}/ipfix/{}".format(api_version, tenant_id, site_id, element_id, ipfix_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def ipfixcollectorcontexts(self, ipfixcollectorcontext_id, tenant_id=None, api_version="v2.0"): """ Delete a IPFix collector context (v2.0) **Parameters:**: - **ipfixcollectorcontext_id**: IPFix Collector Context ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/ipfixcollectorcontexts/{}".format(api_version, tenant_id, ipfixcollectorcontext_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def ipfixfiltercontexts(self, ipfixfiltercontext_id, tenant_id=None, api_version="v2.0"): """ Delete a IPFix filter context (v2.0) **Parameters:**: - **ipfixfiltercontext_id**: IPFix Filter Context ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/ipfixfiltercontexts/{}".format(api_version, tenant_id, ipfixfiltercontext_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def ipfixglobalprefixes(self, ipfixglobalprefix_id, tenant_id=None, api_version="v2.0"): """ Delete a IPFix global prefix (v2.0) **Parameters:**: - **ipfixglobalprefix_id**: IPFix Global Prefix ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/ipfixglobalprefixes/{}".format(api_version, tenant_id, ipfixglobalprefix_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def ipfixprofiles(self, ipfixprofile_id, tenant_id=None, api_version="v2.0"): """ Delete IPFix Profile (v2.0) **Parameters:**: - **ipfixprofile_id**: IPFix Profile ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/ipfixprofiles/{}".format(api_version, tenant_id, ipfixprofile_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def ipfixtemplates(self, ipfixtemplate_id, tenant_id=None, api_version="v2.0"): """ Delete a IPFix template (v2.0) **Parameters:**: - **ipfixtemplate_id**: IPFix Template ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/ipfixtemplates/{}".format(api_version, tenant_id, ipfixtemplate_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def ipsecprofiles(self, ipsecprofile_id, tenant_id=None, api_version="v2.1"): """ Delete a IPSEC Profile (v2.1) **Parameters:**: - **ipsecprofile_id**: IPSEC Profile ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/ipsecprofiles/{}".format(api_version, tenant_id, ipsecprofile_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def lannetworks(self, site_id, lannetwork_id, tenant_id=None, api_version="v3.3"): """ Delete an existing LAN (v3.3) **Parameters:**: - **site_id**: Site ID - **lannetwork_id**: LAN Network ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v3.3) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/lannetworks/{}".format(api_version, tenant_id, site_id, lannetwork_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def localprefixfilters(self, localprefixfilter_id, tenant_id=None, api_version="v2.0"): """ Delete a local prefix filter. (v2.0) **Parameters:**: - **localprefixfilter_id**: Local Prefix Filter ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/localprefixfilters/{}".format(api_version, tenant_id, localprefixfilter_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def mstp_instances(self, site_id, element_id, mstp_instance_id, tenant_id=None, api_version="v2.0"): """ Delete MSTP instance for an element (v2.0) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **mstp_instance_id**: MSTP Instance ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/elements/{}/mstp_instances/{}".format(api_version, tenant_id, site_id, element_id, mstp_instance_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def multicastpeergroups(self, multicastpeergroup_id, tenant_id=None, api_version="v2.1"): """ Delete multicast peer group (v2.1) **Parameters:**: - **multicastpeergroup_id**: Multicast Peer Group ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/multicastpeergroups/{}".format(api_version, tenant_id, multicastpeergroup_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def multicastrps(self, site_id, element_id, multicastrp_id, tenant_id=None, api_version="v2.0"): """ Deletes Multicast RP config (v2.0) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **multicastrp_id**: Multicast RP ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/elements/{}/multicastrps/{}".format(api_version, tenant_id, site_id, element_id, multicastrp_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def multicastsourcesiteconfigs(self, site_id, multicastsourcesiteconfig_id, tenant_id=None, api_version="v2.0"): """ Delete multicast source site config (v2.0) **Parameters:**: - **site_id**: Site ID - **multicastsourcesiteconfig_id**: Multicast Source Site Config ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/multicastsourcesiteconfigs/{}".format(api_version, tenant_id, site_id, multicastsourcesiteconfig_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def natglobalprefixes(self, natglobalprefix_id, tenant_id=None, api_version="v2.0"): """ Delete a NAT Global Prefix. (v2.0) **Parameters:**: - **natglobalprefix_id**: NAT Global Prefix ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/natglobalprefixes/{}".format(api_version, tenant_id, natglobalprefix_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def natlocalprefixes(self, natlocalprefix_id, tenant_id=None, api_version="v2.0"): """ Delete a NAT local prefix. (v2.0) **Parameters:**: - **natlocalprefix_id**: NAT Local Prefix ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/natlocalprefixes/{}".format(api_version, tenant_id, natlocalprefix_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def natpolicypools(self, natpolicypool_id, tenant_id=None, api_version="v2.0"): """ Delete a NAT Policy Pool. (v2.0) **Parameters:**: - **natpolicypool_id**: NAT Policy Pool ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/natpolicypools/{}".format(api_version, tenant_id, natpolicypool_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def natpolicyrules(self, natpolicyset_id, natpolicyrule_id, tenant_id=None, api_version="v2.0"): """ Delete NAT policy rule of tenant. (v2.0) **Parameters:**: - **natpolicyset_id**: NAT Policy Set ID - **natpolicyrule_id**: NAT Policy Rule ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/natpolicysets/{}/natpolicyrules/{}".format(api_version, tenant_id, natpolicyset_id, natpolicyrule_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def natpolicysets(self, natpolicyset_id, tenant_id=None, api_version="v2.0"): """ Delete NAT policy set. (v2.0) **Parameters:**: - **natpolicyset_id**: NAT Policy Set ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/natpolicysets/{}".format(api_version, tenant_id, natpolicyset_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def natpolicysetstacks(self, natpolicysetstack_id, tenant_id=None, api_version="v2.0"): """ Delete NAT Policy Set Stack. (v2.0) **Parameters:**: - **natpolicysetstack_id**: NAT Policy Set Stack ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/natpolicysetstacks/{}".format(api_version, tenant_id, natpolicysetstack_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def natzones(self, natzone_id, tenant_id=None, api_version="v2.0"): """ Delete a Nat Policy Zone. (v2.0) **Parameters:**: - **natzone_id**: NAT Zone ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/natzones/{}".format(api_version, tenant_id, natzone_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def networkcontexts(self, networkcontext_id, tenant_id=None, api_version="v2.0"): """ Delete LAN segment (v2.0) **Parameters:**: - **networkcontext_id**: Network Context ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/networkcontexts/{}".format(api_version, tenant_id, networkcontext_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def networkpolicyglobalprefixes(self, networkpolicyglobalprefix_id, tenant_id=None, api_version="v2.1"): """ Delete a Network Policy Global Prefix. (v2.1) **Parameters:**: - **networkpolicyglobalprefix_id**: Network Policy Global Prefix ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/networkpolicyglobalprefixes/{}".format(api_version, tenant_id, networkpolicyglobalprefix_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def networkpolicyrules(self, networkpolicyset_id, networkpolicyrule_id, tenant_id=None, api_version="v2.2"): """ Delete network policy rule of tenant. (v2.2) **Parameters:**: - **networkpolicyset_id**: Network Policy Set ID - **networkpolicyrule_id**: Network Policy Rule ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.2) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/networkpolicysets/{}/networkpolicyrules/{}".format(api_version, tenant_id, networkpolicyset_id, networkpolicyrule_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def networkpolicysets(self, networkpolicyset_id, tenant_id=None, api_version="v2.0"): """ Delete Network Policy Set. (v2.0) **Parameters:**: - **networkpolicyset_id**: Network Policy Set ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/networkpolicysets/{}".format(api_version, tenant_id, networkpolicyset_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def networkpolicysetstacks(self, networkpolicysetstack_id, tenant_id=None, api_version="v2.0"): """ Delete a NetworkPolicySetStack (v2.0) **Parameters:**: - **networkpolicysetstack_id**: Network Policy Set Stack ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/networkpolicysetstacks/{}".format(api_version, tenant_id, networkpolicysetstack_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def ngfwsecuritypolicyglobalprefixes(self, ngfwsecuritypolicyglobalprefix_id, tenant_id=None, api_version="v2.1"): """ Delete a Security Policy V2 Local Prefix by tenant ID and its ID (v2.1) **Parameters:**: - **ngfwsecuritypolicyglobalprefix_id**: NGFW Security Policy Global Prefix ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/ngfwsecuritypolicyglobalprefixes/{}".format(api_version, tenant_id, ngfwsecuritypolicyglobalprefix_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def ngfwsecuritypolicylocalprefixes(self, ngfwsecuritypolicylocalprefix_id, tenant_id=None, api_version="v2.0"): """ Delete a Security Policy V2 Local Prefix by tenant ID and its ID (v2.0) **Parameters:**: - **ngfwsecuritypolicylocalprefix_id**: NGFW Security Policy Local Prefix ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/ngfwsecuritypolicylocalprefixes/{}".format(api_version, tenant_id, ngfwsecuritypolicylocalprefix_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def ngfwsecuritypolicyrules(self, ngfwsecuritypolicyset_id, ngfwsecuritypolicyrule_id, tenant_id=None, api_version="v2.1"): """ Delete an existing Security Policy V2 Rule under a policy set (v2.1) **Parameters:**: - **ngfwsecuritypolicyset_id**: NGFW Security Policy Set ID - **ngfwsecuritypolicyrule_id**: NGFW Security Policy Rule ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/ngfwsecuritypolicysets/{}/ngfwsecuritypolicyrules/{}".format(api_version, tenant_id, ngfwsecuritypolicyset_id, ngfwsecuritypolicyrule_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def ngfwsecuritypolicysets(self, ngfwsecuritypolicyset_id, tenant_id=None, api_version="v2.0"): """ Delete an existing Security Policy V2 Set by tenant ID and its ID (v2.0) **Parameters:**: - **ngfwsecuritypolicyset_id**: NGFW Security Policy Set ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/ngfwsecuritypolicysets/{}".format(api_version, tenant_id, ngfwsecuritypolicyset_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def ngfwsecuritypolicysetstacks(self, ngfwsecuritypolicysetstack_id, tenant_id=None, api_version="v2.0"): """ Delete an existing Security Policy V2 Set Stack by tenant ID and its ID (v2.0) **Parameters:**: - **ngfwsecuritypolicysetstack_id**: NGFW Security Policy Set Stack ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/ngfwsecuritypolicysetstacks/{}".format(api_version, tenant_id, ngfwsecuritypolicysetstack_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def operator_sessions(self, operator_id, session_id, tenant_id=None, api_version="v2.0"): """ Delete session for tenant_id, operator id, and session id (v2.0) **Parameters:**: - **operator_id**: Operator ID - **session_id**: User Session ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/operators/{}/sessions/{}".format(api_version, tenant_id, operator_id, session_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def ospfconfigs(self, site_id, element_id, ospfconfig_id, tenant_id=None, api_version="v2.0"): """ DELETE Ospfconfigs API Function **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **ospfconfig_id**: OSPF Config ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/elements/{}/ospfconfigs/{}".format(api_version, tenant_id, site_id, element_id, ospfconfig_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def pathgroups(self, pathgroup_id, tenant_id=None, api_version="v2.1"): """ Delete A Path Group of a tenant. (v2.1) **Parameters:**: - **pathgroup_id**: Path Group ID (for network service/DC routing) - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/pathgroups/{}".format(api_version, tenant_id, pathgroup_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def perfmgmtpolicysets(self, perfmgmtpolicyset_id, tenant_id=None, api_version="v2.0"): """ DELETE Perfmgmtpolicysets API Function **Parameters:**: - **perfmgmtpolicyset_id**: Performance Management Policy Set ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/perfmgmtpolicysets/{}".format(api_version, tenant_id, perfmgmtpolicyset_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def perfmgmtpolicysets_perfmgmtpolicyrules(self, perfmgmtpolicyset_id, perfmgmtpolicyrule_id, tenant_id=None, api_version="v2.1"): """ DELETE Perfmgmtpolicysets_Perfmgmtpolicyrules API Function **Parameters:**: - **perfmgmtpolicyset_id**: Performance Management Policy Set ID - **perfmgmtpolicyrule_id**: Performance Management Policy Rule ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/perfmgmtpolicysets/{}/perfmgmtpolicyrules/{}".format(api_version, tenant_id, perfmgmtpolicyset_id, perfmgmtpolicyrule_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def perfmgmtpolicysetstacks(self, perfmgmtpolicysetstack_id, tenant_id=None, api_version="v2.0"): """ DELETE Perfmgmtpolicysetstacks API Function **Parameters:**: - **perfmgmtpolicysetstack_id**: Performance Management Policy Set Stack ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/perfmgmtpolicysetstacks/{}".format(api_version, tenant_id, perfmgmtpolicysetstack_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def perfmgmtthresholdprofiles(self, perfmgmtthresholdprofile_id, tenant_id=None, api_version="v2.1"): """ DELETE Perfmgmtthresholdprofiles API Function **Parameters:**: - **perfmgmtthresholdprofile_id**: Performance Management Policy Threshold Profile ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/perfmgmtthresholdprofiles/{}".format(api_version, tenant_id, perfmgmtthresholdprofile_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def policyrules(self, policyset_id, policyrule_id, tenant_id=None, api_version="v3.1"): """ Delete policy rule of tenant. (v3.1) **Parameters:**: - **policyset_id**: Policy Set ID - **policyrule_id**: Policy Rule ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v3.1) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/policysets/{}/policyrules/{}".format(api_version, tenant_id, policyset_id, policyrule_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def policysets(self, policyset_id, tenant_id=None, api_version="v3.0"): """ Delete policy set. (v3.0) **Parameters:**: - **policyset_id**: Policy Set ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v3.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/policysets/{}".format(api_version, tenant_id, policyset_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def prefixfilters(self, site_id, prefixfilter_id, tenant_id=None, api_version="v2.0"): """ Delete an existing security prefix filter (v2.0) **Parameters:**: - **site_id**: Site ID - **prefixfilter_id**: Prefix Filter ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/prefixfilters/{}".format(api_version, tenant_id, site_id, prefixfilter_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def prioritypolicyglobalprefixes(self, prioritypolicyglobalprefix_id, tenant_id=None, api_version="v2.1"): """ Delete a Priority Policy Global Prefix. (v2.1) **Parameters:**: - **prioritypolicyglobalprefix_id**: Priority Policy Global Prefix ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/prioritypolicyglobalprefixes/{}".format(api_version, tenant_id, prioritypolicyglobalprefix_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def prioritypolicyrules(self, prioritypolicyset_id, prioritypolicyrule_id, tenant_id=None, api_version="v2.1"): """ Delete priority policy rule of tenant. (v2.1) **Parameters:**: - **prioritypolicyset_id**: Priority Policy Set ID - **prioritypolicyrule_id**: Priority Policy Rule ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/prioritypolicysets/{}/prioritypolicyrules/{}".format(api_version, tenant_id, prioritypolicyset_id, prioritypolicyrule_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def prioritypolicysets(self, prioritypolicyset_id, tenant_id=None, api_version="v2.0"): """ Delete Priority Policy Set. (v2.0) **Parameters:**: - **prioritypolicyset_id**: Priority Policy Set ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/prioritypolicysets/{}".format(api_version, tenant_id, prioritypolicyset_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def prioritypolicysetstacks(self, prioritypolicysetstack_id, tenant_id=None, api_version="v2.0"): """ Delete a PriorityPolicySetStack (v2.0) **Parameters:**: - **prioritypolicysetstack_id**: Priority Policy Stack ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/prioritypolicysetstacks/{}".format(api_version, tenant_id, prioritypolicysetstack_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def prismaaccess_configs(self, site_id, prismaaccess_config_id, tenant_id=None, api_version="v2.0"): """ Delete a Prisma Access Config with remote networks and security processing node (v2.0) **Parameters:**: - **site_id**: Site ID - **prismaaccess_config_id**: Prisma Acceess Config ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/prismaaccess_configs/{}".format(api_version, tenant_id, site_id, prismaaccess_config_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def prismasase_connections(self, site_id, prismasase_connection_id, tenant_id=None, api_version="v2.1"): """ DELETE Prismasase_Connections API Function **Parameters:**: - **site_id**: Site ID - **prismasase_connection_id**: Prisma SASE Connection ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/prismasase_connections/{}".format(api_version, tenant_id, site_id, prismasase_connection_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def prismasase_connections_configs(self, tenant_id=None, api_version="v2.1"): """ DELETE Prismasase_Connections_Configs API Function **Parameters:**: - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/prismasase_connections/configs".format(api_version, tenant_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def probeconfigs(self, probeconfig_id, tenant_id=None, api_version="v2.0"): """ DELETE Probeconfigs API Function **Parameters:**: - **probeconfig_id**: Probe Config ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/probeconfigs/{}".format(api_version, tenant_id, probeconfig_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def probeprofiles(self, probeprofile_id, tenant_id=None, api_version="v2.0"): """ DELETE Probeprofiles API Function **Parameters:**: - **probeprofile_id**: Probe Profile ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/probeprofiles/{}".format(api_version, tenant_id, probeprofile_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def radii(self, element_id, radii_id, tenant_id=None, api_version="v2.0"): """ Delete radius configuration in an element (v2.0) **Parameters:**: - **element_id**: Element (Device) ID - **radii_id**: Radii ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/elements/{}/radii/{}".format(api_version, tenant_id, element_id, radii_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def roles(self, role_id, tenant_id=None, api_version="v2.1"): """ Delete a custom role (v2.1) **Parameters:**: - **role_id**: Role ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/roles/{}".format(api_version, tenant_id, role_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def routing_aspathaccesslists(self, site_id, element_id, routing_aspathaccesslist_id, tenant_id=None, api_version="v2.1"): """ Delete Access List (v2.1) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **routing_aspathaccesslist_id**: Routing AS-PATH Access List ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/elements/{}/routing_aspathaccesslists/{}".format(api_version, tenant_id, site_id, element_id, routing_aspathaccesslist_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def routing_ipcommunitylists(self, site_id, element_id, routing_ipcommunitylist_id, tenant_id=None, api_version="v2.0"): """ Delete Community List (v2.0) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **routing_ipcommunitylist_id**: Routing IP Community List ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/elements/{}/routing_ipcommunitylists/{}".format(api_version, tenant_id, site_id, element_id, routing_ipcommunitylist_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def routing_prefixlists(self, site_id, element_id, routing_prefixlist_id, tenant_id=None, api_version="v2.1"): """ Delete Prefix List (v2.1) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **routing_prefixlist_id**: Routing IP Prefix List ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/elements/{}/routing_prefixlists/{}".format(api_version, tenant_id, site_id, element_id, routing_prefixlist_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def routing_routemaps(self, site_id, element_id, routing_routemap_id, tenant_id=None, api_version="v2.3"): """ Delete Route Map (v2.3) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **routing_routemap_id**: Routing Route Map ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.3) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/elements/{}/routing_routemaps/{}".format(api_version, tenant_id, site_id, element_id, routing_routemap_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def sdwanapps_configs(self, sdwanapp_id, config_id, tenant_id=None, api_version="v2.0"): """ DELETE Sdwanapps_Configs API Function **Parameters:**: - **sdwanapp_id**: SDWAN Application ID - **config_id**: SDWAN App Config ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sdwanapps/{}/configs/{}".format(api_version, tenant_id, sdwanapp_id, config_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def securitypolicyrules(self, securitypolicyset_id, securitypolicyrule_id, tenant_id=None, api_version="v2.0"): """ Delete a security policyrule. (v2.0) **Parameters:**: - **securitypolicyset_id**: Security Policy Set ID - **securitypolicyrule_id**: Security Policy Rule ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/securitypolicysets/{}/securitypolicyrules/{}".format(api_version, tenant_id, securitypolicyset_id, securitypolicyrule_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def securitypolicysets(self, securitypolicyset_id, tenant_id=None, api_version="v2.0"): """ Delete a security policyset. (v2.0) **Parameters:**: - **securitypolicyset_id**: Security Policy Set ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/securitypolicysets/{}".format(api_version, tenant_id, securitypolicyset_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def securityzones(self, securityzone_id, tenant_id=None, api_version="v2.0"): """ Delete an existing security zone (v2.0) **Parameters:**: - **securityzone_id**: Security Zone (ZBFW) ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/securityzones/{}".format(api_version, tenant_id, securityzone_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def servicebindingmaps(self, servicebindingmap_id, tenant_id=None, api_version="v2.1"): """ Delete a Service Binding Map (v2.1) **Parameters:**: - **servicebindingmap_id**: Service Binding Map ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/servicebindingmaps/{}".format(api_version, tenant_id, servicebindingmap_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def serviceendpoints(self, serviceendpoint_id, tenant_id=None, api_version="v2.4"): """ Delete a Service Endpoint (v2.4) **Parameters:**: - **serviceendpoint_id**: Service Endpoint ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.4) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/serviceendpoints/{}".format(api_version, tenant_id, serviceendpoint_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def servicelabels(self, servicelabel_id, tenant_id=None, api_version="v2.1"): """ Delete a Service Label (v2.1) **Parameters:**: - **servicelabel_id**: Service Label ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/servicelabels/{}".format(api_version, tenant_id, servicelabel_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def site_extensions(self, site_id, extension_id, tenant_id=None, api_version="v2.0"): """ Delete a specific extension associated with a site (v2.0) **Parameters:**: - **site_id**: Site ID - **extension_id**: Extension ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/extensions/{}".format(api_version, tenant_id, site_id, extension_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def site_ipfixlocalprefixes(self, site_id, ipfixlocalprefix_id, tenant_id=None, api_version="v2.0"): """ Delete a IPFix site prefix association (v2.0) **Parameters:**: - **site_id**: Site ID - **ipfixlocalprefix_id**: IPFix Local Prefix ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/ipfixlocalprefixes/{}".format(api_version, tenant_id, site_id, ipfixlocalprefix_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def site_natlocalprefixes(self, site_id, natlocalprefix_id, tenant_id=None, api_version="v2.0"): """ Delete an existing Site NAT prefix (v2.0) **Parameters:**: - **site_id**: Site ID - **natlocalprefix_id**: NAT Local Prefix ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/natlocalprefixes/{}".format(api_version, tenant_id, site_id, natlocalprefix_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def site_networkpolicylocalprefixes(self, site_id, networkpolicylocalprefix_id, tenant_id=None, api_version="v2.1"): """ Delete an existing Site Network Policy local prefix association (v2.1) **Parameters:**: - **site_id**: Site ID - **networkpolicylocalprefix_id**: Network Policy Local Prefix ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/networkpolicylocalprefixes/{}".format(api_version, tenant_id, site_id, networkpolicylocalprefix_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def site_ngfwsecuritypolicylocalprefixes(self, site_id, ngfwsecuritypolicylocalprefix_id, tenant_id=None, api_version="v2.1"): """ Delete an existing security policy v2 local prefix site association (v2.1) **Parameters:**: - **site_id**: Site ID - **ngfwsecuritypolicylocalprefix_id**: NGFW Security Policy Local Prefix ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/ngfwsecuritypolicylocalprefixes/{}".format(api_version, tenant_id, site_id, ngfwsecuritypolicylocalprefix_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def site_prioritypolicylocalprefixes(self, site_id, prioritypolicylocalprefix_id, tenant_id=None, api_version="v2.1"): """ Delete an existing Site Priority Policy local prefix association (v2.1) **Parameters:**: - **site_id**: Site ID - **prioritypolicylocalprefix_id**: Priority Policy Local Prefix ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/prioritypolicylocalprefixes/{}".format(api_version, tenant_id, site_id, prioritypolicylocalprefix_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def sites(self, site_id, tenant_id=None, api_version="v4.10"): """ Delete a site (v4.10) **Parameters:**: - **site_id**: Site ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v4.10) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}".format(api_version, tenant_id, site_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def sitesecurityzones(self, site_id, sitesecurityzone_id, tenant_id=None, api_version="v2.0"): """ Delete an existing security zone (v2.0) **Parameters:**: - **site_id**: Site ID - **sitesecurityzone_id**: Site Security Zone ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/sitesecurityzones/{}".format(api_version, tenant_id, site_id, sitesecurityzone_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def snmpagents(self, site_id, element_id, snmpagent_id, tenant_id=None, api_version="v2.1"): """ delete SNMP Agent (v2.1) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **snmpagent_id**: SNMP Agent ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/elements/{}/snmpagents/{}".format(api_version, tenant_id, site_id, element_id, snmpagent_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def snmptraps(self, site_id, element_id, snmptrap_id, tenant_id=None, api_version="v2.0"): """ delete SNMP Trap (v2.0) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **snmptrap_id**: SNMP Trap ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/elements/{}/snmptraps/{}".format(api_version, tenant_id, site_id, element_id, snmptrap_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def spokeclusters(self, site_id, spokecluster_id, tenant_id=None, api_version="v2.0"): """ Delete spoke cluster. (v2.0) **Parameters:**: - **site_id**: Site ID - **spokecluster_id**: Spoke Cluster ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/spokeclusters/{}".format(api_version, tenant_id, site_id, spokecluster_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def staticroutes(self, site_id, element_id, staticroute_id, tenant_id=None, api_version="v2.3"): """ Delete static route (v2.3) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **staticroute_id**: Static Route ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.3) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/elements/{}/staticroutes/{}".format(api_version, tenant_id, site_id, element_id, staticroute_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def syslogserverprofiles(self, syslogserverprofile_id, tenant_id=None, api_version="v2.0"): """ Delete Syslog Server Profile (v2.0) **Parameters:**: - **syslogserverprofile_id**: Sys Log Server Profile ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/syslogserverprofiles/{}".format(api_version, tenant_id, syslogserverprofile_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def syslogservers(self, site_id, element_id, syslogserver_id, tenant_id=None, api_version="v2.2"): """ Delete Syslog Server (v2.2) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **syslogserver_id**: SYSLOG server ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.2) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/elements/{}/syslogservers/{}".format(api_version, tenant_id, site_id, element_id, syslogserver_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def templates_ntp(self, ntp_id, tenant_id=None, api_version="v2.0"): """ Delete an existing NTP Template (v2.0) **Parameters:**: - **ntp_id**: NTP Configuration ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/templates/ntp/{}".format(api_version, tenant_id, ntp_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def tenant_anynetlinks(self, anynetlink_id, tenant_id=None, api_version="v3.4"): """ DELETE Tenant_Anynetlinks API Function **Parameters:**: - **anynetlink_id**: Anynet (Secure Fabric) Link ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v3.4) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/anynetlinks/{}".format(api_version, tenant_id, anynetlink_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def tenant_ipfixlocalprefixes(self, ipfixlocalprefix_id, tenant_id=None, api_version="v2.0"): """ Delete a IPFix local prefix (v2.0) **Parameters:**: - **ipfixlocalprefix_id**: IPFix Local Prefix ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/ipfixlocalprefixes/{}".format(api_version, tenant_id, ipfixlocalprefix_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def tenant_networkpolicylocalprefixes(self, networkpolicylocalprefix_id, tenant_id=None, api_version="v2.0"): """ Delete a Network Policy local prefix. (v2.0) **Parameters:**: - **networkpolicylocalprefix_id**: Network Policy Local Prefix ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/networkpolicylocalprefixes/{}".format(api_version, tenant_id, networkpolicylocalprefix_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def tenant_operators(self, operator_id, tenant_id=None, api_version="v2.2"): """ Delete a tenant operator (v2.2) **Parameters:**: - **operator_id**: Operator ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.2) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/operators/{}".format(api_version, tenant_id, operator_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def tenant_permissions(self, permission_id, tenant_id=None, api_version="v2.0"): """ Delete a tenant custom permission (v2.0) **Parameters:**: - **permission_id**: Permission ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/permissions/{}".format(api_version, tenant_id, permission_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def tenant_prioritypolicylocalprefixes(self, prioritypolicylocalprefix_id, tenant_id=None, api_version="v2.0"): """ Delete a Priority Policy local prefix. (v2.0) **Parameters:**: - **prioritypolicylocalprefix_id**: Priority Policy Local Prefix ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/prioritypolicylocalprefixes/{}".format(api_version, tenant_id, prioritypolicylocalprefix_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def tenantpassageconfigs(self, tenantpassageconfig_id, tenant_id=None, api_version="v2.0"): """ DELETE Tenantpassageconfigs API Function **Parameters:**: - **tenantpassageconfig_id**: Tenant Passage Config ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/tenantpassageconfigs/{}".format(api_version, tenant_id, tenantpassageconfig_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def useridagents(self, useridagent_id, tenant_id=None, api_version="v2.0"): """ DELETE Useridagents API Function **Parameters:**: - **useridagent_id**: User Id Agent ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/useridagents/{}".format(api_version, tenant_id, useridagent_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def users(self, user_id, tenant_id=None, api_version="v2.0"): """ Delete an user identity. (v2.0) **Parameters:**: - **user_id**: User ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/users/{}".format(api_version, tenant_id, user_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def vrfcontextprofiles(self, vrfcontextprofile_id, tenant_id=None, api_version="v2.0"): """ DELETE Vrfcontextprofiles API Function **Parameters:**: - **vrfcontextprofile_id**: VRF Context Profile ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/vrfcontextprofiles/{}".format(api_version, tenant_id, vrfcontextprofile_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def vrfcontexts(self, vrfcontext_id, tenant_id=None, api_version="v2.0"): """ DELETE Vrfcontexts API Function **Parameters:**: - **vrfcontext_id**: VRF Context ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/vrfcontexts/{}".format(api_version, tenant_id, vrfcontext_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def waninterfaces(self, site_id, waninterface_id, tenant_id=None, api_version="v2.8"): """ Delete existing WAN interface (v2.8) **Parameters:**: - **site_id**: Site ID - **waninterface_id**: WAN Interface ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.8) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/waninterfaces/{}".format(api_version, tenant_id, site_id, waninterface_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def wannetworks(self, wannetwork_id, tenant_id=None, api_version="v2.1"): """ Delete an existing WAN (v2.1) **Parameters:**: - **wannetwork_id**: WAN Network ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/wannetworks/{}".format(api_version, tenant_id, wannetwork_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def wanoverlays(self, wanoverlay_id, tenant_id=None, api_version="v2.0"): """ Delete app/wan context (v2.0) **Parameters:**: - **wanoverlay_id**: WAN Overlay ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/wanoverlays/{}".format(api_version, tenant_id, wanoverlay_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def ws_extensions(self, extension_id, tenant_id=None, api_version="v2.0"): """ DELETE Ws_Extensions API Function **Parameters:**: - **extension_id**: Extension ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/ws/extensions/{}".format(api_version, tenant_id, extension_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") # Public Digest compatibility maps below, mapping what is available via # /v2.0/permissions API versus what is used in this SDK. access_elementusers = elementusers_access """ Backwards-compatibility alias of `access_elementusers` to `elementusers_access`""" anynetlinks_t = tenant_anynetlinks """ Backwards-compatibility alias of `anynetlinks_t` to `tenant_anynetlinks`""" configs_prismasase_connections = prismasase_connections_configs """ Backwards-compatibility alias of `configs_prismasase_connections` to `prismasase_connections_configs`""" configs_sdwanapps = sdwanapps_configs """ Backwards-compatibility alias of `configs_sdwanapps` to `sdwanapps_configs`""" deployments_sitetemplates_bulkconfigurations = bulkconfigurations_sitetemplates_deployments """ Backwards-compatibility alias of `deployments_sitetemplates_bulkconfigurations` to `bulkconfigurations_sitetemplates_deployments`""" deviceidconfigs_i = element_deviceidconfigs """ Backwards-compatibility alias of `deviceidconfigs_i` to `element_deviceidconfigs`""" elementpassageconfigs_e = elementpassageconfigs """ Backwards-compatibility alias of `elementpassageconfigs_e` to `elementpassageconfigs`""" extensions_i = element_extensions """ Backwards-compatibility alias of `extensions_i` to `element_extensions`""" extensions_s = site_extensions """ Backwards-compatibility alias of `extensions_s` to `site_extensions`""" extensions_ws = ws_extensions """ Backwards-compatibility alias of `extensions_ws` to `ws_extensions`""" interfaces_elementshells = elementshells_interfaces """ Backwards-compatibility alias of `interfaces_elementshells` to `elementshells_interfaces`""" ipfixlocalprefixes_s = site_ipfixlocalprefixes """ Backwards-compatibility alias of `ipfixlocalprefixes_s` to `site_ipfixlocalprefixes`""" ipfixlocalprefixes_t = tenant_ipfixlocalprefixes """ Backwards-compatibility alias of `ipfixlocalprefixes_t` to `tenant_ipfixlocalprefixes`""" natlocalprefixes_s = site_natlocalprefixes """ Backwards-compatibility alias of `natlocalprefixes_s` to `site_natlocalprefixes`""" natlocalprefixes_t = natlocalprefixes """ Backwards-compatibility alias of `natlocalprefixes_t` to `natlocalprefixes`""" networkpolicylocalprefixes_s = site_networkpolicylocalprefixes """ Backwards-compatibility alias of `networkpolicylocalprefixes_s` to `site_networkpolicylocalprefixes`""" networkpolicylocalprefixes_t = tenant_networkpolicylocalprefixes """ Backwards-compatibility alias of `networkpolicylocalprefixes_t` to `tenant_networkpolicylocalprefixes`""" ngfwsecuritypolicylocalprefixes_s = site_ngfwsecuritypolicylocalprefixes """ Backwards-compatibility alias of `ngfwsecuritypolicylocalprefixes_s` to `site_ngfwsecuritypolicylocalprefixes`""" ngfwsecuritypolicylocalprefixes_t = ngfwsecuritypolicylocalprefixes """ Backwards-compatibility alias of `ngfwsecuritypolicylocalprefixes_t` to `ngfwsecuritypolicylocalprefixes`""" ntp_templates = templates_ntp """ Backwards-compatibility alias of `ntp_templates` to `templates_ntp`""" operators_t = tenant_operators """ Backwards-compatibility alias of `operators_t` to `tenant_operators`""" overrides_appdefs = appdefs_overrides """ Backwards-compatibility alias of `overrides_appdefs` to `appdefs_overrides`""" passages_e = element_passages """ Backwards-compatibility alias of `passages_e` to `element_passages`""" perfmgmtpolicyrules_perfmgmtpolicysets = perfmgmtpolicysets_perfmgmtpolicyrules """ Backwards-compatibility alias of `perfmgmtpolicyrules_perfmgmtpolicysets` to `perfmgmtpolicysets_perfmgmtpolicyrules`""" permissions_clients_o = esp_operator_permissions_client """ Backwards-compatibility alias of `permissions_clients_o` to `esp_operator_permissions_client`""" permissions_t = tenant_permissions """ Backwards-compatibility alias of `permissions_t` to `tenant_permissions`""" prioritypolicylocalprefixes_s = site_prioritypolicylocalprefixes """ Backwards-compatibility alias of `prioritypolicylocalprefixes_s` to `site_prioritypolicylocalprefixes`""" prioritypolicylocalprefixes_t = tenant_prioritypolicylocalprefixes """ Backwards-compatibility alias of `prioritypolicylocalprefixes_t` to `tenant_prioritypolicylocalprefixes`""" sessions_t = operator_sessions """ Backwards-compatibility alias of `sessions_t` to `operator_sessions`""" sitetemplates_bulkconfigurations = bulkconfigurations_sitetemplates """ Backwards-compatibility alias of `sitetemplates_bulkconfigurations` to `bulkconfigurations_sitetemplates`""" snmpdiscoverystartnodes_deviceidconfigs = deviceidconfigs_snmpdiscoverystartnodes """ Backwards-compatibility alias of `snmpdiscoverystartnodes_deviceidconfigs` to `deviceidconfigs_snmpdiscoverystartnodes`""" toolkitsessions_e = element_toolkitsessions """ Backwards-compatibility alias of `toolkitsessions_e` to `element_toolkitsessions`"""
Module variables
var api_logger
logging.getlogger object to enable debug printing via cloudgenix.API.set_debug
Classes
class Delete
CloudGenix API - DELETE requests
Object to handle making Delete requests via shared Requests Session.
class Delete(object): """ CloudGenix API - DELETE requests Object to handle making Delete requests via shared Requests Session. """ # placeholder for parent class namespace _parent_class = None def apnprofiles(self, apnprofile_id, tenant_id=None, api_version="v2.0"): """ Delete an APN Profile (v2.0) **Parameters:**: - **apnprofile_id**: APN Profile ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/apnprofiles/{}".format(api_version, tenant_id, apnprofile_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def appdefs(self, appdef_id, tenant_id=None, api_version="v2.6"): """ Delete an application definition (v2.6) **Parameters:**: - **appdef_id**: Application Definition ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.6) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/appdefs/{}".format(api_version, tenant_id, appdef_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def appdefs_overrides(self, appdef_id, override_id, tenant_id=None, api_version="v2.3"): """ Delete application definition overrides for system appdef (v2.3) **Parameters:**: - **appdef_id**: Application Definition ID - **override_id**: AppDef Override ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.3) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/appdefs/{}/overrides/{}".format(api_version, tenant_id, appdef_id, override_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def authtokens(self, operator_id, authtoken_id, tenant_id=None, api_version="v2.1"): """ Delete an auth token (v2.1) **Parameters:**: - **operator_id**: Operator ID - **authtoken_id**: Static AUTH_TOKEN ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/operators/{}/authtokens/{}".format(api_version, tenant_id, operator_id, authtoken_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def bgppeers(self, site_id, element_id, bgppeer_id, tenant_id=None, api_version="v2.5"): """ Delete BGP Peer config (v2.5) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **bgppeer_id**: BGP Peer ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.5) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/elements/{}/bgppeers/{}".format(api_version, tenant_id, site_id, element_id, bgppeer_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def bulkconfigurations_sitetemplates(self, sitetemplate_id, tenant_id=None, api_version="v2.0"): """ DELETE Bulkconfigurations_Sitetemplates API Function **Parameters:**: - **sitetemplate_id**: Site Template ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/bulkconfigurations/sitetemplates/{}".format(api_version, tenant_id, sitetemplate_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def bulkconfigurations_sitetemplates_deployments(self, sitetemplate_id, deployment_id, tenant_id=None, api_version="v2.0"): """ DELETE Bulkconfigurations_Sitetemplates_Deployments API Function **Parameters:**: - **sitetemplate_id**: Site Template ID - **deployment_id**: Deployment ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/bulkconfigurations/sitetemplates/{}/deployments/{}".format(api_version, tenant_id, sitetemplate_id, deployment_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def demsiteconfigs(self, site_id, demsiteconfig_id, tenant_id=None, api_version="v2.0"): """ DELETE Demsiteconfigs API Function **Parameters:**: - **site_id**: Site ID - **demsiteconfig_id**: - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/demsiteconfigs/{}".format(api_version, tenant_id, 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, tenant_id=None, api_version="v2.0"): """ DELETE Deviceidconfigs_Snmpdiscoverystartnodes API Function **Parameters:**: - **site_id**: Site ID - **deviceidconfig_id**: Device Id Config ID - **snmpdiscoverystartnode_id**: SNMP Discovery Start Node ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/deviceidconfigs/{}/snmpdiscoverystartnodes/{}".format(api_version, tenant_id, site_id, deviceidconfig_id, snmpdiscoverystartnode_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def deviceidprofiles(self, deviceidprofile_id, tenant_id=None, api_version="v2.0"): """ DELETE Deviceidprofiles API Function **Parameters:**: - **deviceidprofile_id**: Device Id Profile ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/deviceidprofiles/{}".format(api_version, tenant_id, deviceidprofile_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def dhcpservers(self, site_id, dhcpserver_id, tenant_id=None, api_version="v2.3"): """ Delete DHCPServer for a Tenant on a site (v2.3) **Parameters:**: - **site_id**: Site ID - **dhcpserver_id**: DHCP Server ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.3) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/dhcpservers/{}".format(api_version, tenant_id, site_id, dhcpserver_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def directoryservices(self, directoryservice_id, tenant_id=None, api_version="v2.0"): """ DELETE Directoryservices API Function **Parameters:**: - **directoryservice_id**: Directory Service ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/directoryservices/{}".format(api_version, tenant_id, directoryservice_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def dnsserviceprofiles(self, dnsserviceprofile_id, tenant_id=None, api_version="v2.1"): """ Delete a DNS service profile (v2.1) **Parameters:**: - **dnsserviceprofile_id**: DNS Service Profile ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/dnsserviceprofiles/{}".format(api_version, tenant_id, dnsserviceprofile_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def dnsserviceroles(self, dnsservicerole_id, tenant_id=None, api_version="v2.0"): """ Delete a DNS service role (v2.0) **Parameters:**: - **dnsservicerole_id**: DNS Service Role ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/dnsserviceroles/{}".format(api_version, tenant_id, dnsservicerole_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def dnsservices(self, site_id, element_id, dnsservice_id, tenant_id=None, api_version="v2.0"): """ Delete a DNS service config (v2.0) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **dnsservice_id**: DNS Service ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/elements/{}/dnsservices/{}".format(api_version, tenant_id, site_id, element_id, dnsservice_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def element_deviceidconfigs(self, site_id, element_id, deviceidconfig_id, tenant_id=None, api_version="v2.0"): """ DELETE Element_Deviceidconfigs API Function **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **deviceidconfig_id**: Device Id Config ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/elements/{}/deviceidconfigs/{}".format(api_version, tenant_id, site_id, element_id, deviceidconfig_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def element_extensions(self, site_id, element_id, extension_id, tenant_id=None, api_version="v2.0"): """ Delete a specific extension associated with an element (v2.0) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **extension_id**: Extension ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/elements/{}/extensions/{}".format(api_version, tenant_id, site_id, element_id, extension_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def element_passages(self, element_id, passage_id, tenant_id=None, api_version="v2.0"): """ DELETE Element_Passages API Function **Parameters:**: - **element_id**: Element (Device) ID - **passage_id**: Passage Configuration ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/elements/{}/passages/{}".format(api_version, tenant_id, element_id, passage_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def element_toolkitsessions(self, element_id, toolkitsession_id, tenant_id=None, api_version="v2.0"): """ DELETE Element_Toolkitsessions API Function **Parameters:**: - **element_id**: Element (Device) ID - **toolkitsession_id**: Toolkit Session ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/elements/{}/toolkitsessions/{}".format(api_version, tenant_id, element_id, toolkitsession_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def elementpassageconfigs(self, element_id, elementpassageconfig_id, tenant_id=None, api_version="v2.0"): """ DELETE Elementpassageconfigs API Function **Parameters:**: - **element_id**: Element (Device) ID - **elementpassageconfig_id**: Element Passage Configuration ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/elements/{}/elementpassageconfigs/{}".format(api_version, tenant_id, element_id, elementpassageconfig_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def elementsecurityzones(self, site_id, element_id, securityzone_id, tenant_id=None, api_version="v2.0"): """ Delete an existing security zone (v2.0) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **securityzone_id**: Security Zone (ZBFW) ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/elements/{}/securityzones/{}".format(api_version, tenant_id, site_id, element_id, securityzone_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def elementshells(self, site_id, elementshell_id, tenant_id=None, api_version="v2.0"): """ DELETE Elementshells API Function **Parameters:**: - **site_id**: Site ID - **elementshell_id**: Element Shell ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/elementshells/{}".format(api_version, tenant_id, site_id, elementshell_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def elementshells_interfaces(self, site_id, elementshell_id, interface_id, tenant_id=None, api_version="v2.1"): """ DELETE Elementshells_Interfaces API Function **Parameters:**: - **site_id**: Site ID - **elementshell_id**: Element Shell ID - **interface_id**: Interface ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/elementshells/{}/interfaces/{}".format(api_version, tenant_id, site_id, elementshell_id, interface_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def elementusers(self, elementuser_id, tenant_id=None, api_version="v2.1"): """ Delete element user (v2.1) **Parameters:**: - **elementuser_id**: Element User ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/elementusers/{}".format(api_version, tenant_id, elementuser_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def elementusers_access(self, elementuser_id, access_id, tenant_id=None, api_version="v2.1"): """ Delete element user Access (v2.1) **Parameters:**: - **elementuser_id**: Element User ID - **access_id**: Access ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/elementusers/{}/access/{}".format(api_version, tenant_id, elementuser_id, access_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def esp_operator_permissions_client(self, operator_id, client_id, tenant_id=None, api_version="v2.1"): """ Delete esp operator permissions assigned under a client (v2.1) **Parameters:**: - **operator_id**: Operator ID - **client_id**: ESP/MSP Client ID (typically their tenant_id) - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/operators/{}/clients/{}/permissions".format(api_version, tenant_id, operator_id, client_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def eventcorrelationpolicyrules(self, eventcorrelationpolicyset_id, eventcorrelationpolicyrule_id, tenant_id=None, api_version="v2.1"): """ Delete specific event correlation policy rule (v2.1) **Parameters:**: - **eventcorrelationpolicyset_id**: Event Correlation Policy Set ID - **eventcorrelationpolicyrule_id**: Event Correlation Policy Rule ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/eventcorrelationpolicysets/{}/eventcorrelationpolicyrules/{}".format(api_version, tenant_id, eventcorrelationpolicyset_id, eventcorrelationpolicyrule_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def eventcorrelationpolicysets(self, eventcorrelationpolicyset_id, tenant_id=None, api_version="v2.0"): """ Delete specific event correlation policyset (v2.0) **Parameters:**: - **eventcorrelationpolicyset_id**: Event Correlation Policy Set ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/eventcorrelationpolicysets/{}".format(api_version, tenant_id, eventcorrelationpolicyset_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def externalcaconfigs(self, externalcaconfig_id, tenant_id=None, api_version="v2.0"): """ DELETE Externalcaconfigs API Function **Parameters:**: - **externalcaconfig_id**: External CA Config ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/externalcaconfigs/{}".format(api_version, tenant_id, externalcaconfig_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def globalprefixfilters(self, globalprefixfilter_id, tenant_id=None, api_version="v2.0"): """ Delete a global prefix filter. (v2.0) **Parameters:**: - **globalprefixfilter_id**: Global Prefix Filter ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/globalprefixfilters/{}".format(api_version, tenant_id, globalprefixfilter_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def hubclustermembers(self, site_id, hubcluster_id, hubclustermember_id, tenant_id=None, api_version="v3.0"): """ Deletes specific hub cluster member. (v3.0) **Parameters:**: - **site_id**: Site ID - **hubcluster_id**: Hub (DC) Cluster ID - **hubclustermember_id**: Hub Cluster Member ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v3.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/hubclusters/{}/hubclustermembers/{}".format(api_version, tenant_id, site_id, hubcluster_id, hubclustermember_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def hubclusters(self, site_id, hubcluster_id, tenant_id=None, api_version="v4.0"): """ Delete hub cluster (v4.0) **Parameters:**: - **site_id**: Site ID - **hubcluster_id**: Hub (DC) Cluster ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v4.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/hubclusters/{}".format(api_version, tenant_id, site_id, hubcluster_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def idps(self, idp_id, tenant_id=None, api_version="v3.3"): """ Delete idp (v3.3) **Parameters:**: - **idp_id**: SAML IDentity provider configuration ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v3.3) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/idps/{}".format(api_version, tenant_id, idp_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def interfaces(self, site_id, element_id, interface_id, tenant_id=None, api_version="v4.18"): """ Delete a Interface (v4.18) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **interface_id**: Interface ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v4.18) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/elements/{}/interfaces/{}".format(api_version, tenant_id, site_id, element_id, interface_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def ipfix(self, site_id, element_id, ipfix_id, tenant_id=None, api_version="v2.0"): """ Delete IPFix config (v2.0) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **ipfix_id**: IPFix ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/elements/{}/ipfix/{}".format(api_version, tenant_id, site_id, element_id, ipfix_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def ipfixcollectorcontexts(self, ipfixcollectorcontext_id, tenant_id=None, api_version="v2.0"): """ Delete a IPFix collector context (v2.0) **Parameters:**: - **ipfixcollectorcontext_id**: IPFix Collector Context ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/ipfixcollectorcontexts/{}".format(api_version, tenant_id, ipfixcollectorcontext_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def ipfixfiltercontexts(self, ipfixfiltercontext_id, tenant_id=None, api_version="v2.0"): """ Delete a IPFix filter context (v2.0) **Parameters:**: - **ipfixfiltercontext_id**: IPFix Filter Context ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/ipfixfiltercontexts/{}".format(api_version, tenant_id, ipfixfiltercontext_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def ipfixglobalprefixes(self, ipfixglobalprefix_id, tenant_id=None, api_version="v2.0"): """ Delete a IPFix global prefix (v2.0) **Parameters:**: - **ipfixglobalprefix_id**: IPFix Global Prefix ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/ipfixglobalprefixes/{}".format(api_version, tenant_id, ipfixglobalprefix_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def ipfixprofiles(self, ipfixprofile_id, tenant_id=None, api_version="v2.0"): """ Delete IPFix Profile (v2.0) **Parameters:**: - **ipfixprofile_id**: IPFix Profile ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/ipfixprofiles/{}".format(api_version, tenant_id, ipfixprofile_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def ipfixtemplates(self, ipfixtemplate_id, tenant_id=None, api_version="v2.0"): """ Delete a IPFix template (v2.0) **Parameters:**: - **ipfixtemplate_id**: IPFix Template ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/ipfixtemplates/{}".format(api_version, tenant_id, ipfixtemplate_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def ipsecprofiles(self, ipsecprofile_id, tenant_id=None, api_version="v2.1"): """ Delete a IPSEC Profile (v2.1) **Parameters:**: - **ipsecprofile_id**: IPSEC Profile ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/ipsecprofiles/{}".format(api_version, tenant_id, ipsecprofile_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def lannetworks(self, site_id, lannetwork_id, tenant_id=None, api_version="v3.3"): """ Delete an existing LAN (v3.3) **Parameters:**: - **site_id**: Site ID - **lannetwork_id**: LAN Network ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v3.3) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/lannetworks/{}".format(api_version, tenant_id, site_id, lannetwork_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def localprefixfilters(self, localprefixfilter_id, tenant_id=None, api_version="v2.0"): """ Delete a local prefix filter. (v2.0) **Parameters:**: - **localprefixfilter_id**: Local Prefix Filter ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/localprefixfilters/{}".format(api_version, tenant_id, localprefixfilter_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def mstp_instances(self, site_id, element_id, mstp_instance_id, tenant_id=None, api_version="v2.0"): """ Delete MSTP instance for an element (v2.0) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **mstp_instance_id**: MSTP Instance ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/elements/{}/mstp_instances/{}".format(api_version, tenant_id, site_id, element_id, mstp_instance_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def multicastpeergroups(self, multicastpeergroup_id, tenant_id=None, api_version="v2.1"): """ Delete multicast peer group (v2.1) **Parameters:**: - **multicastpeergroup_id**: Multicast Peer Group ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/multicastpeergroups/{}".format(api_version, tenant_id, multicastpeergroup_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def multicastrps(self, site_id, element_id, multicastrp_id, tenant_id=None, api_version="v2.0"): """ Deletes Multicast RP config (v2.0) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **multicastrp_id**: Multicast RP ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/elements/{}/multicastrps/{}".format(api_version, tenant_id, site_id, element_id, multicastrp_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def multicastsourcesiteconfigs(self, site_id, multicastsourcesiteconfig_id, tenant_id=None, api_version="v2.0"): """ Delete multicast source site config (v2.0) **Parameters:**: - **site_id**: Site ID - **multicastsourcesiteconfig_id**: Multicast Source Site Config ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/multicastsourcesiteconfigs/{}".format(api_version, tenant_id, site_id, multicastsourcesiteconfig_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def natglobalprefixes(self, natglobalprefix_id, tenant_id=None, api_version="v2.0"): """ Delete a NAT Global Prefix. (v2.0) **Parameters:**: - **natglobalprefix_id**: NAT Global Prefix ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/natglobalprefixes/{}".format(api_version, tenant_id, natglobalprefix_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def natlocalprefixes(self, natlocalprefix_id, tenant_id=None, api_version="v2.0"): """ Delete a NAT local prefix. (v2.0) **Parameters:**: - **natlocalprefix_id**: NAT Local Prefix ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/natlocalprefixes/{}".format(api_version, tenant_id, natlocalprefix_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def natpolicypools(self, natpolicypool_id, tenant_id=None, api_version="v2.0"): """ Delete a NAT Policy Pool. (v2.0) **Parameters:**: - **natpolicypool_id**: NAT Policy Pool ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/natpolicypools/{}".format(api_version, tenant_id, natpolicypool_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def natpolicyrules(self, natpolicyset_id, natpolicyrule_id, tenant_id=None, api_version="v2.0"): """ Delete NAT policy rule of tenant. (v2.0) **Parameters:**: - **natpolicyset_id**: NAT Policy Set ID - **natpolicyrule_id**: NAT Policy Rule ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/natpolicysets/{}/natpolicyrules/{}".format(api_version, tenant_id, natpolicyset_id, natpolicyrule_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def natpolicysets(self, natpolicyset_id, tenant_id=None, api_version="v2.0"): """ Delete NAT policy set. (v2.0) **Parameters:**: - **natpolicyset_id**: NAT Policy Set ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/natpolicysets/{}".format(api_version, tenant_id, natpolicyset_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def natpolicysetstacks(self, natpolicysetstack_id, tenant_id=None, api_version="v2.0"): """ Delete NAT Policy Set Stack. (v2.0) **Parameters:**: - **natpolicysetstack_id**: NAT Policy Set Stack ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/natpolicysetstacks/{}".format(api_version, tenant_id, natpolicysetstack_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def natzones(self, natzone_id, tenant_id=None, api_version="v2.0"): """ Delete a Nat Policy Zone. (v2.0) **Parameters:**: - **natzone_id**: NAT Zone ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/natzones/{}".format(api_version, tenant_id, natzone_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def networkcontexts(self, networkcontext_id, tenant_id=None, api_version="v2.0"): """ Delete LAN segment (v2.0) **Parameters:**: - **networkcontext_id**: Network Context ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/networkcontexts/{}".format(api_version, tenant_id, networkcontext_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def networkpolicyglobalprefixes(self, networkpolicyglobalprefix_id, tenant_id=None, api_version="v2.1"): """ Delete a Network Policy Global Prefix. (v2.1) **Parameters:**: - **networkpolicyglobalprefix_id**: Network Policy Global Prefix ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/networkpolicyglobalprefixes/{}".format(api_version, tenant_id, networkpolicyglobalprefix_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def networkpolicyrules(self, networkpolicyset_id, networkpolicyrule_id, tenant_id=None, api_version="v2.2"): """ Delete network policy rule of tenant. (v2.2) **Parameters:**: - **networkpolicyset_id**: Network Policy Set ID - **networkpolicyrule_id**: Network Policy Rule ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.2) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/networkpolicysets/{}/networkpolicyrules/{}".format(api_version, tenant_id, networkpolicyset_id, networkpolicyrule_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def networkpolicysets(self, networkpolicyset_id, tenant_id=None, api_version="v2.0"): """ Delete Network Policy Set. (v2.0) **Parameters:**: - **networkpolicyset_id**: Network Policy Set ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/networkpolicysets/{}".format(api_version, tenant_id, networkpolicyset_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def networkpolicysetstacks(self, networkpolicysetstack_id, tenant_id=None, api_version="v2.0"): """ Delete a NetworkPolicySetStack (v2.0) **Parameters:**: - **networkpolicysetstack_id**: Network Policy Set Stack ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/networkpolicysetstacks/{}".format(api_version, tenant_id, networkpolicysetstack_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def ngfwsecuritypolicyglobalprefixes(self, ngfwsecuritypolicyglobalprefix_id, tenant_id=None, api_version="v2.1"): """ Delete a Security Policy V2 Local Prefix by tenant ID and its ID (v2.1) **Parameters:**: - **ngfwsecuritypolicyglobalprefix_id**: NGFW Security Policy Global Prefix ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/ngfwsecuritypolicyglobalprefixes/{}".format(api_version, tenant_id, ngfwsecuritypolicyglobalprefix_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def ngfwsecuritypolicylocalprefixes(self, ngfwsecuritypolicylocalprefix_id, tenant_id=None, api_version="v2.0"): """ Delete a Security Policy V2 Local Prefix by tenant ID and its ID (v2.0) **Parameters:**: - **ngfwsecuritypolicylocalprefix_id**: NGFW Security Policy Local Prefix ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/ngfwsecuritypolicylocalprefixes/{}".format(api_version, tenant_id, ngfwsecuritypolicylocalprefix_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def ngfwsecuritypolicyrules(self, ngfwsecuritypolicyset_id, ngfwsecuritypolicyrule_id, tenant_id=None, api_version="v2.1"): """ Delete an existing Security Policy V2 Rule under a policy set (v2.1) **Parameters:**: - **ngfwsecuritypolicyset_id**: NGFW Security Policy Set ID - **ngfwsecuritypolicyrule_id**: NGFW Security Policy Rule ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/ngfwsecuritypolicysets/{}/ngfwsecuritypolicyrules/{}".format(api_version, tenant_id, ngfwsecuritypolicyset_id, ngfwsecuritypolicyrule_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def ngfwsecuritypolicysets(self, ngfwsecuritypolicyset_id, tenant_id=None, api_version="v2.0"): """ Delete an existing Security Policy V2 Set by tenant ID and its ID (v2.0) **Parameters:**: - **ngfwsecuritypolicyset_id**: NGFW Security Policy Set ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/ngfwsecuritypolicysets/{}".format(api_version, tenant_id, ngfwsecuritypolicyset_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def ngfwsecuritypolicysetstacks(self, ngfwsecuritypolicysetstack_id, tenant_id=None, api_version="v2.0"): """ Delete an existing Security Policy V2 Set Stack by tenant ID and its ID (v2.0) **Parameters:**: - **ngfwsecuritypolicysetstack_id**: NGFW Security Policy Set Stack ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/ngfwsecuritypolicysetstacks/{}".format(api_version, tenant_id, ngfwsecuritypolicysetstack_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def operator_sessions(self, operator_id, session_id, tenant_id=None, api_version="v2.0"): """ Delete session for tenant_id, operator id, and session id (v2.0) **Parameters:**: - **operator_id**: Operator ID - **session_id**: User Session ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/operators/{}/sessions/{}".format(api_version, tenant_id, operator_id, session_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def ospfconfigs(self, site_id, element_id, ospfconfig_id, tenant_id=None, api_version="v2.0"): """ DELETE Ospfconfigs API Function **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **ospfconfig_id**: OSPF Config ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/elements/{}/ospfconfigs/{}".format(api_version, tenant_id, site_id, element_id, ospfconfig_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def pathgroups(self, pathgroup_id, tenant_id=None, api_version="v2.1"): """ Delete A Path Group of a tenant. (v2.1) **Parameters:**: - **pathgroup_id**: Path Group ID (for network service/DC routing) - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/pathgroups/{}".format(api_version, tenant_id, pathgroup_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def perfmgmtpolicysets(self, perfmgmtpolicyset_id, tenant_id=None, api_version="v2.0"): """ DELETE Perfmgmtpolicysets API Function **Parameters:**: - **perfmgmtpolicyset_id**: Performance Management Policy Set ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/perfmgmtpolicysets/{}".format(api_version, tenant_id, perfmgmtpolicyset_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def perfmgmtpolicysets_perfmgmtpolicyrules(self, perfmgmtpolicyset_id, perfmgmtpolicyrule_id, tenant_id=None, api_version="v2.1"): """ DELETE Perfmgmtpolicysets_Perfmgmtpolicyrules API Function **Parameters:**: - **perfmgmtpolicyset_id**: Performance Management Policy Set ID - **perfmgmtpolicyrule_id**: Performance Management Policy Rule ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/perfmgmtpolicysets/{}/perfmgmtpolicyrules/{}".format(api_version, tenant_id, perfmgmtpolicyset_id, perfmgmtpolicyrule_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def perfmgmtpolicysetstacks(self, perfmgmtpolicysetstack_id, tenant_id=None, api_version="v2.0"): """ DELETE Perfmgmtpolicysetstacks API Function **Parameters:**: - **perfmgmtpolicysetstack_id**: Performance Management Policy Set Stack ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/perfmgmtpolicysetstacks/{}".format(api_version, tenant_id, perfmgmtpolicysetstack_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def perfmgmtthresholdprofiles(self, perfmgmtthresholdprofile_id, tenant_id=None, api_version="v2.1"): """ DELETE Perfmgmtthresholdprofiles API Function **Parameters:**: - **perfmgmtthresholdprofile_id**: Performance Management Policy Threshold Profile ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/perfmgmtthresholdprofiles/{}".format(api_version, tenant_id, perfmgmtthresholdprofile_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def policyrules(self, policyset_id, policyrule_id, tenant_id=None, api_version="v3.1"): """ Delete policy rule of tenant. (v3.1) **Parameters:**: - **policyset_id**: Policy Set ID - **policyrule_id**: Policy Rule ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v3.1) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/policysets/{}/policyrules/{}".format(api_version, tenant_id, policyset_id, policyrule_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def policysets(self, policyset_id, tenant_id=None, api_version="v3.0"): """ Delete policy set. (v3.0) **Parameters:**: - **policyset_id**: Policy Set ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v3.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/policysets/{}".format(api_version, tenant_id, policyset_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def prefixfilters(self, site_id, prefixfilter_id, tenant_id=None, api_version="v2.0"): """ Delete an existing security prefix filter (v2.0) **Parameters:**: - **site_id**: Site ID - **prefixfilter_id**: Prefix Filter ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/prefixfilters/{}".format(api_version, tenant_id, site_id, prefixfilter_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def prioritypolicyglobalprefixes(self, prioritypolicyglobalprefix_id, tenant_id=None, api_version="v2.1"): """ Delete a Priority Policy Global Prefix. (v2.1) **Parameters:**: - **prioritypolicyglobalprefix_id**: Priority Policy Global Prefix ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/prioritypolicyglobalprefixes/{}".format(api_version, tenant_id, prioritypolicyglobalprefix_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def prioritypolicyrules(self, prioritypolicyset_id, prioritypolicyrule_id, tenant_id=None, api_version="v2.1"): """ Delete priority policy rule of tenant. (v2.1) **Parameters:**: - **prioritypolicyset_id**: Priority Policy Set ID - **prioritypolicyrule_id**: Priority Policy Rule ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/prioritypolicysets/{}/prioritypolicyrules/{}".format(api_version, tenant_id, prioritypolicyset_id, prioritypolicyrule_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def prioritypolicysets(self, prioritypolicyset_id, tenant_id=None, api_version="v2.0"): """ Delete Priority Policy Set. (v2.0) **Parameters:**: - **prioritypolicyset_id**: Priority Policy Set ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/prioritypolicysets/{}".format(api_version, tenant_id, prioritypolicyset_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def prioritypolicysetstacks(self, prioritypolicysetstack_id, tenant_id=None, api_version="v2.0"): """ Delete a PriorityPolicySetStack (v2.0) **Parameters:**: - **prioritypolicysetstack_id**: Priority Policy Stack ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/prioritypolicysetstacks/{}".format(api_version, tenant_id, prioritypolicysetstack_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def prismaaccess_configs(self, site_id, prismaaccess_config_id, tenant_id=None, api_version="v2.0"): """ Delete a Prisma Access Config with remote networks and security processing node (v2.0) **Parameters:**: - **site_id**: Site ID - **prismaaccess_config_id**: Prisma Acceess Config ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/prismaaccess_configs/{}".format(api_version, tenant_id, site_id, prismaaccess_config_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def prismasase_connections(self, site_id, prismasase_connection_id, tenant_id=None, api_version="v2.1"): """ DELETE Prismasase_Connections API Function **Parameters:**: - **site_id**: Site ID - **prismasase_connection_id**: Prisma SASE Connection ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/prismasase_connections/{}".format(api_version, tenant_id, site_id, prismasase_connection_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def prismasase_connections_configs(self, tenant_id=None, api_version="v2.1"): """ DELETE Prismasase_Connections_Configs API Function **Parameters:**: - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/prismasase_connections/configs".format(api_version, tenant_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def probeconfigs(self, probeconfig_id, tenant_id=None, api_version="v2.0"): """ DELETE Probeconfigs API Function **Parameters:**: - **probeconfig_id**: Probe Config ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/probeconfigs/{}".format(api_version, tenant_id, probeconfig_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def probeprofiles(self, probeprofile_id, tenant_id=None, api_version="v2.0"): """ DELETE Probeprofiles API Function **Parameters:**: - **probeprofile_id**: Probe Profile ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/probeprofiles/{}".format(api_version, tenant_id, probeprofile_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def radii(self, element_id, radii_id, tenant_id=None, api_version="v2.0"): """ Delete radius configuration in an element (v2.0) **Parameters:**: - **element_id**: Element (Device) ID - **radii_id**: Radii ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/elements/{}/radii/{}".format(api_version, tenant_id, element_id, radii_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def roles(self, role_id, tenant_id=None, api_version="v2.1"): """ Delete a custom role (v2.1) **Parameters:**: - **role_id**: Role ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/roles/{}".format(api_version, tenant_id, role_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def routing_aspathaccesslists(self, site_id, element_id, routing_aspathaccesslist_id, tenant_id=None, api_version="v2.1"): """ Delete Access List (v2.1) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **routing_aspathaccesslist_id**: Routing AS-PATH Access List ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/elements/{}/routing_aspathaccesslists/{}".format(api_version, tenant_id, site_id, element_id, routing_aspathaccesslist_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def routing_ipcommunitylists(self, site_id, element_id, routing_ipcommunitylist_id, tenant_id=None, api_version="v2.0"): """ Delete Community List (v2.0) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **routing_ipcommunitylist_id**: Routing IP Community List ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/elements/{}/routing_ipcommunitylists/{}".format(api_version, tenant_id, site_id, element_id, routing_ipcommunitylist_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def routing_prefixlists(self, site_id, element_id, routing_prefixlist_id, tenant_id=None, api_version="v2.1"): """ Delete Prefix List (v2.1) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **routing_prefixlist_id**: Routing IP Prefix List ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/elements/{}/routing_prefixlists/{}".format(api_version, tenant_id, site_id, element_id, routing_prefixlist_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def routing_routemaps(self, site_id, element_id, routing_routemap_id, tenant_id=None, api_version="v2.3"): """ Delete Route Map (v2.3) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **routing_routemap_id**: Routing Route Map ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.3) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/elements/{}/routing_routemaps/{}".format(api_version, tenant_id, site_id, element_id, routing_routemap_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def sdwanapps_configs(self, sdwanapp_id, config_id, tenant_id=None, api_version="v2.0"): """ DELETE Sdwanapps_Configs API Function **Parameters:**: - **sdwanapp_id**: SDWAN Application ID - **config_id**: SDWAN App Config ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sdwanapps/{}/configs/{}".format(api_version, tenant_id, sdwanapp_id, config_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def securitypolicyrules(self, securitypolicyset_id, securitypolicyrule_id, tenant_id=None, api_version="v2.0"): """ Delete a security policyrule. (v2.0) **Parameters:**: - **securitypolicyset_id**: Security Policy Set ID - **securitypolicyrule_id**: Security Policy Rule ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/securitypolicysets/{}/securitypolicyrules/{}".format(api_version, tenant_id, securitypolicyset_id, securitypolicyrule_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def securitypolicysets(self, securitypolicyset_id, tenant_id=None, api_version="v2.0"): """ Delete a security policyset. (v2.0) **Parameters:**: - **securitypolicyset_id**: Security Policy Set ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/securitypolicysets/{}".format(api_version, tenant_id, securitypolicyset_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def securityzones(self, securityzone_id, tenant_id=None, api_version="v2.0"): """ Delete an existing security zone (v2.0) **Parameters:**: - **securityzone_id**: Security Zone (ZBFW) ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/securityzones/{}".format(api_version, tenant_id, securityzone_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def servicebindingmaps(self, servicebindingmap_id, tenant_id=None, api_version="v2.1"): """ Delete a Service Binding Map (v2.1) **Parameters:**: - **servicebindingmap_id**: Service Binding Map ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/servicebindingmaps/{}".format(api_version, tenant_id, servicebindingmap_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def serviceendpoints(self, serviceendpoint_id, tenant_id=None, api_version="v2.4"): """ Delete a Service Endpoint (v2.4) **Parameters:**: - **serviceendpoint_id**: Service Endpoint ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.4) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/serviceendpoints/{}".format(api_version, tenant_id, serviceendpoint_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def servicelabels(self, servicelabel_id, tenant_id=None, api_version="v2.1"): """ Delete a Service Label (v2.1) **Parameters:**: - **servicelabel_id**: Service Label ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/servicelabels/{}".format(api_version, tenant_id, servicelabel_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def site_extensions(self, site_id, extension_id, tenant_id=None, api_version="v2.0"): """ Delete a specific extension associated with a site (v2.0) **Parameters:**: - **site_id**: Site ID - **extension_id**: Extension ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/extensions/{}".format(api_version, tenant_id, site_id, extension_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def site_ipfixlocalprefixes(self, site_id, ipfixlocalprefix_id, tenant_id=None, api_version="v2.0"): """ Delete a IPFix site prefix association (v2.0) **Parameters:**: - **site_id**: Site ID - **ipfixlocalprefix_id**: IPFix Local Prefix ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/ipfixlocalprefixes/{}".format(api_version, tenant_id, site_id, ipfixlocalprefix_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def site_natlocalprefixes(self, site_id, natlocalprefix_id, tenant_id=None, api_version="v2.0"): """ Delete an existing Site NAT prefix (v2.0) **Parameters:**: - **site_id**: Site ID - **natlocalprefix_id**: NAT Local Prefix ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/natlocalprefixes/{}".format(api_version, tenant_id, site_id, natlocalprefix_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def site_networkpolicylocalprefixes(self, site_id, networkpolicylocalprefix_id, tenant_id=None, api_version="v2.1"): """ Delete an existing Site Network Policy local prefix association (v2.1) **Parameters:**: - **site_id**: Site ID - **networkpolicylocalprefix_id**: Network Policy Local Prefix ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/networkpolicylocalprefixes/{}".format(api_version, tenant_id, site_id, networkpolicylocalprefix_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def site_ngfwsecuritypolicylocalprefixes(self, site_id, ngfwsecuritypolicylocalprefix_id, tenant_id=None, api_version="v2.1"): """ Delete an existing security policy v2 local prefix site association (v2.1) **Parameters:**: - **site_id**: Site ID - **ngfwsecuritypolicylocalprefix_id**: NGFW Security Policy Local Prefix ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/ngfwsecuritypolicylocalprefixes/{}".format(api_version, tenant_id, site_id, ngfwsecuritypolicylocalprefix_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def site_prioritypolicylocalprefixes(self, site_id, prioritypolicylocalprefix_id, tenant_id=None, api_version="v2.1"): """ Delete an existing Site Priority Policy local prefix association (v2.1) **Parameters:**: - **site_id**: Site ID - **prioritypolicylocalprefix_id**: Priority Policy Local Prefix ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/prioritypolicylocalprefixes/{}".format(api_version, tenant_id, site_id, prioritypolicylocalprefix_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def sites(self, site_id, tenant_id=None, api_version="v4.10"): """ Delete a site (v4.10) **Parameters:**: - **site_id**: Site ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v4.10) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}".format(api_version, tenant_id, site_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def sitesecurityzones(self, site_id, sitesecurityzone_id, tenant_id=None, api_version="v2.0"): """ Delete an existing security zone (v2.0) **Parameters:**: - **site_id**: Site ID - **sitesecurityzone_id**: Site Security Zone ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/sitesecurityzones/{}".format(api_version, tenant_id, site_id, sitesecurityzone_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def snmpagents(self, site_id, element_id, snmpagent_id, tenant_id=None, api_version="v2.1"): """ delete SNMP Agent (v2.1) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **snmpagent_id**: SNMP Agent ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/elements/{}/snmpagents/{}".format(api_version, tenant_id, site_id, element_id, snmpagent_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def snmptraps(self, site_id, element_id, snmptrap_id, tenant_id=None, api_version="v2.0"): """ delete SNMP Trap (v2.0) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **snmptrap_id**: SNMP Trap ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/elements/{}/snmptraps/{}".format(api_version, tenant_id, site_id, element_id, snmptrap_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def spokeclusters(self, site_id, spokecluster_id, tenant_id=None, api_version="v2.0"): """ Delete spoke cluster. (v2.0) **Parameters:**: - **site_id**: Site ID - **spokecluster_id**: Spoke Cluster ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/spokeclusters/{}".format(api_version, tenant_id, site_id, spokecluster_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def staticroutes(self, site_id, element_id, staticroute_id, tenant_id=None, api_version="v2.3"): """ Delete static route (v2.3) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **staticroute_id**: Static Route ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.3) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/elements/{}/staticroutes/{}".format(api_version, tenant_id, site_id, element_id, staticroute_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def syslogserverprofiles(self, syslogserverprofile_id, tenant_id=None, api_version="v2.0"): """ Delete Syslog Server Profile (v2.0) **Parameters:**: - **syslogserverprofile_id**: Sys Log Server Profile ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/syslogserverprofiles/{}".format(api_version, tenant_id, syslogserverprofile_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def syslogservers(self, site_id, element_id, syslogserver_id, tenant_id=None, api_version="v2.2"): """ Delete Syslog Server (v2.2) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **syslogserver_id**: SYSLOG server ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.2) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/elements/{}/syslogservers/{}".format(api_version, tenant_id, site_id, element_id, syslogserver_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def templates_ntp(self, ntp_id, tenant_id=None, api_version="v2.0"): """ Delete an existing NTP Template (v2.0) **Parameters:**: - **ntp_id**: NTP Configuration ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/templates/ntp/{}".format(api_version, tenant_id, ntp_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def tenant_anynetlinks(self, anynetlink_id, tenant_id=None, api_version="v3.4"): """ DELETE Tenant_Anynetlinks API Function **Parameters:**: - **anynetlink_id**: Anynet (Secure Fabric) Link ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v3.4) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/anynetlinks/{}".format(api_version, tenant_id, anynetlink_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def tenant_ipfixlocalprefixes(self, ipfixlocalprefix_id, tenant_id=None, api_version="v2.0"): """ Delete a IPFix local prefix (v2.0) **Parameters:**: - **ipfixlocalprefix_id**: IPFix Local Prefix ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/ipfixlocalprefixes/{}".format(api_version, tenant_id, ipfixlocalprefix_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def tenant_networkpolicylocalprefixes(self, networkpolicylocalprefix_id, tenant_id=None, api_version="v2.0"): """ Delete a Network Policy local prefix. (v2.0) **Parameters:**: - **networkpolicylocalprefix_id**: Network Policy Local Prefix ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/networkpolicylocalprefixes/{}".format(api_version, tenant_id, networkpolicylocalprefix_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def tenant_operators(self, operator_id, tenant_id=None, api_version="v2.2"): """ Delete a tenant operator (v2.2) **Parameters:**: - **operator_id**: Operator ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.2) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/operators/{}".format(api_version, tenant_id, operator_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def tenant_permissions(self, permission_id, tenant_id=None, api_version="v2.0"): """ Delete a tenant custom permission (v2.0) **Parameters:**: - **permission_id**: Permission ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/permissions/{}".format(api_version, tenant_id, permission_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def tenant_prioritypolicylocalprefixes(self, prioritypolicylocalprefix_id, tenant_id=None, api_version="v2.0"): """ Delete a Priority Policy local prefix. (v2.0) **Parameters:**: - **prioritypolicylocalprefix_id**: Priority Policy Local Prefix ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/prioritypolicylocalprefixes/{}".format(api_version, tenant_id, prioritypolicylocalprefix_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def tenantpassageconfigs(self, tenantpassageconfig_id, tenant_id=None, api_version="v2.0"): """ DELETE Tenantpassageconfigs API Function **Parameters:**: - **tenantpassageconfig_id**: Tenant Passage Config ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/tenantpassageconfigs/{}".format(api_version, tenant_id, tenantpassageconfig_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def useridagents(self, useridagent_id, tenant_id=None, api_version="v2.0"): """ DELETE Useridagents API Function **Parameters:**: - **useridagent_id**: User Id Agent ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/useridagents/{}".format(api_version, tenant_id, useridagent_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def users(self, user_id, tenant_id=None, api_version="v2.0"): """ Delete an user identity. (v2.0) **Parameters:**: - **user_id**: User ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/users/{}".format(api_version, tenant_id, user_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def vrfcontextprofiles(self, vrfcontextprofile_id, tenant_id=None, api_version="v2.0"): """ DELETE Vrfcontextprofiles API Function **Parameters:**: - **vrfcontextprofile_id**: VRF Context Profile ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/vrfcontextprofiles/{}".format(api_version, tenant_id, vrfcontextprofile_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def vrfcontexts(self, vrfcontext_id, tenant_id=None, api_version="v2.0"): """ DELETE Vrfcontexts API Function **Parameters:**: - **vrfcontext_id**: VRF Context ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/vrfcontexts/{}".format(api_version, tenant_id, vrfcontext_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def waninterfaces(self, site_id, waninterface_id, tenant_id=None, api_version="v2.8"): """ Delete existing WAN interface (v2.8) **Parameters:**: - **site_id**: Site ID - **waninterface_id**: WAN Interface ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.8) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/waninterfaces/{}".format(api_version, tenant_id, site_id, waninterface_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def wannetworks(self, wannetwork_id, tenant_id=None, api_version="v2.1"): """ Delete an existing WAN (v2.1) **Parameters:**: - **wannetwork_id**: WAN Network ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/wannetworks/{}".format(api_version, tenant_id, wannetwork_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def wanoverlays(self, wanoverlay_id, tenant_id=None, api_version="v2.0"): """ Delete app/wan context (v2.0) **Parameters:**: - **wanoverlay_id**: WAN Overlay ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/wanoverlays/{}".format(api_version, tenant_id, wanoverlay_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") def ws_extensions(self, extension_id, tenant_id=None, api_version="v2.0"): """ DELETE Ws_Extensions API Function **Parameters:**: - **extension_id**: Extension ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/ws/extensions/{}".format(api_version, tenant_id, extension_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete") # Public Digest compatibility maps below, mapping what is available via # /v2.0/permissions API versus what is used in this SDK. access_elementusers = elementusers_access """ Backwards-compatibility alias of `access_elementusers` to `elementusers_access`""" anynetlinks_t = tenant_anynetlinks """ Backwards-compatibility alias of `anynetlinks_t` to `tenant_anynetlinks`""" configs_prismasase_connections = prismasase_connections_configs """ Backwards-compatibility alias of `configs_prismasase_connections` to `prismasase_connections_configs`""" configs_sdwanapps = sdwanapps_configs """ Backwards-compatibility alias of `configs_sdwanapps` to `sdwanapps_configs`""" deployments_sitetemplates_bulkconfigurations = bulkconfigurations_sitetemplates_deployments """ Backwards-compatibility alias of `deployments_sitetemplates_bulkconfigurations` to `bulkconfigurations_sitetemplates_deployments`""" deviceidconfigs_i = element_deviceidconfigs """ Backwards-compatibility alias of `deviceidconfigs_i` to `element_deviceidconfigs`""" elementpassageconfigs_e = elementpassageconfigs """ Backwards-compatibility alias of `elementpassageconfigs_e` to `elementpassageconfigs`""" extensions_i = element_extensions """ Backwards-compatibility alias of `extensions_i` to `element_extensions`""" extensions_s = site_extensions """ Backwards-compatibility alias of `extensions_s` to `site_extensions`""" extensions_ws = ws_extensions """ Backwards-compatibility alias of `extensions_ws` to `ws_extensions`""" interfaces_elementshells = elementshells_interfaces """ Backwards-compatibility alias of `interfaces_elementshells` to `elementshells_interfaces`""" ipfixlocalprefixes_s = site_ipfixlocalprefixes """ Backwards-compatibility alias of `ipfixlocalprefixes_s` to `site_ipfixlocalprefixes`""" ipfixlocalprefixes_t = tenant_ipfixlocalprefixes """ Backwards-compatibility alias of `ipfixlocalprefixes_t` to `tenant_ipfixlocalprefixes`""" natlocalprefixes_s = site_natlocalprefixes """ Backwards-compatibility alias of `natlocalprefixes_s` to `site_natlocalprefixes`""" natlocalprefixes_t = natlocalprefixes """ Backwards-compatibility alias of `natlocalprefixes_t` to `natlocalprefixes`""" networkpolicylocalprefixes_s = site_networkpolicylocalprefixes """ Backwards-compatibility alias of `networkpolicylocalprefixes_s` to `site_networkpolicylocalprefixes`""" networkpolicylocalprefixes_t = tenant_networkpolicylocalprefixes """ Backwards-compatibility alias of `networkpolicylocalprefixes_t` to `tenant_networkpolicylocalprefixes`""" ngfwsecuritypolicylocalprefixes_s = site_ngfwsecuritypolicylocalprefixes """ Backwards-compatibility alias of `ngfwsecuritypolicylocalprefixes_s` to `site_ngfwsecuritypolicylocalprefixes`""" ngfwsecuritypolicylocalprefixes_t = ngfwsecuritypolicylocalprefixes """ Backwards-compatibility alias of `ngfwsecuritypolicylocalprefixes_t` to `ngfwsecuritypolicylocalprefixes`""" ntp_templates = templates_ntp """ Backwards-compatibility alias of `ntp_templates` to `templates_ntp`""" operators_t = tenant_operators """ Backwards-compatibility alias of `operators_t` to `tenant_operators`""" overrides_appdefs = appdefs_overrides """ Backwards-compatibility alias of `overrides_appdefs` to `appdefs_overrides`""" passages_e = element_passages """ Backwards-compatibility alias of `passages_e` to `element_passages`""" perfmgmtpolicyrules_perfmgmtpolicysets = perfmgmtpolicysets_perfmgmtpolicyrules """ Backwards-compatibility alias of `perfmgmtpolicyrules_perfmgmtpolicysets` to `perfmgmtpolicysets_perfmgmtpolicyrules`""" permissions_clients_o = esp_operator_permissions_client """ Backwards-compatibility alias of `permissions_clients_o` to `esp_operator_permissions_client`""" permissions_t = tenant_permissions """ Backwards-compatibility alias of `permissions_t` to `tenant_permissions`""" prioritypolicylocalprefixes_s = site_prioritypolicylocalprefixes """ Backwards-compatibility alias of `prioritypolicylocalprefixes_s` to `site_prioritypolicylocalprefixes`""" prioritypolicylocalprefixes_t = tenant_prioritypolicylocalprefixes """ Backwards-compatibility alias of `prioritypolicylocalprefixes_t` to `tenant_prioritypolicylocalprefixes`""" sessions_t = operator_sessions """ Backwards-compatibility alias of `sessions_t` to `operator_sessions`""" sitetemplates_bulkconfigurations = bulkconfigurations_sitetemplates """ Backwards-compatibility alias of `sitetemplates_bulkconfigurations` to `bulkconfigurations_sitetemplates`""" snmpdiscoverystartnodes_deviceidconfigs = deviceidconfigs_snmpdiscoverystartnodes """ Backwards-compatibility alias of `snmpdiscoverystartnodes_deviceidconfigs` to `deviceidconfigs_snmpdiscoverystartnodes`""" toolkitsessions_e = element_toolkitsessions """ Backwards-compatibility alias of `toolkitsessions_e` to `element_toolkitsessions`"""
Ancestors (in MRO)
- Delete
- builtins.object
Class variables
var access_elementusers
Backwards-compatibility alias of access_elementusers to elementusers_access
var anynetlinks_t
Backwards-compatibility alias of anynetlinks_t to tenant_anynetlinks
var configs_prismasase_connections
Backwards-compatibility alias of configs_prismasase_connections to prismasase_connections_configs
var configs_sdwanapps
Backwards-compatibility alias of configs_sdwanapps to sdwanapps_configs
var deployments_sitetemplates_bulkconfigurations
Backwards-compatibility alias of deployments_sitetemplates_bulkconfigurations to bulkconfigurations_sitetemplates_deployments
var deviceidconfigs_i
Backwards-compatibility alias of deviceidconfigs_i to element_deviceidconfigs
var elementpassageconfigs_e
Backwards-compatibility alias of elementpassageconfigs_e to elementpassageconfigs
var extensions_i
Backwards-compatibility alias of extensions_i to element_extensions
var extensions_s
Backwards-compatibility alias of extensions_s to site_extensions
var extensions_ws
Backwards-compatibility alias of extensions_ws to ws_extensions
var interfaces_elementshells
Backwards-compatibility alias of interfaces_elementshells to elementshells_interfaces
var ipfixlocalprefixes_s
Backwards-compatibility alias of ipfixlocalprefixes_s to site_ipfixlocalprefixes
var ipfixlocalprefixes_t
Backwards-compatibility alias of ipfixlocalprefixes_t to tenant_ipfixlocalprefixes
var natlocalprefixes_s
Backwards-compatibility alias of natlocalprefixes_s to site_natlocalprefixes
var natlocalprefixes_t
Backwards-compatibility alias of natlocalprefixes_t to natlocalprefixes
var networkpolicylocalprefixes_s
Backwards-compatibility alias of networkpolicylocalprefixes_s to site_networkpolicylocalprefixes
var networkpolicylocalprefixes_t
Backwards-compatibility alias of networkpolicylocalprefixes_t to tenant_networkpolicylocalprefixes
var ngfwsecuritypolicylocalprefixes_s
Backwards-compatibility alias of ngfwsecuritypolicylocalprefixes_s to site_ngfwsecuritypolicylocalprefixes
var ngfwsecuritypolicylocalprefixes_t
Backwards-compatibility alias of ngfwsecuritypolicylocalprefixes_t to ngfwsecuritypolicylocalprefixes
var ntp_templates
Backwards-compatibility alias of ntp_templates to templates_ntp
var operators_t
Backwards-compatibility alias of operators_t to tenant_operators
var overrides_appdefs
Backwards-compatibility alias of overrides_appdefs to appdefs_overrides
var passages_e
Backwards-compatibility alias of passages_e to element_passages
var perfmgmtpolicyrules_perfmgmtpolicysets
Backwards-compatibility alias of perfmgmtpolicyrules_perfmgmtpolicysets to perfmgmtpolicysets_perfmgmtpolicyrules
var permissions_clients_o
Backwards-compatibility alias of permissions_clients_o to esp_operator_permissions_client
var permissions_t
Backwards-compatibility alias of permissions_t to tenant_permissions
var prioritypolicylocalprefixes_s
Backwards-compatibility alias of prioritypolicylocalprefixes_s to site_prioritypolicylocalprefixes
var prioritypolicylocalprefixes_t
Backwards-compatibility alias of prioritypolicylocalprefixes_t to tenant_prioritypolicylocalprefixes
var sessions_t
Backwards-compatibility alias of sessions_t to operator_sessions
var sitetemplates_bulkconfigurations
Backwards-compatibility alias of sitetemplates_bulkconfigurations to bulkconfigurations_sitetemplates
var snmpdiscoverystartnodes_deviceidconfigs
Backwards-compatibility alias of snmpdiscoverystartnodes_deviceidconfigs to deviceidconfigs_snmpdiscoverystartnodes
var toolkitsessions_e
Backwards-compatibility alias of toolkitsessions_e to element_toolkitsessions
Static methods
def apnprofiles(
self, apnprofile_id, tenant_id=None, api_version='v2.0')
Delete an APN Profile (v2.0)
Parameters::
- apnprofile_id: APN Profile ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def apnprofiles(self, apnprofile_id, tenant_id=None, api_version="v2.0"): """ Delete an APN Profile (v2.0) **Parameters:**: - **apnprofile_id**: APN Profile ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/apnprofiles/{}".format(api_version, tenant_id, apnprofile_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def appdefs(
self, appdef_id, tenant_id=None, api_version='v2.6')
Delete an application definition (v2.6)
Parameters::
- appdef_id: Application Definition ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.6)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def appdefs(self, appdef_id, tenant_id=None, api_version="v2.6"): """ Delete an application definition (v2.6) **Parameters:**: - **appdef_id**: Application Definition ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.6) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/appdefs/{}".format(api_version, tenant_id, appdef_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def appdefs_overrides(
self, appdef_id, override_id, tenant_id=None, api_version='v2.3')
Delete application definition overrides for system appdef (v2.3)
Parameters::
- appdef_id: Application Definition ID
- override_id: AppDef Override ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.3)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def appdefs_overrides(self, appdef_id, override_id, tenant_id=None, api_version="v2.3"): """ Delete application definition overrides for system appdef (v2.3) **Parameters:**: - **appdef_id**: Application Definition ID - **override_id**: AppDef Override ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.3) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/appdefs/{}/overrides/{}".format(api_version, tenant_id, appdef_id, override_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def authtokens(
self, operator_id, authtoken_id, tenant_id=None, api_version='v2.1')
Delete an auth token (v2.1)
Parameters::
- operator_id: Operator ID
- authtoken_id: Static AUTH_TOKEN ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.1)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def authtokens(self, operator_id, authtoken_id, tenant_id=None, api_version="v2.1"): """ Delete an auth token (v2.1) **Parameters:**: - **operator_id**: Operator ID - **authtoken_id**: Static AUTH_TOKEN ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/operators/{}/authtokens/{}".format(api_version, tenant_id, operator_id, authtoken_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def bgppeers(
self, site_id, element_id, bgppeer_id, tenant_id=None, api_version='v2.5')
Delete BGP Peer config (v2.5)
Parameters::
- site_id: Site ID
- element_id: Element (Device) ID
- bgppeer_id: BGP Peer ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.5)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def bgppeers(self, site_id, element_id, bgppeer_id, tenant_id=None, api_version="v2.5"): """ Delete BGP Peer config (v2.5) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **bgppeer_id**: BGP Peer ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.5) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/elements/{}/bgppeers/{}".format(api_version, tenant_id, site_id, element_id, bgppeer_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def bulkconfigurations_sitetemplates(
self, sitetemplate_id, tenant_id=None, api_version='v2.0')
DELETE Bulkconfigurations_Sitetemplates API Function
Parameters::
- sitetemplate_id: Site Template ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def bulkconfigurations_sitetemplates(self, sitetemplate_id, tenant_id=None, api_version="v2.0"): """ DELETE Bulkconfigurations_Sitetemplates API Function **Parameters:**: - **sitetemplate_id**: Site Template ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/bulkconfigurations/sitetemplates/{}".format(api_version, tenant_id, sitetemplate_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def bulkconfigurations_sitetemplates_deployments(
self, sitetemplate_id, deployment_id, tenant_id=None, api_version='v2.0')
DELETE Bulkconfigurations_Sitetemplates_Deployments API Function
Parameters::
- sitetemplate_id: Site Template ID
- deployment_id: Deployment ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def bulkconfigurations_sitetemplates_deployments(self, sitetemplate_id, deployment_id, tenant_id=None, api_version="v2.0"): """ DELETE Bulkconfigurations_Sitetemplates_Deployments API Function **Parameters:**: - **sitetemplate_id**: Site Template ID - **deployment_id**: Deployment ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/bulkconfigurations/sitetemplates/{}/deployments/{}".format(api_version, tenant_id, sitetemplate_id, deployment_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def demsiteconfigs(
self, site_id, demsiteconfig_id, tenant_id=None, api_version='v2.0')
DELETE Demsiteconfigs API Function
Parameters::
- site_id: Site ID
- demsiteconfig_id:
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def demsiteconfigs(self, site_id, demsiteconfig_id, tenant_id=None, api_version="v2.0"): """ DELETE Demsiteconfigs API Function **Parameters:**: - **site_id**: Site ID - **demsiteconfig_id**: - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/demsiteconfigs/{}".format(api_version, tenant_id, 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, tenant_id=None, api_version='v2.0')
DELETE Deviceidconfigs_Snmpdiscoverystartnodes API Function
Parameters::
- site_id: Site ID
- deviceidconfig_id: Device Id Config ID
- snmpdiscoverystartnode_id: SNMP Discovery Start Node ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def deviceidconfigs_snmpdiscoverystartnodes(self, site_id, deviceidconfig_id, snmpdiscoverystartnode_id, tenant_id=None, api_version="v2.0"): """ DELETE Deviceidconfigs_Snmpdiscoverystartnodes API Function **Parameters:**: - **site_id**: Site ID - **deviceidconfig_id**: Device Id Config ID - **snmpdiscoverystartnode_id**: SNMP Discovery Start Node ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/deviceidconfigs/{}/snmpdiscoverystartnodes/{}".format(api_version, tenant_id, site_id, deviceidconfig_id, snmpdiscoverystartnode_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def deviceidprofiles(
self, deviceidprofile_id, tenant_id=None, api_version='v2.0')
DELETE Deviceidprofiles API Function
Parameters::
- deviceidprofile_id: Device Id Profile ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def deviceidprofiles(self, deviceidprofile_id, tenant_id=None, api_version="v2.0"): """ DELETE Deviceidprofiles API Function **Parameters:**: - **deviceidprofile_id**: Device Id Profile ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/deviceidprofiles/{}".format(api_version, tenant_id, deviceidprofile_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def dhcpservers(
self, site_id, dhcpserver_id, tenant_id=None, api_version='v2.3')
Delete DHCPServer for a Tenant on a site (v2.3)
Parameters::
- site_id: Site ID
- dhcpserver_id: DHCP Server ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.3)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def dhcpservers(self, site_id, dhcpserver_id, tenant_id=None, api_version="v2.3"): """ Delete DHCPServer for a Tenant on a site (v2.3) **Parameters:**: - **site_id**: Site ID - **dhcpserver_id**: DHCP Server ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.3) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/dhcpservers/{}".format(api_version, tenant_id, site_id, dhcpserver_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def directoryservices(
self, directoryservice_id, tenant_id=None, api_version='v2.0')
DELETE Directoryservices API Function
Parameters::
- directoryservice_id: Directory Service ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def directoryservices(self, directoryservice_id, tenant_id=None, api_version="v2.0"): """ DELETE Directoryservices API Function **Parameters:**: - **directoryservice_id**: Directory Service ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/directoryservices/{}".format(api_version, tenant_id, directoryservice_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def dnsserviceprofiles(
self, dnsserviceprofile_id, tenant_id=None, api_version='v2.1')
Delete a DNS service profile (v2.1)
Parameters::
- dnsserviceprofile_id: DNS Service Profile ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.1)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def dnsserviceprofiles(self, dnsserviceprofile_id, tenant_id=None, api_version="v2.1"): """ Delete a DNS service profile (v2.1) **Parameters:**: - **dnsserviceprofile_id**: DNS Service Profile ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/dnsserviceprofiles/{}".format(api_version, tenant_id, dnsserviceprofile_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def dnsserviceroles(
self, dnsservicerole_id, tenant_id=None, api_version='v2.0')
Delete a DNS service role (v2.0)
Parameters::
- dnsservicerole_id: DNS Service Role ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def dnsserviceroles(self, dnsservicerole_id, tenant_id=None, api_version="v2.0"): """ Delete a DNS service role (v2.0) **Parameters:**: - **dnsservicerole_id**: DNS Service Role ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/dnsserviceroles/{}".format(api_version, tenant_id, dnsservicerole_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def dnsservices(
self, site_id, element_id, dnsservice_id, tenant_id=None, api_version='v2.0')
Delete a DNS service config (v2.0)
Parameters::
- site_id: Site ID
- element_id: Element (Device) ID
- dnsservice_id: DNS Service ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def dnsservices(self, site_id, element_id, dnsservice_id, tenant_id=None, api_version="v2.0"): """ Delete a DNS service config (v2.0) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **dnsservice_id**: DNS Service ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/elements/{}/dnsservices/{}".format(api_version, tenant_id, site_id, element_id, dnsservice_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def element_deviceidconfigs(
self, site_id, element_id, deviceidconfig_id, tenant_id=None, api_version='v2.0')
DELETE Element_Deviceidconfigs API Function
Parameters::
- site_id: Site ID
- element_id: Element (Device) ID
- deviceidconfig_id: Device Id Config ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def element_deviceidconfigs(self, site_id, element_id, deviceidconfig_id, tenant_id=None, api_version="v2.0"): """ DELETE Element_Deviceidconfigs API Function **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **deviceidconfig_id**: Device Id Config ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/elements/{}/deviceidconfigs/{}".format(api_version, tenant_id, site_id, element_id, deviceidconfig_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def element_extensions(
self, site_id, element_id, extension_id, tenant_id=None, api_version='v2.0')
Delete a specific extension associated with an element (v2.0)
Parameters::
- site_id: Site ID
- element_id: Element (Device) ID
- extension_id: Extension ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def element_extensions(self, site_id, element_id, extension_id, tenant_id=None, api_version="v2.0"): """ Delete a specific extension associated with an element (v2.0) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **extension_id**: Extension ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/elements/{}/extensions/{}".format(api_version, tenant_id, site_id, element_id, extension_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def element_passages(
self, element_id, passage_id, tenant_id=None, api_version='v2.0')
DELETE Element_Passages API Function
Parameters::
- element_id: Element (Device) ID
- passage_id: Passage Configuration ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def element_passages(self, element_id, passage_id, tenant_id=None, api_version="v2.0"): """ DELETE Element_Passages API Function **Parameters:**: - **element_id**: Element (Device) ID - **passage_id**: Passage Configuration ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/elements/{}/passages/{}".format(api_version, tenant_id, element_id, passage_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def element_toolkitsessions(
self, element_id, toolkitsession_id, tenant_id=None, api_version='v2.0')
DELETE Element_Toolkitsessions API Function
Parameters::
- element_id: Element (Device) ID
- toolkitsession_id: Toolkit Session ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def element_toolkitsessions(self, element_id, toolkitsession_id, tenant_id=None, api_version="v2.0"): """ DELETE Element_Toolkitsessions API Function **Parameters:**: - **element_id**: Element (Device) ID - **toolkitsession_id**: Toolkit Session ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/elements/{}/toolkitsessions/{}".format(api_version, tenant_id, element_id, toolkitsession_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def elementpassageconfigs(
self, element_id, elementpassageconfig_id, tenant_id=None, api_version='v2.0')
DELETE Elementpassageconfigs API Function
Parameters::
- element_id: Element (Device) ID
- elementpassageconfig_id: Element Passage Configuration ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def elementpassageconfigs(self, element_id, elementpassageconfig_id, tenant_id=None, api_version="v2.0"): """ DELETE Elementpassageconfigs API Function **Parameters:**: - **element_id**: Element (Device) ID - **elementpassageconfig_id**: Element Passage Configuration ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/elements/{}/elementpassageconfigs/{}".format(api_version, tenant_id, element_id, elementpassageconfig_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def elementsecurityzones(
self, site_id, element_id, securityzone_id, tenant_id=None, api_version='v2.0')
Delete an existing security zone (v2.0)
Parameters::
- site_id: Site ID
- element_id: Element (Device) ID
- securityzone_id: Security Zone (ZBFW) ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def elementsecurityzones(self, site_id, element_id, securityzone_id, tenant_id=None, api_version="v2.0"): """ Delete an existing security zone (v2.0) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **securityzone_id**: Security Zone (ZBFW) ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/elements/{}/securityzones/{}".format(api_version, tenant_id, site_id, element_id, securityzone_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def elementshells(
self, site_id, elementshell_id, tenant_id=None, api_version='v2.0')
DELETE Elementshells API Function
Parameters::
- site_id: Site ID
- elementshell_id: Element Shell ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def elementshells(self, site_id, elementshell_id, tenant_id=None, api_version="v2.0"): """ DELETE Elementshells API Function **Parameters:**: - **site_id**: Site ID - **elementshell_id**: Element Shell ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/elementshells/{}".format(api_version, tenant_id, site_id, elementshell_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def elementshells_interfaces(
self, site_id, elementshell_id, interface_id, tenant_id=None, api_version='v2.1')
DELETE Elementshells_Interfaces API Function
Parameters::
- site_id: Site ID
- elementshell_id: Element Shell ID
- interface_id: Interface ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.1)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def elementshells_interfaces(self, site_id, elementshell_id, interface_id, tenant_id=None, api_version="v2.1"): """ DELETE Elementshells_Interfaces API Function **Parameters:**: - **site_id**: Site ID - **elementshell_id**: Element Shell ID - **interface_id**: Interface ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/elementshells/{}/interfaces/{}".format(api_version, tenant_id, site_id, elementshell_id, interface_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def elementusers(
self, elementuser_id, tenant_id=None, api_version='v2.1')
Delete element user (v2.1)
Parameters::
- elementuser_id: Element User ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.1)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def elementusers(self, elementuser_id, tenant_id=None, api_version="v2.1"): """ Delete element user (v2.1) **Parameters:**: - **elementuser_id**: Element User ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/elementusers/{}".format(api_version, tenant_id, elementuser_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def elementusers_access(
self, elementuser_id, access_id, tenant_id=None, api_version='v2.1')
Delete element user Access (v2.1)
Parameters::
- elementuser_id: Element User ID
- access_id: Access ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.1)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def elementusers_access(self, elementuser_id, access_id, tenant_id=None, api_version="v2.1"): """ Delete element user Access (v2.1) **Parameters:**: - **elementuser_id**: Element User ID - **access_id**: Access ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/elementusers/{}/access/{}".format(api_version, tenant_id, elementuser_id, access_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def esp_operator_permissions_client(
self, operator_id, client_id, tenant_id=None, api_version='v2.1')
Delete esp operator permissions assigned under a client (v2.1)
Parameters::
- operator_id: Operator ID
- client_id: ESP/MSP Client ID (typically their tenant_id)
- tenant_id: Tenant ID
- api_version: API version to use (default v2.1)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def esp_operator_permissions_client(self, operator_id, client_id, tenant_id=None, api_version="v2.1"): """ Delete esp operator permissions assigned under a client (v2.1) **Parameters:**: - **operator_id**: Operator ID - **client_id**: ESP/MSP Client ID (typically their tenant_id) - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/operators/{}/clients/{}/permissions".format(api_version, tenant_id, operator_id, client_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def eventcorrelationpolicyrules(
self, eventcorrelationpolicyset_id, eventcorrelationpolicyrule_id, tenant_id=None, api_version='v2.1')
Delete specific event correlation policy rule (v2.1)
Parameters::
- eventcorrelationpolicyset_id: Event Correlation Policy Set ID
- eventcorrelationpolicyrule_id: Event Correlation Policy Rule ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.1)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def eventcorrelationpolicyrules(self, eventcorrelationpolicyset_id, eventcorrelationpolicyrule_id, tenant_id=None, api_version="v2.1"): """ Delete specific event correlation policy rule (v2.1) **Parameters:**: - **eventcorrelationpolicyset_id**: Event Correlation Policy Set ID - **eventcorrelationpolicyrule_id**: Event Correlation Policy Rule ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/eventcorrelationpolicysets/{}/eventcorrelationpolicyrules/{}".format(api_version, tenant_id, eventcorrelationpolicyset_id, eventcorrelationpolicyrule_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def eventcorrelationpolicysets(
self, eventcorrelationpolicyset_id, tenant_id=None, api_version='v2.0')
Delete specific event correlation policyset (v2.0)
Parameters::
- eventcorrelationpolicyset_id: Event Correlation Policy Set ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def eventcorrelationpolicysets(self, eventcorrelationpolicyset_id, tenant_id=None, api_version="v2.0"): """ Delete specific event correlation policyset (v2.0) **Parameters:**: - **eventcorrelationpolicyset_id**: Event Correlation Policy Set ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/eventcorrelationpolicysets/{}".format(api_version, tenant_id, eventcorrelationpolicyset_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def externalcaconfigs(
self, externalcaconfig_id, tenant_id=None, api_version='v2.0')
DELETE Externalcaconfigs API Function
Parameters::
- externalcaconfig_id: External CA Config ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def externalcaconfigs(self, externalcaconfig_id, tenant_id=None, api_version="v2.0"): """ DELETE Externalcaconfigs API Function **Parameters:**: - **externalcaconfig_id**: External CA Config ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/externalcaconfigs/{}".format(api_version, tenant_id, externalcaconfig_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def globalprefixfilters(
self, globalprefixfilter_id, tenant_id=None, api_version='v2.0')
Delete a global prefix filter. (v2.0)
Parameters::
- globalprefixfilter_id: Global Prefix Filter ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def globalprefixfilters(self, globalprefixfilter_id, tenant_id=None, api_version="v2.0"): """ Delete a global prefix filter. (v2.0) **Parameters:**: - **globalprefixfilter_id**: Global Prefix Filter ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/globalprefixfilters/{}".format(api_version, tenant_id, globalprefixfilter_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def hubclustermembers(
self, site_id, hubcluster_id, hubclustermember_id, tenant_id=None, api_version='v3.0')
Deletes specific hub cluster member. (v3.0)
Parameters::
- site_id: Site ID
- hubcluster_id: Hub (DC) Cluster ID
- hubclustermember_id: Hub Cluster Member ID
- tenant_id: Tenant ID
- api_version: API version to use (default v3.0)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def hubclustermembers(self, site_id, hubcluster_id, hubclustermember_id, tenant_id=None, api_version="v3.0"): """ Deletes specific hub cluster member. (v3.0) **Parameters:**: - **site_id**: Site ID - **hubcluster_id**: Hub (DC) Cluster ID - **hubclustermember_id**: Hub Cluster Member ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v3.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/hubclusters/{}/hubclustermembers/{}".format(api_version, tenant_id, site_id, hubcluster_id, hubclustermember_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def hubclusters(
self, site_id, hubcluster_id, tenant_id=None, api_version='v4.0')
Delete hub cluster (v4.0)
Parameters::
- site_id: Site ID
- hubcluster_id: Hub (DC) Cluster ID
- tenant_id: Tenant ID
- api_version: API version to use (default v4.0)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def hubclusters(self, site_id, hubcluster_id, tenant_id=None, api_version="v4.0"): """ Delete hub cluster (v4.0) **Parameters:**: - **site_id**: Site ID - **hubcluster_id**: Hub (DC) Cluster ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v4.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/hubclusters/{}".format(api_version, tenant_id, site_id, hubcluster_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def idps(
self, idp_id, tenant_id=None, api_version='v3.3')
Delete idp (v3.3)
Parameters::
- idp_id: SAML IDentity provider configuration ID
- tenant_id: Tenant ID
- api_version: API version to use (default v3.3)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def idps(self, idp_id, tenant_id=None, api_version="v3.3"): """ Delete idp (v3.3) **Parameters:**: - **idp_id**: SAML IDentity provider configuration ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v3.3) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/idps/{}".format(api_version, tenant_id, idp_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def interfaces(
self, site_id, element_id, interface_id, tenant_id=None, api_version='v4.18')
Delete a Interface (v4.18)
Parameters::
- site_id: Site ID
- element_id: Element (Device) ID
- interface_id: Interface ID
- tenant_id: Tenant ID
- api_version: API version to use (default v4.18)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def interfaces(self, site_id, element_id, interface_id, tenant_id=None, api_version="v4.18"): """ Delete a Interface (v4.18) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **interface_id**: Interface ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v4.18) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/elements/{}/interfaces/{}".format(api_version, tenant_id, site_id, element_id, interface_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def ipfix(
self, site_id, element_id, ipfix_id, tenant_id=None, api_version='v2.0')
Delete IPFix config (v2.0)
Parameters::
- site_id: Site ID
- element_id: Element (Device) ID
- ipfix_id: IPFix ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def ipfix(self, site_id, element_id, ipfix_id, tenant_id=None, api_version="v2.0"): """ Delete IPFix config (v2.0) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **ipfix_id**: IPFix ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/elements/{}/ipfix/{}".format(api_version, tenant_id, site_id, element_id, ipfix_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def ipfixcollectorcontexts(
self, ipfixcollectorcontext_id, tenant_id=None, api_version='v2.0')
Delete a IPFix collector context (v2.0)
Parameters::
- ipfixcollectorcontext_id: IPFix Collector Context ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def ipfixcollectorcontexts(self, ipfixcollectorcontext_id, tenant_id=None, api_version="v2.0"): """ Delete a IPFix collector context (v2.0) **Parameters:**: - **ipfixcollectorcontext_id**: IPFix Collector Context ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/ipfixcollectorcontexts/{}".format(api_version, tenant_id, ipfixcollectorcontext_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def ipfixfiltercontexts(
self, ipfixfiltercontext_id, tenant_id=None, api_version='v2.0')
Delete a IPFix filter context (v2.0)
Parameters::
- ipfixfiltercontext_id: IPFix Filter Context ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def ipfixfiltercontexts(self, ipfixfiltercontext_id, tenant_id=None, api_version="v2.0"): """ Delete a IPFix filter context (v2.0) **Parameters:**: - **ipfixfiltercontext_id**: IPFix Filter Context ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/ipfixfiltercontexts/{}".format(api_version, tenant_id, ipfixfiltercontext_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def ipfixglobalprefixes(
self, ipfixglobalprefix_id, tenant_id=None, api_version='v2.0')
Delete a IPFix global prefix (v2.0)
Parameters::
- ipfixglobalprefix_id: IPFix Global Prefix ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def ipfixglobalprefixes(self, ipfixglobalprefix_id, tenant_id=None, api_version="v2.0"): """ Delete a IPFix global prefix (v2.0) **Parameters:**: - **ipfixglobalprefix_id**: IPFix Global Prefix ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/ipfixglobalprefixes/{}".format(api_version, tenant_id, ipfixglobalprefix_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def ipfixprofiles(
self, ipfixprofile_id, tenant_id=None, api_version='v2.0')
Delete IPFix Profile (v2.0)
Parameters::
- ipfixprofile_id: IPFix Profile ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def ipfixprofiles(self, ipfixprofile_id, tenant_id=None, api_version="v2.0"): """ Delete IPFix Profile (v2.0) **Parameters:**: - **ipfixprofile_id**: IPFix Profile ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/ipfixprofiles/{}".format(api_version, tenant_id, ipfixprofile_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def ipfixtemplates(
self, ipfixtemplate_id, tenant_id=None, api_version='v2.0')
Delete a IPFix template (v2.0)
Parameters::
- ipfixtemplate_id: IPFix Template ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def ipfixtemplates(self, ipfixtemplate_id, tenant_id=None, api_version="v2.0"): """ Delete a IPFix template (v2.0) **Parameters:**: - **ipfixtemplate_id**: IPFix Template ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/ipfixtemplates/{}".format(api_version, tenant_id, ipfixtemplate_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def ipsecprofiles(
self, ipsecprofile_id, tenant_id=None, api_version='v2.1')
Delete a IPSEC Profile (v2.1)
Parameters::
- ipsecprofile_id: IPSEC Profile ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.1)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def ipsecprofiles(self, ipsecprofile_id, tenant_id=None, api_version="v2.1"): """ Delete a IPSEC Profile (v2.1) **Parameters:**: - **ipsecprofile_id**: IPSEC Profile ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/ipsecprofiles/{}".format(api_version, tenant_id, ipsecprofile_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def lannetworks(
self, site_id, lannetwork_id, tenant_id=None, api_version='v3.3')
Delete an existing LAN (v3.3)
Parameters::
- site_id: Site ID
- lannetwork_id: LAN Network ID
- tenant_id: Tenant ID
- api_version: API version to use (default v3.3)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def lannetworks(self, site_id, lannetwork_id, tenant_id=None, api_version="v3.3"): """ Delete an existing LAN (v3.3) **Parameters:**: - **site_id**: Site ID - **lannetwork_id**: LAN Network ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v3.3) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/lannetworks/{}".format(api_version, tenant_id, site_id, lannetwork_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def localprefixfilters(
self, localprefixfilter_id, tenant_id=None, api_version='v2.0')
Delete a local prefix filter. (v2.0)
Parameters::
- localprefixfilter_id: Local Prefix Filter ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def localprefixfilters(self, localprefixfilter_id, tenant_id=None, api_version="v2.0"): """ Delete a local prefix filter. (v2.0) **Parameters:**: - **localprefixfilter_id**: Local Prefix Filter ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/localprefixfilters/{}".format(api_version, tenant_id, localprefixfilter_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def mstp_instances(
self, site_id, element_id, mstp_instance_id, tenant_id=None, api_version='v2.0')
Delete MSTP instance for an element (v2.0)
Parameters::
- site_id: Site ID
- element_id: Element (Device) ID
- mstp_instance_id: MSTP Instance ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def mstp_instances(self, site_id, element_id, mstp_instance_id, tenant_id=None, api_version="v2.0"): """ Delete MSTP instance for an element (v2.0) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **mstp_instance_id**: MSTP Instance ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/elements/{}/mstp_instances/{}".format(api_version, tenant_id, site_id, element_id, mstp_instance_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def multicastpeergroups(
self, multicastpeergroup_id, tenant_id=None, api_version='v2.1')
Delete multicast peer group (v2.1)
Parameters::
- multicastpeergroup_id: Multicast Peer Group ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.1)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def multicastpeergroups(self, multicastpeergroup_id, tenant_id=None, api_version="v2.1"): """ Delete multicast peer group (v2.1) **Parameters:**: - **multicastpeergroup_id**: Multicast Peer Group ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/multicastpeergroups/{}".format(api_version, tenant_id, multicastpeergroup_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def multicastrps(
self, site_id, element_id, multicastrp_id, tenant_id=None, api_version='v2.0')
Deletes Multicast RP config (v2.0)
Parameters::
- site_id: Site ID
- element_id: Element (Device) ID
- multicastrp_id: Multicast RP ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def multicastrps(self, site_id, element_id, multicastrp_id, tenant_id=None, api_version="v2.0"): """ Deletes Multicast RP config (v2.0) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **multicastrp_id**: Multicast RP ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/elements/{}/multicastrps/{}".format(api_version, tenant_id, site_id, element_id, multicastrp_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def multicastsourcesiteconfigs(
self, site_id, multicastsourcesiteconfig_id, tenant_id=None, api_version='v2.0')
Delete multicast source site config (v2.0)
Parameters::
- site_id: Site ID
- multicastsourcesiteconfig_id: Multicast Source Site Config ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def multicastsourcesiteconfigs(self, site_id, multicastsourcesiteconfig_id, tenant_id=None, api_version="v2.0"): """ Delete multicast source site config (v2.0) **Parameters:**: - **site_id**: Site ID - **multicastsourcesiteconfig_id**: Multicast Source Site Config ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/multicastsourcesiteconfigs/{}".format(api_version, tenant_id, site_id, multicastsourcesiteconfig_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def natglobalprefixes(
self, natglobalprefix_id, tenant_id=None, api_version='v2.0')
Delete a NAT Global Prefix. (v2.0)
Parameters::
- natglobalprefix_id: NAT Global Prefix ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def natglobalprefixes(self, natglobalprefix_id, tenant_id=None, api_version="v2.0"): """ Delete a NAT Global Prefix. (v2.0) **Parameters:**: - **natglobalprefix_id**: NAT Global Prefix ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/natglobalprefixes/{}".format(api_version, tenant_id, natglobalprefix_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def natlocalprefixes(
self, natlocalprefix_id, tenant_id=None, api_version='v2.0')
Delete a NAT local prefix. (v2.0)
Parameters::
- natlocalprefix_id: NAT Local Prefix ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def natlocalprefixes(self, natlocalprefix_id, tenant_id=None, api_version="v2.0"): """ Delete a NAT local prefix. (v2.0) **Parameters:**: - **natlocalprefix_id**: NAT Local Prefix ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/natlocalprefixes/{}".format(api_version, tenant_id, natlocalprefix_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def natpolicypools(
self, natpolicypool_id, tenant_id=None, api_version='v2.0')
Delete a NAT Policy Pool. (v2.0)
Parameters::
- natpolicypool_id: NAT Policy Pool ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def natpolicypools(self, natpolicypool_id, tenant_id=None, api_version="v2.0"): """ Delete a NAT Policy Pool. (v2.0) **Parameters:**: - **natpolicypool_id**: NAT Policy Pool ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/natpolicypools/{}".format(api_version, tenant_id, natpolicypool_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def natpolicyrules(
self, natpolicyset_id, natpolicyrule_id, tenant_id=None, api_version='v2.0')
Delete NAT policy rule of tenant. (v2.0)
Parameters::
- natpolicyset_id: NAT Policy Set ID
- natpolicyrule_id: NAT Policy Rule ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def natpolicyrules(self, natpolicyset_id, natpolicyrule_id, tenant_id=None, api_version="v2.0"): """ Delete NAT policy rule of tenant. (v2.0) **Parameters:**: - **natpolicyset_id**: NAT Policy Set ID - **natpolicyrule_id**: NAT Policy Rule ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/natpolicysets/{}/natpolicyrules/{}".format(api_version, tenant_id, natpolicyset_id, natpolicyrule_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def natpolicysets(
self, natpolicyset_id, tenant_id=None, api_version='v2.0')
Delete NAT policy set. (v2.0)
Parameters::
- natpolicyset_id: NAT Policy Set ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def natpolicysets(self, natpolicyset_id, tenant_id=None, api_version="v2.0"): """ Delete NAT policy set. (v2.0) **Parameters:**: - **natpolicyset_id**: NAT Policy Set ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/natpolicysets/{}".format(api_version, tenant_id, natpolicyset_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def natpolicysetstacks(
self, natpolicysetstack_id, tenant_id=None, api_version='v2.0')
Delete NAT Policy Set Stack. (v2.0)
Parameters::
- natpolicysetstack_id: NAT Policy Set Stack ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def natpolicysetstacks(self, natpolicysetstack_id, tenant_id=None, api_version="v2.0"): """ Delete NAT Policy Set Stack. (v2.0) **Parameters:**: - **natpolicysetstack_id**: NAT Policy Set Stack ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/natpolicysetstacks/{}".format(api_version, tenant_id, natpolicysetstack_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def natzones(
self, natzone_id, tenant_id=None, api_version='v2.0')
Delete a Nat Policy Zone. (v2.0)
Parameters::
- natzone_id: NAT Zone ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def natzones(self, natzone_id, tenant_id=None, api_version="v2.0"): """ Delete a Nat Policy Zone. (v2.0) **Parameters:**: - **natzone_id**: NAT Zone ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/natzones/{}".format(api_version, tenant_id, natzone_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def networkcontexts(
self, networkcontext_id, tenant_id=None, api_version='v2.0')
Delete LAN segment (v2.0)
Parameters::
- networkcontext_id: Network Context ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def networkcontexts(self, networkcontext_id, tenant_id=None, api_version="v2.0"): """ Delete LAN segment (v2.0) **Parameters:**: - **networkcontext_id**: Network Context ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/networkcontexts/{}".format(api_version, tenant_id, networkcontext_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def networkpolicyglobalprefixes(
self, networkpolicyglobalprefix_id, tenant_id=None, api_version='v2.1')
Delete a Network Policy Global Prefix. (v2.1)
Parameters::
- networkpolicyglobalprefix_id: Network Policy Global Prefix ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.1)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def networkpolicyglobalprefixes(self, networkpolicyglobalprefix_id, tenant_id=None, api_version="v2.1"): """ Delete a Network Policy Global Prefix. (v2.1) **Parameters:**: - **networkpolicyglobalprefix_id**: Network Policy Global Prefix ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/networkpolicyglobalprefixes/{}".format(api_version, tenant_id, networkpolicyglobalprefix_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def networkpolicyrules(
self, networkpolicyset_id, networkpolicyrule_id, tenant_id=None, api_version='v2.2')
Delete network policy rule of tenant. (v2.2)
Parameters::
- networkpolicyset_id: Network Policy Set ID
- networkpolicyrule_id: Network Policy Rule ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.2)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def networkpolicyrules(self, networkpolicyset_id, networkpolicyrule_id, tenant_id=None, api_version="v2.2"): """ Delete network policy rule of tenant. (v2.2) **Parameters:**: - **networkpolicyset_id**: Network Policy Set ID - **networkpolicyrule_id**: Network Policy Rule ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.2) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/networkpolicysets/{}/networkpolicyrules/{}".format(api_version, tenant_id, networkpolicyset_id, networkpolicyrule_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def networkpolicysets(
self, networkpolicyset_id, tenant_id=None, api_version='v2.0')
Delete Network Policy Set. (v2.0)
Parameters::
- networkpolicyset_id: Network Policy Set ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def networkpolicysets(self, networkpolicyset_id, tenant_id=None, api_version="v2.0"): """ Delete Network Policy Set. (v2.0) **Parameters:**: - **networkpolicyset_id**: Network Policy Set ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/networkpolicysets/{}".format(api_version, tenant_id, networkpolicyset_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def networkpolicysetstacks(
self, networkpolicysetstack_id, tenant_id=None, api_version='v2.0')
Delete a NetworkPolicySetStack (v2.0)
Parameters::
- networkpolicysetstack_id: Network Policy Set Stack ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def networkpolicysetstacks(self, networkpolicysetstack_id, tenant_id=None, api_version="v2.0"): """ Delete a NetworkPolicySetStack (v2.0) **Parameters:**: - **networkpolicysetstack_id**: Network Policy Set Stack ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/networkpolicysetstacks/{}".format(api_version, tenant_id, networkpolicysetstack_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def ngfwsecuritypolicyglobalprefixes(
self, ngfwsecuritypolicyglobalprefix_id, tenant_id=None, api_version='v2.1')
Delete a Security Policy V2 Local Prefix by tenant ID and its ID (v2.1)
Parameters::
- ngfwsecuritypolicyglobalprefix_id: NGFW Security Policy Global Prefix ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.1)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def ngfwsecuritypolicyglobalprefixes(self, ngfwsecuritypolicyglobalprefix_id, tenant_id=None, api_version="v2.1"): """ Delete a Security Policy V2 Local Prefix by tenant ID and its ID (v2.1) **Parameters:**: - **ngfwsecuritypolicyglobalprefix_id**: NGFW Security Policy Global Prefix ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/ngfwsecuritypolicyglobalprefixes/{}".format(api_version, tenant_id, ngfwsecuritypolicyglobalprefix_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def ngfwsecuritypolicylocalprefixes(
self, ngfwsecuritypolicylocalprefix_id, tenant_id=None, api_version='v2.0')
Delete a Security Policy V2 Local Prefix by tenant ID and its ID (v2.0)
Parameters::
- ngfwsecuritypolicylocalprefix_id: NGFW Security Policy Local Prefix ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def ngfwsecuritypolicylocalprefixes(self, ngfwsecuritypolicylocalprefix_id, tenant_id=None, api_version="v2.0"): """ Delete a Security Policy V2 Local Prefix by tenant ID and its ID (v2.0) **Parameters:**: - **ngfwsecuritypolicylocalprefix_id**: NGFW Security Policy Local Prefix ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/ngfwsecuritypolicylocalprefixes/{}".format(api_version, tenant_id, ngfwsecuritypolicylocalprefix_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def ngfwsecuritypolicyrules(
self, ngfwsecuritypolicyset_id, ngfwsecuritypolicyrule_id, tenant_id=None, api_version='v2.1')
Delete an existing Security Policy V2 Rule under a policy set (v2.1)
Parameters::
- ngfwsecuritypolicyset_id: NGFW Security Policy Set ID
- ngfwsecuritypolicyrule_id: NGFW Security Policy Rule ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.1)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def ngfwsecuritypolicyrules(self, ngfwsecuritypolicyset_id, ngfwsecuritypolicyrule_id, tenant_id=None, api_version="v2.1"): """ Delete an existing Security Policy V2 Rule under a policy set (v2.1) **Parameters:**: - **ngfwsecuritypolicyset_id**: NGFW Security Policy Set ID - **ngfwsecuritypolicyrule_id**: NGFW Security Policy Rule ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/ngfwsecuritypolicysets/{}/ngfwsecuritypolicyrules/{}".format(api_version, tenant_id, ngfwsecuritypolicyset_id, ngfwsecuritypolicyrule_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def ngfwsecuritypolicysets(
self, ngfwsecuritypolicyset_id, tenant_id=None, api_version='v2.0')
Delete an existing Security Policy V2 Set by tenant ID and its ID (v2.0)
Parameters::
- ngfwsecuritypolicyset_id: NGFW Security Policy Set ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def ngfwsecuritypolicysets(self, ngfwsecuritypolicyset_id, tenant_id=None, api_version="v2.0"): """ Delete an existing Security Policy V2 Set by tenant ID and its ID (v2.0) **Parameters:**: - **ngfwsecuritypolicyset_id**: NGFW Security Policy Set ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/ngfwsecuritypolicysets/{}".format(api_version, tenant_id, ngfwsecuritypolicyset_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def ngfwsecuritypolicysetstacks(
self, ngfwsecuritypolicysetstack_id, tenant_id=None, api_version='v2.0')
Delete an existing Security Policy V2 Set Stack by tenant ID and its ID (v2.0)
Parameters::
- ngfwsecuritypolicysetstack_id: NGFW Security Policy Set Stack ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def ngfwsecuritypolicysetstacks(self, ngfwsecuritypolicysetstack_id, tenant_id=None, api_version="v2.0"): """ Delete an existing Security Policy V2 Set Stack by tenant ID and its ID (v2.0) **Parameters:**: - **ngfwsecuritypolicysetstack_id**: NGFW Security Policy Set Stack ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/ngfwsecuritypolicysetstacks/{}".format(api_version, tenant_id, ngfwsecuritypolicysetstack_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def operator_sessions(
self, operator_id, session_id, tenant_id=None, api_version='v2.0')
Delete session for tenant_id, operator id, and session id (v2.0)
Parameters::
- operator_id: Operator ID
- session_id: User Session ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def operator_sessions(self, operator_id, session_id, tenant_id=None, api_version="v2.0"): """ Delete session for tenant_id, operator id, and session id (v2.0) **Parameters:**: - **operator_id**: Operator ID - **session_id**: User Session ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/operators/{}/sessions/{}".format(api_version, tenant_id, operator_id, session_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def ospfconfigs(
self, site_id, element_id, ospfconfig_id, tenant_id=None, api_version='v2.0')
DELETE Ospfconfigs API Function
Parameters::
- site_id: Site ID
- element_id: Element (Device) ID
- ospfconfig_id: OSPF Config ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def ospfconfigs(self, site_id, element_id, ospfconfig_id, tenant_id=None, api_version="v2.0"): """ DELETE Ospfconfigs API Function **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **ospfconfig_id**: OSPF Config ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/elements/{}/ospfconfigs/{}".format(api_version, tenant_id, site_id, element_id, ospfconfig_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def pathgroups(
self, pathgroup_id, tenant_id=None, api_version='v2.1')
Delete A Path Group of a tenant. (v2.1)
Parameters::
- pathgroup_id: Path Group ID (for network service/DC routing)
- tenant_id: Tenant ID
- api_version: API version to use (default v2.1)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def pathgroups(self, pathgroup_id, tenant_id=None, api_version="v2.1"): """ Delete A Path Group of a tenant. (v2.1) **Parameters:**: - **pathgroup_id**: Path Group ID (for network service/DC routing) - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/pathgroups/{}".format(api_version, tenant_id, pathgroup_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def perfmgmtpolicysets(
self, perfmgmtpolicyset_id, tenant_id=None, api_version='v2.0')
DELETE Perfmgmtpolicysets API Function
Parameters::
- perfmgmtpolicyset_id: Performance Management Policy Set ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def perfmgmtpolicysets(self, perfmgmtpolicyset_id, tenant_id=None, api_version="v2.0"): """ DELETE Perfmgmtpolicysets API Function **Parameters:**: - **perfmgmtpolicyset_id**: Performance Management Policy Set ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/perfmgmtpolicysets/{}".format(api_version, tenant_id, perfmgmtpolicyset_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def perfmgmtpolicysets_perfmgmtpolicyrules(
self, perfmgmtpolicyset_id, perfmgmtpolicyrule_id, tenant_id=None, api_version='v2.1')
DELETE Perfmgmtpolicysets_Perfmgmtpolicyrules API Function
Parameters::
- perfmgmtpolicyset_id: Performance Management Policy Set ID
- perfmgmtpolicyrule_id: Performance Management Policy Rule ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.1)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def perfmgmtpolicysets_perfmgmtpolicyrules(self, perfmgmtpolicyset_id, perfmgmtpolicyrule_id, tenant_id=None, api_version="v2.1"): """ DELETE Perfmgmtpolicysets_Perfmgmtpolicyrules API Function **Parameters:**: - **perfmgmtpolicyset_id**: Performance Management Policy Set ID - **perfmgmtpolicyrule_id**: Performance Management Policy Rule ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/perfmgmtpolicysets/{}/perfmgmtpolicyrules/{}".format(api_version, tenant_id, perfmgmtpolicyset_id, perfmgmtpolicyrule_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def perfmgmtpolicysetstacks(
self, perfmgmtpolicysetstack_id, tenant_id=None, api_version='v2.0')
DELETE Perfmgmtpolicysetstacks API Function
Parameters::
- perfmgmtpolicysetstack_id: Performance Management Policy Set Stack ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def perfmgmtpolicysetstacks(self, perfmgmtpolicysetstack_id, tenant_id=None, api_version="v2.0"): """ DELETE Perfmgmtpolicysetstacks API Function **Parameters:**: - **perfmgmtpolicysetstack_id**: Performance Management Policy Set Stack ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/perfmgmtpolicysetstacks/{}".format(api_version, tenant_id, perfmgmtpolicysetstack_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def perfmgmtthresholdprofiles(
self, perfmgmtthresholdprofile_id, tenant_id=None, api_version='v2.1')
DELETE Perfmgmtthresholdprofiles API Function
Parameters::
- perfmgmtthresholdprofile_id: Performance Management Policy Threshold Profile ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.1)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def perfmgmtthresholdprofiles(self, perfmgmtthresholdprofile_id, tenant_id=None, api_version="v2.1"): """ DELETE Perfmgmtthresholdprofiles API Function **Parameters:**: - **perfmgmtthresholdprofile_id**: Performance Management Policy Threshold Profile ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/perfmgmtthresholdprofiles/{}".format(api_version, tenant_id, perfmgmtthresholdprofile_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def policyrules(
self, policyset_id, policyrule_id, tenant_id=None, api_version='v3.1')
Delete policy rule of tenant. (v3.1)
Parameters::
- policyset_id: Policy Set ID
- policyrule_id: Policy Rule ID
- tenant_id: Tenant ID
- api_version: API version to use (default v3.1)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def policyrules(self, policyset_id, policyrule_id, tenant_id=None, api_version="v3.1"): """ Delete policy rule of tenant. (v3.1) **Parameters:**: - **policyset_id**: Policy Set ID - **policyrule_id**: Policy Rule ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v3.1) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/policysets/{}/policyrules/{}".format(api_version, tenant_id, policyset_id, policyrule_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def policysets(
self, policyset_id, tenant_id=None, api_version='v3.0')
Delete policy set. (v3.0)
Parameters::
- policyset_id: Policy Set ID
- tenant_id: Tenant ID
- api_version: API version to use (default v3.0)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def policysets(self, policyset_id, tenant_id=None, api_version="v3.0"): """ Delete policy set. (v3.0) **Parameters:**: - **policyset_id**: Policy Set ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v3.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/policysets/{}".format(api_version, tenant_id, policyset_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def prefixfilters(
self, site_id, prefixfilter_id, tenant_id=None, api_version='v2.0')
Delete an existing security prefix filter (v2.0)
Parameters::
- site_id: Site ID
- prefixfilter_id: Prefix Filter ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def prefixfilters(self, site_id, prefixfilter_id, tenant_id=None, api_version="v2.0"): """ Delete an existing security prefix filter (v2.0) **Parameters:**: - **site_id**: Site ID - **prefixfilter_id**: Prefix Filter ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/prefixfilters/{}".format(api_version, tenant_id, site_id, prefixfilter_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def prioritypolicyglobalprefixes(
self, prioritypolicyglobalprefix_id, tenant_id=None, api_version='v2.1')
Delete a Priority Policy Global Prefix. (v2.1)
Parameters::
- prioritypolicyglobalprefix_id: Priority Policy Global Prefix ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.1)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def prioritypolicyglobalprefixes(self, prioritypolicyglobalprefix_id, tenant_id=None, api_version="v2.1"): """ Delete a Priority Policy Global Prefix. (v2.1) **Parameters:**: - **prioritypolicyglobalprefix_id**: Priority Policy Global Prefix ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/prioritypolicyglobalprefixes/{}".format(api_version, tenant_id, prioritypolicyglobalprefix_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def prioritypolicyrules(
self, prioritypolicyset_id, prioritypolicyrule_id, tenant_id=None, api_version='v2.1')
Delete priority policy rule of tenant. (v2.1)
Parameters::
- prioritypolicyset_id: Priority Policy Set ID
- prioritypolicyrule_id: Priority Policy Rule ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.1)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def prioritypolicyrules(self, prioritypolicyset_id, prioritypolicyrule_id, tenant_id=None, api_version="v2.1"): """ Delete priority policy rule of tenant. (v2.1) **Parameters:**: - **prioritypolicyset_id**: Priority Policy Set ID - **prioritypolicyrule_id**: Priority Policy Rule ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/prioritypolicysets/{}/prioritypolicyrules/{}".format(api_version, tenant_id, prioritypolicyset_id, prioritypolicyrule_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def prioritypolicysets(
self, prioritypolicyset_id, tenant_id=None, api_version='v2.0')
Delete Priority Policy Set. (v2.0)
Parameters::
- prioritypolicyset_id: Priority Policy Set ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def prioritypolicysets(self, prioritypolicyset_id, tenant_id=None, api_version="v2.0"): """ Delete Priority Policy Set. (v2.0) **Parameters:**: - **prioritypolicyset_id**: Priority Policy Set ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/prioritypolicysets/{}".format(api_version, tenant_id, prioritypolicyset_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def prioritypolicysetstacks(
self, prioritypolicysetstack_id, tenant_id=None, api_version='v2.0')
Delete a PriorityPolicySetStack (v2.0)
Parameters::
- prioritypolicysetstack_id: Priority Policy Stack ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def prioritypolicysetstacks(self, prioritypolicysetstack_id, tenant_id=None, api_version="v2.0"): """ Delete a PriorityPolicySetStack (v2.0) **Parameters:**: - **prioritypolicysetstack_id**: Priority Policy Stack ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/prioritypolicysetstacks/{}".format(api_version, tenant_id, prioritypolicysetstack_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def prismaaccess_configs(
self, site_id, prismaaccess_config_id, tenant_id=None, api_version='v2.0')
Delete a Prisma Access Config with remote networks and security processing node (v2.0)
Parameters::
- site_id: Site ID
- prismaaccess_config_id: Prisma Acceess Config ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def prismaaccess_configs(self, site_id, prismaaccess_config_id, tenant_id=None, api_version="v2.0"): """ Delete a Prisma Access Config with remote networks and security processing node (v2.0) **Parameters:**: - **site_id**: Site ID - **prismaaccess_config_id**: Prisma Acceess Config ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/prismaaccess_configs/{}".format(api_version, tenant_id, site_id, prismaaccess_config_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def prismasase_connections(
self, site_id, prismasase_connection_id, tenant_id=None, api_version='v2.1')
DELETE Prismasase_Connections API Function
Parameters::
- site_id: Site ID
- prismasase_connection_id: Prisma SASE Connection ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.1)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def prismasase_connections(self, site_id, prismasase_connection_id, tenant_id=None, api_version="v2.1"): """ DELETE Prismasase_Connections API Function **Parameters:**: - **site_id**: Site ID - **prismasase_connection_id**: Prisma SASE Connection ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/prismasase_connections/{}".format(api_version, tenant_id, site_id, prismasase_connection_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def prismasase_connections_configs(
self, tenant_id=None, api_version='v2.1')
DELETE Prismasase_Connections_Configs API Function
Parameters::
- tenant_id: Tenant ID
- api_version: API version to use (default v2.1)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def prismasase_connections_configs(self, tenant_id=None, api_version="v2.1"): """ DELETE Prismasase_Connections_Configs API Function **Parameters:**: - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/prismasase_connections/configs".format(api_version, tenant_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def probeconfigs(
self, probeconfig_id, tenant_id=None, api_version='v2.0')
DELETE Probeconfigs API Function
Parameters::
- probeconfig_id: Probe Config ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def probeconfigs(self, probeconfig_id, tenant_id=None, api_version="v2.0"): """ DELETE Probeconfigs API Function **Parameters:**: - **probeconfig_id**: Probe Config ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/probeconfigs/{}".format(api_version, tenant_id, probeconfig_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def probeprofiles(
self, probeprofile_id, tenant_id=None, api_version='v2.0')
DELETE Probeprofiles API Function
Parameters::
- probeprofile_id: Probe Profile ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def probeprofiles(self, probeprofile_id, tenant_id=None, api_version="v2.0"): """ DELETE Probeprofiles API Function **Parameters:**: - **probeprofile_id**: Probe Profile ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/probeprofiles/{}".format(api_version, tenant_id, probeprofile_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def radii(
self, element_id, radii_id, tenant_id=None, api_version='v2.0')
Delete radius configuration in an element (v2.0)
Parameters::
- element_id: Element (Device) ID
- radii_id: Radii ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def radii(self, element_id, radii_id, tenant_id=None, api_version="v2.0"): """ Delete radius configuration in an element (v2.0) **Parameters:**: - **element_id**: Element (Device) ID - **radii_id**: Radii ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/elements/{}/radii/{}".format(api_version, tenant_id, element_id, radii_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def roles(
self, role_id, tenant_id=None, api_version='v2.1')
Delete a custom role (v2.1)
Parameters::
- role_id: Role ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.1)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def roles(self, role_id, tenant_id=None, api_version="v2.1"): """ Delete a custom role (v2.1) **Parameters:**: - **role_id**: Role ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/roles/{}".format(api_version, tenant_id, role_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def routing_aspathaccesslists(
self, site_id, element_id, routing_aspathaccesslist_id, tenant_id=None, api_version='v2.1')
Delete Access List (v2.1)
Parameters::
- site_id: Site ID
- element_id: Element (Device) ID
- routing_aspathaccesslist_id: Routing AS-PATH Access List ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.1)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def routing_aspathaccesslists(self, site_id, element_id, routing_aspathaccesslist_id, tenant_id=None, api_version="v2.1"): """ Delete Access List (v2.1) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **routing_aspathaccesslist_id**: Routing AS-PATH Access List ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/elements/{}/routing_aspathaccesslists/{}".format(api_version, tenant_id, site_id, element_id, routing_aspathaccesslist_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def routing_ipcommunitylists(
self, site_id, element_id, routing_ipcommunitylist_id, tenant_id=None, api_version='v2.0')
Delete Community List (v2.0)
Parameters::
- site_id: Site ID
- element_id: Element (Device) ID
- routing_ipcommunitylist_id: Routing IP Community List ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def routing_ipcommunitylists(self, site_id, element_id, routing_ipcommunitylist_id, tenant_id=None, api_version="v2.0"): """ Delete Community List (v2.0) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **routing_ipcommunitylist_id**: Routing IP Community List ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/elements/{}/routing_ipcommunitylists/{}".format(api_version, tenant_id, site_id, element_id, routing_ipcommunitylist_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def routing_prefixlists(
self, site_id, element_id, routing_prefixlist_id, tenant_id=None, api_version='v2.1')
Delete Prefix List (v2.1)
Parameters::
- site_id: Site ID
- element_id: Element (Device) ID
- routing_prefixlist_id: Routing IP Prefix List ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.1)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def routing_prefixlists(self, site_id, element_id, routing_prefixlist_id, tenant_id=None, api_version="v2.1"): """ Delete Prefix List (v2.1) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **routing_prefixlist_id**: Routing IP Prefix List ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/elements/{}/routing_prefixlists/{}".format(api_version, tenant_id, site_id, element_id, routing_prefixlist_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def routing_routemaps(
self, site_id, element_id, routing_routemap_id, tenant_id=None, api_version='v2.3')
Delete Route Map (v2.3)
Parameters::
- site_id: Site ID
- element_id: Element (Device) ID
- routing_routemap_id: Routing Route Map ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.3)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def routing_routemaps(self, site_id, element_id, routing_routemap_id, tenant_id=None, api_version="v2.3"): """ Delete Route Map (v2.3) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **routing_routemap_id**: Routing Route Map ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.3) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/elements/{}/routing_routemaps/{}".format(api_version, tenant_id, site_id, element_id, routing_routemap_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def sdwanapps_configs(
self, sdwanapp_id, config_id, tenant_id=None, api_version='v2.0')
DELETE Sdwanapps_Configs API Function
Parameters::
- sdwanapp_id: SDWAN Application ID
- config_id: SDWAN App Config ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def sdwanapps_configs(self, sdwanapp_id, config_id, tenant_id=None, api_version="v2.0"): """ DELETE Sdwanapps_Configs API Function **Parameters:**: - **sdwanapp_id**: SDWAN Application ID - **config_id**: SDWAN App Config ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sdwanapps/{}/configs/{}".format(api_version, tenant_id, sdwanapp_id, config_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def securitypolicyrules(
self, securitypolicyset_id, securitypolicyrule_id, tenant_id=None, api_version='v2.0')
Delete a security policyrule. (v2.0)
Parameters::
- securitypolicyset_id: Security Policy Set ID
- securitypolicyrule_id: Security Policy Rule ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def securitypolicyrules(self, securitypolicyset_id, securitypolicyrule_id, tenant_id=None, api_version="v2.0"): """ Delete a security policyrule. (v2.0) **Parameters:**: - **securitypolicyset_id**: Security Policy Set ID - **securitypolicyrule_id**: Security Policy Rule ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/securitypolicysets/{}/securitypolicyrules/{}".format(api_version, tenant_id, securitypolicyset_id, securitypolicyrule_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def securitypolicysets(
self, securitypolicyset_id, tenant_id=None, api_version='v2.0')
Delete a security policyset. (v2.0)
Parameters::
- securitypolicyset_id: Security Policy Set ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def securitypolicysets(self, securitypolicyset_id, tenant_id=None, api_version="v2.0"): """ Delete a security policyset. (v2.0) **Parameters:**: - **securitypolicyset_id**: Security Policy Set ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/securitypolicysets/{}".format(api_version, tenant_id, securitypolicyset_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def securityzones(
self, securityzone_id, tenant_id=None, api_version='v2.0')
Delete an existing security zone (v2.0)
Parameters::
- securityzone_id: Security Zone (ZBFW) ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def securityzones(self, securityzone_id, tenant_id=None, api_version="v2.0"): """ Delete an existing security zone (v2.0) **Parameters:**: - **securityzone_id**: Security Zone (ZBFW) ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/securityzones/{}".format(api_version, tenant_id, securityzone_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def servicebindingmaps(
self, servicebindingmap_id, tenant_id=None, api_version='v2.1')
Delete a Service Binding Map (v2.1)
Parameters::
- servicebindingmap_id: Service Binding Map ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.1)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def servicebindingmaps(self, servicebindingmap_id, tenant_id=None, api_version="v2.1"): """ Delete a Service Binding Map (v2.1) **Parameters:**: - **servicebindingmap_id**: Service Binding Map ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/servicebindingmaps/{}".format(api_version, tenant_id, servicebindingmap_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def serviceendpoints(
self, serviceendpoint_id, tenant_id=None, api_version='v2.4')
Delete a Service Endpoint (v2.4)
Parameters::
- serviceendpoint_id: Service Endpoint ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.4)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def serviceendpoints(self, serviceendpoint_id, tenant_id=None, api_version="v2.4"): """ Delete a Service Endpoint (v2.4) **Parameters:**: - **serviceendpoint_id**: Service Endpoint ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.4) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/serviceendpoints/{}".format(api_version, tenant_id, serviceendpoint_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def servicelabels(
self, servicelabel_id, tenant_id=None, api_version='v2.1')
Delete a Service Label (v2.1)
Parameters::
- servicelabel_id: Service Label ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.1)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def servicelabels(self, servicelabel_id, tenant_id=None, api_version="v2.1"): """ Delete a Service Label (v2.1) **Parameters:**: - **servicelabel_id**: Service Label ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/servicelabels/{}".format(api_version, tenant_id, servicelabel_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def site_extensions(
self, site_id, extension_id, tenant_id=None, api_version='v2.0')
Delete a specific extension associated with a site (v2.0)
Parameters::
- site_id: Site ID
- extension_id: Extension ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def site_extensions(self, site_id, extension_id, tenant_id=None, api_version="v2.0"): """ Delete a specific extension associated with a site (v2.0) **Parameters:**: - **site_id**: Site ID - **extension_id**: Extension ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/extensions/{}".format(api_version, tenant_id, site_id, extension_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def site_ipfixlocalprefixes(
self, site_id, ipfixlocalprefix_id, tenant_id=None, api_version='v2.0')
Delete a IPFix site prefix association (v2.0)
Parameters::
- site_id: Site ID
- ipfixlocalprefix_id: IPFix Local Prefix ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def site_ipfixlocalprefixes(self, site_id, ipfixlocalprefix_id, tenant_id=None, api_version="v2.0"): """ Delete a IPFix site prefix association (v2.0) **Parameters:**: - **site_id**: Site ID - **ipfixlocalprefix_id**: IPFix Local Prefix ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/ipfixlocalprefixes/{}".format(api_version, tenant_id, site_id, ipfixlocalprefix_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def site_natlocalprefixes(
self, site_id, natlocalprefix_id, tenant_id=None, api_version='v2.0')
Delete an existing Site NAT prefix (v2.0)
Parameters::
- site_id: Site ID
- natlocalprefix_id: NAT Local Prefix ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def site_natlocalprefixes(self, site_id, natlocalprefix_id, tenant_id=None, api_version="v2.0"): """ Delete an existing Site NAT prefix (v2.0) **Parameters:**: - **site_id**: Site ID - **natlocalprefix_id**: NAT Local Prefix ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/natlocalprefixes/{}".format(api_version, tenant_id, site_id, natlocalprefix_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def site_networkpolicylocalprefixes(
self, site_id, networkpolicylocalprefix_id, tenant_id=None, api_version='v2.1')
Delete an existing Site Network Policy local prefix association (v2.1)
Parameters::
- site_id: Site ID
- networkpolicylocalprefix_id: Network Policy Local Prefix ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.1)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def site_networkpolicylocalprefixes(self, site_id, networkpolicylocalprefix_id, tenant_id=None, api_version="v2.1"): """ Delete an existing Site Network Policy local prefix association (v2.1) **Parameters:**: - **site_id**: Site ID - **networkpolicylocalprefix_id**: Network Policy Local Prefix ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/networkpolicylocalprefixes/{}".format(api_version, tenant_id, site_id, networkpolicylocalprefix_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def site_ngfwsecuritypolicylocalprefixes(
self, site_id, ngfwsecuritypolicylocalprefix_id, tenant_id=None, api_version='v2.1')
Delete an existing security policy v2 local prefix site association (v2.1)
Parameters::
- site_id: Site ID
- ngfwsecuritypolicylocalprefix_id: NGFW Security Policy Local Prefix ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.1)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def site_ngfwsecuritypolicylocalprefixes(self, site_id, ngfwsecuritypolicylocalprefix_id, tenant_id=None, api_version="v2.1"): """ Delete an existing security policy v2 local prefix site association (v2.1) **Parameters:**: - **site_id**: Site ID - **ngfwsecuritypolicylocalprefix_id**: NGFW Security Policy Local Prefix ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/ngfwsecuritypolicylocalprefixes/{}".format(api_version, tenant_id, site_id, ngfwsecuritypolicylocalprefix_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def site_prioritypolicylocalprefixes(
self, site_id, prioritypolicylocalprefix_id, tenant_id=None, api_version='v2.1')
Delete an existing Site Priority Policy local prefix association (v2.1)
Parameters::
- site_id: Site ID
- prioritypolicylocalprefix_id: Priority Policy Local Prefix ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.1)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def site_prioritypolicylocalprefixes(self, site_id, prioritypolicylocalprefix_id, tenant_id=None, api_version="v2.1"): """ Delete an existing Site Priority Policy local prefix association (v2.1) **Parameters:**: - **site_id**: Site ID - **prioritypolicylocalprefix_id**: Priority Policy Local Prefix ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/prioritypolicylocalprefixes/{}".format(api_version, tenant_id, site_id, prioritypolicylocalprefix_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def sites(
self, site_id, tenant_id=None, api_version='v4.10')
Delete a site (v4.10)
Parameters::
- site_id: Site ID
- tenant_id: Tenant ID
- api_version: API version to use (default v4.10)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def sites(self, site_id, tenant_id=None, api_version="v4.10"): """ Delete a site (v4.10) **Parameters:**: - **site_id**: Site ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v4.10) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}".format(api_version, tenant_id, site_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def sitesecurityzones(
self, site_id, sitesecurityzone_id, tenant_id=None, api_version='v2.0')
Delete an existing security zone (v2.0)
Parameters::
- site_id: Site ID
- sitesecurityzone_id: Site Security Zone ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def sitesecurityzones(self, site_id, sitesecurityzone_id, tenant_id=None, api_version="v2.0"): """ Delete an existing security zone (v2.0) **Parameters:**: - **site_id**: Site ID - **sitesecurityzone_id**: Site Security Zone ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/sitesecurityzones/{}".format(api_version, tenant_id, site_id, sitesecurityzone_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def snmpagents(
self, site_id, element_id, snmpagent_id, tenant_id=None, api_version='v2.1')
delete SNMP Agent (v2.1)
Parameters::
- site_id: Site ID
- element_id: Element (Device) ID
- snmpagent_id: SNMP Agent ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.1)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def snmpagents(self, site_id, element_id, snmpagent_id, tenant_id=None, api_version="v2.1"): """ delete SNMP Agent (v2.1) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **snmpagent_id**: SNMP Agent ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/elements/{}/snmpagents/{}".format(api_version, tenant_id, site_id, element_id, snmpagent_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def snmptraps(
self, site_id, element_id, snmptrap_id, tenant_id=None, api_version='v2.0')
delete SNMP Trap (v2.0)
Parameters::
- site_id: Site ID
- element_id: Element (Device) ID
- snmptrap_id: SNMP Trap ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def snmptraps(self, site_id, element_id, snmptrap_id, tenant_id=None, api_version="v2.0"): """ delete SNMP Trap (v2.0) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **snmptrap_id**: SNMP Trap ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/elements/{}/snmptraps/{}".format(api_version, tenant_id, site_id, element_id, snmptrap_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def spokeclusters(
self, site_id, spokecluster_id, tenant_id=None, api_version='v2.0')
Delete spoke cluster. (v2.0)
Parameters::
- site_id: Site ID
- spokecluster_id: Spoke Cluster ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def spokeclusters(self, site_id, spokecluster_id, tenant_id=None, api_version="v2.0"): """ Delete spoke cluster. (v2.0) **Parameters:**: - **site_id**: Site ID - **spokecluster_id**: Spoke Cluster ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/spokeclusters/{}".format(api_version, tenant_id, site_id, spokecluster_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def staticroutes(
self, site_id, element_id, staticroute_id, tenant_id=None, api_version='v2.3')
Delete static route (v2.3)
Parameters::
- site_id: Site ID
- element_id: Element (Device) ID
- staticroute_id: Static Route ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.3)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def staticroutes(self, site_id, element_id, staticroute_id, tenant_id=None, api_version="v2.3"): """ Delete static route (v2.3) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **staticroute_id**: Static Route ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.3) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/elements/{}/staticroutes/{}".format(api_version, tenant_id, site_id, element_id, staticroute_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def syslogserverprofiles(
self, syslogserverprofile_id, tenant_id=None, api_version='v2.0')
Delete Syslog Server Profile (v2.0)
Parameters::
- syslogserverprofile_id: Sys Log Server Profile ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def syslogserverprofiles(self, syslogserverprofile_id, tenant_id=None, api_version="v2.0"): """ Delete Syslog Server Profile (v2.0) **Parameters:**: - **syslogserverprofile_id**: Sys Log Server Profile ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/syslogserverprofiles/{}".format(api_version, tenant_id, syslogserverprofile_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def syslogservers(
self, site_id, element_id, syslogserver_id, tenant_id=None, api_version='v2.2')
Delete Syslog Server (v2.2)
Parameters::
- site_id: Site ID
- element_id: Element (Device) ID
- syslogserver_id: SYSLOG server ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.2)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def syslogservers(self, site_id, element_id, syslogserver_id, tenant_id=None, api_version="v2.2"): """ Delete Syslog Server (v2.2) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **syslogserver_id**: SYSLOG server ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.2) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/elements/{}/syslogservers/{}".format(api_version, tenant_id, site_id, element_id, syslogserver_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def templates_ntp(
self, ntp_id, tenant_id=None, api_version='v2.0')
Delete an existing NTP Template (v2.0)
Parameters::
- ntp_id: NTP Configuration ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def templates_ntp(self, ntp_id, tenant_id=None, api_version="v2.0"): """ Delete an existing NTP Template (v2.0) **Parameters:**: - **ntp_id**: NTP Configuration ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/templates/ntp/{}".format(api_version, tenant_id, ntp_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def tenant_anynetlinks(
self, anynetlink_id, tenant_id=None, api_version='v3.4')
DELETE Tenant_Anynetlinks API Function
Parameters::
- anynetlink_id: Anynet (Secure Fabric) Link ID
- tenant_id: Tenant ID
- api_version: API version to use (default v3.4)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def tenant_anynetlinks(self, anynetlink_id, tenant_id=None, api_version="v3.4"): """ DELETE Tenant_Anynetlinks API Function **Parameters:**: - **anynetlink_id**: Anynet (Secure Fabric) Link ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v3.4) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/anynetlinks/{}".format(api_version, tenant_id, anynetlink_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def tenant_ipfixlocalprefixes(
self, ipfixlocalprefix_id, tenant_id=None, api_version='v2.0')
Delete a IPFix local prefix (v2.0)
Parameters::
- ipfixlocalprefix_id: IPFix Local Prefix ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def tenant_ipfixlocalprefixes(self, ipfixlocalprefix_id, tenant_id=None, api_version="v2.0"): """ Delete a IPFix local prefix (v2.0) **Parameters:**: - **ipfixlocalprefix_id**: IPFix Local Prefix ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/ipfixlocalprefixes/{}".format(api_version, tenant_id, ipfixlocalprefix_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def tenant_networkpolicylocalprefixes(
self, networkpolicylocalprefix_id, tenant_id=None, api_version='v2.0')
Delete a Network Policy local prefix. (v2.0)
Parameters::
- networkpolicylocalprefix_id: Network Policy Local Prefix ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def tenant_networkpolicylocalprefixes(self, networkpolicylocalprefix_id, tenant_id=None, api_version="v2.0"): """ Delete a Network Policy local prefix. (v2.0) **Parameters:**: - **networkpolicylocalprefix_id**: Network Policy Local Prefix ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/networkpolicylocalprefixes/{}".format(api_version, tenant_id, networkpolicylocalprefix_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def tenant_operators(
self, operator_id, tenant_id=None, api_version='v2.2')
Delete a tenant operator (v2.2)
Parameters::
- operator_id: Operator ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.2)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def tenant_operators(self, operator_id, tenant_id=None, api_version="v2.2"): """ Delete a tenant operator (v2.2) **Parameters:**: - **operator_id**: Operator ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.2) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/operators/{}".format(api_version, tenant_id, operator_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def tenant_permissions(
self, permission_id, tenant_id=None, api_version='v2.0')
Delete a tenant custom permission (v2.0)
Parameters::
- permission_id: Permission ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def tenant_permissions(self, permission_id, tenant_id=None, api_version="v2.0"): """ Delete a tenant custom permission (v2.0) **Parameters:**: - **permission_id**: Permission ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/permissions/{}".format(api_version, tenant_id, permission_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def tenant_prioritypolicylocalprefixes(
self, prioritypolicylocalprefix_id, tenant_id=None, api_version='v2.0')
Delete a Priority Policy local prefix. (v2.0)
Parameters::
- prioritypolicylocalprefix_id: Priority Policy Local Prefix ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def tenant_prioritypolicylocalprefixes(self, prioritypolicylocalprefix_id, tenant_id=None, api_version="v2.0"): """ Delete a Priority Policy local prefix. (v2.0) **Parameters:**: - **prioritypolicylocalprefix_id**: Priority Policy Local Prefix ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/prioritypolicylocalprefixes/{}".format(api_version, tenant_id, prioritypolicylocalprefix_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def tenantpassageconfigs(
self, tenantpassageconfig_id, tenant_id=None, api_version='v2.0')
DELETE Tenantpassageconfigs API Function
Parameters::
- tenantpassageconfig_id: Tenant Passage Config ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def tenantpassageconfigs(self, tenantpassageconfig_id, tenant_id=None, api_version="v2.0"): """ DELETE Tenantpassageconfigs API Function **Parameters:**: - **tenantpassageconfig_id**: Tenant Passage Config ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/tenantpassageconfigs/{}".format(api_version, tenant_id, tenantpassageconfig_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def useridagents(
self, useridagent_id, tenant_id=None, api_version='v2.0')
DELETE Useridagents API Function
Parameters::
- useridagent_id: User Id Agent ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def useridagents(self, useridagent_id, tenant_id=None, api_version="v2.0"): """ DELETE Useridagents API Function **Parameters:**: - **useridagent_id**: User Id Agent ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/useridagents/{}".format(api_version, tenant_id, useridagent_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def users(
self, user_id, tenant_id=None, api_version='v2.0')
Delete an user identity. (v2.0)
Parameters::
- user_id: User ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def users(self, user_id, tenant_id=None, api_version="v2.0"): """ Delete an user identity. (v2.0) **Parameters:**: - **user_id**: User ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/users/{}".format(api_version, tenant_id, user_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def vrfcontextprofiles(
self, vrfcontextprofile_id, tenant_id=None, api_version='v2.0')
DELETE Vrfcontextprofiles API Function
Parameters::
- vrfcontextprofile_id: VRF Context Profile ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def vrfcontextprofiles(self, vrfcontextprofile_id, tenant_id=None, api_version="v2.0"): """ DELETE Vrfcontextprofiles API Function **Parameters:**: - **vrfcontextprofile_id**: VRF Context Profile ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/vrfcontextprofiles/{}".format(api_version, tenant_id, vrfcontextprofile_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def vrfcontexts(
self, vrfcontext_id, tenant_id=None, api_version='v2.0')
DELETE Vrfcontexts API Function
Parameters::
- vrfcontext_id: VRF Context ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def vrfcontexts(self, vrfcontext_id, tenant_id=None, api_version="v2.0"): """ DELETE Vrfcontexts API Function **Parameters:**: - **vrfcontext_id**: VRF Context ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/vrfcontexts/{}".format(api_version, tenant_id, vrfcontext_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def waninterfaces(
self, site_id, waninterface_id, tenant_id=None, api_version='v2.8')
Delete existing WAN interface (v2.8)
Parameters::
- site_id: Site ID
- waninterface_id: WAN Interface ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.8)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def waninterfaces(self, site_id, waninterface_id, tenant_id=None, api_version="v2.8"): """ Delete existing WAN interface (v2.8) **Parameters:**: - **site_id**: Site ID - **waninterface_id**: WAN Interface ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.8) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/sites/{}/waninterfaces/{}".format(api_version, tenant_id, site_id, waninterface_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def wannetworks(
self, wannetwork_id, tenant_id=None, api_version='v2.1')
Delete an existing WAN (v2.1)
Parameters::
- wannetwork_id: WAN Network ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.1)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def wannetworks(self, wannetwork_id, tenant_id=None, api_version="v2.1"): """ Delete an existing WAN (v2.1) **Parameters:**: - **wannetwork_id**: WAN Network ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/wannetworks/{}".format(api_version, tenant_id, wannetwork_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def wanoverlays(
self, wanoverlay_id, tenant_id=None, api_version='v2.0')
Delete app/wan context (v2.0)
Parameters::
- wanoverlay_id: WAN Overlay ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def wanoverlays(self, wanoverlay_id, tenant_id=None, api_version="v2.0"): """ Delete app/wan context (v2.0) **Parameters:**: - **wanoverlay_id**: WAN Overlay ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/wanoverlays/{}".format(api_version, tenant_id, wanoverlay_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")
def ws_extensions(
self, extension_id, tenant_id=None, api_version='v2.0')
DELETE Ws_Extensions API Function
Parameters::
- extension_id: Extension ID
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def ws_extensions(self, extension_id, tenant_id=None, api_version="v2.0"): """ DELETE Ws_Extensions API Function **Parameters:**: - **extension_id**: Extension ID - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ 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.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/ws/extensions/{}".format(api_version, tenant_id, extension_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "delete")