cloudgenix.put_api module
CloudGenix Python SDK - PUT
Author: CloudGenix
Copyright: (c) 2017-2023 CloudGenix, Inc
License: MIT
#!/usr/bin/env python """ CloudGenix Python SDK - PUT **Author:** CloudGenix **Copyright:** (c) 2017-2023 CloudGenix, Inc **License:** MIT """ import logging __author__ = "CloudGenix Developer Support <developers@cloudgenix.com>" __email__ = "developers@cloudgenix.com" __copyright__ = "Copyright (c) 2017-2023 CloudGenix, Inc" __license__ = """ MIT License Copyright (c) 2017-2023 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 Put(object): """ CloudGenix API - PUT requests Object to handle making Put requests via shared Requests Session. """ # placeholder for parent class namespace _parent_class = None def apnprofiles(self, apnprofile_id, data, tenant_id=None, api_version="v2.0"): """ Update an APN Profile (v2.0) **Parameters:**: - **apnprofile_id**: APN Profile ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **apn:** Type: string - **authentication:** Type: string - **clear_password:** Type: boolean - **description:** Type: string - **name:** Type: string - **password:** Type: string - **tags:** [Type: string] - **user_name:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def appdefs(self, appdef_id, data, tenant_id=None, api_version="v2.5"): """ Update an application definition (v2.5) **Parameters:**: - **appdef_id**: Application Definition ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.5) **Payload Attributes:** - **abbreviation:** Type: string - **aggregate_flows:** Type: boolean - **app_type:** Type: string - **app_unreachability_detection:** Type: boolean - **category:** Type: string - **conn_idle_timeout:** Type: integer - **description:** Type: string - **display_name:** Type: string - **domains:** [Type: string] - **ingress_traffic_pct:** Type: integer - **ip_rules:** [Type: object] - **is_deprecated:** Type: boolean - **network_scan_application:** Type: boolean - **order_number:** Type: integer - **overrides_allowed:** Type: boolean - **p_category:** Type: string - **p_parent_id:** Type: string - **p_sub_category:** Type: string - **parent_id:** Type: string - **path_affinity:** Type: string - **session_timeout:** Type: integer - **supported_engines:** Type: string - **system_app_overridden:** Type: boolean - **tags:** [Type: string] - **tcp_rules:** [Type: string] - **transfer_type:** Type: string - **udp_rules:** [Type: object] - **use_parentapp_network_policy:** Type: boolean **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def appdefs_overrides(self, appdef_id, override_id, data, tenant_id=None, api_version="v2.3"): """ Update a application definition overrides for system appdef (v2.3) **Parameters:**: - **appdef_id**: Application Definition ID - **override_id**: AppDef Override ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.3) **Payload Attributes:** - **aggregate_flows:** Type: boolean - **app_unreachability_detection:** Type: boolean - **category:** Type: string - **conn_idle_timeout:** Type: integer - **description:** Type: string - **domains:** [Type: string] - **ingress_traffic_pct:** Type: integer - **ip_rules:** - **dest_filters:** [Type: string] - **dest_prefixes:** [Type: string] - **dscp:** - **value:** Type: integer - **protocol:** Type: string - **src_filters:** [Type: string] - **override_default_ip_rules:** Type: boolean - **override_default_tcp_rules:** Type: boolean - **override_default_udp_rules:** Type: boolean - **override_domains:** Type: boolean - **overrides_disable:** Type: boolean - **p_category:** Type: string - **path_affinity:** Type: string - **session_timeout:** Type: integer - **tags:** [Type: string] - **tcp_rules:** - **client_filters:** [Type: string] - **client_port:** - **end:** Type: string - **start:** Type: string - **dscp:** - **value:** Type: integer - **server_filters:** [Type: string] - **server_port:** - **end:** Type: string - **start:** Type: string - **server_prefixes:** [Type: string] - **transfer_type:** Type: string - **udp_rules:** - **dest_prefixes:** [Type: string] - **dscp:** - **value:** Type: integer - **udp_filters:** [Type: string] - **udp_port:** - **end:** Type: string - **start:** Type: string - **use_parentapp_network_policy:** Type: boolean **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def appdefs_version(self, appdefs_version_id, data, tenant_id=None, api_version="v2.0"): """ Change standard apps version (v2.0) **Parameters:**: - **appdefs_version_id**: Application Definition Version ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **app_version:** Type: string - **disabled:** Type: boolean - **disabled_reason:** Type: string - **inactive:** Type: boolean - **inactive_reason:** Type: string - **region:** Type: string - **reqState:** Type: string - **sigfile_url:** Type: string - **tenant_id:** Type: string - **uApp_version:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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_version/{}".format(api_version, tenant_id, appdefs_version_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "put", data=data) def application_probe(self, site_id, element_id, data, tenant_id=None, api_version="v2.0"): """ Update application probe configuration (v2.0) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **description:** Type: string - **enable_probe:** Type: boolean - **name:** Type: string - **source_interface_id:** Type: string - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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/{}/application_probe".format(api_version, tenant_id, site_id, element_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "put", data=data) def bgpconfigs(self, site_id, element_id, bgpconfig_id, data, tenant_id=None, api_version="v2.3"): """ Updates BGP config (v2.3) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **bgpconfig_id**: BGP Configuration ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.3) **Payload Attributes:** - **admin_distance:** Type: integer - **adv_interval:** Type: integer - **graceful_restart:** Type: boolean - **hold_time:** Type: integer - **ipv6_prefixes_to_adv_to_wan:** [Type: string] - **keepalive_time:** Type: integer - **local_as_num:** Type: string - **maximum_paths:** Type: integer - **md5_secret:** Type: string - **multi_hop_limit:** Type: integer - **peer_auth_type:** Type: string - **peer_retry_time:** Type: integer - **prefix_adv_type:** Type: string - **prefix_adv_type_to_lan:** Type: string - **prefixes_to_adv_to_wan:** [Type: string] - **router_id:** Type: string - **stalepath_time:** Type: integer **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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/{}/bgpconfigs/{}".format(api_version, tenant_id, site_id, element_id, bgpconfig_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "put", data=data) def bgppeers(self, site_id, element_id, bgppeer_id, data, tenant_id=None, api_version="v2.4"): """ Update BGP Peer config (v2.4) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **bgppeer_id**: BGP Peer ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.4) **Payload Attributes:** - **allow_v4_prefixes:** Type: boolean - **allow_v6_prefixes:** Type: boolean - **bgp_config:** - **adv_interval:** Type: integer - **hold_time:** Type: integer - **keepalive_time:** Type: integer - **local_as_num:** Type: string - **md5_secret:** Type: string - **multi_hop_limit:** Type: integer - **peer_auth_type:** Type: string - **peer_retry_time:** Type: integer - **description:** Type: string - **name:** Type: string - **peer_ip:** Type: string - **peer_ip_v6:** Type: string - **peer_type:** Type: string - **remote_as_num:** Type: string - **route_map_in_id:** Type: string - **route_map_out_id:** Type: string - **router_id:** Type: string - **scope:** Type: string - **shutdown:** Type: boolean - **tags:** [Type: string] - **update_source:** Type: string - **update_source_v6:** Type: string - **vrf_context_id:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def bulkconfigurations_sitetemplates(self, sitetemplate_id, data, tenant_id=None, api_version="v2.0"): """ PUT Bulkconfigurations_Sitetemplates API Function **Parameters:**: - **sitetemplate_id**: Site Template ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def cellular_modules_sim_security(self, element_id, cellular_module_id, sim_security_id, data, tenant_id=None, api_version="v2.0"): """ Update cellular module (v2.0) **Parameters:**: - **element_id**: Element (Device) ID - **cellular_module_id**: Cellular Module ID - **sim_security_id**: SIM Security ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **description:** Type: string - **name:** Type: string - **pin:** Type: string - **remove_pin:** Type: boolean - **slot_number:** Type: integer - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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/{}/cellular_modules/{}/sim_security/{}".format(api_version, tenant_id, element_id, cellular_module_id, sim_security_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "put", data=data) def demsiteconfigs(self, site_id, demsiteconfig_id, data, tenant_id=None, api_version="v2.0"): """ PUT Demsiteconfigs API Function **Parameters:**: - **site_id**: Site ID - **demsiteconfig_id**: - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def deviceidconfigs(self, site_id, deviceidconfig_id, data, tenant_id=None, api_version="v2.1"): """ PUT Deviceidconfigs API Function **Parameters:**: - **site_id**: Site ID - **deviceidconfig_id**: Device Id Config ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Payload Attributes:** **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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/{}".format(api_version, tenant_id, site_id, deviceidconfig_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "put", data=data) def deviceidconfigs_snmpdiscoverystartnodes(self, site_id, deviceidconfig_id, snmpdiscoverystartnode_id, data, tenant_id=None, api_version="v2.0"): """ PUT Deviceidconfigs_Snmpdiscoverystartnodes API Function **Parameters:**: - **site_id**: Site ID - **deviceidconfig_id**: Device Id Config ID - **snmpdiscoverystartnode_id**: SNMP Discovery Start Node ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def deviceidprofiles(self, deviceidprofile_id, data, tenant_id=None, api_version="v2.0"): """ PUT Deviceidprofiles API Function **Parameters:**: - **deviceidprofile_id**: Device Id Profile ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def dhcpservers(self, site_id, dhcpserver_id, data, tenant_id=None, api_version="v2.3"): """ Update an existing dhcp server configuration for a subnet (v2.3) **Parameters:**: - **site_id**: Site ID - **dhcpserver_id**: DHCP Server ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.3) **Payload Attributes:** - **address_family:** Type: string - **broadcast_address:** Type: string - **custom_options:** - **option_definition:** Type: string - **option_value:** Type: string - **vendor_class_identifier:** Type: string - **default_lease_time:** Type: integer - **description:** Type: string - **disabled:** Type: boolean - **dns_servers:** [Type: string] - **domain_name:** Type: string - **gateway:** Type: string - **ip_ranges:** - **end_ip:** Type: string - **start_ip:** Type: string - **max_lease_time:** Type: integer - **network_context_id:** Type: string - **static_mappings:** - **client_duid:** Type: string - **ip_address:** Type: string - **mac:** Type: string - **name:** Type: string - **subnet:** Type: string - **tags:** [Type: string] - **vrf_context_id:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def directoryservices(self, directoryservice_id, data, tenant_id=None, api_version="v2.0"): """ PUT Directoryservices API Function **Parameters:**: - **directoryservice_id**: Directory Service ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def dnsserviceprofiles(self, dnsserviceprofile_id, data, tenant_id=None, api_version="v2.1"): """ Update a DNS service profile (v2.1) **Parameters:**: - **dnsserviceprofile_id**: DNS Service Profile ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Payload Attributes:** - **authoritative_config:** - **caa_records:** - **flags:** Type: string - **name:** Type: string - **tag:** Type: string - **value:** Type: string - **cname_records:** - **name:** [Type: string] - **target:** Type: string - **ttl:** Type: integer - **dns_resource_records:** - **hex_data:** Type: string - **name:** Type: string - **rr_number:** Type: integer - **host_records:** - **domain_names:** [Type: string] - **ipv4_address:** Type: string - **ipv6_address:** Type: string - **ttl:** Type: integer - **mx_host_records:** - **hostname:** Type: string - **mx_name:** Type: string - **preference:** Type: integer - **naptr_records:** - **flags:** Type: string - **name:** Type: string - **order:** Type: integer - **preference:** Type: integer - **regexp:** Type: string - **replacement:** Type: string - **service:** Type: string - **peers:** [Type: string] - **ptr_records:** - **name:** Type: string - **target:** Type: string - **secondary_servers:** [Type: string] - **servers:** - **dnsservicerole_id:** Type: string - **domain_name:** Type: string - **soa:** - **expiry:** Type: integer - **host_master:** Type: string - **refresh:** Type: integer - **retry:** Type: integer - **serial_number:** Type: integer - **srv_hosts:** - **domain_name:** Type: string - **port:** Type: integer - **priority:** Type: integer - **protocol:** Type: string - **service:** Type: string - **target:** Type: integer - **weight:** Type: integer - **synth_domains:** - **domain:** Type: string - **end_ipaddress:** Type: string - **ipaddress_prefix:** Type: string - **prefix:** Type: string - **start_ipaddress:** Type: string - **ttl:** Type: integer - **txt_records:** - **domain_name:** Type: string - **texts:** [Type: string] - **zones:** - **domain_name:** Type: string - **exclude_prefix:** [Type: string] - **include_prefix:** [Type: string] - **cache_config:** - **cache_size:** Type: integer - **disable_negative_caching:** Type: boolean - **max_cache_ttl:** Type: integer - **min_cache_ttl:** Type: integer - **negative_cache_ttl:** Type: integer - **description:** Type: string - **dns_forward_config:** - **dns_servers:** - **address_family:** Type: string - **dnsserver_ip:** Type: string - **dnsserver_port:** Type: integer - **domain_names:** [Type: string] - **forward_dnsservicerole_id:** Type: string - **ip_prefix:** Type: string - **source_port:** Type: integer - **max_source_port:** Type: integer - **min_source_port:** Type: integer - **send_to_all_dns_servers:** Type: boolean - **dns_queries_metadata:** - **add_client_mac:** - **mac_encoding_format:** Type: string - **add_customer_premises_equipment:** - **identifier_text:** Type: string - **type:** Type: string - **add_subnets:** - **ipv4_address:** Type: string - **ipv4_prefix_length:** Type: integer - **ipv6_address:** Type: string - **ipv6_prefix_length:** Type: integer - **dns_rebind_config:** - **enable_localhost_rebind:** Type: boolean - **rebind_domains:** [Type: string] - **stop_dns_rebind_privateip:** Type: boolean - **dns_response_overrides:** - **aliases:** - **mask:** Type: integer - **original_end_ip:** Type: string - **original_ip:** Type: string - **original_start_ip:** Type: string - **replace_ip:** Type: string - **bogus_nx_domains:** [Type: string] - **disable_private_ip_lookups:** Type: boolean - **ignore_ip_addresses:** [Type: string] - **local_ttl:** Type: integer - **max_ttl:** Type: integer - **dnssec_config:** - **disable_dnssec_timecheck:** Type: boolean - **dns_check_unsigned:** Type: boolean - **enabled:** Type: boolean - **trust_anchors:** - **class:** Type: string - **domain:** Type: string - **key_digest:** - **algorithm:** Type: integer - **digest:** Type: string - **digest_type:** Type: integer - **key_tag:** Type: integer - **domains_to_addresses:** - **domain_names:** [Type: string] - **ipv4_address:** Type: string - **ipv6_address:** Type: string - **edns_packet_max:** Type: integer - **enable_dns_loop_detection:** Type: boolean - **enable_dnssec_proxy:** Type: boolean - **enable_strict_domain_name:** Type: boolean - **listen_dnsservicerole_id:** Type: string - **listen_port:** Type: integer - **name:** Type: string - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def dnsserviceroles(self, dnsservicerole_id, data, tenant_id=None, api_version="v2.0"): """ Update a DNS service role (v2.0) **Parameters:**: - **dnsservicerole_id**: DNS Service Role ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **description:** Type: string - **name:** Type: string - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def dnsservices(self, site_id, element_id, dnsservice_id, data, tenant_id=None, api_version="v2.0"): """ Update a DNS service config (v2.0) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **dnsservice_id**: DNS Service ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **cache_config:** - **cache_size:** Type: integer - **description:** Type: string - **disabled:** Type: boolean - **disabled_reason:** Type: string - **dns_queries_metadata:** - **add_customer_premises_equipment:** - **identifier_text:** Type: string - **type:** Type: string - **add_subnets:** - **ipv4_address:** Type: string - **ipv4_prefix_length:** Type: integer - **ipv6_address:** Type: string - **ipv6_prefix_length:** Type: integer - **dnsservice_profile_id:** Type: string - **dnsservicerole_bindings:** - **dnsservicerole_id:** Type: string - **interfaces:** - **interface_id:** Type: string - **interface_ip:** Type: string - **domains_to_addresses:** - **domain_names:** [Type: string] - **ipv4_address:** Type: string - **ipv6_address:** Type: string - **domains_to_interfaces:** - **domain_names:** [Type: string] - **interface_id:** Type: string - **element_id:** Type: string - **enabled:** Type: boolean - **inactive:** Type: boolean - **inactive_reason:** Type: string - **max_concurrent_dns_queries:** Type: integer - **name:** Type: string - **region:** Type: string - **site_id:** Type: string - **tags:** [Type: string] - **tenant_id:** Type: string - **upperCaseName:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def element_admin_state(self, site_id, element_id, data, tenant_id=None, api_version="v2.0"): """ Update admin state Northbound (v2.0) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **admin_action:** Type: string - **allowed_roles:** [Type: string] - **cluster_insertion_mode:** Type: string - **cluster_member_id:** Type: string - **connected:** Type: boolean - **deployment_op:** Type: string - **description:** Type: string - **hw_id:** Type: string - **model_name:** Type: string - **name:** Type: string - **role:** Type: string - **serial_number:** Type: string - **site_id:** Type: string - **software_version:** Type: string - **state:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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/{}/admin_state".format(api_version, tenant_id, site_id, element_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "put", data=data) def element_cellular_modules(self, element_id, cellular_module_id, data, tenant_id=None, api_version="v2.0"): """ Update cellular module (v2.0) **Parameters:**: - **element_id**: Element (Device) ID - **cellular_module_id**: Cellular Module ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **description:** Type: string - **gps_enable:** Type: boolean - **name:** Type: string - **primary_sim:** Type: integer - **radio_on:** Type: boolean - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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/{}/cellular_modules/{}".format(api_version, tenant_id, element_id, cellular_module_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "put", data=data) def element_cellular_modules_firmware(self, element_id, cellular_module_id, data, tenant_id=None, api_version="v2.0"): """ Update cellular module firmware configuration (v2.0) **Parameters:**: - **element_id**: Element (Device) ID - **cellular_module_id**: Cellular Module ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **cellular_module_image_ids:** [Type: string] - **download_interval:** Type: integer - **interface_ids:** [Type: string] - **scheduled_download:** Type: string - **scheduled_upgrade:** Type: string - **upgrade_interval:** Type: integer **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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/{}/cellular_modules/{}/firmware".format(api_version, tenant_id, element_id, cellular_module_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "put", data=data) def element_deviceidconfigs(self, site_id, element_id, deviceidconfig_id, data, tenant_id=None, api_version="v2.0"): """ PUT Element_Deviceidconfigs API Function **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **deviceidconfig_id**: Device Id Config ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def element_extensions(self, site_id, element_id, extension_id, data, tenant_id=None, api_version="v2.0"): """ Update element level extension configuration (v2.0) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **extension_id**: Extension ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **conf:** Type: object - **disabled:** Type: boolean - **entity_id:** Type: string - **name:** Type: string - **namespace:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def element_state(self, element_id, data, tenant_id=None, api_version="v2.0"): """ Update element state (v2.0) **Parameters:**: - **element_id**: Element (Device) ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **image_id:** Type: string - **scheduled_upgrade:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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/{}/state".format(api_version, tenant_id, element_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "put", data=data) def elementaccessconfigs(self, element_id, elementaccessconfig_id, data, tenant_id=None, api_version="v2.2"): """ Update an Access Config on particular element. (v2.2) **Parameters:**: - **element_id**: Element (Device) ID - **elementaccessconfig_id**: Element Access Config ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.2) **Payload Attributes:** - **account_disable_interval:** Type: integer - **inactive_interval:** Type: integer - **otpkey_version:** Type: integer - **retry_login_count:** Type: integer - **ssh_enabled:** Type: boolean - **ssh_outbound_enabled:** Type: boolean **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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/{}/elementaccessconfigs/{}".format(api_version, tenant_id, element_id, elementaccessconfig_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "put", data=data) def elements(self, element_id, data, tenant_id=None, api_version="v3.1"): """ Used for associations and element updates (v3.1) **Parameters:**: - **element_id**: Element (Device) ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v3.1) **Payload Attributes:** - **cluster_id:** Type: string - **description:** Type: string - **device_profile_id:** Type: string - **l3_direct_private_wan_forwarding:** Type: boolean - **l3_lan_forwarding:** Type: boolean - **led_config:** - **service_led_on:** Type: boolean - **main_power_usage_threshold:** Type: integer - **name:** Type: string - **nat_policysetstack_id:** Type: string - **network_policysetstack_id:** Type: string - **priority_policysetstack_id:** Type: string - **site_id:** Type: string - **spoke_ha_config:** - **cluster_id:** Type: string - **enable:** Type: boolean - **priority:** Type: integer - **source_interface:** Type: string - **track:** - **interfaces:** - **interface_id:** Type: string - **reduce_priority:** Type: integer - **waninterfaces:** - **reduce_priority:** Type: integer - **wan_interface_id:** Type: string - **sw_obj:** - **location:** Type: string - **version:** Type: string - **switch_config:** - **default_vlan_id:** Type: integer - **mstp_enabled:** Type: boolean - **stp_aging_timer:** Type: integer - **stp_forward_delay:** Type: integer - **stp_hello_time:** Type: integer - **stp_max_age:** Type: integer - **stp_mode:** Type: string - **stp_priority:** Type: integer - **tags:** [Type: string] - **tenant_id:** Type: string - **vpn_to_vpn_forwarding:** Type: boolean **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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/{}".format(api_version, tenant_id, element_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "put", data=data) def elementsecurityzones(self, site_id, element_id, securityzone_id, data, tenant_id=None, api_version="v2.0"): """ Update an existing element security zone (v2.0) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **securityzone_id**: Security Zone (ZBFW) ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **interface_ids:** [Type: string] - **lannetwork_ids:** [Type: string] - **site_id:** Type: string - **tenant_id:** Type: string - **waninterface_ids:** [Type: string] - **wanoverlay_ids:** [Type: string] - **zone_id:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def elementshells(self, site_id, elementshell_id, data, tenant_id=None, api_version="v2.0"): """ PUT Elementshells API Function **Parameters:**: - **site_id**: Site ID - **elementshell_id**: Element Shell ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def elementshells_interfaces(self, site_id, elementshell_id, interface_id, data, tenant_id=None, api_version="v2.0"): """ PUT Elementshells_Interfaces API Function **Parameters:**: - **site_id**: Site ID - **elementshell_id**: Element Shell ID - **interface_id**: Interface ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def elementusers(self, elementuser_id, data, tenant_id=None, api_version="v2.1"): """ Update an existing element user. (v2.1) **Parameters:**: - **elementuser_id**: Element User ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Payload Attributes:** - **is_tenant_level:** Type: boolean - **login_id:** Type: string - **password:** Type: string - **role:** Type: string - **tenant_id:** Type: string - **username:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def elementusers_access(self, elementuser_id, access_id, data, tenant_id=None, api_version="v2.1"): """ Update an existing element user access. (v2.1) **Parameters:**: - **elementuser_id**: Element User ID - **access_id**: Access ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Payload Attributes:** - **element_id:** Type: string - **role:** Type: string - **tenant_id:** Type: string - **user_id:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def enterpriseprefixset(self, data, tenant_id=None, api_version="v2.1"): """ PUT Enterpriseprefixset API Function **Parameters:**: - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Payload Attributes:** **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_id. raise TypeError("tenant_id is required but not set or cached.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/enterpriseprefixset".format(api_version, tenant_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "put", data=data) def esp_operator_permissions_client(self, operator_id, client_id, data, tenant_id=None, api_version="v2.1"): """ Create or update esp operator permissions assigned under a client (v2.1) **Parameters:**: - **operator_id**: Operator ID - **client_id**: ESP/MSP Client ID (typically their tenant_id) - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Payload Attributes:** - **client_id:** Type: string - **custom_roles:** - **custom_permissions:** - **allowed_after_ms:** Type: integer - **allowed_before_ms:** Type: integer - **disabled:** Type: boolean - **disabled_reason:** Type: string - **disallow_permission:** Type: boolean - **id:** Type: string - **inactive:** Type: boolean - **inactive_reason:** Type: string - **region:** Type: string - **tenant_id:** Type: string - **value:** Type: string - **disabled:** Type: boolean - **disallow_permissions:** - **value:** Type: string - **id:** Type: string - **inactive:** Type: boolean - **name:** Type: string - **permissions:** - **value:** Type: string - **roles:** - **name:** Type: string - **disabled:** Type: boolean - **disabled_reason:** Type: string - **email:** Type: string - **enable_session_ip_lock:** Type: boolean - **inactive:** Type: boolean - **inactive_reason:** Type: string - **ipv4_list:** - **ipv4:** Type: string - **name:** Type: string - **operator_id:** Type: string - **region:** Type: string - **roles:** - **name:** Type: string - **settings:** Type: string - **tenant_id:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def eventcorrelationpolicyrules(self, eventcorrelationpolicyset_id, eventcorrelationpolicyrule_id, data, tenant_id=None, api_version="v2.1"): """ Update event correlation policyrule configuration (v2.1) **Parameters:**: - **eventcorrelationpolicyset_id**: Event Correlation Policy Set ID - **eventcorrelationpolicyrule_id**: Event Correlation Policy Rule ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Payload Attributes:** - **dampening_duration:** Type: integer - **description:** Type: string - **enabled:** Type: boolean - **end_time:** Type: integer - **escalation_rules:** - **flap_rule:** - **flap_duration:** Type: integer - **flap_rate:** Type: integer - **standing_rule:** - **priority:** Type: string - **standing_for:** Type: integer - **event_codes:** [Type: string] - **name:** Type: string - **priority:** Type: string - **resource_ids:** [Type: string] - **resource_type:** Type: string - **start_time:** Type: integer - **sub_resource_type:** Type: string - **suppress:** Type: string - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def eventcorrelationpolicysets(self, eventcorrelationpolicyset_id, data, tenant_id=None, api_version="v2.0"): """ Update event correlation policyset configuration (v2.0) **Parameters:**: - **eventcorrelationpolicyset_id**: Event Correlation Policy Set ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **active_policyset:** Type: boolean - **clone_from:** Type: string - **description:** Type: string - **name:** Type: string - **policyrule_order:** [Type: string] - **severity_priority_mapping:** - **priority:** Type: string - **severity:** Type: string - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def events(self, event_id, data, tenant_id=None, api_version="v2.3"): """ PUT Events API Function **Parameters:**: - **event_id**: Event ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.3) **Payload Attributes:** **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_id. raise TypeError("tenant_id is required but not set or cached.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/events/{}".format(api_version, tenant_id, event_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "put", data=data) def externalcaconfigs(self, externalcaconfig_id, data, tenant_id=None, api_version="v2.0"): """ PUT Externalcaconfigs API Function **Parameters:**: - **externalcaconfig_id**: External CA Config ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def globalprefixfilters(self, globalprefixfilter_id, data, tenant_id=None, api_version="v2.0"): """ Update a new global prefix filter. (v2.0) **Parameters:**: - **globalprefixfilter_id**: Global Prefix Filter ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **description:** Type: string - **filters:** - **type:** Type: string - **name:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def hubclustermembers(self, site_id, hubcluster_id, hubclustermember_id, data, tenant_id=None, api_version="v3.0"): """ Update specific hub cluster member. (v3.0) **Parameters:**: - **site_id**: Site ID - **hubcluster_id**: Hub (DC) Cluster ID - **hubclustermember_id**: Hub Cluster Member ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v3.0) **Payload Attributes:** - **headend1_site_ids:** [Type: string] - **headend2_site_ids:** [Type: string] - **hub_element_id:** Type: string - **load_factors:** - **alarm_threshold:** Type: integer - **allocated:** Type: integer - **subscription_factor:** Type: number - **threshold:** - **critical_alarm:** Type: integer - **major_alarm:** Type: integer - **subscription_factor:** Type: number - **type:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def hubclusters(self, site_id, hubcluster_id, data, tenant_id=None, api_version="v4.0"): """ Update hub cluster (v4.0) **Parameters:**: - **site_id**: Site ID - **hubcluster_id**: Hub (DC) Cluster ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v4.0) **Payload Attributes:** - **default_cluster:** Type: boolean - **description:** Type: string - **elements:** - **hubClusterElementNumber:** Type: string - **hub_element_id:** Type: string - **locked:** Type: boolean - **name:** Type: string - **peer_sites:** [Type: string] - **site_count_alarm_threshold:** Type: integer - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def idps(self, idp_id, data, tenant_id=None, api_version="v3.3"): """ Update sso (v3.3) **Parameters:**: - **idp_id**: SAML IDentity provider configuration ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v3.3) **Payload Attributes:** - **auto_provision_operators:** Type: boolean - **auto_provision_roles:** Type: boolean - **disabled:** Type: boolean - **disabled_reason:** Type: string - **idp_domain_admin_email:** Type: string - **idp_domains:** [Type: string] - **idp_entity_id:** Type: string - **idp_login_url:** Type: string - **idp_logout_url:** Type: string - **idp_metadata_b64:** Type: string - **inactive:** Type: boolean - **inactive_reason:** Type: string - **is_hob:** Type: boolean - **match_email_domain:** Type: boolean - **role_map:** Type: object - **session_timeout_s:** Type: integer - **sign_redirect_binding:** Type: boolean - **sp_metadata_b64:** Type: string - **sp_x509_b64:** Type: string - **sp_x509_serial_no:** Type: string - **tenant_id:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def interfaces(self, site_id, element_id, interface_id, data, tenant_id=None, api_version="v4.17"): """ Update an Interface (v4.17) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **interface_id**: Interface ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v4.17) **Payload Attributes:** - **admin_up:** Type: boolean - **attached_lan_networks:** - **lan_network_id:** Type: string - **vlan_id:** Type: integer - **authentication_config:** - **fallback_retry_count:** Type: integer - **mode:** Type: string - **reauthentication_timeout:** Type: integer - **bound_interfaces:** [Type: string] - **bypass_pair:** - **lan:** Type: string - **lan_state_propagation:** Type: boolean - **use_relay:** Type: boolean - **wan:** Type: string - **cellular_config:** - **apn_config:** - **apn:** Type: string - **authentication:** Type: string - **clear_password:** Type: boolean - **password:** Type: string - **password_encrypted:** Type: string - **user_name:** Type: string - **apnprofile_id:** Type: string - **auto_apn:** Type: boolean - **parent_module_id:** Type: string - **parent_sim_slot_number:** Type: integer - **description:** Type: string - **devicemgmt_policysetstack_id:** Type: string - **dhcp_relay:** - **enabled:** Type: boolean - **option_82:** - **circuit_id:** Type: string - **enabled:** Type: boolean - **reforwarding_policy:** Type: string - **remote_id:** Type: string - **server_ips:** [Type: string] - **source_interface:** Type: string - **directed_broadcast:** Type: boolean - **ethernet_port:** - **full_duplex:** Type: boolean - **port_id:** - **connector:** Type: string - **device:** Type: string - **disabled:** Type: boolean - **disabled_reason:** Type: string - **element_id:** Type: string - **id:** Type: string - **inactive:** Type: boolean - **inactive_reason:** Type: string - **max_mtu:** Type: integer - **max_speed:** Type: integer - **name:** Type: string - **original_mac_address:** Type: string - **region:** Type: string - **site_id:** Type: string - **tenant_id:** Type: string - **port_name:** Type: string - **speed:** Type: integer - **interface_profile_id:** Type: string - **ipfixcollectorcontext_id:** Type: string - **ipfixfiltercontext_id:** Type: string - **ipv4_config:** - **dhcp_config:** - **client_id:** Type: string - **hostname:** Type: string - **dns_v4_config:** - **name_servers:** [Type: string] - **search:** [Type: string] - **pppoe_config:** - **chap_passwd:** Type: string - **chap_user:** Type: string - **set_route:** Type: boolean - **routes:** - **destination:** Type: string - **via:** Type: string - **static_config:** - **address:** Type: string - **type:** Type: string - **ipv6_config:** - **dhcp_config:** - **client_id:** Type: string - **hostname:** Type: string - **dns_v6_config:** - **name_servers:** [Type: string] - **search:** [Type: string] - **routes:** - **destination:** Type: string - **via:** Type: string - **static_config:** - **address:** Type: string - **enable_prefix_distribution:** Type: boolean - **type:** Type: string - **lldp_enabled:** Type: boolean - **mac_address:** Type: string - **mtu:** Type: integer - **multicast_config:** - **igmp_version:** Type: string - **multicast_enabled:** Type: boolean - **name:** Type: string - **nat_address:** Type: string - **nat_address_v6:** Type: string - **nat_pools:** - **ipv4_ranges:** - **end:** Type: string - **start:** Type: string - **nat_pool_id:** Type: string - **nat_port:** Type: integer - **nat_port_v6:** Type: integer - **nat_zone_id:** Type: string - **network_context_id:** Type: string - **parent:** Type: string - **peer_bypasspair_wan_port_type:** Type: string - **poe_enabled:** Type: boolean - **power_usage_threshold:** Type: integer - **pppoe_config:** - **host_uniq:** Type: string - **ip_address_type:** Type: string - **password:** Type: string - **reconnection_delay:** Type: integer - **service_name:** Type: string - **username:** Type: string - **scope:** Type: string - **secondary_ip_configs:** - **ipv4_address:** Type: string - **scope:** Type: string - **service_link_config:** - **gre_config:** - **csum:** Type: boolean - **keepalive_enable:** Type: boolean - **keepalive_fail_count:** Type: integer - **keepalive_interval:** Type: integer - **ipsec_config:** - **authentication:** - **certificate:** Type: string - **certificate_profile_id:** Type: string - **comment:** Type: string - **ikev1_params:** - **xauth_id:** Type: string - **xauth_secret:** Type: string - **xauth_secret_encrypted:** Type: string - **xauth_secret_hash:** Type: string - **xauth_type:** Type: string - **local_ca_certificate:** Type: string - **local_id:** Type: string - **local_id_custom:** Type: string - **local_pa_certificate_id:** Type: string - **pa_master_key_id:** Type: string - **passphrase:** Type: string - **passphrase_encrypted:** Type: string - **peer_id_check:** Type: string - **permit_peer_id_mismatch:** Type: boolean - **private_key:** Type: string - **private_key_encrypted:** Type: string - **remote_ca_certificate:** Type: string - **remote_id:** Type: string - **secret:** Type: string - **secret_encrypted:** Type: string - **secret_hash:** Type: string - **strict_validation_peer_extended_key_use:** Type: boolean - **type:** Type: string - **x509Objects:** - **certHolder:** Type: object - **certificate:** Type: string - **is_local_ca_cert_set:** Type: boolean - **is_remote_ca_cert_set:** Type: boolean - **keyPair:** Type: object - **local_ca_certificate:** Type: string - **local_ca_certs_set:** [Type: object] - **passphrase:** Type: string - **private_key:** Type: string - **remote_ca_certificate:** Type: string - **remote_ca_certs_set:** [Type: object] - **ipsec_profile_id:** Type: string - **last_parent:** Type: string - **parent:** Type: string - **peer:** - **hostname:** Type: string - **ip_addresses:** [Type: string] - **service_endpoint_id:** Type: string - **type:** Type: string - **site_wan_interface_ids:** [Type: string] - **static_arp_configs:** - **ipv4_address:** Type: string - **mac_address:** Type: string - **sub_interface:** - **vlan_id:** Type: integer - **switch_port_config:** - **access_vlan_id:** Type: integer - **bpdu_guard_enabled:** Type: boolean - **forward_fast_enabled:** Type: boolean - **native_vlan_id:** Type: integer - **root_guard_enabled:** Type: boolean - **storm_control_config:** - **broadcast_threshold:** Type: integer - **multicast_threshold:** Type: integer - **unicast_threshold:** Type: integer - **stp_port_cost:** Type: integer - **stp_port_enabled:** Type: boolean - **stp_port_priority:** Type: integer - **trunk_vlans:** [Type: string] - **vlan_mode:** Type: string - **voice_vlan_id:** Type: integer - **tags:** [Type: string] - **type:** Type: string - **used_for:** Type: string - **vlan_config:** - **element_vlan_unique_id:** Type: string - **mstp_instance:** Type: integer - **vlan_id:** Type: integer - **voice_enabled:** Type: boolean - **vrf_context_id:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def ipfix(self, site_id, element_id, ipfix_id, data, tenant_id=None, api_version="v2.0"): """ Update a IPFix Config (v2.0) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **ipfix_id**: IPFix ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **collector_config:** - **host:** Type: string - **host_port:** Type: integer - **ipfixcollectorcontext_id:** Type: string - **max_message_size:** Type: integer - **protocol:** Type: string - **description:** Type: string - **export_cache_timeout:** Type: integer - **filters:** - **app_def_ids:** [Type: string] - **dst_ports:** - **end:** Type: string - **start:** Type: string - **dst_prefixes_id:** Type: string - **ipfixfiltercontext_ids:** [Type: string] - **priority_traffic_types:** [Type: string] - **protocols:** [Type: string] - **rtp_transport_type:** Type: string - **src_ports:** - **end:** Type: string - **start:** Type: string - **src_prefixes_id:** Type: string - **wan_path_direction:** Type: string - **ipfixprofile_id:** Type: string - **ipfixtemplate_id:** Type: string - **name:** Type: string - **sampler:** - **algorithm:** Type: string - **time_interval:** Type: integer - **time_spacing:** Type: integer - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def ipfixcollectorcontexts(self, ipfixcollectorcontext_id, data, tenant_id=None, api_version="v2.0"): """ Update a IPFix Collector context (v2.0) **Parameters:**: - **ipfixcollectorcontext_id**: IPFix Collector Context ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **description:** Type: string - **name:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def ipfixfiltercontexts(self, ipfixfiltercontext_id, data, tenant_id=None, api_version="v2.0"): """ Update a IPFix Filter context (v2.0) **Parameters:**: - **ipfixfiltercontext_id**: IPFix Filter Context ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **description:** Type: string - **name:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def ipfixglobalprefixes(self, ipfixglobalprefix_id, data, tenant_id=None, api_version="v2.0"): """ Update a IPFix Global prefix (v2.0) **Parameters:**: - **ipfixglobalprefix_id**: IPFix Global Prefix ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **description:** Type: string - **ipv4_prefixes:** [Type: string] - **name:** Type: string - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def ipfixprofiles(self, ipfixprofile_id, data, tenant_id=None, api_version="v2.0"): """ Update a IPFix Profile (v2.0) **Parameters:**: - **ipfixprofile_id**: IPFix Profile ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **collector_config:** - **host:** Type: string - **host_port:** Type: integer - **ipfixcollectorcontext_id:** Type: string - **max_message_size:** Type: integer - **protocol:** Type: string - **description:** Type: string - **export_cache_timeout:** Type: integer - **filters:** - **app_def_ids:** [Type: string] - **dst_ports:** - **end:** Type: string - **start:** Type: string - **dst_prefixes_id:** Type: string - **ipfixfiltercontext_ids:** [Type: string] - **priority_traffic_types:** [Type: string] - **protocols:** [Type: string] - **rtp_transport_type:** Type: string - **src_ports:** - **end:** Type: string - **start:** Type: string - **src_prefixes_id:** Type: string - **wan_path_direction:** Type: string - **ipfixtemplate_id:** Type: string - **name:** Type: string - **sampler:** - **algorithm:** Type: string - **time_interval:** Type: integer - **time_spacing:** Type: integer - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def ipfixtemplates(self, ipfixtemplate_id, data, tenant_id=None, api_version="v2.0"): """ Update a IPFix template (v2.0) **Parameters:**: - **ipfixtemplate_id**: IPFix Template ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **description:** Type: string - **flow_fields:** [Type: string] - **generate_biflow:** Type: boolean - **name:** Type: string - **option_export_timeout:** Type: integer - **options:** [Type: string] - **tags:** [Type: string] - **template_export_timeout:** Type: integer **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def ipsecprofiles(self, ipsecprofile_id, data, tenant_id=None, api_version="v2.1"): """ Update a IPSECProfile (v2.1) **Parameters:**: - **ipsecprofile_id**: IPSEC Profile ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Payload Attributes:** - **authentication:** - **certificate:** Type: string - **certificate_profile_id:** Type: string - **comment:** Type: string - **ikev1_params:** - **xauth_id:** Type: string - **xauth_secret:** Type: string - **xauth_secret_encrypted:** Type: string - **xauth_secret_hash:** Type: string - **xauth_type:** Type: string - **local_ca_certificate:** Type: string - **local_id:** Type: string - **local_id_custom:** Type: string - **local_pa_certificate_id:** Type: string - **pa_master_key_id:** Type: string - **passphrase:** Type: string - **passphrase_encrypted:** Type: string - **peer_id_check:** Type: string - **permit_peer_id_mismatch:** Type: boolean - **private_key:** Type: string - **private_key_encrypted:** Type: string - **remote_ca_certificate:** Type: string - **remote_id:** Type: string - **secret:** Type: string - **secret_encrypted:** Type: string - **secret_hash:** Type: string - **strict_validation_peer_extended_key_use:** Type: boolean - **type:** Type: string - **x509Objects:** - **certHolder:** Type: object - **certificate:** Type: string - **is_local_ca_cert_set:** Type: boolean - **is_remote_ca_cert_set:** Type: boolean - **keyPair:** Type: object - **local_ca_certificate:** Type: string - **local_ca_certs_set:** [Type: object] - **passphrase:** Type: string - **private_key:** Type: string - **remote_ca_certificate:** Type: string - **remote_ca_certs_set:** [Type: object] - **description:** Type: string - **dpd_delay:** Type: integer - **dpd_enable:** Type: boolean - **dpd_timeout:** Type: integer - **esp_group:** - **force_encapsulation:** Type: boolean - **lifesize:** - **units:** Type: string - **value:** Type: integer - **lifetime:** Type: integer - **lifetime_units:** Type: string - **mode:** Type: string - **proposals:** - **dh_groups:** Type: string - **encryption:** Type: string - **hash:** Type: string - **responder_sase_proposals:** - **dh_group:** [Type: string] - **encryption:** [Type: string] - **hash:** [Type: string] - **ike_group:** - **aggressive:** Type: boolean - **authentication_multiple:** Type: integer - **key_exchange:** Type: string - **lifetime:** Type: integer - **lifetime_units:** Type: string - **port:** Type: integer - **proposals:** - **dh_groups:** Type: string - **encryption:** Type: string - **hash:** Type: string - **reauth:** Type: boolean - **name:** Type: string - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def lannetworks(self, site_id, lannetwork_id, data, tenant_id=None, api_version="v3.3"): """ Update an existing LAN (v3.3) **Parameters:**: - **site_id**: Site ID - **lannetwork_id**: LAN Network ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v3.3) **Payload Attributes:** - **description:** Type: string - **ipv4_config:** - **default_routers:** [Type: string] - **dhcp_relay:** - **enabled:** Type: boolean - **option_82:** - **circuit_id:** Type: string - **enabled:** Type: boolean - **reforwarding_policy:** Type: string - **remote_id:** Type: string - **server_ips:** [Type: string] - **source_interface:** Type: string - **dhcp_server:** - **broadcast_address:** Type: string - **custom_options:** - **option_definition:** Type: string - **option_value:** Type: string - **default_lease_time:** Type: integer - **description:** Type: string - **disabled:** Type: boolean - **dns_servers:** [Type: string] - **domain_name:** Type: string - **gateway:** Type: string - **id:** Type: string - **ip_ranges:** - **end_ip:** Type: string - **start_ip:** Type: string - **max_lease_time:** Type: integer - **network_context_id:** Type: string - **static_mappings:** - **ip_address:** Type: string - **mac:** Type: string - **name:** Type: string - **subnet:** Type: string - **tags:** [Type: string] - **prefixes:** [Type: string] - **ipv6_config:** - **default_routers:** [Type: string] - **prefixes:** [Type: string] - **name:** Type: string - **network_context_id:** Type: string - **scope:** Type: string - **tags:** [Type: string] - **vrf_context_id:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def localprefixfilters(self, localprefixfilter_id, data, tenant_id=None, api_version="v2.0"): """ Update a new local prefix filter. (v2.0) **Parameters:**: - **localprefixfilter_id**: Local Prefix Filter ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **description:** Type: string - **name:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def machine_cellular_modules_firmware(self, machine_id, cellular_module_id, data, tenant_id=None, api_version="v2.0"): """ Update cellular module firmware configuration (v2.0) **Parameters:**: - **machine_id**: Machine ID - **cellular_module_id**: Cellular Module ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **cellular_module_image_ids:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_id. raise TypeError("tenant_id is required but not set or cached.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/machines/{}/cellular_modules/{}/firmware".format(api_version, tenant_id, machine_id, cellular_module_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "put", data=data) def mstp_instances(self, site_id, element_id, mstp_instance_id, data, tenant_id=None, api_version="v2.0"): """ Update a MSTP Instance (v2.0) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **mstp_instance_id**: MSTP Instance ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **description:** Type: string - **instance_number:** Type: integer - **instance_priority:** Type: integer - **name:** Type: string - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def multicastglobalconfigs(self, site_id, element_id, multicastglobalconfig_id, data, tenant_id=None, api_version="v2.1"): """ Update Multicast config (v2.1) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **multicastglobalconfig_id**: Multicast Global Config ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Payload Attributes:** - **bsm_enabled:** Type: boolean - **dr_priority:** Type: integer - **igmp_protocol_parameters:** - **last_member_query_count:** Type: integer - **last_member_query_interval:** Type: integer - **query_interval:** Type: integer - **query_max_response_time:** Type: integer - **pim_protocol_parameters:** - **hello_hold_time:** Type: integer - **hello_interval:** Type: integer - **join_prune_interval:** Type: integer - **spt_switchover_enabled:** Type: boolean **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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/{}/multicastglobalconfigs/{}".format(api_version, tenant_id, site_id, element_id, multicastglobalconfig_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "put", data=data) def multicastpeergroups(self, multicastpeergroup_id, data, tenant_id=None, api_version="v2.1"): """ Update multicast peer group (v2.1) **Parameters:**: - **multicastpeergroup_id**: Multicast Peer Group ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Payload Attributes:** - **description:** Type: string - **is_source_site_receiver:** Type: boolean - **name:** Type: string - **peer_sites:** - **peer_site_id:** Type: string - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def multicastrps(self, site_id, element_id, multicastrp_id, data, tenant_id=None, api_version="v2.0"): """ Updates Multicast RP config (v2.0) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **multicastrp_id**: Multicast RP ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **description:** Type: string - **groups:** - **ipv4_prefix:** Type: string - **is_active_rp:** Type: boolean - **ipv4_address:** Type: string - **name:** Type: string - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def multicastsourcesiteconfigs(self, site_id, multicastsourcesiteconfig_id, data, tenant_id=None, api_version="v2.0"): """ Update multicast source site config (v2.0) **Parameters:**: - **site_id**: Site ID - **multicastsourcesiteconfig_id**: Multicast Source Site Config ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **site_configs:** - **group_ipv4_prefix:** Type: string - **source_ipv4_address:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def natglobalprefixes(self, natglobalprefix_id, data, tenant_id=None, api_version="v2.0"): """ Update an existing NAT prefix. (v2.0) **Parameters:**: - **natglobalprefix_id**: NAT Global Prefix ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **description:** Type: string - **ipv4_prefixes:** [Type: string] - **name:** Type: string - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def natlocalprefixes(self, natlocalprefix_id, data, tenant_id=None, api_version="v2.0"): """ Update a NAT local prefix. (v2.0) **Parameters:**: - **natlocalprefix_id**: NAT Local Prefix ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **description:** Type: string - **name:** Type: string - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def natpolicypools(self, natpolicypool_id, data, tenant_id=None, api_version="v2.0"): """ Update a NAT Policy Pool. (v2.0) **Parameters:**: - **natpolicypool_id**: NAT Policy Pool ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **description:** Type: string - **name:** Type: string - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def natpolicyrules(self, natpolicyset_id, natpolicyrule_id, data, tenant_id=None, api_version="v2.0"): """ Update policy rule of tenant. (v2.0) **Parameters:**: - **natpolicyset_id**: NAT Policy Set ID - **natpolicyrule_id**: NAT Policy Rule ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **actions:** - **nat_pool_id:** Type: string - **port:** Type: integer - **protocols:** [Type: string] - **type:** Type: string - **description:** Type: string - **destination_ports:** - **from:** Type: integer - **to:** Type: integer - **destination_prefixes:** - **description:** Type: string - **id:** Type: string - **ipv4_prefixes:** [Type: string] - **ipv6_prefixes:** [Type: string] - **name:** Type: string - **tags:** [Type: string] - **destination_prefixes_id:** Type: string - **destination_zone:** - **default_for_public_interfaces:** Type: boolean - **description:** Type: string - **disabled:** Type: boolean - **disabled_reason:** Type: string - **id:** Type: string - **inactive:** Type: boolean - **inactive_reason:** Type: string - **name:** Type: string - **region:** Type: string - **tags:** [Type: string] - **tenant_id:** Type: string - **destination_zone_id:** Type: string - **disabled:** Type: boolean - **disabled_reason:** Type: string - **enabled:** Type: boolean - **inactive:** Type: boolean - **inactive_reason:** Type: string - **name:** Type: string - **natpolicypools:** - **description:** Type: string - **id:** Type: string - **name:** Type: string - **tags:** [Type: string] - **policyset_id:** Type: string - **protocol:** Type: integer - **region:** Type: string - **source_ports:** - **from:** Type: integer - **to:** Type: integer - **source_prefixes:** - **description:** Type: string - **id:** Type: string - **ipv4_prefixes:** [Type: string] - **ipv6_prefixes:** [Type: string] - **name:** Type: string - **tags:** [Type: string] - **source_prefixes_id:** Type: string - **source_zone:** - **default_for_public_interfaces:** Type: boolean - **description:** Type: string - **disabled:** Type: boolean - **disabled_reason:** Type: string - **id:** Type: string - **inactive:** Type: boolean - **inactive_reason:** Type: string - **name:** Type: string - **region:** Type: string - **tags:** [Type: string] - **tenant_id:** Type: string - **source_zone_id:** Type: string - **tags:** [Type: string] - **tenant_id:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def natpolicysets(self, natpolicyset_id, data, tenant_id=None, api_version="v2.0"): """ Update NAT policy set. (v2.0) **Parameters:**: - **natpolicyset_id**: NAT Policy Set ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **clone_from:** Type: string - **description:** Type: string - **destination_zone_policyrule_order:** [Type: string] - **disabled:** Type: boolean - **disabled_reason:** Type: string - **inactive:** Type: boolean - **inactive_reason:** Type: string - **name:** Type: string - **policy_req_version:** Type: string - **policy_rules:** - **actions:** - **nat_pool_id:** Type: string - **port:** Type: integer - **protocols:** [Type: string] - **type:** Type: string - **description:** Type: string - **destination_ports:** - **from:** Type: integer - **to:** Type: integer - **destination_prefixes:** - **description:** Type: string - **id:** Type: string - **ipv4_prefixes:** [Type: string] - **ipv6_prefixes:** [Type: string] - **name:** Type: string - **tags:** [Type: string] - **destination_prefixes_id:** Type: string - **destination_zone:** - **default_for_public_interfaces:** Type: boolean - **description:** Type: string - **disabled:** Type: boolean - **disabled_reason:** Type: string - **id:** Type: string - **inactive:** Type: boolean - **inactive_reason:** Type: string - **name:** Type: string - **region:** Type: string - **tags:** [Type: string] - **tenant_id:** Type: string - **destination_zone_id:** Type: string - **disabled:** Type: boolean - **disabled_reason:** Type: string - **enabled:** Type: boolean - **id:** Type: string - **inactive:** Type: boolean - **inactive_reason:** Type: string - **name:** Type: string - **natpolicypools:** - **description:** Type: string - **id:** Type: string - **name:** Type: string - **tags:** [Type: string] - **policyset_id:** Type: string - **protocol:** Type: integer - **region:** Type: string - **source_ports:** - **from:** Type: integer - **to:** Type: integer - **source_prefixes:** - **description:** Type: string - **id:** Type: string - **ipv4_prefixes:** [Type: string] - **ipv6_prefixes:** [Type: string] - **name:** Type: string - **tags:** [Type: string] - **source_prefixes_id:** Type: string - **source_zone:** - **default_for_public_interfaces:** Type: boolean - **description:** Type: string - **disabled:** Type: boolean - **disabled_reason:** Type: string - **id:** Type: string - **inactive:** Type: boolean - **inactive_reason:** Type: string - **name:** Type: string - **region:** Type: string - **tags:** [Type: string] - **tenant_id:** Type: string - **source_zone_id:** Type: string - **tags:** [Type: string] - **tenant_id:** Type: string - **region:** Type: string - **send_to_element:** Type: boolean - **source_zone_policyrule_order:** [Type: string] - **tags:** [Type: string] - **tenant_id:** Type: string - **update_order:** Type: boolean **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def natpolicysetstacks(self, natpolicysetstack_id, data, tenant_id=None, api_version="v2.0"): """ Update NAT Policy Set Stack. (v2.0) **Parameters:**: - **natpolicysetstack_id**: NAT Policy Set Stack ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **default_policysetstack:** Type: boolean - **description:** Type: string - **name:** Type: string - **policyset_ids:** [Type: string] - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def natzones(self, natzone_id, data, tenant_id=None, api_version="v2.0"): """ Update a Nat Policy Zone. (v2.0) **Parameters:**: - **natzone_id**: NAT Zone ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **default_for_public_interfaces:** Type: boolean - **description:** Type: string - **disabled:** Type: boolean - **disabled_reason:** Type: string - **inactive:** Type: boolean - **inactive_reason:** Type: string - **name:** Type: string - **region:** Type: string - **tags:** [Type: string] - **tenant_id:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def networkcontexts(self, networkcontext_id, data, tenant_id=None, api_version="v2.0"): """ Update LAN segment (v2.0) **Parameters:**: - **networkcontext_id**: Network Context ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **description:** Type: string - **name:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def networkpolicyglobalprefixes(self, networkpolicyglobalprefix_id, data, tenant_id=None, api_version="v2.1"): """ Update a Network global prefix. (v2.1) **Parameters:**: - **networkpolicyglobalprefix_id**: Network Policy Global Prefix ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Payload Attributes:** - **description:** Type: string - **ipv4_prefixes:** [Type: string] - **ipv6_prefixes:** [Type: string] - **name:** Type: string - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def networkpolicyrules(self, networkpolicyset_id, networkpolicyrule_id, data, tenant_id=None, api_version="v2.2"): """ Update network policy rule of tenant. (v2.2) **Parameters:**: - **networkpolicyset_id**: Network Policy Set ID - **networkpolicyrule_id**: Network Policy Rule ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.2) **Payload Attributes:** - **app_def_ids:** [Type: string] - **description:** Type: string - **destination_prefixes_id:** Type: string - **enabled:** Type: boolean - **name:** Type: string - **network_context_id:** Type: string - **order_number:** Type: integer - **paths_allowed:** - **active_paths:** - **label:** Type: string - **path_type:** Type: string - **backup_paths:** - **label:** Type: string - **path_type:** Type: string - **l3_failure_paths:** - **label:** Type: string - **path_type:** Type: string - **service_context:** - **active_service_label_id:** Type: string - **active_service_label_type:** Type: string - **backup_service_label_id:** Type: string - **backup_service_label_type:** Type: string - **type:** Type: string - **source_prefixes_id:** Type: string - **tags:** [Type: string] - **user_or_group:** - **user_group_ids:** [Type: string] - **user_ids:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def networkpolicysets(self, networkpolicyset_id, data, tenant_id=None, api_version="v2.0"): """ Update Network Policy Set. (v2.0) **Parameters:**: - **networkpolicyset_id**: Network Policy Set ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **clone_from:** Type: string - **defaultrule_policyset:** Type: boolean - **description:** Type: string - **disabled:** Type: boolean - **disabled_reason:** Type: string - **inactive:** Type: boolean - **inactive_reason:** Type: string - **name:** Type: string - **policy_req_version:** Type: string - **policy_rules:** - **app_def_ids:** [Type: string] - **description:** Type: string - **destination_prefixes_id:** Type: string - **enabled:** Type: boolean - **id:** Type: string - **name:** Type: string - **network_context_id:** Type: string - **order_number:** Type: integer - **paths_allowed:** - **active_paths:** - **label:** Type: string - **path_type:** Type: string - **backup_paths:** - **label:** Type: string - **path_type:** Type: string - **l3_failure_paths:** - **label:** Type: string - **path_type:** Type: string - **service_context:** - **active_service_label_id:** Type: string - **active_service_label_type:** Type: string - **backup_service_label_id:** Type: string - **backup_service_label_type:** Type: string - **type:** Type: string - **source_prefixes_id:** Type: string - **tags:** [Type: string] - **region:** Type: string - **send_to_element:** Type: boolean - **tags:** [Type: string] - **tenant_id:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def networkpolicysetstacks(self, networkpolicysetstack_id, data, tenant_id=None, api_version="v2.0"): """ Update a NetworkPolicySetStack (v2.0) **Parameters:**: - **networkpolicysetstack_id**: Network Policy Set Stack ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **default_policysetstack:** Type: boolean - **defaultrule_policyset:** - **clone_from:** Type: string - **defaultrule_policyset:** Type: boolean - **description:** Type: string - **disabled:** Type: boolean - **disabled_reason:** Type: string - **id:** Type: string - **inactive:** Type: boolean - **inactive_reason:** Type: string - **name:** Type: string - **policy_req_version:** Type: string - **policy_rules:** - **app_def_ids:** [Type: string] - **description:** Type: string - **destination_prefixes_id:** Type: string - **enabled:** Type: boolean - **id:** Type: string - **name:** Type: string - **network_context_id:** Type: string - **order_number:** Type: integer - **paths_allowed:** - **active_paths:** - **label:** Type: string - **path_type:** Type: string - **backup_paths:** - **label:** Type: string - **path_type:** Type: string - **l3_failure_paths:** - **label:** Type: string - **path_type:** Type: string - **service_context:** - **active_service_label_id:** Type: string - **active_service_label_type:** Type: string - **backup_service_label_id:** Type: string - **backup_service_label_type:** Type: string - **type:** Type: string - **source_prefixes_id:** Type: string - **tags:** [Type: string] - **region:** Type: string - **send_to_element:** Type: boolean - **tags:** [Type: string] - **tenant_id:** Type: string - **defaultrule_policyset_id:** Type: string - **description:** Type: string - **disabled:** Type: boolean - **disabled_reason:** Type: string - **inactive:** Type: boolean - **inactive_reason:** Type: string - **legacy_policystack:** Type: boolean - **name:** Type: string - **policyset_ids:** [Type: string] - **policysets:** - **clone_from:** Type: string - **description:** Type: string - **disabled:** Type: boolean - **disabled_reason:** Type: string - **id:** Type: string - **inactive:** Type: boolean - **inactive_reason:** Type: string - **name:** Type: string - **policy_rules:** - **description:** Type: string - **disabled:** Type: boolean - **disabled_reason:** Type: string - **id:** Type: string - **inactive:** Type: boolean - **inactive_reason:** Type: string - **name:** Type: string - **policyset_id:** Type: string - **region:** Type: string - **tags:** [Type: string] - **tenant_id:** Type: string - **region:** Type: string - **send_to_element:** Type: boolean - **tags:** [Type: string] - **tenant_id:** Type: string - **region:** Type: string - **tags:** [Type: string] - **tenant_id:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def ngfwsecuritypolicyglobalprefixes(self, ngfwsecuritypolicyglobalprefix_id, data, tenant_id=None, api_version="v2.1"): """ Update an existing Security Policy V2 Global Prefix (v2.1) **Parameters:**: - **ngfwsecuritypolicyglobalprefix_id**: NGFW Security Policy Global Prefix ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Payload Attributes:** - **description:** Type: string - **ipv4_prefixes:** [Type: string] - **ipv6_prefixes:** [Type: string] - **name:** Type: string - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def ngfwsecuritypolicylocalprefixes(self, ngfwsecuritypolicylocalprefix_id, data, tenant_id=None, api_version="v2.0"): """ Update an existing Security Policy V2 Local Prefix (v2.0) **Parameters:**: - **ngfwsecuritypolicylocalprefix_id**: NGFW Security Policy Local Prefix ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **description:** Type: string - **name:** Type: string - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def ngfwsecuritypolicyrules(self, ngfwsecuritypolicyset_id, ngfwsecuritypolicyrule_id, data, tenant_id=None, api_version="v2.1"): """ Update 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 - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Payload Attributes:** - **action:** Type: string - **app_def_ids:** [Type: string] - **description:** Type: string - **destination_prefix_ids:** [Type: string] - **destination_zone_ids:** [Type: string] - **enabled:** Type: boolean - **name:** Type: string - **services:** - **destination_ports:** - **from:** Type: integer - **to:** Type: integer - **protocol:** Type: integer - **source_ports:** - **from:** Type: integer - **to:** Type: integer - **source_prefix_ids:** [Type: string] - **source_zone_ids:** [Type: string] - **tags:** [Type: string] - **user_or_group:** - **user_group_ids:** [Type: string] - **user_ids:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def ngfwsecuritypolicysets(self, ngfwsecuritypolicyset_id, data, tenant_id=None, api_version="v2.0"): """ Update an existing Security Policy V2 Set (v2.0) **Parameters:**: - **ngfwsecuritypolicyset_id**: NGFW Security Policy Set ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **clone_from:** Type: string - **defaultrule_policyset:** Type: boolean - **description:** Type: string - **name:** Type: string - **policyrule_order:** [Type: string] - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def ngfwsecuritypolicysetstacks(self, ngfwsecuritypolicysetstack_id, data, tenant_id=None, api_version="v2.0"): """ Update an existing Security Policy V2 Set Stack (v2.0) **Parameters:**: - **ngfwsecuritypolicysetstack_id**: NGFW Security Policy Set Stack ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **defaultrule_policyset_id:** Type: string - **description:** Type: string - **name:** Type: string - **policyset_ids:** [Type: string] - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def ntp(self, element_id, ntp_id, data, tenant_id=None, api_version="v2.0"): """ Update an existing element NTP. (v2.0) **Parameters:**: - **element_id**: Element (Device) ID - **ntp_id**: NTP Configuration ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **description:** Type: string - **name:** Type: string - **ntp_servers:** - **host:** Type: string - **max_poll:** Type: integer - **min_poll:** Type: integer - **version:** Type: integer - **source_interface_ids:** [Type: string] - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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/{}/ntp/{}".format(api_version, tenant_id, element_id, ntp_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "put", data=data) def otpaccessconfigs(self, otpaccessconfig_id, data, tenant_id=None, api_version="v2.0"): """ Update an OTP Access for all elements under an Tenant. (v2.0) **Parameters:**: - **otpaccessconfig_id**: OTP Access configuration ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **otp_attempts:** Type: integer - **otp_validity_minutes:** Type: integer **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_id. raise TypeError("tenant_id is required but not set or cached.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/otpaccessconfigs/{}".format(api_version, tenant_id, otpaccessconfig_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "put", data=data) def pathgroups(self, pathgroup_id, data, tenant_id=None, api_version="v2.1"): """ Update A Path Group of a tenant. (v2.1) **Parameters:**: - **pathgroup_id**: Path Group ID (for network service/DC routing) - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Payload Attributes:** - **description:** Type: string - **name:** Type: string - **paths:** - **label:** Type: string - **path_type:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def perfmgmtpolicysets(self, perfmgmtpolicyset_id, data, tenant_id=None, api_version="v2.0"): """ PUT Perfmgmtpolicysets API Function **Parameters:**: - **perfmgmtpolicyset_id**: Performance Management Policy Set ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def perfmgmtpolicysets_perfmgmtpolicyrules(self, perfmgmtpolicyset_id, perfmgmtpolicyrule_id, data, tenant_id=None, api_version="v2.0"): """ PUT Perfmgmtpolicysets_Perfmgmtpolicyrules API Function **Parameters:**: - **perfmgmtpolicyset_id**: Performance Management Policy Set ID - **perfmgmtpolicyrule_id**: Performance Management Policy Rule ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def perfmgmtpolicysetstacks(self, perfmgmtpolicysetstack_id, data, tenant_id=None, api_version="v2.0"): """ PUT Perfmgmtpolicysetstacks API Function **Parameters:**: - **perfmgmtpolicysetstack_id**: Performance Management Policy Set Stack ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def perfmgmtthresholdprofiles(self, perfmgmtthresholdprofile_id, data, tenant_id=None, api_version="v2.0"): """ PUT Perfmgmtthresholdprofiles API Function **Parameters:**: - **perfmgmtthresholdprofile_id**: Performance Management Policy Threshold Profile ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def policyrules(self, policyset_id, policyrule_id, data, tenant_id=None, api_version="v3.1"): """ Update policy rule of tenant. (v3.1) **Parameters:**: - **policyset_id**: Policy Set ID - **policyrule_id**: Policy Rule ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v3.1) **Payload Attributes:** - **app_def_id:** Type: string - **description:** Type: string - **name:** Type: string - **network_context_id:** Type: string - **paths_allowed:** - **active_paths:** - **label:** Type: string - **path_type:** Type: string - **backup_paths:** - **label:** Type: string - **path_type:** Type: string - **l3_failure_paths:** - **label:** Type: string - **path_type:** Type: string - **priority_num:** Type: integer - **service_context:** - **active_service_label_id:** Type: string - **active_service_label_type:** Type: string - **backup_service_label_id:** Type: string - **backup_service_label_type:** Type: string - **type:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def policysets(self, policyset_id, data, tenant_id=None, api_version="v3.0"): """ Update policy set. (v3.0) **Parameters:**: - **policyset_id**: Policy Set ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v3.0) **Payload Attributes:** - **bandwidth_allocation_schemes:** - **bandwidth_range:** - **high:** Type: number - **low:** Type: number - **business_priorities:** - **bandwidth_allocation:** Type: number - **bandwidth_split_per_type:** - **bulk:** Type: number - **rt_audio:** Type: number - **rt_video:** Type: number - **transactional:** Type: number - **priority_num:** Type: integer - **business_priority_names:** - **priority_name:** Type: string - **priority_num:** Type: integer - **default_policy:** Type: boolean - **description:** Type: string - **name:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def prefixfilters(self, site_id, prefixfilter_id, data, tenant_id=None, api_version="v2.0"): """ Update an existing security prefix filter (v2.0) **Parameters:**: - **site_id**: Site ID - **prefixfilter_id**: Prefix Filter ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **filters:** - **type:** Type: string - **prefix_filter_id:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def prioritypolicyglobalprefixes(self, prioritypolicyglobalprefix_id, data, tenant_id=None, api_version="v2.1"): """ Update a Priority global prefix. (v2.1) **Parameters:**: - **prioritypolicyglobalprefix_id**: Priority Policy Global Prefix ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Payload Attributes:** - **description:** Type: string - **ipv4_prefixes:** [Type: string] - **ipv6_prefixes:** [Type: string] - **name:** Type: string - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def prioritypolicyrules(self, prioritypolicyset_id, prioritypolicyrule_id, data, tenant_id=None, api_version="v2.1"): """ Update priority policy rule of tenant. (v2.1) **Parameters:**: - **prioritypolicyset_id**: Priority Policy Set ID - **prioritypolicyrule_id**: Priority Policy Rule ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Payload Attributes:** - **app_def_ids:** [Type: string] - **description:** Type: string - **destination_prefixes_id:** Type: string - **dscp:** - **value:** Type: integer - **enabled:** Type: boolean - **name:** Type: string - **network_context_id:** Type: string - **order_number:** Type: integer - **priority_number:** Type: integer - **source_prefixes_id:** Type: string - **tags:** [Type: string] - **user_or_group:** - **user_group_ids:** [Type: string] - **user_ids:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def prioritypolicysets(self, prioritypolicyset_id, data, tenant_id=None, api_version="v2.0"): """ Update Priority Policy Set. (v2.0) **Parameters:**: - **prioritypolicyset_id**: Priority Policy Set ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **bandwidth_allocation_schemes:** - **bandwidth_range:** - **high:** Type: number - **low:** Type: number - **business_priorities:** - **bandwidth_allocation:** Type: number - **bandwidth_split_per_type:** - **bulk:** Type: number - **rt_audio:** Type: number - **rt_video:** Type: number - **transactional:** Type: number - **priority_number:** Type: integer - **business_priority_names:** - **priority_name:** Type: string - **priority_num:** Type: integer - **clone_from:** Type: string - **default_rule_dscp_mappings:** - **dscp:** [Type: integer] - **priority_number:** Type: integer - **transfer_type:** Type: string - **defaultrule_policyset:** Type: boolean - **description:** Type: string - **name:** Type: string - **tags:** [Type: string] - **template:** Type: boolean **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def prioritypolicysetstacks(self, prioritypolicysetstack_id, data, tenant_id=None, api_version="v2.0"): """ Update a PriorityPolicySetStack (v2.0) **Parameters:**: - **prioritypolicysetstack_id**: Priority Policy Stack ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **default_policysetstack:** Type: boolean - **defaultrule_policyset_id:** Type: string - **description:** Type: string - **name:** Type: string - **policyset_ids:** [Type: string] - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def prismaaccess_configs(self, site_id, prismaaccess_config_id, data, tenant_id=None, api_version="v2.0"): """ Update 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 - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **remote_networks:** - **edge_location_display:** Type: string - **edge_location_value:** Type: string - **remote_network_names:** [Type: string] - **service_link_ids:** [Type: string] - **spn_name:** Type: string - **site_id:** Type: string - **tenant_id:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def prismasase_connections(self, site_id, prismasase_connection_id, data, tenant_id=None, api_version="v2.0"): """ PUT Prismasase_Connections API Function **Parameters:**: - **site_id**: Site ID - **prismasase_connection_id**: Prisma SASE Connection ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def prismasase_connections_configs(self, data, tenant_id=None, api_version="v2.0"): """ PUT Prismasase_Connections_Configs API Function **Parameters:**: - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def radii(self, element_id, radii_id, data, tenant_id=None, api_version="v2.0"): """ Used for element radius configuration updates (v2.0) **Parameters:**: - **element_id**: Element (Device) ID - **radii_id**: Radii ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **description:** Type: string - **name:** Type: string - **override_indicator:** [Type: string] - **radius_configuration:** - **accounting_port:** Type: integer - **authentication_port:** Type: integer - **ip_version:** Type: integer - **priority:** Type: integer - **retain_shared_secret:** Type: boolean - **server_ip_address:** Type: string - **shared_secret:** Type: string - **shared_secret_encrypted:** Type: string - **radius_profile_id:** Type: string - **source_interface_id:** Type: string - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def recovery_tokens(self, machine_id, recovery_token_id, data, tenant_id=None, api_version="v2.1"): """ Update Recovery Token for Fips change mode (v2.1) **Parameters:**: - **machine_id**: Machine ID - **recovery_token_id**: Recovery Token ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Payload Attributes:** - **token_validity_in_hour:** Type: integer **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_id. raise TypeError("tenant_id is required but not set or cached.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/machines/{}/recovery_tokens/{}".format(api_version, tenant_id, machine_id, recovery_token_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "put", data=data) def roles(self, role_id, data, tenant_id=None, api_version="v2.1"): """ Update a custom role (v2.1) **Parameters:**: - **role_id**: Role ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Payload Attributes:** - **custom_permissions:** - **allowed_after_ms:** Type: integer - **allowed_before_ms:** Type: integer - **disabled:** Type: boolean - **disabled_reason:** Type: string - **disallow_permission:** Type: boolean - **id:** Type: string - **inactive:** Type: boolean - **inactive_reason:** Type: string - **region:** Type: string - **tenant_id:** Type: string - **value:** Type: string - **description:** Type: string - **disabled:** Type: boolean - **disabled_reason:** Type: string - **disallow_permissions:** - **value:** Type: string - **inactive:** Type: boolean - **inactive_reason:** Type: string - **is_system_owned:** Type: boolean - **name:** Type: string - **permissions:** - **value:** Type: string - **region:** Type: string - **roles:** - **name:** Type: string - **tenant_id:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def routing_aspathaccesslists(self, site_id, element_id, routing_aspathaccesslist_id, data, tenant_id=None, api_version="v2.1"): """ Updates Access List (v2.1) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **routing_aspathaccesslist_id**: Routing AS-PATH Access List ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Payload Attributes:** - **as_path_regex_list:** - **as_path_regex:** Type: string - **order:** Type: integer - **permit:** Type: boolean - **auto_generated:** Type: boolean - **description:** Type: string - **name:** Type: string - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def routing_ipcommunitylists(self, site_id, element_id, routing_ipcommunitylist_id, data, tenant_id=None, api_version="v2.0"): """ Updates Community List (v2.0) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **routing_ipcommunitylist_id**: Routing IP Community List ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **auto_generated:** Type: boolean - **community_list:** - **community_str:** Type: string - **permit:** Type: boolean - **description:** Type: string - **name:** Type: string - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def routing_prefixlists(self, site_id, element_id, routing_prefixlist_id, data, tenant_id=None, api_version="v2.1"): """ Updates Prefix List (v2.1) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **routing_prefixlist_id**: Routing IP Prefix List ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Payload Attributes:** - **auto_generated:** Type: boolean - **description:** Type: string - **name:** Type: string - **prefix_filter_list:** - **ge:** Type: integer - **ipv6_prefix:** Type: string - **le:** Type: integer - **order:** Type: integer - **permit:** Type: boolean - **prefix:** Type: string - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def routing_routemaps(self, site_id, element_id, routing_routemap_id, data, tenant_id=None, api_version="v2.2"): """ Updates Route Map (v2.2) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **routing_routemap_id**: Routing Route Map ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.2) **Payload Attributes:** - **auto_generated:** Type: boolean - **description:** Type: string - **name:** Type: string - **route_map_entries:** - **continue_entry:** Type: string - **match:** - **as_path_id:** Type: string - **community_list_id:** Type: string - **ip_next_hop_id:** Type: string - **ip_prefix_list_id:** Type: string - **tag:** Type: integer - **order:** Type: integer - **permit:** Type: boolean - **set:** - **as_path_prepend:** Type: string - **community:** Type: string - **ip_next_hop:** Type: string - **local_preference:** Type: integer - **tag:** Type: integer - **weight:** Type: integer - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def sdwanapps_configs(self, sdwanapp_id, config_id, data, tenant_id=None, api_version="v2.0"): """ PUT Sdwanapps_Configs API Function **Parameters:**: - **sdwanapp_id**: SDWAN Application ID - **config_id**: SDWAN App Config ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def securitypolicyrules(self, securitypolicyset_id, securitypolicyrule_id, data, tenant_id=None, api_version="v2.0"): """ Update a tenant security policy rule. (v2.0) **Parameters:**: - **securitypolicyset_id**: Security Policy Set ID - **securitypolicyrule_id**: Security Policy Rule ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **action:** Type: string - **application_ids:** [Type: string] - **description:** Type: string - **destination_filter_ids:** [Type: string] - **destination_zone_ids:** [Type: string] - **disabled_flag:** Type: boolean - **name:** Type: string - **source_filter_ids:** [Type: string] - **source_zone_ids:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def securitypolicysets(self, securitypolicyset_id, data, tenant_id=None, api_version="v2.0"): """ Update a tenant security policy set. (v2.0) **Parameters:**: - **securitypolicyset_id**: Security Policy Set ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **description:** Type: string - **name:** Type: string - **policyrule_order:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def securityzones(self, securityzone_id, data, tenant_id=None, api_version="v2.0"): """ Update an existing security zone (v2.0) **Parameters:**: - **securityzone_id**: Security Zone (ZBFW) ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **description:** Type: string - **name:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def servicebindingmaps(self, servicebindingmap_id, data, tenant_id=None, api_version="v2.1"): """ Update a ServiceBindingMap (v2.1) **Parameters:**: - **servicebindingmap_id**: Service Binding Map ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Payload Attributes:** - **description:** Type: string - **is_default:** Type: boolean - **name:** Type: string - **service_bindings:** - **service_endpoint_ids:** [Type: string] - **service_label_id:** Type: string - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def serviceendpoints(self, serviceendpoint_id, data, tenant_id=None, api_version="v2.4"): """ Update a ServiceEndpoint (v2.4) **Parameters:**: - **serviceendpoint_id**: Service Endpoint ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.4) **Payload Attributes:** - **address:** - **city:** Type: string - **country:** Type: string - **post_code:** Type: string - **state:** Type: string - **street:** Type: string - **street2:** Type: string - **admin_up:** Type: boolean - **allow_enterprise_traffic:** Type: boolean - **description:** Type: string - **disable_tunnel_reoptimization:** Type: boolean - **liveliness_probe:** - **http:** - **failure_count:** Type: integer - **http_status_codes:** [Type: integer] - **interval:** Type: integer - **url:** Type: string - **icmp_ping:** - **failure_count:** Type: integer - **interval:** Type: integer - **ip_addresses:** [Type: string] - **location:** - **description:** Type: string - **latitude:** Type: number - **longitude:** Type: number - **name:** Type: string - **sase_properties:** - **allocated_bandwidth_mbps:** Type: integer - **allocated_sc_count:** Type: integer - **pa_compute_region_oid:** Type: string - **total_sc_bandwidth_mbps:** Type: integer - **service_link_peers:** - **hostnames:** [Type: string] - **ip_addresses:** [Type: string] - **site_id:** Type: string - **tags:** [Type: string] - **type:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def servicelabels(self, servicelabel_id, data, tenant_id=None, api_version="v2.1"): """ Update a ServiceLabel (v2.1) **Parameters:**: - **servicelabel_id**: Service Label ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Payload Attributes:** - **description:** Type: string - **name:** Type: string - **sase_properties:** - **active_sase_label:** Type: boolean - **tags:** [Type: string] - **type:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def site_admin_state(self, site_id, data, tenant_id=None, api_version="v3.0"): """ Update an existing site (v3.0) **Parameters:**: - **site_id**: Site ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v3.0) **Payload Attributes:** - **address:** - **city:** Type: string - **country:** Type: string - **post_code:** Type: string - **state:** Type: string - **street:** Type: string - **street2:** Type: string - **admin_state:** Type: string - **description:** Type: string - **element_cluster_role:** Type: string - **location:** - **description:** Type: string - **latitude:** Type: number - **longitude:** Type: number - **name:** Type: string - **policy_set_id:** Type: string - **security_policyset_id:** Type: string - **service_binding:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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/{}/admin_state".format(api_version, tenant_id, site_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "put", data=data) def site_extensions(self, site_id, extension_id, data, tenant_id=None, api_version="v2.0"): """ Update site level extension configuration (v2.0) **Parameters:**: - **site_id**: Site ID - **extension_id**: Extension ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **conf:** Type: object - **disabled:** Type: boolean - **entity_id:** Type: string - **name:** Type: string - **namespace:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def site_ipfixlocalprefixes(self, site_id, ipfixlocalprefix_id, data, tenant_id=None, api_version="v2.0"): """ Update a IPFix site prefix association (v2.0) **Parameters:**: - **site_id**: Site ID - **ipfixlocalprefix_id**: IPFix Local Prefix ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **ipv4_prefixes:** [Type: string] - **prefix_id:** Type: string - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def site_natlocalprefixes(self, site_id, natlocalprefix_id, data, tenant_id=None, api_version="v2.0"): """ Update an existing Site NAT Local prefix Association (v2.0) **Parameters:**: - **site_id**: Site ID - **natlocalprefix_id**: NAT Local Prefix ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **ipv4_prefixes:** [Type: string] - **prefix_id:** Type: string - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def site_networkpolicylocalprefixes(self, site_id, networkpolicylocalprefix_id, data, tenant_id=None, api_version="v2.1"): """ Update an existing Site Network policy local prefix (v2.1) **Parameters:**: - **site_id**: Site ID - **networkpolicylocalprefix_id**: Network Policy Local Prefix ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Payload Attributes:** - **ipv4_prefixes:** [Type: string] - **ipv6_prefixes:** [Type: string] - **prefix_id:** Type: string - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def site_ngfwsecuritypolicylocalprefixes(self, site_id, ngfwsecuritypolicylocalprefix_id, data, tenant_id=None, api_version="v2.1"): """ Update an existing security policy V2 local prefix site association (v2.1) **Parameters:**: - **site_id**: Site ID - **ngfwsecuritypolicylocalprefix_id**: NGFW Security Policy Local Prefix ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Payload Attributes:** - **ipv4_prefixes:** [Type: string] - **ipv6_prefixes:** [Type: string] - **prefix_id:** Type: string - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def site_prioritypolicylocalprefixes(self, site_id, prioritypolicylocalprefix_id, data, tenant_id=None, api_version="v2.1"): """ Update an existing Site Priority policy local prefix (v2.1) **Parameters:**: - **site_id**: Site ID - **prioritypolicylocalprefix_id**: Priority Policy Local Prefix ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Payload Attributes:** - **ipv4_prefixes:** [Type: string] - **ipv6_prefixes:** [Type: string] - **prefix_id:** Type: string - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def siteciphers(self, site_id, data, tenant_id=None, api_version="v2.0"): """ Update site cipher (v2.0) **Parameters:**: - **site_id**: Site ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **controller_connection_cipher:** Type: string - **site_id:** Type: string - **tenant_id:** Type: string - **vpn_ciphers:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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/{}/siteciphers".format(api_version, tenant_id, site_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "put", data=data) def sites(self, site_id, data, tenant_id=None, api_version="v4.9"): """ Update an existing site (v4.9) **Parameters:**: - **site_id**: Site ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v4.9) **Payload Attributes:** - **address:** - **city:** Type: string - **country:** Type: string - **post_code:** Type: string - **state:** Type: string - **street:** Type: string - **street2:** Type: string - **admin_state:** Type: string - **description:** Type: string - **element_cluster_role:** Type: string - **extended_tags:** - **key:** Type: string - **value:** Type: string - **value_type:** Type: string - **location:** - **description:** Type: string - **latitude:** Type: number - **longitude:** Type: number - **multicast_peer_group_id:** Type: string - **name:** Type: string - **nat_policysetstack_id:** Type: string - **network_policysetstack_id:** Type: string - **perfmgmt_policysetstack_id:** Type: string - **policy_set_id:** Type: string - **priority_policysetstack_id:** Type: string - **security_policyset_id:** Type: string - **security_policysetstack_id:** Type: string - **service_binding:** Type: string - **tags:** [Type: string] - **vrf_context_profile_id:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def sitesecurityzones(self, site_id, sitesecurityzone_id, data, tenant_id=None, api_version="v2.0"): """ Update an existing security zone (v2.0) **Parameters:**: - **site_id**: Site ID - **sitesecurityzone_id**: Site Security Zone ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **networks:** - **network_id:** Type: string - **network_type:** Type: string - **zone_id:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def snmpagents(self, site_id, element_id, snmpagent_id, data, tenant_id=None, api_version="v2.1"): """ Update SNMP Agent (v2.1) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **snmpagent_id**: SNMP Agent ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Payload Attributes:** - **description:** Type: string - **system_contact:** Type: string - **system_location:** Type: string - **tags:** [Type: string] - **v2_config:** - **community:** Type: string - **v3_config:** - **user_access:** - **auth_phrase:** Type: string - **auth_type:** Type: string - **enc_phrase:** Type: string - **enc_type:** Type: string - **engine_id:** Type: string - **security_level:** Type: string - **user_name:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def snmptraps(self, site_id, element_id, snmptrap_id, data, tenant_id=None, api_version="v2.0"): """ Update SNMP Trap (v2.0) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **snmptrap_id**: SNMP Trap ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **description:** Type: string - **enabled:** Type: boolean - **server_ip:** Type: string - **source_interface:** Type: string - **tags:** [Type: string] - **v2_config:** - **community:** Type: string - **v3_config:** - **user_access:** - **auth_phrase:** Type: string - **auth_type:** Type: string - **enc_phrase:** Type: string - **enc_type:** Type: string - **engine_id:** Type: string - **security_level:** Type: string - **user_name:** Type: string - **version:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def software(self, machine_id, software_id, data, tenant_id=None, api_version="v2.0"): """ Update Machine Software (v2.0) **Parameters:**: - **machine_id**: Machine ID - **software_id**: Software ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **scheduled_upgrade:** Type: string - **tenant_id:** Type: string - **upgrade_interval:** Type: integer - **upgrade_version:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_id. raise TypeError("tenant_id is required but not set or cached.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/machines/{}/software/{}".format(api_version, tenant_id, machine_id, software_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "put", data=data) def software_state(self, element_id, data, tenant_id=None, api_version="v2.0"): """ Upgrade an element (v2.0) **Parameters:**: - **element_id**: Element (Device) ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **download_interval:** Type: integer - **image_id:** Type: string - **interface_ids:** [Type: string] - **scheduled_download:** Type: string - **scheduled_upgrade:** Type: string - **upgrade_interval:** Type: integer **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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/{}/software/state".format(api_version, tenant_id, element_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "put", data=data) def spokeclusters(self, site_id, spokecluster_id, data, tenant_id=None, api_version="v2.0"): """ Update Spoke Cluster (v2.0) **Parameters:**: - **site_id**: Site ID - **spokecluster_id**: Spoke Cluster ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **advertisement_interval:** Type: number - **description:** Type: string - **name:** Type: string - **preempt:** Type: boolean - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def staticroutes(self, site_id, element_id, staticroute_id, data, tenant_id=None, api_version="v2.3"): """ Update static route (v2.3) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **staticroute_id**: Static Route ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.3) **Payload Attributes:** - **address_family:** Type: string - **description:** Type: string - **destination_prefix:** Type: string - **name:** Type: string - **network_context_id:** Type: string - **nexthop_reachability_probe:** Type: boolean - **nexthops:** - **admin_distance:** Type: integer - **nexthop_interface_id:** Type: string - **nexthop_ip:** Type: string - **self:** Type: boolean - **scope:** Type: string - **tags:** [Type: string] - **vrf_context_id:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def syslogserverprofiles(self, syslogserverprofile_id, data, tenant_id=None, api_version="v2.0"): """ Update Syslog Server Profile (v2.0) **Parameters:**: - **syslogserverprofile_id**: Sys Log Server Profile ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **description:** Type: string - **enable_flow_logging:** Type: boolean - **name:** Type: string - **protocol:** Type: string - **remote_ca_certificate:** Type: string - **server_fqdn:** Type: string - **server_ip:** Type: string - **server_port:** Type: integer - **severity_level:** Type: string - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def syslogservers(self, site_id, element_id, syslogserver_id, data, tenant_id=None, api_version="v2.2"): """ Update Syslog Server (v2.2) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **syslogserver_id**: SYSLOG server ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.2) **Payload Attributes:** - **description:** Type: string - **enable_flow_logging:** Type: boolean - **enabled:** Type: boolean - **name:** Type: string - **protocol:** Type: string - **remote_ca_certificate:** Type: string - **server_fqdn:** Type: string - **server_ip:** Type: string - **server_port:** Type: integer - **severity_level:** Type: string - **source_interface:** Type: string - **syslog_profile_id:** Type: string - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def templates_ntp(self, ntp_id, data, tenant_id=None, api_version="v2.0"): """ Update an existing NTP Template (v2.0) **Parameters:**: - **ntp_id**: NTP Configuration ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **default_template:** Type: boolean - **description:** Type: string - **name:** Type: string - **ntp_servers:** - **host:** Type: string - **max_poll:** Type: integer - **min_poll:** Type: integer - **version:** Type: integer - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def tenant_anynetlinks(self, anynetlink_id, data, tenant_id=None, api_version="v3.4"): """ PUT Tenant_Anynetlinks API Function **Parameters:**: - **anynetlink_id**: Anynet (Secure Fabric) Link ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v3.4) **Payload Attributes:** **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def tenant_ipfixlocalprefixes(self, ipfixlocalprefix_id, data, tenant_id=None, api_version="v2.0"): """ Update a IPFix local prefix (v2.0) **Parameters:**: - **ipfixlocalprefix_id**: IPFix Local Prefix ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **description:** Type: string - **name:** Type: string - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def tenant_networkpolicylocalprefixes(self, networkpolicylocalprefix_id, data, tenant_id=None, api_version="v2.0"): """ Update a Network Policy local prefix. (v2.0) **Parameters:**: - **networkpolicylocalprefix_id**: Network Policy Local Prefix ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **description:** Type: string - **name:** Type: string - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def tenant_operators(self, operator_id, data, tenant_id=None, api_version="v2.2"): """ Update a tenant operator (v2.2) **Parameters:**: - **operator_id**: Operator ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.2) **Payload Attributes:** - **addresses:** - **city:** Type: string - **country:** Type: string - **post_code:** Type: string - **state:** Type: string - **street:** Type: string - **street2:** Type: string - **custom_roles:** - **custom_permissions:** - **allowed_after_ms:** Type: integer - **allowed_before_ms:** Type: integer - **disabled:** Type: boolean - **disabled_reason:** Type: string - **disallow_permission:** Type: boolean - **id:** Type: string - **inactive:** Type: boolean - **inactive_reason:** Type: string - **region:** Type: string - **tenant_id:** Type: string - **value:** Type: string - **description:** Type: string - **disabled:** Type: boolean - **disabled_reason:** Type: string - **disallow_permissions:** - **value:** Type: string - **id:** Type: string - **inactive:** Type: boolean - **inactive_reason:** Type: string - **is_system_owned:** Type: boolean - **name:** Type: string - **permissions:** - **value:** Type: string - **region:** Type: string - **roles:** - **name:** Type: string - **tenant_id:** Type: string - **disable_idp_login:** Type: boolean - **disabled:** Type: boolean - **disabled_reason:** Type: string - **email:** Type: string - **email_iam:** Type: string - **email_validated:** Type: boolean - **enable_session_ip_lock:** Type: boolean - **first_name:** Type: string - **from_esp:** Type: boolean - **from_esp_name:** Type: string - **from_esp_tenant_id:** Type: string - **inactive:** Type: boolean - **inactive_reason:** Type: string - **ipv4_list:** - **ipv4:** Type: string - **is_locked:** Type: boolean - **is_system_owned:** Type: boolean - **last_login:** Type: string - **last_name:** Type: string - **linked_accounts:** - **disabled:** Type: boolean - **disabled_reason:** Type: string - **failed_login_attempts:** Type: integer - **id:** Type: string - **inactive:** Type: boolean - **inactive_reason:** Type: string - **provider_key:** Type: string - **provider_value:** Type: string - **provider_value_updated_on:** Type: integer - **region:** Type: string - **tenant_id:** Type: string - **migration_state:** - **phone_numbers:** - **country_code:** Type: integer - **local_extension:** Type: integer - **number:** Type: integer - **types:** - **value:** Type: string - **region:** Type: string - **roles:** - **name:** Type: string - **secondary_emails:** - **email:** Type: string - **settings:** Type: string - **tenant_id:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def tenant_permissions(self, permission_id, data, tenant_id=None, api_version="v2.0"): """ Update a custom permission (v2.0) **Parameters:**: - **permission_id**: Permission ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **allowed_after_ms:** Type: integer - **allowed_before_ms:** Type: integer - **disabled:** Type: boolean - **disabled_reason:** Type: string - **disallow_permission:** Type: boolean - **inactive:** Type: boolean - **inactive_reason:** Type: string - **region:** Type: string - **tenant_id:** Type: string - **value:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def tenant_prioritypolicylocalprefixes(self, prioritypolicylocalprefix_id, data, tenant_id=None, api_version="v2.0"): """ Update a Priority Policy local prefix. (v2.0) **Parameters:**: - **prioritypolicylocalprefix_id**: Priority Policy Local Prefix ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **description:** Type: string - **name:** Type: string - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def tenants(self, data, tenant_id=None, api_version="v2.8"): """ Update tenant (v2.8) **Parameters:**: - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.8) **Payload Attributes:** - **:** Type: string - **address:** - **city:** Type: string - **country:** Type: string - **post_code:** Type: string - **state:** Type: string - **street:** Type: string - **street2:** Type: string - **canonical_name:** Type: string - **clients:** [Type: string] - **csp_tenant_id:** Type: string - **description:** Type: string - **disabled:** Type: string - **disabled_reason:** Type: string - **inactive:** Type: string - **inactive_reason:** Type: string - **ipv4_list:** - **ipv4:** Type: string - **is_esp:** Type: boolean - **is_oneapp_ready:** Type: boolean - **is_pa_iot_security_license:** Type: boolean - **is_support:** Type: boolean - **name:** Type: string - **operator:** - **addresses:** - **city:** Type: string - **country:** Type: string - **post_code:** Type: string - **state:** Type: string - **street:** Type: string - **street2:** Type: string - **custom_roles:** - **custom_permissions:** - **allowed_after_ms:** Type: integer - **allowed_before_ms:** Type: integer - **disabled:** Type: boolean - **disabled_reason:** Type: string - **disallow_permission:** Type: boolean - **id:** Type: string - **inactive:** Type: boolean - **inactive_reason:** Type: string - **region:** Type: string - **tenant_id:** Type: string - **value:** Type: string - **disabled:** Type: boolean - **disallow_permissions:** - **value:** Type: string - **id:** Type: string - **inactive:** Type: boolean - **name:** Type: string - **permissions:** - **value:** Type: string - **roles:** - **name:** Type: string - **disable_idp_login:** Type: boolean - **disabled:** Type: boolean - **disabled_reason:** Type: string - **email:** Type: string - **email_iam:** Type: string - **email_validated:** Type: boolean - **enable_session_ip_lock:** Type: boolean - **first_name:** Type: string - **from_esp:** Type: boolean - **from_esp_name:** Type: string - **from_esp_tenant_id:** Type: string - **id:** Type: string - **inactive:** Type: boolean - **inactive_reason:** Type: string - **ipv4_list:** - **ipv4:** Type: string - **is_locked:** Type: boolean - **is_system_owned:** Type: boolean - **last_login:** Type: string - **last_name:** Type: string - **linked_accounts:** - **disabled:** Type: boolean - **disabled_reason:** Type: string - **failed_login_attempts:** Type: integer - **id:** Type: string - **inactive:** Type: boolean - **inactive_reason:** Type: string - **provider_key:** Type: string - **provider_value:** Type: string - **provider_value_updated_on:** Type: integer - **region:** Type: string - **tenant_id:** Type: string - **migration_state:** - **name:** Type: string - **phone_numbers:** - **country_code:** Type: integer - **local_extension:** Type: integer - **number:** Type: integer - **types:** - **value:** Type: string - **region:** Type: string - **roles:** - **name:** Type: string - **secondary_emails:** - **email:** Type: string - **settings:** Type: string - **tenant_id:** Type: string - **pan_account_id:** Type: string - **pan_tenant_id:** Type: string - **password_policy:** - **enable_failed_login_attempts:** Type: boolean - **enable_failed_login_time_delay:** Type: boolean - **enable_maximum_password_length:** Type: boolean - **enable_minimum_password_length:** Type: boolean - **enable_password_aging:** Type: boolean - **enable_password_identity_difference:** Type: boolean - **enable_password_no_reuse_count:** Type: boolean - **enable_session_ip_lock:** Type: boolean - **enable_two_lower_case_letters:** Type: boolean - **enable_two_numbers:** Type: boolean - **enable_two_special_characters:** Type: boolean - **enable_two_upper_case_letters:** Type: boolean - **failed_login_attempts:** Type: integer - **maximum_password_length:** Type: integer - **minimum_password_length:** Type: integer - **password_aging_days:** Type: integer - **password_aging_notification:** Type: integer - **password_no_reuse_count:** Type: integer - **special_characters:** Type: string - **special_characters_regex:** Type: string - **phone_numbers:** - **country_code:** Type: integer - **local_extension:** Type: integer - **number:** Type: integer - **types:** - **value:** Type: string - **prisma_access_tenant_id:** Type: string - **provider_data:** - **certificate:** - **certificate:** Type: string - **certificate_expiry_utc:** Type: integer - **certificate_type:** Type: string - **disabled:** Type: boolean - **disabled_reason:** Type: string - **id:** Type: string - **inactive:** Type: boolean - **inactive_reason:** Type: string - **issued_by:** - **common_name:** Type: string - **country:** Type: string - **location:** Type: string - **organization:** Type: string - **organization_unit:** Type: string - **state:** Type: string - **issued_to:** - **common_name:** Type: string - **country:** Type: string - **location:** Type: string - **organization:** Type: string - **organization_unit:** Type: string - **state:** Type: string - **parent_id:** - **region:** Type: string - **serial_number:** Type: string - **tenant_id:** Type: string - **version:** Type: string - **password_hash:** Type: string - **provider:** - **canonical_name:** Type: string - **description:** Type: string - **disabled:** Type: boolean - **disabled_reason:** Type: string - **id:** Type: string - **inactive:** Type: boolean - **inactive_reason:** Type: string - **map_external_group:** Type: object - **name:** Type: string - **protocol:** - **region:** Type: string - **template:** Type: string - **tenant_id:** Type: string - **salt:** Type: string - **security:** Type: string - **region:** Type: string - **sase_at:** Type: string - **telemetry_region:** Type: string - **tenant_id:** Type: string - **tsg_id:** Type: string - **tsg_instances:** - **app_id:** Type: string - **region:** Type: string - **tenant_id:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_id. raise TypeError("tenant_id is required but not set or cached.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}".format(api_version, tenant_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "put", data=data) def useridagents(self, useridagent_id, data, tenant_id=None, api_version="v2.0"): """ PUT Useridagents API Function **Parameters:**: - **useridagent_id**: User Id Agent ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def users(self, user_id, data, tenant_id=None, api_version="v2.0"): """ Put an user identity. (v2.0) **Parameters:**: - **user_id**: User ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **disabled:** Type: boolean - **disabled_reason:** Type: string - **first_name:** Type: string - **inactive:** Type: boolean - **inactive_reason:** Type: string - **last_name:** Type: string - **middle_name:** Type: string - **region:** Type: string - **tenant_id:** Type: string - **user_dn:** Type: string - **user_fqn:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def vfflicense_tokens(self, vfflicense_id, token_id, data, tenant_id=None, api_version="v2.0"): """ Update Tenant Vff License Token (v2.0) **Parameters:**: - **vfflicense_id**: Virtual Form Factor License ID - **token_id**: Token ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **ion_key:** Type: string - **is_expired:** Type: boolean - **is_multiuse:** Type: boolean - **is_revoked:** Type: boolean - **is_used:** Type: boolean - **secret_key:** Type: string - **valid_till_secs:** Type: integer - **vfflicense_id:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_id. raise TypeError("tenant_id is required but not set or cached.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/vfflicenses/{}/tokens/{}".format(api_version, tenant_id, vfflicense_id, token_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "put", data=data) def vpnlinks_state(self, vpnlink_id, data, tenant_id=None, api_version="v2.0"): """ Change the VPNLink admin state (v2.0) **Parameters:**: - **vpnlink_id**: VPN Link ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **al_id:** Type: string - **enabled:** Type: boolean **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_id. raise TypeError("tenant_id is required but not set or cached.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/vpnlinks/{}/state".format(api_version, tenant_id, vpnlink_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "put", data=data) def vrfcontextprofiles(self, vrfcontextprofile_id, data, tenant_id=None, api_version="v2.0"): """ PUT Vrfcontextprofiles API Function **Parameters:**: - **vrfcontextprofile_id**: VRF Context Profile ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def vrfcontexts(self, vrfcontext_id, data, tenant_id=None, api_version="v2.0"): """ PUT Vrfcontexts API Function **Parameters:**: - **vrfcontext_id**: VRF Context UD - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def waninterfacelabels(self, waninterfacelabel_id, data, tenant_id=None, api_version="v2.4"): """ Update specific WAN interface label (v2.4) **Parameters:**: - **waninterfacelabel_id**: WAN Interface Label ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.4) **Payload Attributes:** - **bwc_enabled:** Type: boolean - **description:** Type: string - **label:** Type: string - **lqm_enabled:** Type: boolean - **name:** Type: string - **tags:** [Type: string] - **use_for_application_reachability_probes:** Type: boolean - **use_for_controller_connections:** Type: boolean - **use_lqm_for_non_hub_paths:** Type: boolean - **vpnlink_configuration:** - **keep_alive_failure_count:** Type: integer - **keep_alive_interval:** Type: integer **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_id. raise TypeError("tenant_id is required but not set or cached.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/waninterfacelabels/{}".format(api_version, tenant_id, waninterfacelabel_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "put", data=data) def waninterfaces(self, site_id, waninterface_id, data, tenant_id=None, api_version="v2.7"): """ Update the Site WAN interface (v2.7) **Parameters:**: - **site_id**: Site ID - **waninterface_id**: WAN Interface ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.7) **Payload Attributes:** - **bfd_mode:** Type: string - **bw_config_mode:** Type: string - **bwc_enabled:** Type: boolean - **cost:** Type: integer - **description:** Type: string - **label_id:** Type: string - **link_bw_down:** Type: number - **link_bw_up:** Type: number - **lqm_config:** - **hub_site_ids:** [Type: string] - **inter_packet_gap:** Type: integer - **statistic:** Type: string - **lqm_enabled:** Type: boolean - **name:** Type: string - **network_id:** Type: string - **tags:** [Type: string] - **type:** Type: string - **use_for_application_reachability_probes:** Type: boolean - **use_for_controller_connections:** Type: boolean - **use_lqm_for_non_hub_paths:** Type: boolean - **vpnlink_configuration:** - **keep_alive_failure_count:** Type: integer - **keep_alive_interval:** Type: integer **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def wannetworks(self, wannetwork_id, data, tenant_id=None, api_version="v2.1"): """ Update an existing WAN (v2.1) **Parameters:**: - **wannetwork_id**: WAN Network ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Payload Attributes:** - **description:** Type: string - **name:** Type: string - **provider_as_numbers:** [Type: integer] - **tags:** [Type: string] - **type:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def wanoverlays(self, wanoverlay_id, data, tenant_id=None, api_version="v2.0"): """ Update app/wan context (v2.0) **Parameters:**: - **wanoverlay_id**: WAN Overlay ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **description:** Type: string - **name:** Type: string - **vni:** Type: integer **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def ws_extensions(self, extension_id, data, tenant_id=None, api_version="v2.0"): """ PUT Ws_Extensions API Function **Parameters:**: - **extension_id**: Extension ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) # 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`""" admin_state_i = element_admin_state """ Backwards-compatibility alias of `admin_state_i` to `element_admin_state`""" admin_state_s = site_admin_state """ Backwards-compatibility alias of `admin_state_s` to `site_admin_state`""" anynetlinks_t = tenant_anynetlinks """ Backwards-compatibility alias of `anynetlinks_t` to `tenant_anynetlinks`""" cellular_modules_e = element_cellular_modules """ Backwards-compatibility alias of `cellular_modules_e` to `element_cellular_modules`""" 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`""" deviceidconfigs_i = element_deviceidconfigs """ Backwards-compatibility alias of `deviceidconfigs_i` to `element_deviceidconfigs`""" 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`""" firmware_cellular_modules_e = element_cellular_modules_firmware """ Backwards-compatibility alias of `firmware_cellular_modules_e` to `element_cellular_modules_firmware`""" firmware_cellular_modules_m = machine_cellular_modules_firmware """ Backwards-compatibility alias of `firmware_cellular_modules_m` to `machine_cellular_modules_firmware`""" 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`""" 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`""" sim_security_cellular_modules = cellular_modules_sim_security """ Backwards-compatibility alias of `sim_security_cellular_modules` to `cellular_modules_sim_security`""" 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`""" state = element_state """ Backwards-compatibility alias of `state` to `element_state`""" state_software = software_state """ Backwards-compatibility alias of `state_software` to `software_state`""" state_vpnlinks = vpnlinks_state """ Backwards-compatibility alias of `state_vpnlinks` to `vpnlinks_state`""" tokens_vfflicenses = vfflicense_tokens """ Backwards-compatibility alias of `tokens_vfflicenses` to `vfflicense_tokens`"""
Module variables
var api_logger
logging.getlogger object to enable debug printing via cloudgenix.API.set_debug
Classes
class Put
CloudGenix API - PUT requests
Object to handle making Put requests via shared Requests Session.
class Put(object): """ CloudGenix API - PUT requests Object to handle making Put requests via shared Requests Session. """ # placeholder for parent class namespace _parent_class = None def apnprofiles(self, apnprofile_id, data, tenant_id=None, api_version="v2.0"): """ Update an APN Profile (v2.0) **Parameters:**: - **apnprofile_id**: APN Profile ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **apn:** Type: string - **authentication:** Type: string - **clear_password:** Type: boolean - **description:** Type: string - **name:** Type: string - **password:** Type: string - **tags:** [Type: string] - **user_name:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def appdefs(self, appdef_id, data, tenant_id=None, api_version="v2.5"): """ Update an application definition (v2.5) **Parameters:**: - **appdef_id**: Application Definition ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.5) **Payload Attributes:** - **abbreviation:** Type: string - **aggregate_flows:** Type: boolean - **app_type:** Type: string - **app_unreachability_detection:** Type: boolean - **category:** Type: string - **conn_idle_timeout:** Type: integer - **description:** Type: string - **display_name:** Type: string - **domains:** [Type: string] - **ingress_traffic_pct:** Type: integer - **ip_rules:** [Type: object] - **is_deprecated:** Type: boolean - **network_scan_application:** Type: boolean - **order_number:** Type: integer - **overrides_allowed:** Type: boolean - **p_category:** Type: string - **p_parent_id:** Type: string - **p_sub_category:** Type: string - **parent_id:** Type: string - **path_affinity:** Type: string - **session_timeout:** Type: integer - **supported_engines:** Type: string - **system_app_overridden:** Type: boolean - **tags:** [Type: string] - **tcp_rules:** [Type: string] - **transfer_type:** Type: string - **udp_rules:** [Type: object] - **use_parentapp_network_policy:** Type: boolean **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def appdefs_overrides(self, appdef_id, override_id, data, tenant_id=None, api_version="v2.3"): """ Update a application definition overrides for system appdef (v2.3) **Parameters:**: - **appdef_id**: Application Definition ID - **override_id**: AppDef Override ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.3) **Payload Attributes:** - **aggregate_flows:** Type: boolean - **app_unreachability_detection:** Type: boolean - **category:** Type: string - **conn_idle_timeout:** Type: integer - **description:** Type: string - **domains:** [Type: string] - **ingress_traffic_pct:** Type: integer - **ip_rules:** - **dest_filters:** [Type: string] - **dest_prefixes:** [Type: string] - **dscp:** - **value:** Type: integer - **protocol:** Type: string - **src_filters:** [Type: string] - **override_default_ip_rules:** Type: boolean - **override_default_tcp_rules:** Type: boolean - **override_default_udp_rules:** Type: boolean - **override_domains:** Type: boolean - **overrides_disable:** Type: boolean - **p_category:** Type: string - **path_affinity:** Type: string - **session_timeout:** Type: integer - **tags:** [Type: string] - **tcp_rules:** - **client_filters:** [Type: string] - **client_port:** - **end:** Type: string - **start:** Type: string - **dscp:** - **value:** Type: integer - **server_filters:** [Type: string] - **server_port:** - **end:** Type: string - **start:** Type: string - **server_prefixes:** [Type: string] - **transfer_type:** Type: string - **udp_rules:** - **dest_prefixes:** [Type: string] - **dscp:** - **value:** Type: integer - **udp_filters:** [Type: string] - **udp_port:** - **end:** Type: string - **start:** Type: string - **use_parentapp_network_policy:** Type: boolean **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def appdefs_version(self, appdefs_version_id, data, tenant_id=None, api_version="v2.0"): """ Change standard apps version (v2.0) **Parameters:**: - **appdefs_version_id**: Application Definition Version ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **app_version:** Type: string - **disabled:** Type: boolean - **disabled_reason:** Type: string - **inactive:** Type: boolean - **inactive_reason:** Type: string - **region:** Type: string - **reqState:** Type: string - **sigfile_url:** Type: string - **tenant_id:** Type: string - **uApp_version:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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_version/{}".format(api_version, tenant_id, appdefs_version_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "put", data=data) def application_probe(self, site_id, element_id, data, tenant_id=None, api_version="v2.0"): """ Update application probe configuration (v2.0) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **description:** Type: string - **enable_probe:** Type: boolean - **name:** Type: string - **source_interface_id:** Type: string - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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/{}/application_probe".format(api_version, tenant_id, site_id, element_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "put", data=data) def bgpconfigs(self, site_id, element_id, bgpconfig_id, data, tenant_id=None, api_version="v2.3"): """ Updates BGP config (v2.3) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **bgpconfig_id**: BGP Configuration ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.3) **Payload Attributes:** - **admin_distance:** Type: integer - **adv_interval:** Type: integer - **graceful_restart:** Type: boolean - **hold_time:** Type: integer - **ipv6_prefixes_to_adv_to_wan:** [Type: string] - **keepalive_time:** Type: integer - **local_as_num:** Type: string - **maximum_paths:** Type: integer - **md5_secret:** Type: string - **multi_hop_limit:** Type: integer - **peer_auth_type:** Type: string - **peer_retry_time:** Type: integer - **prefix_adv_type:** Type: string - **prefix_adv_type_to_lan:** Type: string - **prefixes_to_adv_to_wan:** [Type: string] - **router_id:** Type: string - **stalepath_time:** Type: integer **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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/{}/bgpconfigs/{}".format(api_version, tenant_id, site_id, element_id, bgpconfig_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "put", data=data) def bgppeers(self, site_id, element_id, bgppeer_id, data, tenant_id=None, api_version="v2.4"): """ Update BGP Peer config (v2.4) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **bgppeer_id**: BGP Peer ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.4) **Payload Attributes:** - **allow_v4_prefixes:** Type: boolean - **allow_v6_prefixes:** Type: boolean - **bgp_config:** - **adv_interval:** Type: integer - **hold_time:** Type: integer - **keepalive_time:** Type: integer - **local_as_num:** Type: string - **md5_secret:** Type: string - **multi_hop_limit:** Type: integer - **peer_auth_type:** Type: string - **peer_retry_time:** Type: integer - **description:** Type: string - **name:** Type: string - **peer_ip:** Type: string - **peer_ip_v6:** Type: string - **peer_type:** Type: string - **remote_as_num:** Type: string - **route_map_in_id:** Type: string - **route_map_out_id:** Type: string - **router_id:** Type: string - **scope:** Type: string - **shutdown:** Type: boolean - **tags:** [Type: string] - **update_source:** Type: string - **update_source_v6:** Type: string - **vrf_context_id:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def bulkconfigurations_sitetemplates(self, sitetemplate_id, data, tenant_id=None, api_version="v2.0"): """ PUT Bulkconfigurations_Sitetemplates API Function **Parameters:**: - **sitetemplate_id**: Site Template ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def cellular_modules_sim_security(self, element_id, cellular_module_id, sim_security_id, data, tenant_id=None, api_version="v2.0"): """ Update cellular module (v2.0) **Parameters:**: - **element_id**: Element (Device) ID - **cellular_module_id**: Cellular Module ID - **sim_security_id**: SIM Security ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **description:** Type: string - **name:** Type: string - **pin:** Type: string - **remove_pin:** Type: boolean - **slot_number:** Type: integer - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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/{}/cellular_modules/{}/sim_security/{}".format(api_version, tenant_id, element_id, cellular_module_id, sim_security_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "put", data=data) def demsiteconfigs(self, site_id, demsiteconfig_id, data, tenant_id=None, api_version="v2.0"): """ PUT Demsiteconfigs API Function **Parameters:**: - **site_id**: Site ID - **demsiteconfig_id**: - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def deviceidconfigs(self, site_id, deviceidconfig_id, data, tenant_id=None, api_version="v2.1"): """ PUT Deviceidconfigs API Function **Parameters:**: - **site_id**: Site ID - **deviceidconfig_id**: Device Id Config ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Payload Attributes:** **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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/{}".format(api_version, tenant_id, site_id, deviceidconfig_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "put", data=data) def deviceidconfigs_snmpdiscoverystartnodes(self, site_id, deviceidconfig_id, snmpdiscoverystartnode_id, data, tenant_id=None, api_version="v2.0"): """ PUT Deviceidconfigs_Snmpdiscoverystartnodes API Function **Parameters:**: - **site_id**: Site ID - **deviceidconfig_id**: Device Id Config ID - **snmpdiscoverystartnode_id**: SNMP Discovery Start Node ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def deviceidprofiles(self, deviceidprofile_id, data, tenant_id=None, api_version="v2.0"): """ PUT Deviceidprofiles API Function **Parameters:**: - **deviceidprofile_id**: Device Id Profile ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def dhcpservers(self, site_id, dhcpserver_id, data, tenant_id=None, api_version="v2.3"): """ Update an existing dhcp server configuration for a subnet (v2.3) **Parameters:**: - **site_id**: Site ID - **dhcpserver_id**: DHCP Server ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.3) **Payload Attributes:** - **address_family:** Type: string - **broadcast_address:** Type: string - **custom_options:** - **option_definition:** Type: string - **option_value:** Type: string - **vendor_class_identifier:** Type: string - **default_lease_time:** Type: integer - **description:** Type: string - **disabled:** Type: boolean - **dns_servers:** [Type: string] - **domain_name:** Type: string - **gateway:** Type: string - **ip_ranges:** - **end_ip:** Type: string - **start_ip:** Type: string - **max_lease_time:** Type: integer - **network_context_id:** Type: string - **static_mappings:** - **client_duid:** Type: string - **ip_address:** Type: string - **mac:** Type: string - **name:** Type: string - **subnet:** Type: string - **tags:** [Type: string] - **vrf_context_id:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def directoryservices(self, directoryservice_id, data, tenant_id=None, api_version="v2.0"): """ PUT Directoryservices API Function **Parameters:**: - **directoryservice_id**: Directory Service ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def dnsserviceprofiles(self, dnsserviceprofile_id, data, tenant_id=None, api_version="v2.1"): """ Update a DNS service profile (v2.1) **Parameters:**: - **dnsserviceprofile_id**: DNS Service Profile ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Payload Attributes:** - **authoritative_config:** - **caa_records:** - **flags:** Type: string - **name:** Type: string - **tag:** Type: string - **value:** Type: string - **cname_records:** - **name:** [Type: string] - **target:** Type: string - **ttl:** Type: integer - **dns_resource_records:** - **hex_data:** Type: string - **name:** Type: string - **rr_number:** Type: integer - **host_records:** - **domain_names:** [Type: string] - **ipv4_address:** Type: string - **ipv6_address:** Type: string - **ttl:** Type: integer - **mx_host_records:** - **hostname:** Type: string - **mx_name:** Type: string - **preference:** Type: integer - **naptr_records:** - **flags:** Type: string - **name:** Type: string - **order:** Type: integer - **preference:** Type: integer - **regexp:** Type: string - **replacement:** Type: string - **service:** Type: string - **peers:** [Type: string] - **ptr_records:** - **name:** Type: string - **target:** Type: string - **secondary_servers:** [Type: string] - **servers:** - **dnsservicerole_id:** Type: string - **domain_name:** Type: string - **soa:** - **expiry:** Type: integer - **host_master:** Type: string - **refresh:** Type: integer - **retry:** Type: integer - **serial_number:** Type: integer - **srv_hosts:** - **domain_name:** Type: string - **port:** Type: integer - **priority:** Type: integer - **protocol:** Type: string - **service:** Type: string - **target:** Type: integer - **weight:** Type: integer - **synth_domains:** - **domain:** Type: string - **end_ipaddress:** Type: string - **ipaddress_prefix:** Type: string - **prefix:** Type: string - **start_ipaddress:** Type: string - **ttl:** Type: integer - **txt_records:** - **domain_name:** Type: string - **texts:** [Type: string] - **zones:** - **domain_name:** Type: string - **exclude_prefix:** [Type: string] - **include_prefix:** [Type: string] - **cache_config:** - **cache_size:** Type: integer - **disable_negative_caching:** Type: boolean - **max_cache_ttl:** Type: integer - **min_cache_ttl:** Type: integer - **negative_cache_ttl:** Type: integer - **description:** Type: string - **dns_forward_config:** - **dns_servers:** - **address_family:** Type: string - **dnsserver_ip:** Type: string - **dnsserver_port:** Type: integer - **domain_names:** [Type: string] - **forward_dnsservicerole_id:** Type: string - **ip_prefix:** Type: string - **source_port:** Type: integer - **max_source_port:** Type: integer - **min_source_port:** Type: integer - **send_to_all_dns_servers:** Type: boolean - **dns_queries_metadata:** - **add_client_mac:** - **mac_encoding_format:** Type: string - **add_customer_premises_equipment:** - **identifier_text:** Type: string - **type:** Type: string - **add_subnets:** - **ipv4_address:** Type: string - **ipv4_prefix_length:** Type: integer - **ipv6_address:** Type: string - **ipv6_prefix_length:** Type: integer - **dns_rebind_config:** - **enable_localhost_rebind:** Type: boolean - **rebind_domains:** [Type: string] - **stop_dns_rebind_privateip:** Type: boolean - **dns_response_overrides:** - **aliases:** - **mask:** Type: integer - **original_end_ip:** Type: string - **original_ip:** Type: string - **original_start_ip:** Type: string - **replace_ip:** Type: string - **bogus_nx_domains:** [Type: string] - **disable_private_ip_lookups:** Type: boolean - **ignore_ip_addresses:** [Type: string] - **local_ttl:** Type: integer - **max_ttl:** Type: integer - **dnssec_config:** - **disable_dnssec_timecheck:** Type: boolean - **dns_check_unsigned:** Type: boolean - **enabled:** Type: boolean - **trust_anchors:** - **class:** Type: string - **domain:** Type: string - **key_digest:** - **algorithm:** Type: integer - **digest:** Type: string - **digest_type:** Type: integer - **key_tag:** Type: integer - **domains_to_addresses:** - **domain_names:** [Type: string] - **ipv4_address:** Type: string - **ipv6_address:** Type: string - **edns_packet_max:** Type: integer - **enable_dns_loop_detection:** Type: boolean - **enable_dnssec_proxy:** Type: boolean - **enable_strict_domain_name:** Type: boolean - **listen_dnsservicerole_id:** Type: string - **listen_port:** Type: integer - **name:** Type: string - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def dnsserviceroles(self, dnsservicerole_id, data, tenant_id=None, api_version="v2.0"): """ Update a DNS service role (v2.0) **Parameters:**: - **dnsservicerole_id**: DNS Service Role ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **description:** Type: string - **name:** Type: string - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def dnsservices(self, site_id, element_id, dnsservice_id, data, tenant_id=None, api_version="v2.0"): """ Update a DNS service config (v2.0) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **dnsservice_id**: DNS Service ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **cache_config:** - **cache_size:** Type: integer - **description:** Type: string - **disabled:** Type: boolean - **disabled_reason:** Type: string - **dns_queries_metadata:** - **add_customer_premises_equipment:** - **identifier_text:** Type: string - **type:** Type: string - **add_subnets:** - **ipv4_address:** Type: string - **ipv4_prefix_length:** Type: integer - **ipv6_address:** Type: string - **ipv6_prefix_length:** Type: integer - **dnsservice_profile_id:** Type: string - **dnsservicerole_bindings:** - **dnsservicerole_id:** Type: string - **interfaces:** - **interface_id:** Type: string - **interface_ip:** Type: string - **domains_to_addresses:** - **domain_names:** [Type: string] - **ipv4_address:** Type: string - **ipv6_address:** Type: string - **domains_to_interfaces:** - **domain_names:** [Type: string] - **interface_id:** Type: string - **element_id:** Type: string - **enabled:** Type: boolean - **inactive:** Type: boolean - **inactive_reason:** Type: string - **max_concurrent_dns_queries:** Type: integer - **name:** Type: string - **region:** Type: string - **site_id:** Type: string - **tags:** [Type: string] - **tenant_id:** Type: string - **upperCaseName:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def element_admin_state(self, site_id, element_id, data, tenant_id=None, api_version="v2.0"): """ Update admin state Northbound (v2.0) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **admin_action:** Type: string - **allowed_roles:** [Type: string] - **cluster_insertion_mode:** Type: string - **cluster_member_id:** Type: string - **connected:** Type: boolean - **deployment_op:** Type: string - **description:** Type: string - **hw_id:** Type: string - **model_name:** Type: string - **name:** Type: string - **role:** Type: string - **serial_number:** Type: string - **site_id:** Type: string - **software_version:** Type: string - **state:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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/{}/admin_state".format(api_version, tenant_id, site_id, element_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "put", data=data) def element_cellular_modules(self, element_id, cellular_module_id, data, tenant_id=None, api_version="v2.0"): """ Update cellular module (v2.0) **Parameters:**: - **element_id**: Element (Device) ID - **cellular_module_id**: Cellular Module ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **description:** Type: string - **gps_enable:** Type: boolean - **name:** Type: string - **primary_sim:** Type: integer - **radio_on:** Type: boolean - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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/{}/cellular_modules/{}".format(api_version, tenant_id, element_id, cellular_module_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "put", data=data) def element_cellular_modules_firmware(self, element_id, cellular_module_id, data, tenant_id=None, api_version="v2.0"): """ Update cellular module firmware configuration (v2.0) **Parameters:**: - **element_id**: Element (Device) ID - **cellular_module_id**: Cellular Module ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **cellular_module_image_ids:** [Type: string] - **download_interval:** Type: integer - **interface_ids:** [Type: string] - **scheduled_download:** Type: string - **scheduled_upgrade:** Type: string - **upgrade_interval:** Type: integer **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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/{}/cellular_modules/{}/firmware".format(api_version, tenant_id, element_id, cellular_module_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "put", data=data) def element_deviceidconfigs(self, site_id, element_id, deviceidconfig_id, data, tenant_id=None, api_version="v2.0"): """ PUT Element_Deviceidconfigs API Function **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **deviceidconfig_id**: Device Id Config ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def element_extensions(self, site_id, element_id, extension_id, data, tenant_id=None, api_version="v2.0"): """ Update element level extension configuration (v2.0) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **extension_id**: Extension ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **conf:** Type: object - **disabled:** Type: boolean - **entity_id:** Type: string - **name:** Type: string - **namespace:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def element_state(self, element_id, data, tenant_id=None, api_version="v2.0"): """ Update element state (v2.0) **Parameters:**: - **element_id**: Element (Device) ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **image_id:** Type: string - **scheduled_upgrade:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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/{}/state".format(api_version, tenant_id, element_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "put", data=data) def elementaccessconfigs(self, element_id, elementaccessconfig_id, data, tenant_id=None, api_version="v2.2"): """ Update an Access Config on particular element. (v2.2) **Parameters:**: - **element_id**: Element (Device) ID - **elementaccessconfig_id**: Element Access Config ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.2) **Payload Attributes:** - **account_disable_interval:** Type: integer - **inactive_interval:** Type: integer - **otpkey_version:** Type: integer - **retry_login_count:** Type: integer - **ssh_enabled:** Type: boolean - **ssh_outbound_enabled:** Type: boolean **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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/{}/elementaccessconfigs/{}".format(api_version, tenant_id, element_id, elementaccessconfig_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "put", data=data) def elements(self, element_id, data, tenant_id=None, api_version="v3.1"): """ Used for associations and element updates (v3.1) **Parameters:**: - **element_id**: Element (Device) ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v3.1) **Payload Attributes:** - **cluster_id:** Type: string - **description:** Type: string - **device_profile_id:** Type: string - **l3_direct_private_wan_forwarding:** Type: boolean - **l3_lan_forwarding:** Type: boolean - **led_config:** - **service_led_on:** Type: boolean - **main_power_usage_threshold:** Type: integer - **name:** Type: string - **nat_policysetstack_id:** Type: string - **network_policysetstack_id:** Type: string - **priority_policysetstack_id:** Type: string - **site_id:** Type: string - **spoke_ha_config:** - **cluster_id:** Type: string - **enable:** Type: boolean - **priority:** Type: integer - **source_interface:** Type: string - **track:** - **interfaces:** - **interface_id:** Type: string - **reduce_priority:** Type: integer - **waninterfaces:** - **reduce_priority:** Type: integer - **wan_interface_id:** Type: string - **sw_obj:** - **location:** Type: string - **version:** Type: string - **switch_config:** - **default_vlan_id:** Type: integer - **mstp_enabled:** Type: boolean - **stp_aging_timer:** Type: integer - **stp_forward_delay:** Type: integer - **stp_hello_time:** Type: integer - **stp_max_age:** Type: integer - **stp_mode:** Type: string - **stp_priority:** Type: integer - **tags:** [Type: string] - **tenant_id:** Type: string - **vpn_to_vpn_forwarding:** Type: boolean **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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/{}".format(api_version, tenant_id, element_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "put", data=data) def elementsecurityzones(self, site_id, element_id, securityzone_id, data, tenant_id=None, api_version="v2.0"): """ Update an existing element security zone (v2.0) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **securityzone_id**: Security Zone (ZBFW) ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **interface_ids:** [Type: string] - **lannetwork_ids:** [Type: string] - **site_id:** Type: string - **tenant_id:** Type: string - **waninterface_ids:** [Type: string] - **wanoverlay_ids:** [Type: string] - **zone_id:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def elementshells(self, site_id, elementshell_id, data, tenant_id=None, api_version="v2.0"): """ PUT Elementshells API Function **Parameters:**: - **site_id**: Site ID - **elementshell_id**: Element Shell ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def elementshells_interfaces(self, site_id, elementshell_id, interface_id, data, tenant_id=None, api_version="v2.0"): """ PUT Elementshells_Interfaces API Function **Parameters:**: - **site_id**: Site ID - **elementshell_id**: Element Shell ID - **interface_id**: Interface ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def elementusers(self, elementuser_id, data, tenant_id=None, api_version="v2.1"): """ Update an existing element user. (v2.1) **Parameters:**: - **elementuser_id**: Element User ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Payload Attributes:** - **is_tenant_level:** Type: boolean - **login_id:** Type: string - **password:** Type: string - **role:** Type: string - **tenant_id:** Type: string - **username:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def elementusers_access(self, elementuser_id, access_id, data, tenant_id=None, api_version="v2.1"): """ Update an existing element user access. (v2.1) **Parameters:**: - **elementuser_id**: Element User ID - **access_id**: Access ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Payload Attributes:** - **element_id:** Type: string - **role:** Type: string - **tenant_id:** Type: string - **user_id:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def enterpriseprefixset(self, data, tenant_id=None, api_version="v2.1"): """ PUT Enterpriseprefixset API Function **Parameters:**: - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Payload Attributes:** **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_id. raise TypeError("tenant_id is required but not set or cached.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/enterpriseprefixset".format(api_version, tenant_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "put", data=data) def esp_operator_permissions_client(self, operator_id, client_id, data, tenant_id=None, api_version="v2.1"): """ Create or update esp operator permissions assigned under a client (v2.1) **Parameters:**: - **operator_id**: Operator ID - **client_id**: ESP/MSP Client ID (typically their tenant_id) - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Payload Attributes:** - **client_id:** Type: string - **custom_roles:** - **custom_permissions:** - **allowed_after_ms:** Type: integer - **allowed_before_ms:** Type: integer - **disabled:** Type: boolean - **disabled_reason:** Type: string - **disallow_permission:** Type: boolean - **id:** Type: string - **inactive:** Type: boolean - **inactive_reason:** Type: string - **region:** Type: string - **tenant_id:** Type: string - **value:** Type: string - **disabled:** Type: boolean - **disallow_permissions:** - **value:** Type: string - **id:** Type: string - **inactive:** Type: boolean - **name:** Type: string - **permissions:** - **value:** Type: string - **roles:** - **name:** Type: string - **disabled:** Type: boolean - **disabled_reason:** Type: string - **email:** Type: string - **enable_session_ip_lock:** Type: boolean - **inactive:** Type: boolean - **inactive_reason:** Type: string - **ipv4_list:** - **ipv4:** Type: string - **name:** Type: string - **operator_id:** Type: string - **region:** Type: string - **roles:** - **name:** Type: string - **settings:** Type: string - **tenant_id:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def eventcorrelationpolicyrules(self, eventcorrelationpolicyset_id, eventcorrelationpolicyrule_id, data, tenant_id=None, api_version="v2.1"): """ Update event correlation policyrule configuration (v2.1) **Parameters:**: - **eventcorrelationpolicyset_id**: Event Correlation Policy Set ID - **eventcorrelationpolicyrule_id**: Event Correlation Policy Rule ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Payload Attributes:** - **dampening_duration:** Type: integer - **description:** Type: string - **enabled:** Type: boolean - **end_time:** Type: integer - **escalation_rules:** - **flap_rule:** - **flap_duration:** Type: integer - **flap_rate:** Type: integer - **standing_rule:** - **priority:** Type: string - **standing_for:** Type: integer - **event_codes:** [Type: string] - **name:** Type: string - **priority:** Type: string - **resource_ids:** [Type: string] - **resource_type:** Type: string - **start_time:** Type: integer - **sub_resource_type:** Type: string - **suppress:** Type: string - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def eventcorrelationpolicysets(self, eventcorrelationpolicyset_id, data, tenant_id=None, api_version="v2.0"): """ Update event correlation policyset configuration (v2.0) **Parameters:**: - **eventcorrelationpolicyset_id**: Event Correlation Policy Set ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **active_policyset:** Type: boolean - **clone_from:** Type: string - **description:** Type: string - **name:** Type: string - **policyrule_order:** [Type: string] - **severity_priority_mapping:** - **priority:** Type: string - **severity:** Type: string - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def events(self, event_id, data, tenant_id=None, api_version="v2.3"): """ PUT Events API Function **Parameters:**: - **event_id**: Event ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.3) **Payload Attributes:** **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_id. raise TypeError("tenant_id is required but not set or cached.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/events/{}".format(api_version, tenant_id, event_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "put", data=data) def externalcaconfigs(self, externalcaconfig_id, data, tenant_id=None, api_version="v2.0"): """ PUT Externalcaconfigs API Function **Parameters:**: - **externalcaconfig_id**: External CA Config ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def globalprefixfilters(self, globalprefixfilter_id, data, tenant_id=None, api_version="v2.0"): """ Update a new global prefix filter. (v2.0) **Parameters:**: - **globalprefixfilter_id**: Global Prefix Filter ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **description:** Type: string - **filters:** - **type:** Type: string - **name:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def hubclustermembers(self, site_id, hubcluster_id, hubclustermember_id, data, tenant_id=None, api_version="v3.0"): """ Update specific hub cluster member. (v3.0) **Parameters:**: - **site_id**: Site ID - **hubcluster_id**: Hub (DC) Cluster ID - **hubclustermember_id**: Hub Cluster Member ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v3.0) **Payload Attributes:** - **headend1_site_ids:** [Type: string] - **headend2_site_ids:** [Type: string] - **hub_element_id:** Type: string - **load_factors:** - **alarm_threshold:** Type: integer - **allocated:** Type: integer - **subscription_factor:** Type: number - **threshold:** - **critical_alarm:** Type: integer - **major_alarm:** Type: integer - **subscription_factor:** Type: number - **type:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def hubclusters(self, site_id, hubcluster_id, data, tenant_id=None, api_version="v4.0"): """ Update hub cluster (v4.0) **Parameters:**: - **site_id**: Site ID - **hubcluster_id**: Hub (DC) Cluster ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v4.0) **Payload Attributes:** - **default_cluster:** Type: boolean - **description:** Type: string - **elements:** - **hubClusterElementNumber:** Type: string - **hub_element_id:** Type: string - **locked:** Type: boolean - **name:** Type: string - **peer_sites:** [Type: string] - **site_count_alarm_threshold:** Type: integer - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def idps(self, idp_id, data, tenant_id=None, api_version="v3.3"): """ Update sso (v3.3) **Parameters:**: - **idp_id**: SAML IDentity provider configuration ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v3.3) **Payload Attributes:** - **auto_provision_operators:** Type: boolean - **auto_provision_roles:** Type: boolean - **disabled:** Type: boolean - **disabled_reason:** Type: string - **idp_domain_admin_email:** Type: string - **idp_domains:** [Type: string] - **idp_entity_id:** Type: string - **idp_login_url:** Type: string - **idp_logout_url:** Type: string - **idp_metadata_b64:** Type: string - **inactive:** Type: boolean - **inactive_reason:** Type: string - **is_hob:** Type: boolean - **match_email_domain:** Type: boolean - **role_map:** Type: object - **session_timeout_s:** Type: integer - **sign_redirect_binding:** Type: boolean - **sp_metadata_b64:** Type: string - **sp_x509_b64:** Type: string - **sp_x509_serial_no:** Type: string - **tenant_id:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def interfaces(self, site_id, element_id, interface_id, data, tenant_id=None, api_version="v4.17"): """ Update an Interface (v4.17) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **interface_id**: Interface ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v4.17) **Payload Attributes:** - **admin_up:** Type: boolean - **attached_lan_networks:** - **lan_network_id:** Type: string - **vlan_id:** Type: integer - **authentication_config:** - **fallback_retry_count:** Type: integer - **mode:** Type: string - **reauthentication_timeout:** Type: integer - **bound_interfaces:** [Type: string] - **bypass_pair:** - **lan:** Type: string - **lan_state_propagation:** Type: boolean - **use_relay:** Type: boolean - **wan:** Type: string - **cellular_config:** - **apn_config:** - **apn:** Type: string - **authentication:** Type: string - **clear_password:** Type: boolean - **password:** Type: string - **password_encrypted:** Type: string - **user_name:** Type: string - **apnprofile_id:** Type: string - **auto_apn:** Type: boolean - **parent_module_id:** Type: string - **parent_sim_slot_number:** Type: integer - **description:** Type: string - **devicemgmt_policysetstack_id:** Type: string - **dhcp_relay:** - **enabled:** Type: boolean - **option_82:** - **circuit_id:** Type: string - **enabled:** Type: boolean - **reforwarding_policy:** Type: string - **remote_id:** Type: string - **server_ips:** [Type: string] - **source_interface:** Type: string - **directed_broadcast:** Type: boolean - **ethernet_port:** - **full_duplex:** Type: boolean - **port_id:** - **connector:** Type: string - **device:** Type: string - **disabled:** Type: boolean - **disabled_reason:** Type: string - **element_id:** Type: string - **id:** Type: string - **inactive:** Type: boolean - **inactive_reason:** Type: string - **max_mtu:** Type: integer - **max_speed:** Type: integer - **name:** Type: string - **original_mac_address:** Type: string - **region:** Type: string - **site_id:** Type: string - **tenant_id:** Type: string - **port_name:** Type: string - **speed:** Type: integer - **interface_profile_id:** Type: string - **ipfixcollectorcontext_id:** Type: string - **ipfixfiltercontext_id:** Type: string - **ipv4_config:** - **dhcp_config:** - **client_id:** Type: string - **hostname:** Type: string - **dns_v4_config:** - **name_servers:** [Type: string] - **search:** [Type: string] - **pppoe_config:** - **chap_passwd:** Type: string - **chap_user:** Type: string - **set_route:** Type: boolean - **routes:** - **destination:** Type: string - **via:** Type: string - **static_config:** - **address:** Type: string - **type:** Type: string - **ipv6_config:** - **dhcp_config:** - **client_id:** Type: string - **hostname:** Type: string - **dns_v6_config:** - **name_servers:** [Type: string] - **search:** [Type: string] - **routes:** - **destination:** Type: string - **via:** Type: string - **static_config:** - **address:** Type: string - **enable_prefix_distribution:** Type: boolean - **type:** Type: string - **lldp_enabled:** Type: boolean - **mac_address:** Type: string - **mtu:** Type: integer - **multicast_config:** - **igmp_version:** Type: string - **multicast_enabled:** Type: boolean - **name:** Type: string - **nat_address:** Type: string - **nat_address_v6:** Type: string - **nat_pools:** - **ipv4_ranges:** - **end:** Type: string - **start:** Type: string - **nat_pool_id:** Type: string - **nat_port:** Type: integer - **nat_port_v6:** Type: integer - **nat_zone_id:** Type: string - **network_context_id:** Type: string - **parent:** Type: string - **peer_bypasspair_wan_port_type:** Type: string - **poe_enabled:** Type: boolean - **power_usage_threshold:** Type: integer - **pppoe_config:** - **host_uniq:** Type: string - **ip_address_type:** Type: string - **password:** Type: string - **reconnection_delay:** Type: integer - **service_name:** Type: string - **username:** Type: string - **scope:** Type: string - **secondary_ip_configs:** - **ipv4_address:** Type: string - **scope:** Type: string - **service_link_config:** - **gre_config:** - **csum:** Type: boolean - **keepalive_enable:** Type: boolean - **keepalive_fail_count:** Type: integer - **keepalive_interval:** Type: integer - **ipsec_config:** - **authentication:** - **certificate:** Type: string - **certificate_profile_id:** Type: string - **comment:** Type: string - **ikev1_params:** - **xauth_id:** Type: string - **xauth_secret:** Type: string - **xauth_secret_encrypted:** Type: string - **xauth_secret_hash:** Type: string - **xauth_type:** Type: string - **local_ca_certificate:** Type: string - **local_id:** Type: string - **local_id_custom:** Type: string - **local_pa_certificate_id:** Type: string - **pa_master_key_id:** Type: string - **passphrase:** Type: string - **passphrase_encrypted:** Type: string - **peer_id_check:** Type: string - **permit_peer_id_mismatch:** Type: boolean - **private_key:** Type: string - **private_key_encrypted:** Type: string - **remote_ca_certificate:** Type: string - **remote_id:** Type: string - **secret:** Type: string - **secret_encrypted:** Type: string - **secret_hash:** Type: string - **strict_validation_peer_extended_key_use:** Type: boolean - **type:** Type: string - **x509Objects:** - **certHolder:** Type: object - **certificate:** Type: string - **is_local_ca_cert_set:** Type: boolean - **is_remote_ca_cert_set:** Type: boolean - **keyPair:** Type: object - **local_ca_certificate:** Type: string - **local_ca_certs_set:** [Type: object] - **passphrase:** Type: string - **private_key:** Type: string - **remote_ca_certificate:** Type: string - **remote_ca_certs_set:** [Type: object] - **ipsec_profile_id:** Type: string - **last_parent:** Type: string - **parent:** Type: string - **peer:** - **hostname:** Type: string - **ip_addresses:** [Type: string] - **service_endpoint_id:** Type: string - **type:** Type: string - **site_wan_interface_ids:** [Type: string] - **static_arp_configs:** - **ipv4_address:** Type: string - **mac_address:** Type: string - **sub_interface:** - **vlan_id:** Type: integer - **switch_port_config:** - **access_vlan_id:** Type: integer - **bpdu_guard_enabled:** Type: boolean - **forward_fast_enabled:** Type: boolean - **native_vlan_id:** Type: integer - **root_guard_enabled:** Type: boolean - **storm_control_config:** - **broadcast_threshold:** Type: integer - **multicast_threshold:** Type: integer - **unicast_threshold:** Type: integer - **stp_port_cost:** Type: integer - **stp_port_enabled:** Type: boolean - **stp_port_priority:** Type: integer - **trunk_vlans:** [Type: string] - **vlan_mode:** Type: string - **voice_vlan_id:** Type: integer - **tags:** [Type: string] - **type:** Type: string - **used_for:** Type: string - **vlan_config:** - **element_vlan_unique_id:** Type: string - **mstp_instance:** Type: integer - **vlan_id:** Type: integer - **voice_enabled:** Type: boolean - **vrf_context_id:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def ipfix(self, site_id, element_id, ipfix_id, data, tenant_id=None, api_version="v2.0"): """ Update a IPFix Config (v2.0) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **ipfix_id**: IPFix ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **collector_config:** - **host:** Type: string - **host_port:** Type: integer - **ipfixcollectorcontext_id:** Type: string - **max_message_size:** Type: integer - **protocol:** Type: string - **description:** Type: string - **export_cache_timeout:** Type: integer - **filters:** - **app_def_ids:** [Type: string] - **dst_ports:** - **end:** Type: string - **start:** Type: string - **dst_prefixes_id:** Type: string - **ipfixfiltercontext_ids:** [Type: string] - **priority_traffic_types:** [Type: string] - **protocols:** [Type: string] - **rtp_transport_type:** Type: string - **src_ports:** - **end:** Type: string - **start:** Type: string - **src_prefixes_id:** Type: string - **wan_path_direction:** Type: string - **ipfixprofile_id:** Type: string - **ipfixtemplate_id:** Type: string - **name:** Type: string - **sampler:** - **algorithm:** Type: string - **time_interval:** Type: integer - **time_spacing:** Type: integer - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def ipfixcollectorcontexts(self, ipfixcollectorcontext_id, data, tenant_id=None, api_version="v2.0"): """ Update a IPFix Collector context (v2.0) **Parameters:**: - **ipfixcollectorcontext_id**: IPFix Collector Context ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **description:** Type: string - **name:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def ipfixfiltercontexts(self, ipfixfiltercontext_id, data, tenant_id=None, api_version="v2.0"): """ Update a IPFix Filter context (v2.0) **Parameters:**: - **ipfixfiltercontext_id**: IPFix Filter Context ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **description:** Type: string - **name:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def ipfixglobalprefixes(self, ipfixglobalprefix_id, data, tenant_id=None, api_version="v2.0"): """ Update a IPFix Global prefix (v2.0) **Parameters:**: - **ipfixglobalprefix_id**: IPFix Global Prefix ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **description:** Type: string - **ipv4_prefixes:** [Type: string] - **name:** Type: string - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def ipfixprofiles(self, ipfixprofile_id, data, tenant_id=None, api_version="v2.0"): """ Update a IPFix Profile (v2.0) **Parameters:**: - **ipfixprofile_id**: IPFix Profile ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **collector_config:** - **host:** Type: string - **host_port:** Type: integer - **ipfixcollectorcontext_id:** Type: string - **max_message_size:** Type: integer - **protocol:** Type: string - **description:** Type: string - **export_cache_timeout:** Type: integer - **filters:** - **app_def_ids:** [Type: string] - **dst_ports:** - **end:** Type: string - **start:** Type: string - **dst_prefixes_id:** Type: string - **ipfixfiltercontext_ids:** [Type: string] - **priority_traffic_types:** [Type: string] - **protocols:** [Type: string] - **rtp_transport_type:** Type: string - **src_ports:** - **end:** Type: string - **start:** Type: string - **src_prefixes_id:** Type: string - **wan_path_direction:** Type: string - **ipfixtemplate_id:** Type: string - **name:** Type: string - **sampler:** - **algorithm:** Type: string - **time_interval:** Type: integer - **time_spacing:** Type: integer - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def ipfixtemplates(self, ipfixtemplate_id, data, tenant_id=None, api_version="v2.0"): """ Update a IPFix template (v2.0) **Parameters:**: - **ipfixtemplate_id**: IPFix Template ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **description:** Type: string - **flow_fields:** [Type: string] - **generate_biflow:** Type: boolean - **name:** Type: string - **option_export_timeout:** Type: integer - **options:** [Type: string] - **tags:** [Type: string] - **template_export_timeout:** Type: integer **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def ipsecprofiles(self, ipsecprofile_id, data, tenant_id=None, api_version="v2.1"): """ Update a IPSECProfile (v2.1) **Parameters:**: - **ipsecprofile_id**: IPSEC Profile ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Payload Attributes:** - **authentication:** - **certificate:** Type: string - **certificate_profile_id:** Type: string - **comment:** Type: string - **ikev1_params:** - **xauth_id:** Type: string - **xauth_secret:** Type: string - **xauth_secret_encrypted:** Type: string - **xauth_secret_hash:** Type: string - **xauth_type:** Type: string - **local_ca_certificate:** Type: string - **local_id:** Type: string - **local_id_custom:** Type: string - **local_pa_certificate_id:** Type: string - **pa_master_key_id:** Type: string - **passphrase:** Type: string - **passphrase_encrypted:** Type: string - **peer_id_check:** Type: string - **permit_peer_id_mismatch:** Type: boolean - **private_key:** Type: string - **private_key_encrypted:** Type: string - **remote_ca_certificate:** Type: string - **remote_id:** Type: string - **secret:** Type: string - **secret_encrypted:** Type: string - **secret_hash:** Type: string - **strict_validation_peer_extended_key_use:** Type: boolean - **type:** Type: string - **x509Objects:** - **certHolder:** Type: object - **certificate:** Type: string - **is_local_ca_cert_set:** Type: boolean - **is_remote_ca_cert_set:** Type: boolean - **keyPair:** Type: object - **local_ca_certificate:** Type: string - **local_ca_certs_set:** [Type: object] - **passphrase:** Type: string - **private_key:** Type: string - **remote_ca_certificate:** Type: string - **remote_ca_certs_set:** [Type: object] - **description:** Type: string - **dpd_delay:** Type: integer - **dpd_enable:** Type: boolean - **dpd_timeout:** Type: integer - **esp_group:** - **force_encapsulation:** Type: boolean - **lifesize:** - **units:** Type: string - **value:** Type: integer - **lifetime:** Type: integer - **lifetime_units:** Type: string - **mode:** Type: string - **proposals:** - **dh_groups:** Type: string - **encryption:** Type: string - **hash:** Type: string - **responder_sase_proposals:** - **dh_group:** [Type: string] - **encryption:** [Type: string] - **hash:** [Type: string] - **ike_group:** - **aggressive:** Type: boolean - **authentication_multiple:** Type: integer - **key_exchange:** Type: string - **lifetime:** Type: integer - **lifetime_units:** Type: string - **port:** Type: integer - **proposals:** - **dh_groups:** Type: string - **encryption:** Type: string - **hash:** Type: string - **reauth:** Type: boolean - **name:** Type: string - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def lannetworks(self, site_id, lannetwork_id, data, tenant_id=None, api_version="v3.3"): """ Update an existing LAN (v3.3) **Parameters:**: - **site_id**: Site ID - **lannetwork_id**: LAN Network ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v3.3) **Payload Attributes:** - **description:** Type: string - **ipv4_config:** - **default_routers:** [Type: string] - **dhcp_relay:** - **enabled:** Type: boolean - **option_82:** - **circuit_id:** Type: string - **enabled:** Type: boolean - **reforwarding_policy:** Type: string - **remote_id:** Type: string - **server_ips:** [Type: string] - **source_interface:** Type: string - **dhcp_server:** - **broadcast_address:** Type: string - **custom_options:** - **option_definition:** Type: string - **option_value:** Type: string - **default_lease_time:** Type: integer - **description:** Type: string - **disabled:** Type: boolean - **dns_servers:** [Type: string] - **domain_name:** Type: string - **gateway:** Type: string - **id:** Type: string - **ip_ranges:** - **end_ip:** Type: string - **start_ip:** Type: string - **max_lease_time:** Type: integer - **network_context_id:** Type: string - **static_mappings:** - **ip_address:** Type: string - **mac:** Type: string - **name:** Type: string - **subnet:** Type: string - **tags:** [Type: string] - **prefixes:** [Type: string] - **ipv6_config:** - **default_routers:** [Type: string] - **prefixes:** [Type: string] - **name:** Type: string - **network_context_id:** Type: string - **scope:** Type: string - **tags:** [Type: string] - **vrf_context_id:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def localprefixfilters(self, localprefixfilter_id, data, tenant_id=None, api_version="v2.0"): """ Update a new local prefix filter. (v2.0) **Parameters:**: - **localprefixfilter_id**: Local Prefix Filter ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **description:** Type: string - **name:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def machine_cellular_modules_firmware(self, machine_id, cellular_module_id, data, tenant_id=None, api_version="v2.0"): """ Update cellular module firmware configuration (v2.0) **Parameters:**: - **machine_id**: Machine ID - **cellular_module_id**: Cellular Module ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **cellular_module_image_ids:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_id. raise TypeError("tenant_id is required but not set or cached.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/machines/{}/cellular_modules/{}/firmware".format(api_version, tenant_id, machine_id, cellular_module_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "put", data=data) def mstp_instances(self, site_id, element_id, mstp_instance_id, data, tenant_id=None, api_version="v2.0"): """ Update a MSTP Instance (v2.0) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **mstp_instance_id**: MSTP Instance ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **description:** Type: string - **instance_number:** Type: integer - **instance_priority:** Type: integer - **name:** Type: string - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def multicastglobalconfigs(self, site_id, element_id, multicastglobalconfig_id, data, tenant_id=None, api_version="v2.1"): """ Update Multicast config (v2.1) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **multicastglobalconfig_id**: Multicast Global Config ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Payload Attributes:** - **bsm_enabled:** Type: boolean - **dr_priority:** Type: integer - **igmp_protocol_parameters:** - **last_member_query_count:** Type: integer - **last_member_query_interval:** Type: integer - **query_interval:** Type: integer - **query_max_response_time:** Type: integer - **pim_protocol_parameters:** - **hello_hold_time:** Type: integer - **hello_interval:** Type: integer - **join_prune_interval:** Type: integer - **spt_switchover_enabled:** Type: boolean **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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/{}/multicastglobalconfigs/{}".format(api_version, tenant_id, site_id, element_id, multicastglobalconfig_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "put", data=data) def multicastpeergroups(self, multicastpeergroup_id, data, tenant_id=None, api_version="v2.1"): """ Update multicast peer group (v2.1) **Parameters:**: - **multicastpeergroup_id**: Multicast Peer Group ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Payload Attributes:** - **description:** Type: string - **is_source_site_receiver:** Type: boolean - **name:** Type: string - **peer_sites:** - **peer_site_id:** Type: string - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def multicastrps(self, site_id, element_id, multicastrp_id, data, tenant_id=None, api_version="v2.0"): """ Updates Multicast RP config (v2.0) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **multicastrp_id**: Multicast RP ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **description:** Type: string - **groups:** - **ipv4_prefix:** Type: string - **is_active_rp:** Type: boolean - **ipv4_address:** Type: string - **name:** Type: string - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def multicastsourcesiteconfigs(self, site_id, multicastsourcesiteconfig_id, data, tenant_id=None, api_version="v2.0"): """ Update multicast source site config (v2.0) **Parameters:**: - **site_id**: Site ID - **multicastsourcesiteconfig_id**: Multicast Source Site Config ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **site_configs:** - **group_ipv4_prefix:** Type: string - **source_ipv4_address:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def natglobalprefixes(self, natglobalprefix_id, data, tenant_id=None, api_version="v2.0"): """ Update an existing NAT prefix. (v2.0) **Parameters:**: - **natglobalprefix_id**: NAT Global Prefix ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **description:** Type: string - **ipv4_prefixes:** [Type: string] - **name:** Type: string - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def natlocalprefixes(self, natlocalprefix_id, data, tenant_id=None, api_version="v2.0"): """ Update a NAT local prefix. (v2.0) **Parameters:**: - **natlocalprefix_id**: NAT Local Prefix ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **description:** Type: string - **name:** Type: string - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def natpolicypools(self, natpolicypool_id, data, tenant_id=None, api_version="v2.0"): """ Update a NAT Policy Pool. (v2.0) **Parameters:**: - **natpolicypool_id**: NAT Policy Pool ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **description:** Type: string - **name:** Type: string - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def natpolicyrules(self, natpolicyset_id, natpolicyrule_id, data, tenant_id=None, api_version="v2.0"): """ Update policy rule of tenant. (v2.0) **Parameters:**: - **natpolicyset_id**: NAT Policy Set ID - **natpolicyrule_id**: NAT Policy Rule ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **actions:** - **nat_pool_id:** Type: string - **port:** Type: integer - **protocols:** [Type: string] - **type:** Type: string - **description:** Type: string - **destination_ports:** - **from:** Type: integer - **to:** Type: integer - **destination_prefixes:** - **description:** Type: string - **id:** Type: string - **ipv4_prefixes:** [Type: string] - **ipv6_prefixes:** [Type: string] - **name:** Type: string - **tags:** [Type: string] - **destination_prefixes_id:** Type: string - **destination_zone:** - **default_for_public_interfaces:** Type: boolean - **description:** Type: string - **disabled:** Type: boolean - **disabled_reason:** Type: string - **id:** Type: string - **inactive:** Type: boolean - **inactive_reason:** Type: string - **name:** Type: string - **region:** Type: string - **tags:** [Type: string] - **tenant_id:** Type: string - **destination_zone_id:** Type: string - **disabled:** Type: boolean - **disabled_reason:** Type: string - **enabled:** Type: boolean - **inactive:** Type: boolean - **inactive_reason:** Type: string - **name:** Type: string - **natpolicypools:** - **description:** Type: string - **id:** Type: string - **name:** Type: string - **tags:** [Type: string] - **policyset_id:** Type: string - **protocol:** Type: integer - **region:** Type: string - **source_ports:** - **from:** Type: integer - **to:** Type: integer - **source_prefixes:** - **description:** Type: string - **id:** Type: string - **ipv4_prefixes:** [Type: string] - **ipv6_prefixes:** [Type: string] - **name:** Type: string - **tags:** [Type: string] - **source_prefixes_id:** Type: string - **source_zone:** - **default_for_public_interfaces:** Type: boolean - **description:** Type: string - **disabled:** Type: boolean - **disabled_reason:** Type: string - **id:** Type: string - **inactive:** Type: boolean - **inactive_reason:** Type: string - **name:** Type: string - **region:** Type: string - **tags:** [Type: string] - **tenant_id:** Type: string - **source_zone_id:** Type: string - **tags:** [Type: string] - **tenant_id:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def natpolicysets(self, natpolicyset_id, data, tenant_id=None, api_version="v2.0"): """ Update NAT policy set. (v2.0) **Parameters:**: - **natpolicyset_id**: NAT Policy Set ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **clone_from:** Type: string - **description:** Type: string - **destination_zone_policyrule_order:** [Type: string] - **disabled:** Type: boolean - **disabled_reason:** Type: string - **inactive:** Type: boolean - **inactive_reason:** Type: string - **name:** Type: string - **policy_req_version:** Type: string - **policy_rules:** - **actions:** - **nat_pool_id:** Type: string - **port:** Type: integer - **protocols:** [Type: string] - **type:** Type: string - **description:** Type: string - **destination_ports:** - **from:** Type: integer - **to:** Type: integer - **destination_prefixes:** - **description:** Type: string - **id:** Type: string - **ipv4_prefixes:** [Type: string] - **ipv6_prefixes:** [Type: string] - **name:** Type: string - **tags:** [Type: string] - **destination_prefixes_id:** Type: string - **destination_zone:** - **default_for_public_interfaces:** Type: boolean - **description:** Type: string - **disabled:** Type: boolean - **disabled_reason:** Type: string - **id:** Type: string - **inactive:** Type: boolean - **inactive_reason:** Type: string - **name:** Type: string - **region:** Type: string - **tags:** [Type: string] - **tenant_id:** Type: string - **destination_zone_id:** Type: string - **disabled:** Type: boolean - **disabled_reason:** Type: string - **enabled:** Type: boolean - **id:** Type: string - **inactive:** Type: boolean - **inactive_reason:** Type: string - **name:** Type: string - **natpolicypools:** - **description:** Type: string - **id:** Type: string - **name:** Type: string - **tags:** [Type: string] - **policyset_id:** Type: string - **protocol:** Type: integer - **region:** Type: string - **source_ports:** - **from:** Type: integer - **to:** Type: integer - **source_prefixes:** - **description:** Type: string - **id:** Type: string - **ipv4_prefixes:** [Type: string] - **ipv6_prefixes:** [Type: string] - **name:** Type: string - **tags:** [Type: string] - **source_prefixes_id:** Type: string - **source_zone:** - **default_for_public_interfaces:** Type: boolean - **description:** Type: string - **disabled:** Type: boolean - **disabled_reason:** Type: string - **id:** Type: string - **inactive:** Type: boolean - **inactive_reason:** Type: string - **name:** Type: string - **region:** Type: string - **tags:** [Type: string] - **tenant_id:** Type: string - **source_zone_id:** Type: string - **tags:** [Type: string] - **tenant_id:** Type: string - **region:** Type: string - **send_to_element:** Type: boolean - **source_zone_policyrule_order:** [Type: string] - **tags:** [Type: string] - **tenant_id:** Type: string - **update_order:** Type: boolean **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def natpolicysetstacks(self, natpolicysetstack_id, data, tenant_id=None, api_version="v2.0"): """ Update NAT Policy Set Stack. (v2.0) **Parameters:**: - **natpolicysetstack_id**: NAT Policy Set Stack ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **default_policysetstack:** Type: boolean - **description:** Type: string - **name:** Type: string - **policyset_ids:** [Type: string] - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def natzones(self, natzone_id, data, tenant_id=None, api_version="v2.0"): """ Update a Nat Policy Zone. (v2.0) **Parameters:**: - **natzone_id**: NAT Zone ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **default_for_public_interfaces:** Type: boolean - **description:** Type: string - **disabled:** Type: boolean - **disabled_reason:** Type: string - **inactive:** Type: boolean - **inactive_reason:** Type: string - **name:** Type: string - **region:** Type: string - **tags:** [Type: string] - **tenant_id:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def networkcontexts(self, networkcontext_id, data, tenant_id=None, api_version="v2.0"): """ Update LAN segment (v2.0) **Parameters:**: - **networkcontext_id**: Network Context ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **description:** Type: string - **name:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def networkpolicyglobalprefixes(self, networkpolicyglobalprefix_id, data, tenant_id=None, api_version="v2.1"): """ Update a Network global prefix. (v2.1) **Parameters:**: - **networkpolicyglobalprefix_id**: Network Policy Global Prefix ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Payload Attributes:** - **description:** Type: string - **ipv4_prefixes:** [Type: string] - **ipv6_prefixes:** [Type: string] - **name:** Type: string - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def networkpolicyrules(self, networkpolicyset_id, networkpolicyrule_id, data, tenant_id=None, api_version="v2.2"): """ Update network policy rule of tenant. (v2.2) **Parameters:**: - **networkpolicyset_id**: Network Policy Set ID - **networkpolicyrule_id**: Network Policy Rule ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.2) **Payload Attributes:** - **app_def_ids:** [Type: string] - **description:** Type: string - **destination_prefixes_id:** Type: string - **enabled:** Type: boolean - **name:** Type: string - **network_context_id:** Type: string - **order_number:** Type: integer - **paths_allowed:** - **active_paths:** - **label:** Type: string - **path_type:** Type: string - **backup_paths:** - **label:** Type: string - **path_type:** Type: string - **l3_failure_paths:** - **label:** Type: string - **path_type:** Type: string - **service_context:** - **active_service_label_id:** Type: string - **active_service_label_type:** Type: string - **backup_service_label_id:** Type: string - **backup_service_label_type:** Type: string - **type:** Type: string - **source_prefixes_id:** Type: string - **tags:** [Type: string] - **user_or_group:** - **user_group_ids:** [Type: string] - **user_ids:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def networkpolicysets(self, networkpolicyset_id, data, tenant_id=None, api_version="v2.0"): """ Update Network Policy Set. (v2.0) **Parameters:**: - **networkpolicyset_id**: Network Policy Set ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **clone_from:** Type: string - **defaultrule_policyset:** Type: boolean - **description:** Type: string - **disabled:** Type: boolean - **disabled_reason:** Type: string - **inactive:** Type: boolean - **inactive_reason:** Type: string - **name:** Type: string - **policy_req_version:** Type: string - **policy_rules:** - **app_def_ids:** [Type: string] - **description:** Type: string - **destination_prefixes_id:** Type: string - **enabled:** Type: boolean - **id:** Type: string - **name:** Type: string - **network_context_id:** Type: string - **order_number:** Type: integer - **paths_allowed:** - **active_paths:** - **label:** Type: string - **path_type:** Type: string - **backup_paths:** - **label:** Type: string - **path_type:** Type: string - **l3_failure_paths:** - **label:** Type: string - **path_type:** Type: string - **service_context:** - **active_service_label_id:** Type: string - **active_service_label_type:** Type: string - **backup_service_label_id:** Type: string - **backup_service_label_type:** Type: string - **type:** Type: string - **source_prefixes_id:** Type: string - **tags:** [Type: string] - **region:** Type: string - **send_to_element:** Type: boolean - **tags:** [Type: string] - **tenant_id:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def networkpolicysetstacks(self, networkpolicysetstack_id, data, tenant_id=None, api_version="v2.0"): """ Update a NetworkPolicySetStack (v2.0) **Parameters:**: - **networkpolicysetstack_id**: Network Policy Set Stack ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **default_policysetstack:** Type: boolean - **defaultrule_policyset:** - **clone_from:** Type: string - **defaultrule_policyset:** Type: boolean - **description:** Type: string - **disabled:** Type: boolean - **disabled_reason:** Type: string - **id:** Type: string - **inactive:** Type: boolean - **inactive_reason:** Type: string - **name:** Type: string - **policy_req_version:** Type: string - **policy_rules:** - **app_def_ids:** [Type: string] - **description:** Type: string - **destination_prefixes_id:** Type: string - **enabled:** Type: boolean - **id:** Type: string - **name:** Type: string - **network_context_id:** Type: string - **order_number:** Type: integer - **paths_allowed:** - **active_paths:** - **label:** Type: string - **path_type:** Type: string - **backup_paths:** - **label:** Type: string - **path_type:** Type: string - **l3_failure_paths:** - **label:** Type: string - **path_type:** Type: string - **service_context:** - **active_service_label_id:** Type: string - **active_service_label_type:** Type: string - **backup_service_label_id:** Type: string - **backup_service_label_type:** Type: string - **type:** Type: string - **source_prefixes_id:** Type: string - **tags:** [Type: string] - **region:** Type: string - **send_to_element:** Type: boolean - **tags:** [Type: string] - **tenant_id:** Type: string - **defaultrule_policyset_id:** Type: string - **description:** Type: string - **disabled:** Type: boolean - **disabled_reason:** Type: string - **inactive:** Type: boolean - **inactive_reason:** Type: string - **legacy_policystack:** Type: boolean - **name:** Type: string - **policyset_ids:** [Type: string] - **policysets:** - **clone_from:** Type: string - **description:** Type: string - **disabled:** Type: boolean - **disabled_reason:** Type: string - **id:** Type: string - **inactive:** Type: boolean - **inactive_reason:** Type: string - **name:** Type: string - **policy_rules:** - **description:** Type: string - **disabled:** Type: boolean - **disabled_reason:** Type: string - **id:** Type: string - **inactive:** Type: boolean - **inactive_reason:** Type: string - **name:** Type: string - **policyset_id:** Type: string - **region:** Type: string - **tags:** [Type: string] - **tenant_id:** Type: string - **region:** Type: string - **send_to_element:** Type: boolean - **tags:** [Type: string] - **tenant_id:** Type: string - **region:** Type: string - **tags:** [Type: string] - **tenant_id:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def ngfwsecuritypolicyglobalprefixes(self, ngfwsecuritypolicyglobalprefix_id, data, tenant_id=None, api_version="v2.1"): """ Update an existing Security Policy V2 Global Prefix (v2.1) **Parameters:**: - **ngfwsecuritypolicyglobalprefix_id**: NGFW Security Policy Global Prefix ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Payload Attributes:** - **description:** Type: string - **ipv4_prefixes:** [Type: string] - **ipv6_prefixes:** [Type: string] - **name:** Type: string - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def ngfwsecuritypolicylocalprefixes(self, ngfwsecuritypolicylocalprefix_id, data, tenant_id=None, api_version="v2.0"): """ Update an existing Security Policy V2 Local Prefix (v2.0) **Parameters:**: - **ngfwsecuritypolicylocalprefix_id**: NGFW Security Policy Local Prefix ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **description:** Type: string - **name:** Type: string - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def ngfwsecuritypolicyrules(self, ngfwsecuritypolicyset_id, ngfwsecuritypolicyrule_id, data, tenant_id=None, api_version="v2.1"): """ Update 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 - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Payload Attributes:** - **action:** Type: string - **app_def_ids:** [Type: string] - **description:** Type: string - **destination_prefix_ids:** [Type: string] - **destination_zone_ids:** [Type: string] - **enabled:** Type: boolean - **name:** Type: string - **services:** - **destination_ports:** - **from:** Type: integer - **to:** Type: integer - **protocol:** Type: integer - **source_ports:** - **from:** Type: integer - **to:** Type: integer - **source_prefix_ids:** [Type: string] - **source_zone_ids:** [Type: string] - **tags:** [Type: string] - **user_or_group:** - **user_group_ids:** [Type: string] - **user_ids:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def ngfwsecuritypolicysets(self, ngfwsecuritypolicyset_id, data, tenant_id=None, api_version="v2.0"): """ Update an existing Security Policy V2 Set (v2.0) **Parameters:**: - **ngfwsecuritypolicyset_id**: NGFW Security Policy Set ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **clone_from:** Type: string - **defaultrule_policyset:** Type: boolean - **description:** Type: string - **name:** Type: string - **policyrule_order:** [Type: string] - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def ngfwsecuritypolicysetstacks(self, ngfwsecuritypolicysetstack_id, data, tenant_id=None, api_version="v2.0"): """ Update an existing Security Policy V2 Set Stack (v2.0) **Parameters:**: - **ngfwsecuritypolicysetstack_id**: NGFW Security Policy Set Stack ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **defaultrule_policyset_id:** Type: string - **description:** Type: string - **name:** Type: string - **policyset_ids:** [Type: string] - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def ntp(self, element_id, ntp_id, data, tenant_id=None, api_version="v2.0"): """ Update an existing element NTP. (v2.0) **Parameters:**: - **element_id**: Element (Device) ID - **ntp_id**: NTP Configuration ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **description:** Type: string - **name:** Type: string - **ntp_servers:** - **host:** Type: string - **max_poll:** Type: integer - **min_poll:** Type: integer - **version:** Type: integer - **source_interface_ids:** [Type: string] - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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/{}/ntp/{}".format(api_version, tenant_id, element_id, ntp_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "put", data=data) def otpaccessconfigs(self, otpaccessconfig_id, data, tenant_id=None, api_version="v2.0"): """ Update an OTP Access for all elements under an Tenant. (v2.0) **Parameters:**: - **otpaccessconfig_id**: OTP Access configuration ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **otp_attempts:** Type: integer - **otp_validity_minutes:** Type: integer **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_id. raise TypeError("tenant_id is required but not set or cached.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/otpaccessconfigs/{}".format(api_version, tenant_id, otpaccessconfig_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "put", data=data) def pathgroups(self, pathgroup_id, data, tenant_id=None, api_version="v2.1"): """ Update A Path Group of a tenant. (v2.1) **Parameters:**: - **pathgroup_id**: Path Group ID (for network service/DC routing) - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Payload Attributes:** - **description:** Type: string - **name:** Type: string - **paths:** - **label:** Type: string - **path_type:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def perfmgmtpolicysets(self, perfmgmtpolicyset_id, data, tenant_id=None, api_version="v2.0"): """ PUT Perfmgmtpolicysets API Function **Parameters:**: - **perfmgmtpolicyset_id**: Performance Management Policy Set ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def perfmgmtpolicysets_perfmgmtpolicyrules(self, perfmgmtpolicyset_id, perfmgmtpolicyrule_id, data, tenant_id=None, api_version="v2.0"): """ PUT Perfmgmtpolicysets_Perfmgmtpolicyrules API Function **Parameters:**: - **perfmgmtpolicyset_id**: Performance Management Policy Set ID - **perfmgmtpolicyrule_id**: Performance Management Policy Rule ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def perfmgmtpolicysetstacks(self, perfmgmtpolicysetstack_id, data, tenant_id=None, api_version="v2.0"): """ PUT Perfmgmtpolicysetstacks API Function **Parameters:**: - **perfmgmtpolicysetstack_id**: Performance Management Policy Set Stack ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def perfmgmtthresholdprofiles(self, perfmgmtthresholdprofile_id, data, tenant_id=None, api_version="v2.0"): """ PUT Perfmgmtthresholdprofiles API Function **Parameters:**: - **perfmgmtthresholdprofile_id**: Performance Management Policy Threshold Profile ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def policyrules(self, policyset_id, policyrule_id, data, tenant_id=None, api_version="v3.1"): """ Update policy rule of tenant. (v3.1) **Parameters:**: - **policyset_id**: Policy Set ID - **policyrule_id**: Policy Rule ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v3.1) **Payload Attributes:** - **app_def_id:** Type: string - **description:** Type: string - **name:** Type: string - **network_context_id:** Type: string - **paths_allowed:** - **active_paths:** - **label:** Type: string - **path_type:** Type: string - **backup_paths:** - **label:** Type: string - **path_type:** Type: string - **l3_failure_paths:** - **label:** Type: string - **path_type:** Type: string - **priority_num:** Type: integer - **service_context:** - **active_service_label_id:** Type: string - **active_service_label_type:** Type: string - **backup_service_label_id:** Type: string - **backup_service_label_type:** Type: string - **type:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def policysets(self, policyset_id, data, tenant_id=None, api_version="v3.0"): """ Update policy set. (v3.0) **Parameters:**: - **policyset_id**: Policy Set ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v3.0) **Payload Attributes:** - **bandwidth_allocation_schemes:** - **bandwidth_range:** - **high:** Type: number - **low:** Type: number - **business_priorities:** - **bandwidth_allocation:** Type: number - **bandwidth_split_per_type:** - **bulk:** Type: number - **rt_audio:** Type: number - **rt_video:** Type: number - **transactional:** Type: number - **priority_num:** Type: integer - **business_priority_names:** - **priority_name:** Type: string - **priority_num:** Type: integer - **default_policy:** Type: boolean - **description:** Type: string - **name:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def prefixfilters(self, site_id, prefixfilter_id, data, tenant_id=None, api_version="v2.0"): """ Update an existing security prefix filter (v2.0) **Parameters:**: - **site_id**: Site ID - **prefixfilter_id**: Prefix Filter ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **filters:** - **type:** Type: string - **prefix_filter_id:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def prioritypolicyglobalprefixes(self, prioritypolicyglobalprefix_id, data, tenant_id=None, api_version="v2.1"): """ Update a Priority global prefix. (v2.1) **Parameters:**: - **prioritypolicyglobalprefix_id**: Priority Policy Global Prefix ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Payload Attributes:** - **description:** Type: string - **ipv4_prefixes:** [Type: string] - **ipv6_prefixes:** [Type: string] - **name:** Type: string - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def prioritypolicyrules(self, prioritypolicyset_id, prioritypolicyrule_id, data, tenant_id=None, api_version="v2.1"): """ Update priority policy rule of tenant. (v2.1) **Parameters:**: - **prioritypolicyset_id**: Priority Policy Set ID - **prioritypolicyrule_id**: Priority Policy Rule ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Payload Attributes:** - **app_def_ids:** [Type: string] - **description:** Type: string - **destination_prefixes_id:** Type: string - **dscp:** - **value:** Type: integer - **enabled:** Type: boolean - **name:** Type: string - **network_context_id:** Type: string - **order_number:** Type: integer - **priority_number:** Type: integer - **source_prefixes_id:** Type: string - **tags:** [Type: string] - **user_or_group:** - **user_group_ids:** [Type: string] - **user_ids:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def prioritypolicysets(self, prioritypolicyset_id, data, tenant_id=None, api_version="v2.0"): """ Update Priority Policy Set. (v2.0) **Parameters:**: - **prioritypolicyset_id**: Priority Policy Set ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **bandwidth_allocation_schemes:** - **bandwidth_range:** - **high:** Type: number - **low:** Type: number - **business_priorities:** - **bandwidth_allocation:** Type: number - **bandwidth_split_per_type:** - **bulk:** Type: number - **rt_audio:** Type: number - **rt_video:** Type: number - **transactional:** Type: number - **priority_number:** Type: integer - **business_priority_names:** - **priority_name:** Type: string - **priority_num:** Type: integer - **clone_from:** Type: string - **default_rule_dscp_mappings:** - **dscp:** [Type: integer] - **priority_number:** Type: integer - **transfer_type:** Type: string - **defaultrule_policyset:** Type: boolean - **description:** Type: string - **name:** Type: string - **tags:** [Type: string] - **template:** Type: boolean **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def prioritypolicysetstacks(self, prioritypolicysetstack_id, data, tenant_id=None, api_version="v2.0"): """ Update a PriorityPolicySetStack (v2.0) **Parameters:**: - **prioritypolicysetstack_id**: Priority Policy Stack ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **default_policysetstack:** Type: boolean - **defaultrule_policyset_id:** Type: string - **description:** Type: string - **name:** Type: string - **policyset_ids:** [Type: string] - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def prismaaccess_configs(self, site_id, prismaaccess_config_id, data, tenant_id=None, api_version="v2.0"): """ Update 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 - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **remote_networks:** - **edge_location_display:** Type: string - **edge_location_value:** Type: string - **remote_network_names:** [Type: string] - **service_link_ids:** [Type: string] - **spn_name:** Type: string - **site_id:** Type: string - **tenant_id:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def prismasase_connections(self, site_id, prismasase_connection_id, data, tenant_id=None, api_version="v2.0"): """ PUT Prismasase_Connections API Function **Parameters:**: - **site_id**: Site ID - **prismasase_connection_id**: Prisma SASE Connection ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def prismasase_connections_configs(self, data, tenant_id=None, api_version="v2.0"): """ PUT Prismasase_Connections_Configs API Function **Parameters:**: - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def radii(self, element_id, radii_id, data, tenant_id=None, api_version="v2.0"): """ Used for element radius configuration updates (v2.0) **Parameters:**: - **element_id**: Element (Device) ID - **radii_id**: Radii ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **description:** Type: string - **name:** Type: string - **override_indicator:** [Type: string] - **radius_configuration:** - **accounting_port:** Type: integer - **authentication_port:** Type: integer - **ip_version:** Type: integer - **priority:** Type: integer - **retain_shared_secret:** Type: boolean - **server_ip_address:** Type: string - **shared_secret:** Type: string - **shared_secret_encrypted:** Type: string - **radius_profile_id:** Type: string - **source_interface_id:** Type: string - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def recovery_tokens(self, machine_id, recovery_token_id, data, tenant_id=None, api_version="v2.1"): """ Update Recovery Token for Fips change mode (v2.1) **Parameters:**: - **machine_id**: Machine ID - **recovery_token_id**: Recovery Token ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Payload Attributes:** - **token_validity_in_hour:** Type: integer **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_id. raise TypeError("tenant_id is required but not set or cached.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/machines/{}/recovery_tokens/{}".format(api_version, tenant_id, machine_id, recovery_token_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "put", data=data) def roles(self, role_id, data, tenant_id=None, api_version="v2.1"): """ Update a custom role (v2.1) **Parameters:**: - **role_id**: Role ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Payload Attributes:** - **custom_permissions:** - **allowed_after_ms:** Type: integer - **allowed_before_ms:** Type: integer - **disabled:** Type: boolean - **disabled_reason:** Type: string - **disallow_permission:** Type: boolean - **id:** Type: string - **inactive:** Type: boolean - **inactive_reason:** Type: string - **region:** Type: string - **tenant_id:** Type: string - **value:** Type: string - **description:** Type: string - **disabled:** Type: boolean - **disabled_reason:** Type: string - **disallow_permissions:** - **value:** Type: string - **inactive:** Type: boolean - **inactive_reason:** Type: string - **is_system_owned:** Type: boolean - **name:** Type: string - **permissions:** - **value:** Type: string - **region:** Type: string - **roles:** - **name:** Type: string - **tenant_id:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def routing_aspathaccesslists(self, site_id, element_id, routing_aspathaccesslist_id, data, tenant_id=None, api_version="v2.1"): """ Updates Access List (v2.1) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **routing_aspathaccesslist_id**: Routing AS-PATH Access List ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Payload Attributes:** - **as_path_regex_list:** - **as_path_regex:** Type: string - **order:** Type: integer - **permit:** Type: boolean - **auto_generated:** Type: boolean - **description:** Type: string - **name:** Type: string - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def routing_ipcommunitylists(self, site_id, element_id, routing_ipcommunitylist_id, data, tenant_id=None, api_version="v2.0"): """ Updates Community List (v2.0) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **routing_ipcommunitylist_id**: Routing IP Community List ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **auto_generated:** Type: boolean - **community_list:** - **community_str:** Type: string - **permit:** Type: boolean - **description:** Type: string - **name:** Type: string - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def routing_prefixlists(self, site_id, element_id, routing_prefixlist_id, data, tenant_id=None, api_version="v2.1"): """ Updates Prefix List (v2.1) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **routing_prefixlist_id**: Routing IP Prefix List ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Payload Attributes:** - **auto_generated:** Type: boolean - **description:** Type: string - **name:** Type: string - **prefix_filter_list:** - **ge:** Type: integer - **ipv6_prefix:** Type: string - **le:** Type: integer - **order:** Type: integer - **permit:** Type: boolean - **prefix:** Type: string - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def routing_routemaps(self, site_id, element_id, routing_routemap_id, data, tenant_id=None, api_version="v2.2"): """ Updates Route Map (v2.2) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **routing_routemap_id**: Routing Route Map ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.2) **Payload Attributes:** - **auto_generated:** Type: boolean - **description:** Type: string - **name:** Type: string - **route_map_entries:** - **continue_entry:** Type: string - **match:** - **as_path_id:** Type: string - **community_list_id:** Type: string - **ip_next_hop_id:** Type: string - **ip_prefix_list_id:** Type: string - **tag:** Type: integer - **order:** Type: integer - **permit:** Type: boolean - **set:** - **as_path_prepend:** Type: string - **community:** Type: string - **ip_next_hop:** Type: string - **local_preference:** Type: integer - **tag:** Type: integer - **weight:** Type: integer - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def sdwanapps_configs(self, sdwanapp_id, config_id, data, tenant_id=None, api_version="v2.0"): """ PUT Sdwanapps_Configs API Function **Parameters:**: - **sdwanapp_id**: SDWAN Application ID - **config_id**: SDWAN App Config ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def securitypolicyrules(self, securitypolicyset_id, securitypolicyrule_id, data, tenant_id=None, api_version="v2.0"): """ Update a tenant security policy rule. (v2.0) **Parameters:**: - **securitypolicyset_id**: Security Policy Set ID - **securitypolicyrule_id**: Security Policy Rule ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **action:** Type: string - **application_ids:** [Type: string] - **description:** Type: string - **destination_filter_ids:** [Type: string] - **destination_zone_ids:** [Type: string] - **disabled_flag:** Type: boolean - **name:** Type: string - **source_filter_ids:** [Type: string] - **source_zone_ids:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def securitypolicysets(self, securitypolicyset_id, data, tenant_id=None, api_version="v2.0"): """ Update a tenant security policy set. (v2.0) **Parameters:**: - **securitypolicyset_id**: Security Policy Set ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **description:** Type: string - **name:** Type: string - **policyrule_order:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def securityzones(self, securityzone_id, data, tenant_id=None, api_version="v2.0"): """ Update an existing security zone (v2.0) **Parameters:**: - **securityzone_id**: Security Zone (ZBFW) ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **description:** Type: string - **name:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def servicebindingmaps(self, servicebindingmap_id, data, tenant_id=None, api_version="v2.1"): """ Update a ServiceBindingMap (v2.1) **Parameters:**: - **servicebindingmap_id**: Service Binding Map ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Payload Attributes:** - **description:** Type: string - **is_default:** Type: boolean - **name:** Type: string - **service_bindings:** - **service_endpoint_ids:** [Type: string] - **service_label_id:** Type: string - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def serviceendpoints(self, serviceendpoint_id, data, tenant_id=None, api_version="v2.4"): """ Update a ServiceEndpoint (v2.4) **Parameters:**: - **serviceendpoint_id**: Service Endpoint ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.4) **Payload Attributes:** - **address:** - **city:** Type: string - **country:** Type: string - **post_code:** Type: string - **state:** Type: string - **street:** Type: string - **street2:** Type: string - **admin_up:** Type: boolean - **allow_enterprise_traffic:** Type: boolean - **description:** Type: string - **disable_tunnel_reoptimization:** Type: boolean - **liveliness_probe:** - **http:** - **failure_count:** Type: integer - **http_status_codes:** [Type: integer] - **interval:** Type: integer - **url:** Type: string - **icmp_ping:** - **failure_count:** Type: integer - **interval:** Type: integer - **ip_addresses:** [Type: string] - **location:** - **description:** Type: string - **latitude:** Type: number - **longitude:** Type: number - **name:** Type: string - **sase_properties:** - **allocated_bandwidth_mbps:** Type: integer - **allocated_sc_count:** Type: integer - **pa_compute_region_oid:** Type: string - **total_sc_bandwidth_mbps:** Type: integer - **service_link_peers:** - **hostnames:** [Type: string] - **ip_addresses:** [Type: string] - **site_id:** Type: string - **tags:** [Type: string] - **type:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def servicelabels(self, servicelabel_id, data, tenant_id=None, api_version="v2.1"): """ Update a ServiceLabel (v2.1) **Parameters:**: - **servicelabel_id**: Service Label ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Payload Attributes:** - **description:** Type: string - **name:** Type: string - **sase_properties:** - **active_sase_label:** Type: boolean - **tags:** [Type: string] - **type:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def site_admin_state(self, site_id, data, tenant_id=None, api_version="v3.0"): """ Update an existing site (v3.0) **Parameters:**: - **site_id**: Site ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v3.0) **Payload Attributes:** - **address:** - **city:** Type: string - **country:** Type: string - **post_code:** Type: string - **state:** Type: string - **street:** Type: string - **street2:** Type: string - **admin_state:** Type: string - **description:** Type: string - **element_cluster_role:** Type: string - **location:** - **description:** Type: string - **latitude:** Type: number - **longitude:** Type: number - **name:** Type: string - **policy_set_id:** Type: string - **security_policyset_id:** Type: string - **service_binding:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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/{}/admin_state".format(api_version, tenant_id, site_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "put", data=data) def site_extensions(self, site_id, extension_id, data, tenant_id=None, api_version="v2.0"): """ Update site level extension configuration (v2.0) **Parameters:**: - **site_id**: Site ID - **extension_id**: Extension ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **conf:** Type: object - **disabled:** Type: boolean - **entity_id:** Type: string - **name:** Type: string - **namespace:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def site_ipfixlocalprefixes(self, site_id, ipfixlocalprefix_id, data, tenant_id=None, api_version="v2.0"): """ Update a IPFix site prefix association (v2.0) **Parameters:**: - **site_id**: Site ID - **ipfixlocalprefix_id**: IPFix Local Prefix ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **ipv4_prefixes:** [Type: string] - **prefix_id:** Type: string - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def site_natlocalprefixes(self, site_id, natlocalprefix_id, data, tenant_id=None, api_version="v2.0"): """ Update an existing Site NAT Local prefix Association (v2.0) **Parameters:**: - **site_id**: Site ID - **natlocalprefix_id**: NAT Local Prefix ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **ipv4_prefixes:** [Type: string] - **prefix_id:** Type: string - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def site_networkpolicylocalprefixes(self, site_id, networkpolicylocalprefix_id, data, tenant_id=None, api_version="v2.1"): """ Update an existing Site Network policy local prefix (v2.1) **Parameters:**: - **site_id**: Site ID - **networkpolicylocalprefix_id**: Network Policy Local Prefix ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Payload Attributes:** - **ipv4_prefixes:** [Type: string] - **ipv6_prefixes:** [Type: string] - **prefix_id:** Type: string - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def site_ngfwsecuritypolicylocalprefixes(self, site_id, ngfwsecuritypolicylocalprefix_id, data, tenant_id=None, api_version="v2.1"): """ Update an existing security policy V2 local prefix site association (v2.1) **Parameters:**: - **site_id**: Site ID - **ngfwsecuritypolicylocalprefix_id**: NGFW Security Policy Local Prefix ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Payload Attributes:** - **ipv4_prefixes:** [Type: string] - **ipv6_prefixes:** [Type: string] - **prefix_id:** Type: string - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def site_prioritypolicylocalprefixes(self, site_id, prioritypolicylocalprefix_id, data, tenant_id=None, api_version="v2.1"): """ Update an existing Site Priority policy local prefix (v2.1) **Parameters:**: - **site_id**: Site ID - **prioritypolicylocalprefix_id**: Priority Policy Local Prefix ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Payload Attributes:** - **ipv4_prefixes:** [Type: string] - **ipv6_prefixes:** [Type: string] - **prefix_id:** Type: string - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def siteciphers(self, site_id, data, tenant_id=None, api_version="v2.0"): """ Update site cipher (v2.0) **Parameters:**: - **site_id**: Site ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **controller_connection_cipher:** Type: string - **site_id:** Type: string - **tenant_id:** Type: string - **vpn_ciphers:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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/{}/siteciphers".format(api_version, tenant_id, site_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "put", data=data) def sites(self, site_id, data, tenant_id=None, api_version="v4.9"): """ Update an existing site (v4.9) **Parameters:**: - **site_id**: Site ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v4.9) **Payload Attributes:** - **address:** - **city:** Type: string - **country:** Type: string - **post_code:** Type: string - **state:** Type: string - **street:** Type: string - **street2:** Type: string - **admin_state:** Type: string - **description:** Type: string - **element_cluster_role:** Type: string - **extended_tags:** - **key:** Type: string - **value:** Type: string - **value_type:** Type: string - **location:** - **description:** Type: string - **latitude:** Type: number - **longitude:** Type: number - **multicast_peer_group_id:** Type: string - **name:** Type: string - **nat_policysetstack_id:** Type: string - **network_policysetstack_id:** Type: string - **perfmgmt_policysetstack_id:** Type: string - **policy_set_id:** Type: string - **priority_policysetstack_id:** Type: string - **security_policyset_id:** Type: string - **security_policysetstack_id:** Type: string - **service_binding:** Type: string - **tags:** [Type: string] - **vrf_context_profile_id:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def sitesecurityzones(self, site_id, sitesecurityzone_id, data, tenant_id=None, api_version="v2.0"): """ Update an existing security zone (v2.0) **Parameters:**: - **site_id**: Site ID - **sitesecurityzone_id**: Site Security Zone ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **networks:** - **network_id:** Type: string - **network_type:** Type: string - **zone_id:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def snmpagents(self, site_id, element_id, snmpagent_id, data, tenant_id=None, api_version="v2.1"): """ Update SNMP Agent (v2.1) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **snmpagent_id**: SNMP Agent ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Payload Attributes:** - **description:** Type: string - **system_contact:** Type: string - **system_location:** Type: string - **tags:** [Type: string] - **v2_config:** - **community:** Type: string - **v3_config:** - **user_access:** - **auth_phrase:** Type: string - **auth_type:** Type: string - **enc_phrase:** Type: string - **enc_type:** Type: string - **engine_id:** Type: string - **security_level:** Type: string - **user_name:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def snmptraps(self, site_id, element_id, snmptrap_id, data, tenant_id=None, api_version="v2.0"): """ Update SNMP Trap (v2.0) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **snmptrap_id**: SNMP Trap ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **description:** Type: string - **enabled:** Type: boolean - **server_ip:** Type: string - **source_interface:** Type: string - **tags:** [Type: string] - **v2_config:** - **community:** Type: string - **v3_config:** - **user_access:** - **auth_phrase:** Type: string - **auth_type:** Type: string - **enc_phrase:** Type: string - **enc_type:** Type: string - **engine_id:** Type: string - **security_level:** Type: string - **user_name:** Type: string - **version:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def software(self, machine_id, software_id, data, tenant_id=None, api_version="v2.0"): """ Update Machine Software (v2.0) **Parameters:**: - **machine_id**: Machine ID - **software_id**: Software ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **scheduled_upgrade:** Type: string - **tenant_id:** Type: string - **upgrade_interval:** Type: integer - **upgrade_version:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_id. raise TypeError("tenant_id is required but not set or cached.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/machines/{}/software/{}".format(api_version, tenant_id, machine_id, software_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "put", data=data) def software_state(self, element_id, data, tenant_id=None, api_version="v2.0"): """ Upgrade an element (v2.0) **Parameters:**: - **element_id**: Element (Device) ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **download_interval:** Type: integer - **image_id:** Type: string - **interface_ids:** [Type: string] - **scheduled_download:** Type: string - **scheduled_upgrade:** Type: string - **upgrade_interval:** Type: integer **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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/{}/software/state".format(api_version, tenant_id, element_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "put", data=data) def spokeclusters(self, site_id, spokecluster_id, data, tenant_id=None, api_version="v2.0"): """ Update Spoke Cluster (v2.0) **Parameters:**: - **site_id**: Site ID - **spokecluster_id**: Spoke Cluster ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **advertisement_interval:** Type: number - **description:** Type: string - **name:** Type: string - **preempt:** Type: boolean - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def staticroutes(self, site_id, element_id, staticroute_id, data, tenant_id=None, api_version="v2.3"): """ Update static route (v2.3) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **staticroute_id**: Static Route ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.3) **Payload Attributes:** - **address_family:** Type: string - **description:** Type: string - **destination_prefix:** Type: string - **name:** Type: string - **network_context_id:** Type: string - **nexthop_reachability_probe:** Type: boolean - **nexthops:** - **admin_distance:** Type: integer - **nexthop_interface_id:** Type: string - **nexthop_ip:** Type: string - **self:** Type: boolean - **scope:** Type: string - **tags:** [Type: string] - **vrf_context_id:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def syslogserverprofiles(self, syslogserverprofile_id, data, tenant_id=None, api_version="v2.0"): """ Update Syslog Server Profile (v2.0) **Parameters:**: - **syslogserverprofile_id**: Sys Log Server Profile ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **description:** Type: string - **enable_flow_logging:** Type: boolean - **name:** Type: string - **protocol:** Type: string - **remote_ca_certificate:** Type: string - **server_fqdn:** Type: string - **server_ip:** Type: string - **server_port:** Type: integer - **severity_level:** Type: string - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def syslogservers(self, site_id, element_id, syslogserver_id, data, tenant_id=None, api_version="v2.2"): """ Update Syslog Server (v2.2) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **syslogserver_id**: SYSLOG server ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.2) **Payload Attributes:** - **description:** Type: string - **enable_flow_logging:** Type: boolean - **enabled:** Type: boolean - **name:** Type: string - **protocol:** Type: string - **remote_ca_certificate:** Type: string - **server_fqdn:** Type: string - **server_ip:** Type: string - **server_port:** Type: integer - **severity_level:** Type: string - **source_interface:** Type: string - **syslog_profile_id:** Type: string - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def templates_ntp(self, ntp_id, data, tenant_id=None, api_version="v2.0"): """ Update an existing NTP Template (v2.0) **Parameters:**: - **ntp_id**: NTP Configuration ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **default_template:** Type: boolean - **description:** Type: string - **name:** Type: string - **ntp_servers:** - **host:** Type: string - **max_poll:** Type: integer - **min_poll:** Type: integer - **version:** Type: integer - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def tenant_anynetlinks(self, anynetlink_id, data, tenant_id=None, api_version="v3.4"): """ PUT Tenant_Anynetlinks API Function **Parameters:**: - **anynetlink_id**: Anynet (Secure Fabric) Link ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v3.4) **Payload Attributes:** **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def tenant_ipfixlocalprefixes(self, ipfixlocalprefix_id, data, tenant_id=None, api_version="v2.0"): """ Update a IPFix local prefix (v2.0) **Parameters:**: - **ipfixlocalprefix_id**: IPFix Local Prefix ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **description:** Type: string - **name:** Type: string - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def tenant_networkpolicylocalprefixes(self, networkpolicylocalprefix_id, data, tenant_id=None, api_version="v2.0"): """ Update a Network Policy local prefix. (v2.0) **Parameters:**: - **networkpolicylocalprefix_id**: Network Policy Local Prefix ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **description:** Type: string - **name:** Type: string - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def tenant_operators(self, operator_id, data, tenant_id=None, api_version="v2.2"): """ Update a tenant operator (v2.2) **Parameters:**: - **operator_id**: Operator ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.2) **Payload Attributes:** - **addresses:** - **city:** Type: string - **country:** Type: string - **post_code:** Type: string - **state:** Type: string - **street:** Type: string - **street2:** Type: string - **custom_roles:** - **custom_permissions:** - **allowed_after_ms:** Type: integer - **allowed_before_ms:** Type: integer - **disabled:** Type: boolean - **disabled_reason:** Type: string - **disallow_permission:** Type: boolean - **id:** Type: string - **inactive:** Type: boolean - **inactive_reason:** Type: string - **region:** Type: string - **tenant_id:** Type: string - **value:** Type: string - **description:** Type: string - **disabled:** Type: boolean - **disabled_reason:** Type: string - **disallow_permissions:** - **value:** Type: string - **id:** Type: string - **inactive:** Type: boolean - **inactive_reason:** Type: string - **is_system_owned:** Type: boolean - **name:** Type: string - **permissions:** - **value:** Type: string - **region:** Type: string - **roles:** - **name:** Type: string - **tenant_id:** Type: string - **disable_idp_login:** Type: boolean - **disabled:** Type: boolean - **disabled_reason:** Type: string - **email:** Type: string - **email_iam:** Type: string - **email_validated:** Type: boolean - **enable_session_ip_lock:** Type: boolean - **first_name:** Type: string - **from_esp:** Type: boolean - **from_esp_name:** Type: string - **from_esp_tenant_id:** Type: string - **inactive:** Type: boolean - **inactive_reason:** Type: string - **ipv4_list:** - **ipv4:** Type: string - **is_locked:** Type: boolean - **is_system_owned:** Type: boolean - **last_login:** Type: string - **last_name:** Type: string - **linked_accounts:** - **disabled:** Type: boolean - **disabled_reason:** Type: string - **failed_login_attempts:** Type: integer - **id:** Type: string - **inactive:** Type: boolean - **inactive_reason:** Type: string - **provider_key:** Type: string - **provider_value:** Type: string - **provider_value_updated_on:** Type: integer - **region:** Type: string - **tenant_id:** Type: string - **migration_state:** - **phone_numbers:** - **country_code:** Type: integer - **local_extension:** Type: integer - **number:** Type: integer - **types:** - **value:** Type: string - **region:** Type: string - **roles:** - **name:** Type: string - **secondary_emails:** - **email:** Type: string - **settings:** Type: string - **tenant_id:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def tenant_permissions(self, permission_id, data, tenant_id=None, api_version="v2.0"): """ Update a custom permission (v2.0) **Parameters:**: - **permission_id**: Permission ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **allowed_after_ms:** Type: integer - **allowed_before_ms:** Type: integer - **disabled:** Type: boolean - **disabled_reason:** Type: string - **disallow_permission:** Type: boolean - **inactive:** Type: boolean - **inactive_reason:** Type: string - **region:** Type: string - **tenant_id:** Type: string - **value:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def tenant_prioritypolicylocalprefixes(self, prioritypolicylocalprefix_id, data, tenant_id=None, api_version="v2.0"): """ Update a Priority Policy local prefix. (v2.0) **Parameters:**: - **prioritypolicylocalprefix_id**: Priority Policy Local Prefix ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **description:** Type: string - **name:** Type: string - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def tenants(self, data, tenant_id=None, api_version="v2.8"): """ Update tenant (v2.8) **Parameters:**: - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.8) **Payload Attributes:** - **:** Type: string - **address:** - **city:** Type: string - **country:** Type: string - **post_code:** Type: string - **state:** Type: string - **street:** Type: string - **street2:** Type: string - **canonical_name:** Type: string - **clients:** [Type: string] - **csp_tenant_id:** Type: string - **description:** Type: string - **disabled:** Type: string - **disabled_reason:** Type: string - **inactive:** Type: string - **inactive_reason:** Type: string - **ipv4_list:** - **ipv4:** Type: string - **is_esp:** Type: boolean - **is_oneapp_ready:** Type: boolean - **is_pa_iot_security_license:** Type: boolean - **is_support:** Type: boolean - **name:** Type: string - **operator:** - **addresses:** - **city:** Type: string - **country:** Type: string - **post_code:** Type: string - **state:** Type: string - **street:** Type: string - **street2:** Type: string - **custom_roles:** - **custom_permissions:** - **allowed_after_ms:** Type: integer - **allowed_before_ms:** Type: integer - **disabled:** Type: boolean - **disabled_reason:** Type: string - **disallow_permission:** Type: boolean - **id:** Type: string - **inactive:** Type: boolean - **inactive_reason:** Type: string - **region:** Type: string - **tenant_id:** Type: string - **value:** Type: string - **disabled:** Type: boolean - **disallow_permissions:** - **value:** Type: string - **id:** Type: string - **inactive:** Type: boolean - **name:** Type: string - **permissions:** - **value:** Type: string - **roles:** - **name:** Type: string - **disable_idp_login:** Type: boolean - **disabled:** Type: boolean - **disabled_reason:** Type: string - **email:** Type: string - **email_iam:** Type: string - **email_validated:** Type: boolean - **enable_session_ip_lock:** Type: boolean - **first_name:** Type: string - **from_esp:** Type: boolean - **from_esp_name:** Type: string - **from_esp_tenant_id:** Type: string - **id:** Type: string - **inactive:** Type: boolean - **inactive_reason:** Type: string - **ipv4_list:** - **ipv4:** Type: string - **is_locked:** Type: boolean - **is_system_owned:** Type: boolean - **last_login:** Type: string - **last_name:** Type: string - **linked_accounts:** - **disabled:** Type: boolean - **disabled_reason:** Type: string - **failed_login_attempts:** Type: integer - **id:** Type: string - **inactive:** Type: boolean - **inactive_reason:** Type: string - **provider_key:** Type: string - **provider_value:** Type: string - **provider_value_updated_on:** Type: integer - **region:** Type: string - **tenant_id:** Type: string - **migration_state:** - **name:** Type: string - **phone_numbers:** - **country_code:** Type: integer - **local_extension:** Type: integer - **number:** Type: integer - **types:** - **value:** Type: string - **region:** Type: string - **roles:** - **name:** Type: string - **secondary_emails:** - **email:** Type: string - **settings:** Type: string - **tenant_id:** Type: string - **pan_account_id:** Type: string - **pan_tenant_id:** Type: string - **password_policy:** - **enable_failed_login_attempts:** Type: boolean - **enable_failed_login_time_delay:** Type: boolean - **enable_maximum_password_length:** Type: boolean - **enable_minimum_password_length:** Type: boolean - **enable_password_aging:** Type: boolean - **enable_password_identity_difference:** Type: boolean - **enable_password_no_reuse_count:** Type: boolean - **enable_session_ip_lock:** Type: boolean - **enable_two_lower_case_letters:** Type: boolean - **enable_two_numbers:** Type: boolean - **enable_two_special_characters:** Type: boolean - **enable_two_upper_case_letters:** Type: boolean - **failed_login_attempts:** Type: integer - **maximum_password_length:** Type: integer - **minimum_password_length:** Type: integer - **password_aging_days:** Type: integer - **password_aging_notification:** Type: integer - **password_no_reuse_count:** Type: integer - **special_characters:** Type: string - **special_characters_regex:** Type: string - **phone_numbers:** - **country_code:** Type: integer - **local_extension:** Type: integer - **number:** Type: integer - **types:** - **value:** Type: string - **prisma_access_tenant_id:** Type: string - **provider_data:** - **certificate:** - **certificate:** Type: string - **certificate_expiry_utc:** Type: integer - **certificate_type:** Type: string - **disabled:** Type: boolean - **disabled_reason:** Type: string - **id:** Type: string - **inactive:** Type: boolean - **inactive_reason:** Type: string - **issued_by:** - **common_name:** Type: string - **country:** Type: string - **location:** Type: string - **organization:** Type: string - **organization_unit:** Type: string - **state:** Type: string - **issued_to:** - **common_name:** Type: string - **country:** Type: string - **location:** Type: string - **organization:** Type: string - **organization_unit:** Type: string - **state:** Type: string - **parent_id:** - **region:** Type: string - **serial_number:** Type: string - **tenant_id:** Type: string - **version:** Type: string - **password_hash:** Type: string - **provider:** - **canonical_name:** Type: string - **description:** Type: string - **disabled:** Type: boolean - **disabled_reason:** Type: string - **id:** Type: string - **inactive:** Type: boolean - **inactive_reason:** Type: string - **map_external_group:** Type: object - **name:** Type: string - **protocol:** - **region:** Type: string - **template:** Type: string - **tenant_id:** Type: string - **salt:** Type: string - **security:** Type: string - **region:** Type: string - **sase_at:** Type: string - **telemetry_region:** Type: string - **tenant_id:** Type: string - **tsg_id:** Type: string - **tsg_instances:** - **app_id:** Type: string - **region:** Type: string - **tenant_id:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_id. raise TypeError("tenant_id is required but not set or cached.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}".format(api_version, tenant_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "put", data=data) def useridagents(self, useridagent_id, data, tenant_id=None, api_version="v2.0"): """ PUT Useridagents API Function **Parameters:**: - **useridagent_id**: User Id Agent ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def users(self, user_id, data, tenant_id=None, api_version="v2.0"): """ Put an user identity. (v2.0) **Parameters:**: - **user_id**: User ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **disabled:** Type: boolean - **disabled_reason:** Type: string - **first_name:** Type: string - **inactive:** Type: boolean - **inactive_reason:** Type: string - **last_name:** Type: string - **middle_name:** Type: string - **region:** Type: string - **tenant_id:** Type: string - **user_dn:** Type: string - **user_fqn:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def vfflicense_tokens(self, vfflicense_id, token_id, data, tenant_id=None, api_version="v2.0"): """ Update Tenant Vff License Token (v2.0) **Parameters:**: - **vfflicense_id**: Virtual Form Factor License ID - **token_id**: Token ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **ion_key:** Type: string - **is_expired:** Type: boolean - **is_multiuse:** Type: boolean - **is_revoked:** Type: boolean - **is_used:** Type: boolean - **secret_key:** Type: string - **valid_till_secs:** Type: integer - **vfflicense_id:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_id. raise TypeError("tenant_id is required but not set or cached.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/vfflicenses/{}/tokens/{}".format(api_version, tenant_id, vfflicense_id, token_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "put", data=data) def vpnlinks_state(self, vpnlink_id, data, tenant_id=None, api_version="v2.0"): """ Change the VPNLink admin state (v2.0) **Parameters:**: - **vpnlink_id**: VPN Link ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **al_id:** Type: string - **enabled:** Type: boolean **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_id. raise TypeError("tenant_id is required but not set or cached.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/vpnlinks/{}/state".format(api_version, tenant_id, vpnlink_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "put", data=data) def vrfcontextprofiles(self, vrfcontextprofile_id, data, tenant_id=None, api_version="v2.0"): """ PUT Vrfcontextprofiles API Function **Parameters:**: - **vrfcontextprofile_id**: VRF Context Profile ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def vrfcontexts(self, vrfcontext_id, data, tenant_id=None, api_version="v2.0"): """ PUT Vrfcontexts API Function **Parameters:**: - **vrfcontext_id**: VRF Context UD - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def waninterfacelabels(self, waninterfacelabel_id, data, tenant_id=None, api_version="v2.4"): """ Update specific WAN interface label (v2.4) **Parameters:**: - **waninterfacelabel_id**: WAN Interface Label ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.4) **Payload Attributes:** - **bwc_enabled:** Type: boolean - **description:** Type: string - **label:** Type: string - **lqm_enabled:** Type: boolean - **name:** Type: string - **tags:** [Type: string] - **use_for_application_reachability_probes:** Type: boolean - **use_for_controller_connections:** Type: boolean - **use_lqm_for_non_hub_paths:** Type: boolean - **vpnlink_configuration:** - **keep_alive_failure_count:** Type: integer - **keep_alive_interval:** Type: integer **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_id. raise TypeError("tenant_id is required but not set or cached.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/waninterfacelabels/{}".format(api_version, tenant_id, waninterfacelabel_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "put", data=data) def waninterfaces(self, site_id, waninterface_id, data, tenant_id=None, api_version="v2.7"): """ Update the Site WAN interface (v2.7) **Parameters:**: - **site_id**: Site ID - **waninterface_id**: WAN Interface ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.7) **Payload Attributes:** - **bfd_mode:** Type: string - **bw_config_mode:** Type: string - **bwc_enabled:** Type: boolean - **cost:** Type: integer - **description:** Type: string - **label_id:** Type: string - **link_bw_down:** Type: number - **link_bw_up:** Type: number - **lqm_config:** - **hub_site_ids:** [Type: string] - **inter_packet_gap:** Type: integer - **statistic:** Type: string - **lqm_enabled:** Type: boolean - **name:** Type: string - **network_id:** Type: string - **tags:** [Type: string] - **type:** Type: string - **use_for_application_reachability_probes:** Type: boolean - **use_for_controller_connections:** Type: boolean - **use_lqm_for_non_hub_paths:** Type: boolean - **vpnlink_configuration:** - **keep_alive_failure_count:** Type: integer - **keep_alive_interval:** Type: integer **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def wannetworks(self, wannetwork_id, data, tenant_id=None, api_version="v2.1"): """ Update an existing WAN (v2.1) **Parameters:**: - **wannetwork_id**: WAN Network ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Payload Attributes:** - **description:** Type: string - **name:** Type: string - **provider_as_numbers:** [Type: integer] - **tags:** [Type: string] - **type:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def wanoverlays(self, wanoverlay_id, data, tenant_id=None, api_version="v2.0"): """ Update app/wan context (v2.0) **Parameters:**: - **wanoverlay_id**: WAN Overlay ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **description:** Type: string - **name:** Type: string - **vni:** Type: integer **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) def ws_extensions(self, extension_id, data, tenant_id=None, api_version="v2.0"): """ PUT Ws_Extensions API Function **Parameters:**: - **extension_id**: Extension ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data) # 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`""" admin_state_i = element_admin_state """ Backwards-compatibility alias of `admin_state_i` to `element_admin_state`""" admin_state_s = site_admin_state """ Backwards-compatibility alias of `admin_state_s` to `site_admin_state`""" anynetlinks_t = tenant_anynetlinks """ Backwards-compatibility alias of `anynetlinks_t` to `tenant_anynetlinks`""" cellular_modules_e = element_cellular_modules """ Backwards-compatibility alias of `cellular_modules_e` to `element_cellular_modules`""" 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`""" deviceidconfigs = deviceidconfigs """ Backwards-compatibility alias of `deviceidconfigs` to `deviceidconfigs`""" deviceidconfigs_i = element_deviceidconfigs """ Backwards-compatibility alias of `deviceidconfigs_i` to `element_deviceidconfigs`""" 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`""" firmware_cellular_modules_e = element_cellular_modules_firmware """ Backwards-compatibility alias of `firmware_cellular_modules_e` to `element_cellular_modules_firmware`""" firmware_cellular_modules_m = machine_cellular_modules_firmware """ Backwards-compatibility alias of `firmware_cellular_modules_m` to `machine_cellular_modules_firmware`""" 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`""" 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`""" sim_security_cellular_modules = cellular_modules_sim_security """ Backwards-compatibility alias of `sim_security_cellular_modules` to `cellular_modules_sim_security`""" 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`""" state = element_state """ Backwards-compatibility alias of `state` to `element_state`""" state_software = software_state """ Backwards-compatibility alias of `state_software` to `software_state`""" state_vpnlinks = vpnlinks_state """ Backwards-compatibility alias of `state_vpnlinks` to `vpnlinks_state`""" tokens_vfflicenses = vfflicense_tokens """ Backwards-compatibility alias of `tokens_vfflicenses` to `vfflicense_tokens`"""
Ancestors (in MRO)
- Put
- builtins.object
Class variables
var access_elementusers
Backwards-compatibility alias of access_elementusers to elementusers_access
var admin_state_i
Backwards-compatibility alias of admin_state_i to element_admin_state
var admin_state_s
Backwards-compatibility alias of admin_state_s to site_admin_state
var anynetlinks_t
Backwards-compatibility alias of anynetlinks_t to tenant_anynetlinks
var cellular_modules_e
Backwards-compatibility alias of cellular_modules_e to element_cellular_modules
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 deviceidconfigs
Backwards-compatibility alias of deviceidconfigs to deviceidconfigs
var deviceidconfigs_i
Backwards-compatibility alias of deviceidconfigs_i to element_deviceidconfigs
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 firmware_cellular_modules_e
Backwards-compatibility alias of firmware_cellular_modules_e to element_cellular_modules_firmware
var firmware_cellular_modules_m
Backwards-compatibility alias of firmware_cellular_modules_m to machine_cellular_modules_firmware
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 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 sim_security_cellular_modules
Backwards-compatibility alias of sim_security_cellular_modules to cellular_modules_sim_security
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 state
Backwards-compatibility alias of state to element_state
var state_software
Backwards-compatibility alias of state_software to software_state
var state_vpnlinks
Backwards-compatibility alias of state_vpnlinks to vpnlinks_state
var tokens_vfflicenses
Backwards-compatibility alias of tokens_vfflicenses to vfflicense_tokens
Static methods
def apnprofiles(
self, apnprofile_id, data, tenant_id=None, api_version='v2.0')
Update an APN Profile (v2.0)
Parameters::
- apnprofile_id: APN Profile ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Payload Attributes:
- apn: Type: string
- authentication: Type: string
- clear_password: Type: boolean
- description: Type: string
- name: Type: string
- password: Type: string
- tags: [Type: string]
- user_name: Type: string
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def apnprofiles(self, apnprofile_id, data, tenant_id=None, api_version="v2.0"): """ Update an APN Profile (v2.0) **Parameters:**: - **apnprofile_id**: APN Profile ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **apn:** Type: string - **authentication:** Type: string - **clear_password:** Type: boolean - **description:** Type: string - **name:** Type: string - **password:** Type: string - **tags:** [Type: string] - **user_name:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def appdefs(
self, appdef_id, data, tenant_id=None, api_version='v2.5')
Update an application definition (v2.5)
Parameters::
- appdef_id: Application Definition ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.5)
Payload Attributes:
- abbreviation: Type: string
- aggregate_flows: Type: boolean
- app_type: Type: string
- app_unreachability_detection: Type: boolean
- category: Type: string
- conn_idle_timeout: Type: integer
- description: Type: string
- display_name: Type: string
- domains: [Type: string]
- ingress_traffic_pct: Type: integer
- ip_rules: [Type: object]
- is_deprecated: Type: boolean
- network_scan_application: Type: boolean
- order_number: Type: integer
- overrides_allowed: Type: boolean
- p_category: Type: string
- p_parent_id: Type: string
- p_sub_category: Type: string
- parent_id: Type: string
- path_affinity: Type: string
- session_timeout: Type: integer
- supported_engines: Type: string
- system_app_overridden: Type: boolean
- tags: [Type: string]
- tcp_rules: [Type: string]
- transfer_type: Type: string
- udp_rules: [Type: object]
- use_parentapp_network_policy: Type: boolean
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def appdefs(self, appdef_id, data, tenant_id=None, api_version="v2.5"): """ Update an application definition (v2.5) **Parameters:**: - **appdef_id**: Application Definition ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.5) **Payload Attributes:** - **abbreviation:** Type: string - **aggregate_flows:** Type: boolean - **app_type:** Type: string - **app_unreachability_detection:** Type: boolean - **category:** Type: string - **conn_idle_timeout:** Type: integer - **description:** Type: string - **display_name:** Type: string - **domains:** [Type: string] - **ingress_traffic_pct:** Type: integer - **ip_rules:** [Type: object] - **is_deprecated:** Type: boolean - **network_scan_application:** Type: boolean - **order_number:** Type: integer - **overrides_allowed:** Type: boolean - **p_category:** Type: string - **p_parent_id:** Type: string - **p_sub_category:** Type: string - **parent_id:** Type: string - **path_affinity:** Type: string - **session_timeout:** Type: integer - **supported_engines:** Type: string - **system_app_overridden:** Type: boolean - **tags:** [Type: string] - **tcp_rules:** [Type: string] - **transfer_type:** Type: string - **udp_rules:** [Type: object] - **use_parentapp_network_policy:** Type: boolean **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def appdefs_overrides(
self, appdef_id, override_id, data, tenant_id=None, api_version='v2.3')
Update a application definition overrides for system appdef (v2.3)
Parameters::
- appdef_id: Application Definition ID
- override_id: AppDef Override ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.3)
Payload Attributes:
- aggregate_flows: Type: boolean
- app_unreachability_detection: Type: boolean
- category: Type: string
- conn_idle_timeout: Type: integer
- description: Type: string
- domains: [Type: string]
- ingress_traffic_pct: Type: integer
- ip_rules:
- dest_filters: [Type: string]
- dest_prefixes: [Type: string]
- dscp:
- value: Type: integer
- protocol: Type: string
- src_filters: [Type: string]
- override_default_ip_rules: Type: boolean
- override_default_tcp_rules: Type: boolean
- override_default_udp_rules: Type: boolean
- override_domains: Type: boolean
- overrides_disable: Type: boolean
- p_category: Type: string
- path_affinity: Type: string
- session_timeout: Type: integer
- tags: [Type: string]
- tcp_rules:
- client_filters: [Type: string]
- client_port:
- end: Type: string
- start: Type: string
- dscp:
- value: Type: integer
- server_filters: [Type: string]
- server_port:
- end: Type: string
- start: Type: string
- server_prefixes: [Type: string]
- transfer_type: Type: string
- udp_rules:
- dest_prefixes: [Type: string]
- dscp:
- value: Type: integer
- udp_filters: [Type: string]
- udp_port:
- end: Type: string
- start: Type: string
- use_parentapp_network_policy: Type: boolean
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def appdefs_overrides(self, appdef_id, override_id, data, tenant_id=None, api_version="v2.3"): """ Update a application definition overrides for system appdef (v2.3) **Parameters:**: - **appdef_id**: Application Definition ID - **override_id**: AppDef Override ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.3) **Payload Attributes:** - **aggregate_flows:** Type: boolean - **app_unreachability_detection:** Type: boolean - **category:** Type: string - **conn_idle_timeout:** Type: integer - **description:** Type: string - **domains:** [Type: string] - **ingress_traffic_pct:** Type: integer - **ip_rules:** - **dest_filters:** [Type: string] - **dest_prefixes:** [Type: string] - **dscp:** - **value:** Type: integer - **protocol:** Type: string - **src_filters:** [Type: string] - **override_default_ip_rules:** Type: boolean - **override_default_tcp_rules:** Type: boolean - **override_default_udp_rules:** Type: boolean - **override_domains:** Type: boolean - **overrides_disable:** Type: boolean - **p_category:** Type: string - **path_affinity:** Type: string - **session_timeout:** Type: integer - **tags:** [Type: string] - **tcp_rules:** - **client_filters:** [Type: string] - **client_port:** - **end:** Type: string - **start:** Type: string - **dscp:** - **value:** Type: integer - **server_filters:** [Type: string] - **server_port:** - **end:** Type: string - **start:** Type: string - **server_prefixes:** [Type: string] - **transfer_type:** Type: string - **udp_rules:** - **dest_prefixes:** [Type: string] - **dscp:** - **value:** Type: integer - **udp_filters:** [Type: string] - **udp_port:** - **end:** Type: string - **start:** Type: string - **use_parentapp_network_policy:** Type: boolean **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def appdefs_version(
self, appdefs_version_id, data, tenant_id=None, api_version='v2.0')
Change standard apps version (v2.0)
Parameters::
- appdefs_version_id: Application Definition Version ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Payload Attributes:
- app_version: Type: string
- disabled: Type: boolean
- disabled_reason: Type: string
- inactive: Type: boolean
- inactive_reason: Type: string
- region: Type: string
- reqState: Type: string
- sigfile_url: Type: string
- tenant_id: Type: string
- uApp_version: Type: string
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def appdefs_version(self, appdefs_version_id, data, tenant_id=None, api_version="v2.0"): """ Change standard apps version (v2.0) **Parameters:**: - **appdefs_version_id**: Application Definition Version ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **app_version:** Type: string - **disabled:** Type: boolean - **disabled_reason:** Type: string - **inactive:** Type: boolean - **inactive_reason:** Type: string - **region:** Type: string - **reqState:** Type: string - **sigfile_url:** Type: string - **tenant_id:** Type: string - **uApp_version:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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_version/{}".format(api_version, tenant_id, appdefs_version_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "put", data=data)
def application_probe(
self, site_id, element_id, data, tenant_id=None, api_version='v2.0')
Update application probe configuration (v2.0)
Parameters::
- site_id: Site ID
- element_id: Element (Device) ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Payload Attributes:
- description: Type: string
- enable_probe: Type: boolean
- name: Type: string
- source_interface_id: Type: string
- tags: [Type: string]
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def application_probe(self, site_id, element_id, data, tenant_id=None, api_version="v2.0"): """ Update application probe configuration (v2.0) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **description:** Type: string - **enable_probe:** Type: boolean - **name:** Type: string - **source_interface_id:** Type: string - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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/{}/application_probe".format(api_version, tenant_id, site_id, element_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "put", data=data)
def bgpconfigs(
self, site_id, element_id, bgpconfig_id, data, tenant_id=None, api_version='v2.3')
Updates BGP config (v2.3)
Parameters::
- site_id: Site ID
- element_id: Element (Device) ID
- bgpconfig_id: BGP Configuration ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.3)
Payload Attributes:
- admin_distance: Type: integer
- adv_interval: Type: integer
- graceful_restart: Type: boolean
- hold_time: Type: integer
- ipv6_prefixes_to_adv_to_wan: [Type: string]
- keepalive_time: Type: integer
- local_as_num: Type: string
- maximum_paths: Type: integer
- md5_secret: Type: string
- multi_hop_limit: Type: integer
- peer_auth_type: Type: string
- peer_retry_time: Type: integer
- prefix_adv_type: Type: string
- prefix_adv_type_to_lan: Type: string
- prefixes_to_adv_to_wan: [Type: string]
- router_id: Type: string
- stalepath_time: Type: integer
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def bgpconfigs(self, site_id, element_id, bgpconfig_id, data, tenant_id=None, api_version="v2.3"): """ Updates BGP config (v2.3) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **bgpconfig_id**: BGP Configuration ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.3) **Payload Attributes:** - **admin_distance:** Type: integer - **adv_interval:** Type: integer - **graceful_restart:** Type: boolean - **hold_time:** Type: integer - **ipv6_prefixes_to_adv_to_wan:** [Type: string] - **keepalive_time:** Type: integer - **local_as_num:** Type: string - **maximum_paths:** Type: integer - **md5_secret:** Type: string - **multi_hop_limit:** Type: integer - **peer_auth_type:** Type: string - **peer_retry_time:** Type: integer - **prefix_adv_type:** Type: string - **prefix_adv_type_to_lan:** Type: string - **prefixes_to_adv_to_wan:** [Type: string] - **router_id:** Type: string - **stalepath_time:** Type: integer **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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/{}/bgpconfigs/{}".format(api_version, tenant_id, site_id, element_id, bgpconfig_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "put", data=data)
def bgppeers(
self, site_id, element_id, bgppeer_id, data, tenant_id=None, api_version='v2.4')
Update BGP Peer config (v2.4)
Parameters::
- site_id: Site ID
- element_id: Element (Device) ID
- bgppeer_id: BGP Peer ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.4)
Payload Attributes:
- allow_v4_prefixes: Type: boolean
- allow_v6_prefixes: Type: boolean
- bgp_config:
- adv_interval: Type: integer
- hold_time: Type: integer
- keepalive_time: Type: integer
- local_as_num: Type: string
- md5_secret: Type: string
- multi_hop_limit: Type: integer
- peer_auth_type: Type: string
- peer_retry_time: Type: integer
- description: Type: string
- name: Type: string
- peer_ip: Type: string
- peer_ip_v6: Type: string
- peer_type: Type: string
- remote_as_num: Type: string
- route_map_in_id: Type: string
- route_map_out_id: Type: string
- router_id: Type: string
- scope: Type: string
- shutdown: Type: boolean
- tags: [Type: string]
- update_source: Type: string
- update_source_v6: Type: string
- vrf_context_id: Type: string
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def bgppeers(self, site_id, element_id, bgppeer_id, data, tenant_id=None, api_version="v2.4"): """ Update BGP Peer config (v2.4) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **bgppeer_id**: BGP Peer ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.4) **Payload Attributes:** - **allow_v4_prefixes:** Type: boolean - **allow_v6_prefixes:** Type: boolean - **bgp_config:** - **adv_interval:** Type: integer - **hold_time:** Type: integer - **keepalive_time:** Type: integer - **local_as_num:** Type: string - **md5_secret:** Type: string - **multi_hop_limit:** Type: integer - **peer_auth_type:** Type: string - **peer_retry_time:** Type: integer - **description:** Type: string - **name:** Type: string - **peer_ip:** Type: string - **peer_ip_v6:** Type: string - **peer_type:** Type: string - **remote_as_num:** Type: string - **route_map_in_id:** Type: string - **route_map_out_id:** Type: string - **router_id:** Type: string - **scope:** Type: string - **shutdown:** Type: boolean - **tags:** [Type: string] - **update_source:** Type: string - **update_source_v6:** Type: string - **vrf_context_id:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def bulkconfigurations_sitetemplates(
self, sitetemplate_id, data, tenant_id=None, api_version='v2.0')
PUT Bulkconfigurations_Sitetemplates API Function
Parameters::
- sitetemplate_id: Site Template ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Payload Attributes:
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def bulkconfigurations_sitetemplates(self, sitetemplate_id, data, tenant_id=None, api_version="v2.0"): """ PUT Bulkconfigurations_Sitetemplates API Function **Parameters:**: - **sitetemplate_id**: Site Template ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def cellular_modules_sim_security(
self, element_id, cellular_module_id, sim_security_id, data, tenant_id=None, api_version='v2.0')
Update cellular module (v2.0)
Parameters::
- element_id: Element (Device) ID
- cellular_module_id: Cellular Module ID
- sim_security_id: SIM Security ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Payload Attributes:
- description: Type: string
- name: Type: string
- pin: Type: string
- remove_pin: Type: boolean
- slot_number: Type: integer
- tags: [Type: string]
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def cellular_modules_sim_security(self, element_id, cellular_module_id, sim_security_id, data, tenant_id=None, api_version="v2.0"): """ Update cellular module (v2.0) **Parameters:**: - **element_id**: Element (Device) ID - **cellular_module_id**: Cellular Module ID - **sim_security_id**: SIM Security ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **description:** Type: string - **name:** Type: string - **pin:** Type: string - **remove_pin:** Type: boolean - **slot_number:** Type: integer - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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/{}/cellular_modules/{}/sim_security/{}".format(api_version, tenant_id, element_id, cellular_module_id, sim_security_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "put", data=data)
def demsiteconfigs(
self, site_id, demsiteconfig_id, data, tenant_id=None, api_version='v2.0')
PUT Demsiteconfigs API Function
Parameters::
- site_id: Site ID
- demsiteconfig_id:
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Payload Attributes:
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def demsiteconfigs(self, site_id, demsiteconfig_id, data, tenant_id=None, api_version="v2.0"): """ PUT Demsiteconfigs API Function **Parameters:**: - **site_id**: Site ID - **demsiteconfig_id**: - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def deviceidconfigs_snmpdiscoverystartnodes(
self, site_id, deviceidconfig_id, snmpdiscoverystartnode_id, data, tenant_id=None, api_version='v2.0')
PUT Deviceidconfigs_Snmpdiscoverystartnodes API Function
Parameters::
- site_id: Site ID
- deviceidconfig_id: Device Id Config ID
- snmpdiscoverystartnode_id: SNMP Discovery Start Node ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Payload Attributes:
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def deviceidconfigs_snmpdiscoverystartnodes(self, site_id, deviceidconfig_id, snmpdiscoverystartnode_id, data, tenant_id=None, api_version="v2.0"): """ PUT Deviceidconfigs_Snmpdiscoverystartnodes API Function **Parameters:**: - **site_id**: Site ID - **deviceidconfig_id**: Device Id Config ID - **snmpdiscoverystartnode_id**: SNMP Discovery Start Node ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def deviceidprofiles(
self, deviceidprofile_id, data, tenant_id=None, api_version='v2.0')
PUT Deviceidprofiles API Function
Parameters::
- deviceidprofile_id: Device Id Profile ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Payload Attributes:
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def deviceidprofiles(self, deviceidprofile_id, data, tenant_id=None, api_version="v2.0"): """ PUT Deviceidprofiles API Function **Parameters:**: - **deviceidprofile_id**: Device Id Profile ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def dhcpservers(
self, site_id, dhcpserver_id, data, tenant_id=None, api_version='v2.3')
Update an existing dhcp server configuration for a subnet (v2.3)
Parameters::
- site_id: Site ID
- dhcpserver_id: DHCP Server ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.3)
Payload Attributes:
- address_family: Type: string
- broadcast_address: Type: string
- custom_options:
- option_definition: Type: string
- option_value: Type: string
- vendor_class_identifier: Type: string
- default_lease_time: Type: integer
- description: Type: string
- disabled: Type: boolean
- dns_servers: [Type: string]
- domain_name: Type: string
- gateway: Type: string
- ip_ranges:
- end_ip: Type: string
- start_ip: Type: string
- max_lease_time: Type: integer
- network_context_id: Type: string
- static_mappings:
- client_duid: Type: string
- ip_address: Type: string
- mac: Type: string
- name: Type: string
- subnet: Type: string
- tags: [Type: string]
- vrf_context_id: Type: string
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def dhcpservers(self, site_id, dhcpserver_id, data, tenant_id=None, api_version="v2.3"): """ Update an existing dhcp server configuration for a subnet (v2.3) **Parameters:**: - **site_id**: Site ID - **dhcpserver_id**: DHCP Server ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.3) **Payload Attributes:** - **address_family:** Type: string - **broadcast_address:** Type: string - **custom_options:** - **option_definition:** Type: string - **option_value:** Type: string - **vendor_class_identifier:** Type: string - **default_lease_time:** Type: integer - **description:** Type: string - **disabled:** Type: boolean - **dns_servers:** [Type: string] - **domain_name:** Type: string - **gateway:** Type: string - **ip_ranges:** - **end_ip:** Type: string - **start_ip:** Type: string - **max_lease_time:** Type: integer - **network_context_id:** Type: string - **static_mappings:** - **client_duid:** Type: string - **ip_address:** Type: string - **mac:** Type: string - **name:** Type: string - **subnet:** Type: string - **tags:** [Type: string] - **vrf_context_id:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def directoryservices(
self, directoryservice_id, data, tenant_id=None, api_version='v2.0')
PUT Directoryservices API Function
Parameters::
- directoryservice_id: Directory Service ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Payload Attributes:
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def directoryservices(self, directoryservice_id, data, tenant_id=None, api_version="v2.0"): """ PUT Directoryservices API Function **Parameters:**: - **directoryservice_id**: Directory Service ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def dnsserviceprofiles(
self, dnsserviceprofile_id, data, tenant_id=None, api_version='v2.1')
Update a DNS service profile (v2.1)
Parameters::
- dnsserviceprofile_id: DNS Service Profile ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.1)
Payload Attributes:
- authoritative_config:
- caa_records:
- flags: Type: string
- name: Type: string
- tag: Type: string
- value: Type: string
- cname_records:
- name: [Type: string]
- target: Type: string
- ttl: Type: integer
- dns_resource_records:
- hex_data: Type: string
- name: Type: string
- rr_number: Type: integer
- host_records:
- domain_names: [Type: string]
- ipv4_address: Type: string
- ipv6_address: Type: string
- ttl: Type: integer
- mx_host_records:
- hostname: Type: string
- mx_name: Type: string
- preference: Type: integer
- naptr_records:
- flags: Type: string
- name: Type: string
- order: Type: integer
- preference: Type: integer
- regexp: Type: string
- replacement: Type: string
- service: Type: string
- peers: [Type: string]
- ptr_records:
- name: Type: string
- target: Type: string
- secondary_servers: [Type: string]
- servers:
- dnsservicerole_id: Type: string
- domain_name: Type: string
- soa:
- expiry: Type: integer
- host_master: Type: string
- refresh: Type: integer
- retry: Type: integer
- serial_number: Type: integer
- srv_hosts:
- domain_name: Type: string
- port: Type: integer
- priority: Type: integer
- protocol: Type: string
- service: Type: string
- target: Type: integer
- weight: Type: integer
- synth_domains:
- domain: Type: string
- end_ipaddress: Type: string
- ipaddress_prefix: Type: string
- prefix: Type: string
- start_ipaddress: Type: string
- ttl: Type: integer
- txt_records:
- domain_name: Type: string
- texts: [Type: string]
- zones:
- domain_name: Type: string
- exclude_prefix: [Type: string]
- include_prefix: [Type: string]
- caa_records:
- cache_config:
- cache_size: Type: integer
- disable_negative_caching: Type: boolean
- max_cache_ttl: Type: integer
- min_cache_ttl: Type: integer
- negative_cache_ttl: Type: integer
- description: Type: string
- dns_forward_config:
- dns_servers:
- address_family: Type: string
- dnsserver_ip: Type: string
- dnsserver_port: Type: integer
- domain_names: [Type: string]
- forward_dnsservicerole_id: Type: string
- ip_prefix: Type: string
- source_port: Type: integer
- max_source_port: Type: integer
- min_source_port: Type: integer
- send_to_all_dns_servers: Type: boolean
- dns_servers:
- dns_queries_metadata:
- add_client_mac:
- mac_encoding_format: Type: string
- add_customer_premises_equipment:
- identifier_text: Type: string
- type: Type: string
- add_subnets:
- ipv4_address: Type: string
- ipv4_prefix_length: Type: integer
- ipv6_address: Type: string
- ipv6_prefix_length: Type: integer
- add_client_mac:
- dns_rebind_config:
- enable_localhost_rebind: Type: boolean
- rebind_domains: [Type: string]
- stop_dns_rebind_privateip: Type: boolean
- dns_response_overrides:
- aliases:
- mask: Type: integer
- original_end_ip: Type: string
- original_ip: Type: string
- original_start_ip: Type: string
- replace_ip: Type: string
- bogus_nx_domains: [Type: string]
- disable_private_ip_lookups: Type: boolean
- ignore_ip_addresses: [Type: string]
- local_ttl: Type: integer
- max_ttl: Type: integer
- aliases:
- dnssec_config:
- disable_dnssec_timecheck: Type: boolean
- dns_check_unsigned: Type: boolean
- enabled: Type: boolean
- trust_anchors:
- class: Type: string
- domain: Type: string
- key_digest:
- algorithm: Type: integer
- digest: Type: string
- digest_type: Type: integer
- key_tag: Type: integer
- domains_to_addresses:
- domain_names: [Type: string]
- ipv4_address: Type: string
- ipv6_address: Type: string
- edns_packet_max: Type: integer
- enable_dns_loop_detection: Type: boolean
- enable_dnssec_proxy: Type: boolean
- enable_strict_domain_name: Type: boolean
- listen_dnsservicerole_id: Type: string
- listen_port: Type: integer
- name: Type: string
- tags: [Type: string]
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def dnsserviceprofiles(self, dnsserviceprofile_id, data, tenant_id=None, api_version="v2.1"): """ Update a DNS service profile (v2.1) **Parameters:**: - **dnsserviceprofile_id**: DNS Service Profile ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Payload Attributes:** - **authoritative_config:** - **caa_records:** - **flags:** Type: string - **name:** Type: string - **tag:** Type: string - **value:** Type: string - **cname_records:** - **name:** [Type: string] - **target:** Type: string - **ttl:** Type: integer - **dns_resource_records:** - **hex_data:** Type: string - **name:** Type: string - **rr_number:** Type: integer - **host_records:** - **domain_names:** [Type: string] - **ipv4_address:** Type: string - **ipv6_address:** Type: string - **ttl:** Type: integer - **mx_host_records:** - **hostname:** Type: string - **mx_name:** Type: string - **preference:** Type: integer - **naptr_records:** - **flags:** Type: string - **name:** Type: string - **order:** Type: integer - **preference:** Type: integer - **regexp:** Type: string - **replacement:** Type: string - **service:** Type: string - **peers:** [Type: string] - **ptr_records:** - **name:** Type: string - **target:** Type: string - **secondary_servers:** [Type: string] - **servers:** - **dnsservicerole_id:** Type: string - **domain_name:** Type: string - **soa:** - **expiry:** Type: integer - **host_master:** Type: string - **refresh:** Type: integer - **retry:** Type: integer - **serial_number:** Type: integer - **srv_hosts:** - **domain_name:** Type: string - **port:** Type: integer - **priority:** Type: integer - **protocol:** Type: string - **service:** Type: string - **target:** Type: integer - **weight:** Type: integer - **synth_domains:** - **domain:** Type: string - **end_ipaddress:** Type: string - **ipaddress_prefix:** Type: string - **prefix:** Type: string - **start_ipaddress:** Type: string - **ttl:** Type: integer - **txt_records:** - **domain_name:** Type: string - **texts:** [Type: string] - **zones:** - **domain_name:** Type: string - **exclude_prefix:** [Type: string] - **include_prefix:** [Type: string] - **cache_config:** - **cache_size:** Type: integer - **disable_negative_caching:** Type: boolean - **max_cache_ttl:** Type: integer - **min_cache_ttl:** Type: integer - **negative_cache_ttl:** Type: integer - **description:** Type: string - **dns_forward_config:** - **dns_servers:** - **address_family:** Type: string - **dnsserver_ip:** Type: string - **dnsserver_port:** Type: integer - **domain_names:** [Type: string] - **forward_dnsservicerole_id:** Type: string - **ip_prefix:** Type: string - **source_port:** Type: integer - **max_source_port:** Type: integer - **min_source_port:** Type: integer - **send_to_all_dns_servers:** Type: boolean - **dns_queries_metadata:** - **add_client_mac:** - **mac_encoding_format:** Type: string - **add_customer_premises_equipment:** - **identifier_text:** Type: string - **type:** Type: string - **add_subnets:** - **ipv4_address:** Type: string - **ipv4_prefix_length:** Type: integer - **ipv6_address:** Type: string - **ipv6_prefix_length:** Type: integer - **dns_rebind_config:** - **enable_localhost_rebind:** Type: boolean - **rebind_domains:** [Type: string] - **stop_dns_rebind_privateip:** Type: boolean - **dns_response_overrides:** - **aliases:** - **mask:** Type: integer - **original_end_ip:** Type: string - **original_ip:** Type: string - **original_start_ip:** Type: string - **replace_ip:** Type: string - **bogus_nx_domains:** [Type: string] - **disable_private_ip_lookups:** Type: boolean - **ignore_ip_addresses:** [Type: string] - **local_ttl:** Type: integer - **max_ttl:** Type: integer - **dnssec_config:** - **disable_dnssec_timecheck:** Type: boolean - **dns_check_unsigned:** Type: boolean - **enabled:** Type: boolean - **trust_anchors:** - **class:** Type: string - **domain:** Type: string - **key_digest:** - **algorithm:** Type: integer - **digest:** Type: string - **digest_type:** Type: integer - **key_tag:** Type: integer - **domains_to_addresses:** - **domain_names:** [Type: string] - **ipv4_address:** Type: string - **ipv6_address:** Type: string - **edns_packet_max:** Type: integer - **enable_dns_loop_detection:** Type: boolean - **enable_dnssec_proxy:** Type: boolean - **enable_strict_domain_name:** Type: boolean - **listen_dnsservicerole_id:** Type: string - **listen_port:** Type: integer - **name:** Type: string - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def dnsserviceroles(
self, dnsservicerole_id, data, tenant_id=None, api_version='v2.0')
Update a DNS service role (v2.0)
Parameters::
- dnsservicerole_id: DNS Service Role ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Payload Attributes:
- description: Type: string
- name: Type: string
- tags: [Type: string]
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def dnsserviceroles(self, dnsservicerole_id, data, tenant_id=None, api_version="v2.0"): """ Update a DNS service role (v2.0) **Parameters:**: - **dnsservicerole_id**: DNS Service Role ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **description:** Type: string - **name:** Type: string - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def dnsservices(
self, site_id, element_id, dnsservice_id, data, tenant_id=None, api_version='v2.0')
Update a DNS service config (v2.0)
Parameters::
- site_id: Site ID
- element_id: Element (Device) ID
- dnsservice_id: DNS Service ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Payload Attributes:
- cache_config:
- cache_size: Type: integer
- description: Type: string
- disabled: Type: boolean
- disabled_reason: Type: string
- dns_queries_metadata:
- add_customer_premises_equipment:
- identifier_text: Type: string
- type: Type: string
- add_subnets:
- ipv4_address: Type: string
- ipv4_prefix_length: Type: integer
- ipv6_address: Type: string
- ipv6_prefix_length: Type: integer
- add_customer_premises_equipment:
- dnsservice_profile_id: Type: string
- dnsservicerole_bindings:
- dnsservicerole_id: Type: string
- interfaces:
- interface_id: Type: string
- interface_ip: Type: string
- domains_to_addresses:
- domain_names: [Type: string]
- ipv4_address: Type: string
- ipv6_address: Type: string
- domains_to_interfaces:
- domain_names: [Type: string]
- interface_id: Type: string
- element_id: Type: string
- enabled: Type: boolean
- inactive: Type: boolean
- inactive_reason: Type: string
- max_concurrent_dns_queries: Type: integer
- name: Type: string
- region: Type: string
- site_id: Type: string
- tags: [Type: string]
- tenant_id: Type: string
- upperCaseName: Type: string
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def dnsservices(self, site_id, element_id, dnsservice_id, data, tenant_id=None, api_version="v2.0"): """ Update a DNS service config (v2.0) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **dnsservice_id**: DNS Service ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **cache_config:** - **cache_size:** Type: integer - **description:** Type: string - **disabled:** Type: boolean - **disabled_reason:** Type: string - **dns_queries_metadata:** - **add_customer_premises_equipment:** - **identifier_text:** Type: string - **type:** Type: string - **add_subnets:** - **ipv4_address:** Type: string - **ipv4_prefix_length:** Type: integer - **ipv6_address:** Type: string - **ipv6_prefix_length:** Type: integer - **dnsservice_profile_id:** Type: string - **dnsservicerole_bindings:** - **dnsservicerole_id:** Type: string - **interfaces:** - **interface_id:** Type: string - **interface_ip:** Type: string - **domains_to_addresses:** - **domain_names:** [Type: string] - **ipv4_address:** Type: string - **ipv6_address:** Type: string - **domains_to_interfaces:** - **domain_names:** [Type: string] - **interface_id:** Type: string - **element_id:** Type: string - **enabled:** Type: boolean - **inactive:** Type: boolean - **inactive_reason:** Type: string - **max_concurrent_dns_queries:** Type: integer - **name:** Type: string - **region:** Type: string - **site_id:** Type: string - **tags:** [Type: string] - **tenant_id:** Type: string - **upperCaseName:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def element_admin_state(
self, site_id, element_id, data, tenant_id=None, api_version='v2.0')
Update admin state Northbound (v2.0)
Parameters::
- site_id: Site ID
- element_id: Element (Device) ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Payload Attributes:
- admin_action: Type: string
- allowed_roles: [Type: string]
- cluster_insertion_mode: Type: string
- cluster_member_id: Type: string
- connected: Type: boolean
- deployment_op: Type: string
- description: Type: string
- hw_id: Type: string
- model_name: Type: string
- name: Type: string
- role: Type: string
- serial_number: Type: string
- site_id: Type: string
- software_version: Type: string
- state: Type: string
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def element_admin_state(self, site_id, element_id, data, tenant_id=None, api_version="v2.0"): """ Update admin state Northbound (v2.0) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **admin_action:** Type: string - **allowed_roles:** [Type: string] - **cluster_insertion_mode:** Type: string - **cluster_member_id:** Type: string - **connected:** Type: boolean - **deployment_op:** Type: string - **description:** Type: string - **hw_id:** Type: string - **model_name:** Type: string - **name:** Type: string - **role:** Type: string - **serial_number:** Type: string - **site_id:** Type: string - **software_version:** Type: string - **state:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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/{}/admin_state".format(api_version, tenant_id, site_id, element_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "put", data=data)
def element_cellular_modules(
self, element_id, cellular_module_id, data, tenant_id=None, api_version='v2.0')
Update cellular module (v2.0)
Parameters::
- element_id: Element (Device) ID
- cellular_module_id: Cellular Module ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Payload Attributes:
- description: Type: string
- gps_enable: Type: boolean
- name: Type: string
- primary_sim: Type: integer
- radio_on: Type: boolean
- tags: [Type: string]
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def element_cellular_modules(self, element_id, cellular_module_id, data, tenant_id=None, api_version="v2.0"): """ Update cellular module (v2.0) **Parameters:**: - **element_id**: Element (Device) ID - **cellular_module_id**: Cellular Module ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **description:** Type: string - **gps_enable:** Type: boolean - **name:** Type: string - **primary_sim:** Type: integer - **radio_on:** Type: boolean - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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/{}/cellular_modules/{}".format(api_version, tenant_id, element_id, cellular_module_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "put", data=data)
def element_cellular_modules_firmware(
self, element_id, cellular_module_id, data, tenant_id=None, api_version='v2.0')
Update cellular module firmware configuration (v2.0)
Parameters::
- element_id: Element (Device) ID
- cellular_module_id: Cellular Module ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Payload Attributes:
- cellular_module_image_ids: [Type: string]
- download_interval: Type: integer
- interface_ids: [Type: string]
- scheduled_download: Type: string
- scheduled_upgrade: Type: string
- upgrade_interval: Type: integer
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def element_cellular_modules_firmware(self, element_id, cellular_module_id, data, tenant_id=None, api_version="v2.0"): """ Update cellular module firmware configuration (v2.0) **Parameters:**: - **element_id**: Element (Device) ID - **cellular_module_id**: Cellular Module ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **cellular_module_image_ids:** [Type: string] - **download_interval:** Type: integer - **interface_ids:** [Type: string] - **scheduled_download:** Type: string - **scheduled_upgrade:** Type: string - **upgrade_interval:** Type: integer **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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/{}/cellular_modules/{}/firmware".format(api_version, tenant_id, element_id, cellular_module_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "put", data=data)
def element_deviceidconfigs(
self, site_id, element_id, deviceidconfig_id, data, tenant_id=None, api_version='v2.0')
PUT Element_Deviceidconfigs API Function
Parameters::
- site_id: Site ID
- element_id: Element (Device) ID
- deviceidconfig_id: Device Id Config ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Payload Attributes:
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def element_deviceidconfigs(self, site_id, element_id, deviceidconfig_id, data, tenant_id=None, api_version="v2.0"): """ PUT Element_Deviceidconfigs API Function **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **deviceidconfig_id**: Device Id Config ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def element_extensions(
self, site_id, element_id, extension_id, data, tenant_id=None, api_version='v2.0')
Update element level extension configuration (v2.0)
Parameters::
- site_id: Site ID
- element_id: Element (Device) ID
- extension_id: Extension ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Payload Attributes:
- conf: Type: object
- disabled: Type: boolean
- entity_id: Type: string
- name: Type: string
- namespace: Type: string
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def element_extensions(self, site_id, element_id, extension_id, data, tenant_id=None, api_version="v2.0"): """ Update element level extension configuration (v2.0) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **extension_id**: Extension ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **conf:** Type: object - **disabled:** Type: boolean - **entity_id:** Type: string - **name:** Type: string - **namespace:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def element_state(
self, element_id, data, tenant_id=None, api_version='v2.0')
Update element state (v2.0)
Parameters::
- element_id: Element (Device) ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Payload Attributes:
- image_id: Type: string
- scheduled_upgrade: Type: string
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def element_state(self, element_id, data, tenant_id=None, api_version="v2.0"): """ Update element state (v2.0) **Parameters:**: - **element_id**: Element (Device) ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **image_id:** Type: string - **scheduled_upgrade:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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/{}/state".format(api_version, tenant_id, element_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "put", data=data)
def elementaccessconfigs(
self, element_id, elementaccessconfig_id, data, tenant_id=None, api_version='v2.2')
Update an Access Config on particular element. (v2.2)
Parameters::
- element_id: Element (Device) ID
- elementaccessconfig_id: Element Access Config ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.2)
Payload Attributes:
- account_disable_interval: Type: integer
- inactive_interval: Type: integer
- otpkey_version: Type: integer
- retry_login_count: Type: integer
- ssh_enabled: Type: boolean
- ssh_outbound_enabled: Type: boolean
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def elementaccessconfigs(self, element_id, elementaccessconfig_id, data, tenant_id=None, api_version="v2.2"): """ Update an Access Config on particular element. (v2.2) **Parameters:**: - **element_id**: Element (Device) ID - **elementaccessconfig_id**: Element Access Config ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.2) **Payload Attributes:** - **account_disable_interval:** Type: integer - **inactive_interval:** Type: integer - **otpkey_version:** Type: integer - **retry_login_count:** Type: integer - **ssh_enabled:** Type: boolean - **ssh_outbound_enabled:** Type: boolean **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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/{}/elementaccessconfigs/{}".format(api_version, tenant_id, element_id, elementaccessconfig_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "put", data=data)
def elements(
self, element_id, data, tenant_id=None, api_version='v3.1')
Used for associations and element updates (v3.1)
Parameters::
- element_id: Element (Device) ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v3.1)
Payload Attributes:
- cluster_id: Type: string
- description: Type: string
- device_profile_id: Type: string
- l3_direct_private_wan_forwarding: Type: boolean
- l3_lan_forwarding: Type: boolean
- led_config:
- service_led_on: Type: boolean
- main_power_usage_threshold: Type: integer
- name: Type: string
- nat_policysetstack_id: Type: string
- network_policysetstack_id: Type: string
- priority_policysetstack_id: Type: string
- site_id: Type: string
- spoke_ha_config:
- cluster_id: Type: string
- enable: Type: boolean
- priority: Type: integer
- source_interface: Type: string
- track:
- interfaces:
- interface_id: Type: string
- reduce_priority: Type: integer
- waninterfaces:
- reduce_priority: Type: integer
- wan_interface_id: Type: string
- interfaces:
- sw_obj:
- location: Type: string
- version: Type: string
- switch_config:
- default_vlan_id: Type: integer
- mstp_enabled: Type: boolean
- stp_aging_timer: Type: integer
- stp_forward_delay: Type: integer
- stp_hello_time: Type: integer
- stp_max_age: Type: integer
- stp_mode: Type: string
- stp_priority: Type: integer
- tags: [Type: string]
- tenant_id: Type: string
- vpn_to_vpn_forwarding: Type: boolean
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def elements(self, element_id, data, tenant_id=None, api_version="v3.1"): """ Used for associations and element updates (v3.1) **Parameters:**: - **element_id**: Element (Device) ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v3.1) **Payload Attributes:** - **cluster_id:** Type: string - **description:** Type: string - **device_profile_id:** Type: string - **l3_direct_private_wan_forwarding:** Type: boolean - **l3_lan_forwarding:** Type: boolean - **led_config:** - **service_led_on:** Type: boolean - **main_power_usage_threshold:** Type: integer - **name:** Type: string - **nat_policysetstack_id:** Type: string - **network_policysetstack_id:** Type: string - **priority_policysetstack_id:** Type: string - **site_id:** Type: string - **spoke_ha_config:** - **cluster_id:** Type: string - **enable:** Type: boolean - **priority:** Type: integer - **source_interface:** Type: string - **track:** - **interfaces:** - **interface_id:** Type: string - **reduce_priority:** Type: integer - **waninterfaces:** - **reduce_priority:** Type: integer - **wan_interface_id:** Type: string - **sw_obj:** - **location:** Type: string - **version:** Type: string - **switch_config:** - **default_vlan_id:** Type: integer - **mstp_enabled:** Type: boolean - **stp_aging_timer:** Type: integer - **stp_forward_delay:** Type: integer - **stp_hello_time:** Type: integer - **stp_max_age:** Type: integer - **stp_mode:** Type: string - **stp_priority:** Type: integer - **tags:** [Type: string] - **tenant_id:** Type: string - **vpn_to_vpn_forwarding:** Type: boolean **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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/{}".format(api_version, tenant_id, element_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "put", data=data)
def elementsecurityzones(
self, site_id, element_id, securityzone_id, data, tenant_id=None, api_version='v2.0')
Update an existing element security zone (v2.0)
Parameters::
- site_id: Site ID
- element_id: Element (Device) ID
- securityzone_id: Security Zone (ZBFW) ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Payload Attributes:
- interface_ids: [Type: string]
- lannetwork_ids: [Type: string]
- site_id: Type: string
- tenant_id: Type: string
- waninterface_ids: [Type: string]
- wanoverlay_ids: [Type: string]
- zone_id: Type: string
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def elementsecurityzones(self, site_id, element_id, securityzone_id, data, tenant_id=None, api_version="v2.0"): """ Update an existing element security zone (v2.0) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **securityzone_id**: Security Zone (ZBFW) ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **interface_ids:** [Type: string] - **lannetwork_ids:** [Type: string] - **site_id:** Type: string - **tenant_id:** Type: string - **waninterface_ids:** [Type: string] - **wanoverlay_ids:** [Type: string] - **zone_id:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def elementshells(
self, site_id, elementshell_id, data, tenant_id=None, api_version='v2.0')
PUT Elementshells API Function
Parameters::
- site_id: Site ID
- elementshell_id: Element Shell ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Payload Attributes:
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def elementshells(self, site_id, elementshell_id, data, tenant_id=None, api_version="v2.0"): """ PUT Elementshells API Function **Parameters:**: - **site_id**: Site ID - **elementshell_id**: Element Shell ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def elementshells_interfaces(
self, site_id, elementshell_id, interface_id, data, tenant_id=None, api_version='v2.0')
PUT Elementshells_Interfaces API Function
Parameters::
- site_id: Site ID
- elementshell_id: Element Shell ID
- interface_id: Interface ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Payload Attributes:
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def elementshells_interfaces(self, site_id, elementshell_id, interface_id, data, tenant_id=None, api_version="v2.0"): """ PUT Elementshells_Interfaces API Function **Parameters:**: - **site_id**: Site ID - **elementshell_id**: Element Shell ID - **interface_id**: Interface ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def elementusers(
self, elementuser_id, data, tenant_id=None, api_version='v2.1')
Update an existing element user. (v2.1)
Parameters::
- elementuser_id: Element User ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.1)
Payload Attributes:
- is_tenant_level: Type: boolean
- login_id: Type: string
- password: Type: string
- role: Type: string
- tenant_id: Type: string
- username: Type: string
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def elementusers(self, elementuser_id, data, tenant_id=None, api_version="v2.1"): """ Update an existing element user. (v2.1) **Parameters:**: - **elementuser_id**: Element User ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Payload Attributes:** - **is_tenant_level:** Type: boolean - **login_id:** Type: string - **password:** Type: string - **role:** Type: string - **tenant_id:** Type: string - **username:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def elementusers_access(
self, elementuser_id, access_id, data, tenant_id=None, api_version='v2.1')
Update an existing element user access. (v2.1)
Parameters::
- elementuser_id: Element User ID
- access_id: Access ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.1)
Payload Attributes:
- element_id: Type: string
- role: Type: string
- tenant_id: Type: string
- user_id: Type: string
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def elementusers_access(self, elementuser_id, access_id, data, tenant_id=None, api_version="v2.1"): """ Update an existing element user access. (v2.1) **Parameters:**: - **elementuser_id**: Element User ID - **access_id**: Access ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Payload Attributes:** - **element_id:** Type: string - **role:** Type: string - **tenant_id:** Type: string - **user_id:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def enterpriseprefixset(
self, data, tenant_id=None, api_version='v2.1')
PUT Enterpriseprefixset API Function
Parameters::
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.1)
Payload Attributes:
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def enterpriseprefixset(self, data, tenant_id=None, api_version="v2.1"): """ PUT Enterpriseprefixset API Function **Parameters:**: - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Payload Attributes:** **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_id. raise TypeError("tenant_id is required but not set or cached.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/enterpriseprefixset".format(api_version, tenant_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "put", data=data)
def esp_operator_permissions_client(
self, operator_id, client_id, data, tenant_id=None, api_version='v2.1')
Create or update esp operator permissions assigned under a client (v2.1)
Parameters::
- operator_id: Operator ID
- client_id: ESP/MSP Client ID (typically their tenant_id)
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.1)
Payload Attributes:
- client_id: Type: string
- custom_roles:
- custom_permissions:
- allowed_after_ms: Type: integer
- allowed_before_ms: Type: integer
- disabled: Type: boolean
- disabled_reason: Type: string
- disallow_permission: Type: boolean
- id: Type: string
- inactive: Type: boolean
- inactive_reason: Type: string
- region: Type: string
- tenant_id: Type: string
- value: Type: string
- disabled: Type: boolean
- disallow_permissions:
- value: Type: string
- id: Type: string
- inactive: Type: boolean
- name: Type: string
- permissions:
- value: Type: string
- roles:
- name: Type: string
- custom_permissions:
- disabled: Type: boolean
- disabled_reason: Type: string
- email: Type: string
- enable_session_ip_lock: Type: boolean
- inactive: Type: boolean
- inactive_reason: Type: string
- ipv4_list:
- ipv4: Type: string
- name: Type: string
- operator_id: Type: string
- region: Type: string
- roles:
- name: Type: string
- settings: Type: string
- tenant_id: Type: string
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def esp_operator_permissions_client(self, operator_id, client_id, data, tenant_id=None, api_version="v2.1"): """ Create or update esp operator permissions assigned under a client (v2.1) **Parameters:**: - **operator_id**: Operator ID - **client_id**: ESP/MSP Client ID (typically their tenant_id) - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Payload Attributes:** - **client_id:** Type: string - **custom_roles:** - **custom_permissions:** - **allowed_after_ms:** Type: integer - **allowed_before_ms:** Type: integer - **disabled:** Type: boolean - **disabled_reason:** Type: string - **disallow_permission:** Type: boolean - **id:** Type: string - **inactive:** Type: boolean - **inactive_reason:** Type: string - **region:** Type: string - **tenant_id:** Type: string - **value:** Type: string - **disabled:** Type: boolean - **disallow_permissions:** - **value:** Type: string - **id:** Type: string - **inactive:** Type: boolean - **name:** Type: string - **permissions:** - **value:** Type: string - **roles:** - **name:** Type: string - **disabled:** Type: boolean - **disabled_reason:** Type: string - **email:** Type: string - **enable_session_ip_lock:** Type: boolean - **inactive:** Type: boolean - **inactive_reason:** Type: string - **ipv4_list:** - **ipv4:** Type: string - **name:** Type: string - **operator_id:** Type: string - **region:** Type: string - **roles:** - **name:** Type: string - **settings:** Type: string - **tenant_id:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def eventcorrelationpolicyrules(
self, eventcorrelationpolicyset_id, eventcorrelationpolicyrule_id, data, tenant_id=None, api_version='v2.1')
Update event correlation policyrule configuration (v2.1)
Parameters::
- eventcorrelationpolicyset_id: Event Correlation Policy Set ID
- eventcorrelationpolicyrule_id: Event Correlation Policy Rule ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.1)
Payload Attributes:
- dampening_duration: Type: integer
- description: Type: string
- enabled: Type: boolean
- end_time: Type: integer
- escalation_rules:
- flap_rule:
- flap_duration: Type: integer
- flap_rate: Type: integer
- standing_rule:
- priority: Type: string
- standing_for: Type: integer
- flap_rule:
- event_codes: [Type: string]
- name: Type: string
- priority: Type: string
- resource_ids: [Type: string]
- resource_type: Type: string
- start_time: Type: integer
- sub_resource_type: Type: string
- suppress: Type: string
- tags: [Type: string]
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def eventcorrelationpolicyrules(self, eventcorrelationpolicyset_id, eventcorrelationpolicyrule_id, data, tenant_id=None, api_version="v2.1"): """ Update event correlation policyrule configuration (v2.1) **Parameters:**: - **eventcorrelationpolicyset_id**: Event Correlation Policy Set ID - **eventcorrelationpolicyrule_id**: Event Correlation Policy Rule ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Payload Attributes:** - **dampening_duration:** Type: integer - **description:** Type: string - **enabled:** Type: boolean - **end_time:** Type: integer - **escalation_rules:** - **flap_rule:** - **flap_duration:** Type: integer - **flap_rate:** Type: integer - **standing_rule:** - **priority:** Type: string - **standing_for:** Type: integer - **event_codes:** [Type: string] - **name:** Type: string - **priority:** Type: string - **resource_ids:** [Type: string] - **resource_type:** Type: string - **start_time:** Type: integer - **sub_resource_type:** Type: string - **suppress:** Type: string - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def eventcorrelationpolicysets(
self, eventcorrelationpolicyset_id, data, tenant_id=None, api_version='v2.0')
Update event correlation policyset configuration (v2.0)
Parameters::
- eventcorrelationpolicyset_id: Event Correlation Policy Set ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Payload Attributes:
- active_policyset: Type: boolean
- clone_from: Type: string
- description: Type: string
- name: Type: string
- policyrule_order: [Type: string]
- severity_priority_mapping:
- priority: Type: string
- severity: Type: string
- tags: [Type: string]
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def eventcorrelationpolicysets(self, eventcorrelationpolicyset_id, data, tenant_id=None, api_version="v2.0"): """ Update event correlation policyset configuration (v2.0) **Parameters:**: - **eventcorrelationpolicyset_id**: Event Correlation Policy Set ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **active_policyset:** Type: boolean - **clone_from:** Type: string - **description:** Type: string - **name:** Type: string - **policyrule_order:** [Type: string] - **severity_priority_mapping:** - **priority:** Type: string - **severity:** Type: string - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def events(
self, event_id, data, tenant_id=None, api_version='v2.3')
PUT Events API Function
Parameters::
- event_id: Event ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.3)
Payload Attributes:
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def events(self, event_id, data, tenant_id=None, api_version="v2.3"): """ PUT Events API Function **Parameters:**: - **event_id**: Event ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.3) **Payload Attributes:** **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_id. raise TypeError("tenant_id is required but not set or cached.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/events/{}".format(api_version, tenant_id, event_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "put", data=data)
def externalcaconfigs(
self, externalcaconfig_id, data, tenant_id=None, api_version='v2.0')
PUT Externalcaconfigs API Function
Parameters::
- externalcaconfig_id: External CA Config ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Payload Attributes:
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def externalcaconfigs(self, externalcaconfig_id, data, tenant_id=None, api_version="v2.0"): """ PUT Externalcaconfigs API Function **Parameters:**: - **externalcaconfig_id**: External CA Config ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def globalprefixfilters(
self, globalprefixfilter_id, data, tenant_id=None, api_version='v2.0')
Update a new global prefix filter. (v2.0)
Parameters::
- globalprefixfilter_id: Global Prefix Filter ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Payload Attributes:
- description: Type: string
- filters:
- type: Type: string
- name: Type: string
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def globalprefixfilters(self, globalprefixfilter_id, data, tenant_id=None, api_version="v2.0"): """ Update a new global prefix filter. (v2.0) **Parameters:**: - **globalprefixfilter_id**: Global Prefix Filter ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **description:** Type: string - **filters:** - **type:** Type: string - **name:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def hubclustermembers(
self, site_id, hubcluster_id, hubclustermember_id, data, tenant_id=None, api_version='v3.0')
Update specific hub cluster member. (v3.0)
Parameters::
- site_id: Site ID
- hubcluster_id: Hub (DC) Cluster ID
- hubclustermember_id: Hub Cluster Member ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v3.0)
Payload Attributes:
- headend1_site_ids: [Type: string]
- headend2_site_ids: [Type: string]
- hub_element_id: Type: string
- load_factors:
- alarm_threshold: Type: integer
- allocated: Type: integer
- subscription_factor: Type: number
- threshold:
- critical_alarm: Type: integer
- major_alarm: Type: integer
- subscription_factor: Type: number
- type: Type: string
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def hubclustermembers(self, site_id, hubcluster_id, hubclustermember_id, data, tenant_id=None, api_version="v3.0"): """ Update specific hub cluster member. (v3.0) **Parameters:**: - **site_id**: Site ID - **hubcluster_id**: Hub (DC) Cluster ID - **hubclustermember_id**: Hub Cluster Member ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v3.0) **Payload Attributes:** - **headend1_site_ids:** [Type: string] - **headend2_site_ids:** [Type: string] - **hub_element_id:** Type: string - **load_factors:** - **alarm_threshold:** Type: integer - **allocated:** Type: integer - **subscription_factor:** Type: number - **threshold:** - **critical_alarm:** Type: integer - **major_alarm:** Type: integer - **subscription_factor:** Type: number - **type:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def hubclusters(
self, site_id, hubcluster_id, data, tenant_id=None, api_version='v4.0')
Update hub cluster (v4.0)
Parameters::
- site_id: Site ID
- hubcluster_id: Hub (DC) Cluster ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v4.0)
Payload Attributes:
- default_cluster: Type: boolean
- description: Type: string
- elements:
- hubClusterElementNumber: Type: string
- hub_element_id: Type: string
- locked: Type: boolean
- name: Type: string
- peer_sites: [Type: string]
- site_count_alarm_threshold: Type: integer
- tags: [Type: string]
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def hubclusters(self, site_id, hubcluster_id, data, tenant_id=None, api_version="v4.0"): """ Update hub cluster (v4.0) **Parameters:**: - **site_id**: Site ID - **hubcluster_id**: Hub (DC) Cluster ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v4.0) **Payload Attributes:** - **default_cluster:** Type: boolean - **description:** Type: string - **elements:** - **hubClusterElementNumber:** Type: string - **hub_element_id:** Type: string - **locked:** Type: boolean - **name:** Type: string - **peer_sites:** [Type: string] - **site_count_alarm_threshold:** Type: integer - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def idps(
self, idp_id, data, tenant_id=None, api_version='v3.3')
Update sso (v3.3)
Parameters::
- idp_id: SAML IDentity provider configuration ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v3.3)
Payload Attributes:
- auto_provision_operators: Type: boolean
- auto_provision_roles: Type: boolean
- disabled: Type: boolean
- disabled_reason: Type: string
- idp_domain_admin_email: Type: string
- idp_domains: [Type: string]
- idp_entity_id: Type: string
- idp_login_url: Type: string
- idp_logout_url: Type: string
- idp_metadata_b64: Type: string
- inactive: Type: boolean
- inactive_reason: Type: string
- is_hob: Type: boolean
- match_email_domain: Type: boolean
- role_map: Type: object
- session_timeout_s: Type: integer
- sign_redirect_binding: Type: boolean
- sp_metadata_b64: Type: string
- sp_x509_b64: Type: string
- sp_x509_serial_no: Type: string
- tenant_id: Type: string
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def idps(self, idp_id, data, tenant_id=None, api_version="v3.3"): """ Update sso (v3.3) **Parameters:**: - **idp_id**: SAML IDentity provider configuration ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v3.3) **Payload Attributes:** - **auto_provision_operators:** Type: boolean - **auto_provision_roles:** Type: boolean - **disabled:** Type: boolean - **disabled_reason:** Type: string - **idp_domain_admin_email:** Type: string - **idp_domains:** [Type: string] - **idp_entity_id:** Type: string - **idp_login_url:** Type: string - **idp_logout_url:** Type: string - **idp_metadata_b64:** Type: string - **inactive:** Type: boolean - **inactive_reason:** Type: string - **is_hob:** Type: boolean - **match_email_domain:** Type: boolean - **role_map:** Type: object - **session_timeout_s:** Type: integer - **sign_redirect_binding:** Type: boolean - **sp_metadata_b64:** Type: string - **sp_x509_b64:** Type: string - **sp_x509_serial_no:** Type: string - **tenant_id:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def interfaces(
self, site_id, element_id, interface_id, data, tenant_id=None, api_version='v4.17')
Update an Interface (v4.17)
Parameters::
- site_id: Site ID
- element_id: Element (Device) ID
- interface_id: Interface ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v4.17)
Payload Attributes:
- admin_up: Type: boolean
- attached_lan_networks:
- lan_network_id: Type: string
- vlan_id: Type: integer
- authentication_config:
- fallback_retry_count: Type: integer
- mode: Type: string
- reauthentication_timeout: Type: integer
- bound_interfaces: [Type: string]
- bypass_pair:
- lan: Type: string
- lan_state_propagation: Type: boolean
- use_relay: Type: boolean
- wan: Type: string
- cellular_config:
- apn_config:
- apn: Type: string
- authentication: Type: string
- clear_password: Type: boolean
- password: Type: string
- password_encrypted: Type: string
- user_name: Type: string
- apnprofile_id: Type: string
- auto_apn: Type: boolean
- parent_module_id: Type: string
- parent_sim_slot_number: Type: integer
- apn_config:
- description: Type: string
- devicemgmt_policysetstack_id: Type: string
- dhcp_relay:
- enabled: Type: boolean
- option_82:
- circuit_id: Type: string
- enabled: Type: boolean
- reforwarding_policy: Type: string
- remote_id: Type: string
- server_ips: [Type: string]
- source_interface: Type: string
- directed_broadcast: Type: boolean
- ethernet_port:
- full_duplex: Type: boolean
- port_id:
- connector: Type: string
- device: Type: string
- disabled: Type: boolean
- disabled_reason: Type: string
- element_id: Type: string
- id: Type: string
- inactive: Type: boolean
- inactive_reason: Type: string
- max_mtu: Type: integer
- max_speed: Type: integer
- name: Type: string
- original_mac_address: Type: string
- region: Type: string
- site_id: Type: string
- tenant_id: Type: string
- port_name: Type: string
- speed: Type: integer
- interface_profile_id: Type: string
- ipfixcollectorcontext_id: Type: string
- ipfixfiltercontext_id: Type: string
- ipv4_config:
- dhcp_config:
- client_id: Type: string
- hostname: Type: string
- dns_v4_config:
- name_servers: [Type: string]
- search: [Type: string]
- pppoe_config:
- chap_passwd: Type: string
- chap_user: Type: string
- set_route: Type: boolean
- routes:
- destination: Type: string
- via: Type: string
- static_config:
- address: Type: string
- type: Type: string
- dhcp_config:
- ipv6_config:
- dhcp_config:
- client_id: Type: string
- hostname: Type: string
- dns_v6_config:
- name_servers: [Type: string]
- search: [Type: string]
- routes:
- destination: Type: string
- via: Type: string
- static_config:
- address: Type: string
- enable_prefix_distribution: Type: boolean
- type: Type: string
- dhcp_config:
- lldp_enabled: Type: boolean
- mac_address: Type: string
- mtu: Type: integer
- multicast_config:
- igmp_version: Type: string
- multicast_enabled: Type: boolean
- name: Type: string
- nat_address: Type: string
- nat_address_v6: Type: string
- nat_pools:
- ipv4_ranges:
- end: Type: string
- start: Type: string
- nat_pool_id: Type: string
- ipv4_ranges:
- nat_port: Type: integer
- nat_port_v6: Type: integer
- nat_zone_id: Type: string
- network_context_id: Type: string
- parent: Type: string
- peer_bypasspair_wan_port_type: Type: string
- poe_enabled: Type: boolean
- power_usage_threshold: Type: integer
- pppoe_config:
- host_uniq: Type: string
- ip_address_type: Type: string
- password: Type: string
- reconnection_delay: Type: integer
- service_name: Type: string
- username: Type: string
- scope: Type: string
- secondary_ip_configs:
- ipv4_address: Type: string
- scope: Type: string
- service_link_config:
- gre_config:
- csum: Type: boolean
- keepalive_enable: Type: boolean
- keepalive_fail_count: Type: integer
- keepalive_interval: Type: integer
- ipsec_config:
- authentication:
- certificate: Type: string
- certificate_profile_id: Type: string
- comment: Type: string
- ikev1_params:
- xauth_id: Type: string
- xauth_secret: Type: string
- xauth_secret_encrypted: Type: string
- xauth_secret_hash: Type: string
- xauth_type: Type: string
- local_ca_certificate: Type: string
- local_id: Type: string
- local_id_custom: Type: string
- local_pa_certificate_id: Type: string
- pa_master_key_id: Type: string
- passphrase: Type: string
- passphrase_encrypted: Type: string
- peer_id_check: Type: string
- permit_peer_id_mismatch: Type: boolean
- private_key: Type: string
- private_key_encrypted: Type: string
- remote_ca_certificate: Type: string
- remote_id: Type: string
- secret: Type: string
- secret_encrypted: Type: string
- secret_hash: Type: string
- strict_validation_peer_extended_key_use: Type: boolean
- type: Type: string
- x509Objects:
- certHolder: Type: object
- certificate: Type: string
- is_local_ca_cert_set: Type: boolean
- is_remote_ca_cert_set: Type: boolean
- keyPair: Type: object
- local_ca_certificate: Type: string
- local_ca_certs_set: [Type: object]
- passphrase: Type: string
- private_key: Type: string
- remote_ca_certificate: Type: string
- remote_ca_certs_set: [Type: object]
- ipsec_profile_id: Type: string
- authentication:
- last_parent: Type: string
- parent: Type: string
- peer:
- hostname: Type: string
- ip_addresses: [Type: string]
- service_endpoint_id: Type: string
- type: Type: string
- gre_config:
- site_wan_interface_ids: [Type: string]
- static_arp_configs:
- ipv4_address: Type: string
- mac_address: Type: string
- sub_interface:
- vlan_id: Type: integer
- switch_port_config:
- access_vlan_id: Type: integer
- bpdu_guard_enabled: Type: boolean
- forward_fast_enabled: Type: boolean
- native_vlan_id: Type: integer
- root_guard_enabled: Type: boolean
- storm_control_config:
- broadcast_threshold: Type: integer
- multicast_threshold: Type: integer
- unicast_threshold: Type: integer
- stp_port_cost: Type: integer
- stp_port_enabled: Type: boolean
- stp_port_priority: Type: integer
- trunk_vlans: [Type: string]
- vlan_mode: Type: string
- voice_vlan_id: Type: integer
- tags: [Type: string]
- type: Type: string
- used_for: Type: string
- vlan_config:
- element_vlan_unique_id: Type: string
- mstp_instance: Type: integer
- vlan_id: Type: integer
- voice_enabled: Type: boolean
- vrf_context_id: Type: string
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def interfaces(self, site_id, element_id, interface_id, data, tenant_id=None, api_version="v4.17"): """ Update an Interface (v4.17) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **interface_id**: Interface ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v4.17) **Payload Attributes:** - **admin_up:** Type: boolean - **attached_lan_networks:** - **lan_network_id:** Type: string - **vlan_id:** Type: integer - **authentication_config:** - **fallback_retry_count:** Type: integer - **mode:** Type: string - **reauthentication_timeout:** Type: integer - **bound_interfaces:** [Type: string] - **bypass_pair:** - **lan:** Type: string - **lan_state_propagation:** Type: boolean - **use_relay:** Type: boolean - **wan:** Type: string - **cellular_config:** - **apn_config:** - **apn:** Type: string - **authentication:** Type: string - **clear_password:** Type: boolean - **password:** Type: string - **password_encrypted:** Type: string - **user_name:** Type: string - **apnprofile_id:** Type: string - **auto_apn:** Type: boolean - **parent_module_id:** Type: string - **parent_sim_slot_number:** Type: integer - **description:** Type: string - **devicemgmt_policysetstack_id:** Type: string - **dhcp_relay:** - **enabled:** Type: boolean - **option_82:** - **circuit_id:** Type: string - **enabled:** Type: boolean - **reforwarding_policy:** Type: string - **remote_id:** Type: string - **server_ips:** [Type: string] - **source_interface:** Type: string - **directed_broadcast:** Type: boolean - **ethernet_port:** - **full_duplex:** Type: boolean - **port_id:** - **connector:** Type: string - **device:** Type: string - **disabled:** Type: boolean - **disabled_reason:** Type: string - **element_id:** Type: string - **id:** Type: string - **inactive:** Type: boolean - **inactive_reason:** Type: string - **max_mtu:** Type: integer - **max_speed:** Type: integer - **name:** Type: string - **original_mac_address:** Type: string - **region:** Type: string - **site_id:** Type: string - **tenant_id:** Type: string - **port_name:** Type: string - **speed:** Type: integer - **interface_profile_id:** Type: string - **ipfixcollectorcontext_id:** Type: string - **ipfixfiltercontext_id:** Type: string - **ipv4_config:** - **dhcp_config:** - **client_id:** Type: string - **hostname:** Type: string - **dns_v4_config:** - **name_servers:** [Type: string] - **search:** [Type: string] - **pppoe_config:** - **chap_passwd:** Type: string - **chap_user:** Type: string - **set_route:** Type: boolean - **routes:** - **destination:** Type: string - **via:** Type: string - **static_config:** - **address:** Type: string - **type:** Type: string - **ipv6_config:** - **dhcp_config:** - **client_id:** Type: string - **hostname:** Type: string - **dns_v6_config:** - **name_servers:** [Type: string] - **search:** [Type: string] - **routes:** - **destination:** Type: string - **via:** Type: string - **static_config:** - **address:** Type: string - **enable_prefix_distribution:** Type: boolean - **type:** Type: string - **lldp_enabled:** Type: boolean - **mac_address:** Type: string - **mtu:** Type: integer - **multicast_config:** - **igmp_version:** Type: string - **multicast_enabled:** Type: boolean - **name:** Type: string - **nat_address:** Type: string - **nat_address_v6:** Type: string - **nat_pools:** - **ipv4_ranges:** - **end:** Type: string - **start:** Type: string - **nat_pool_id:** Type: string - **nat_port:** Type: integer - **nat_port_v6:** Type: integer - **nat_zone_id:** Type: string - **network_context_id:** Type: string - **parent:** Type: string - **peer_bypasspair_wan_port_type:** Type: string - **poe_enabled:** Type: boolean - **power_usage_threshold:** Type: integer - **pppoe_config:** - **host_uniq:** Type: string - **ip_address_type:** Type: string - **password:** Type: string - **reconnection_delay:** Type: integer - **service_name:** Type: string - **username:** Type: string - **scope:** Type: string - **secondary_ip_configs:** - **ipv4_address:** Type: string - **scope:** Type: string - **service_link_config:** - **gre_config:** - **csum:** Type: boolean - **keepalive_enable:** Type: boolean - **keepalive_fail_count:** Type: integer - **keepalive_interval:** Type: integer - **ipsec_config:** - **authentication:** - **certificate:** Type: string - **certificate_profile_id:** Type: string - **comment:** Type: string - **ikev1_params:** - **xauth_id:** Type: string - **xauth_secret:** Type: string - **xauth_secret_encrypted:** Type: string - **xauth_secret_hash:** Type: string - **xauth_type:** Type: string - **local_ca_certificate:** Type: string - **local_id:** Type: string - **local_id_custom:** Type: string - **local_pa_certificate_id:** Type: string - **pa_master_key_id:** Type: string - **passphrase:** Type: string - **passphrase_encrypted:** Type: string - **peer_id_check:** Type: string - **permit_peer_id_mismatch:** Type: boolean - **private_key:** Type: string - **private_key_encrypted:** Type: string - **remote_ca_certificate:** Type: string - **remote_id:** Type: string - **secret:** Type: string - **secret_encrypted:** Type: string - **secret_hash:** Type: string - **strict_validation_peer_extended_key_use:** Type: boolean - **type:** Type: string - **x509Objects:** - **certHolder:** Type: object - **certificate:** Type: string - **is_local_ca_cert_set:** Type: boolean - **is_remote_ca_cert_set:** Type: boolean - **keyPair:** Type: object - **local_ca_certificate:** Type: string - **local_ca_certs_set:** [Type: object] - **passphrase:** Type: string - **private_key:** Type: string - **remote_ca_certificate:** Type: string - **remote_ca_certs_set:** [Type: object] - **ipsec_profile_id:** Type: string - **last_parent:** Type: string - **parent:** Type: string - **peer:** - **hostname:** Type: string - **ip_addresses:** [Type: string] - **service_endpoint_id:** Type: string - **type:** Type: string - **site_wan_interface_ids:** [Type: string] - **static_arp_configs:** - **ipv4_address:** Type: string - **mac_address:** Type: string - **sub_interface:** - **vlan_id:** Type: integer - **switch_port_config:** - **access_vlan_id:** Type: integer - **bpdu_guard_enabled:** Type: boolean - **forward_fast_enabled:** Type: boolean - **native_vlan_id:** Type: integer - **root_guard_enabled:** Type: boolean - **storm_control_config:** - **broadcast_threshold:** Type: integer - **multicast_threshold:** Type: integer - **unicast_threshold:** Type: integer - **stp_port_cost:** Type: integer - **stp_port_enabled:** Type: boolean - **stp_port_priority:** Type: integer - **trunk_vlans:** [Type: string] - **vlan_mode:** Type: string - **voice_vlan_id:** Type: integer - **tags:** [Type: string] - **type:** Type: string - **used_for:** Type: string - **vlan_config:** - **element_vlan_unique_id:** Type: string - **mstp_instance:** Type: integer - **vlan_id:** Type: integer - **voice_enabled:** Type: boolean - **vrf_context_id:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def ipfix(
self, site_id, element_id, ipfix_id, data, tenant_id=None, api_version='v2.0')
Update a IPFix Config (v2.0)
Parameters::
- site_id: Site ID
- element_id: Element (Device) ID
- ipfix_id: IPFix ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Payload Attributes:
- collector_config:
- host: Type: string
- host_port: Type: integer
- ipfixcollectorcontext_id: Type: string
- max_message_size: Type: integer
- protocol: Type: string
- description: Type: string
- export_cache_timeout: Type: integer
- filters:
- app_def_ids: [Type: string]
- dst_ports:
- end: Type: string
- start: Type: string
- dst_prefixes_id: Type: string
- ipfixfiltercontext_ids: [Type: string]
- priority_traffic_types: [Type: string]
- protocols: [Type: string]
- rtp_transport_type: Type: string
- src_ports:
- end: Type: string
- start: Type: string
- src_prefixes_id: Type: string
- wan_path_direction: Type: string
- ipfixprofile_id: Type: string
- ipfixtemplate_id: Type: string
- name: Type: string
- sampler:
- algorithm: Type: string
- time_interval: Type: integer
- time_spacing: Type: integer
- tags: [Type: string]
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def ipfix(self, site_id, element_id, ipfix_id, data, tenant_id=None, api_version="v2.0"): """ Update a IPFix Config (v2.0) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **ipfix_id**: IPFix ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **collector_config:** - **host:** Type: string - **host_port:** Type: integer - **ipfixcollectorcontext_id:** Type: string - **max_message_size:** Type: integer - **protocol:** Type: string - **description:** Type: string - **export_cache_timeout:** Type: integer - **filters:** - **app_def_ids:** [Type: string] - **dst_ports:** - **end:** Type: string - **start:** Type: string - **dst_prefixes_id:** Type: string - **ipfixfiltercontext_ids:** [Type: string] - **priority_traffic_types:** [Type: string] - **protocols:** [Type: string] - **rtp_transport_type:** Type: string - **src_ports:** - **end:** Type: string - **start:** Type: string - **src_prefixes_id:** Type: string - **wan_path_direction:** Type: string - **ipfixprofile_id:** Type: string - **ipfixtemplate_id:** Type: string - **name:** Type: string - **sampler:** - **algorithm:** Type: string - **time_interval:** Type: integer - **time_spacing:** Type: integer - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def ipfixcollectorcontexts(
self, ipfixcollectorcontext_id, data, tenant_id=None, api_version='v2.0')
Update a IPFix Collector context (v2.0)
Parameters::
- ipfixcollectorcontext_id: IPFix Collector Context ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Payload Attributes:
- description: Type: string
- name: Type: string
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def ipfixcollectorcontexts(self, ipfixcollectorcontext_id, data, tenant_id=None, api_version="v2.0"): """ Update a IPFix Collector context (v2.0) **Parameters:**: - **ipfixcollectorcontext_id**: IPFix Collector Context ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **description:** Type: string - **name:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def ipfixfiltercontexts(
self, ipfixfiltercontext_id, data, tenant_id=None, api_version='v2.0')
Update a IPFix Filter context (v2.0)
Parameters::
- ipfixfiltercontext_id: IPFix Filter Context ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Payload Attributes:
- description: Type: string
- name: Type: string
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def ipfixfiltercontexts(self, ipfixfiltercontext_id, data, tenant_id=None, api_version="v2.0"): """ Update a IPFix Filter context (v2.0) **Parameters:**: - **ipfixfiltercontext_id**: IPFix Filter Context ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **description:** Type: string - **name:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def ipfixglobalprefixes(
self, ipfixglobalprefix_id, data, tenant_id=None, api_version='v2.0')
Update a IPFix Global prefix (v2.0)
Parameters::
- ipfixglobalprefix_id: IPFix Global Prefix ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Payload Attributes:
- description: Type: string
- ipv4_prefixes: [Type: string]
- name: Type: string
- tags: [Type: string]
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def ipfixglobalprefixes(self, ipfixglobalprefix_id, data, tenant_id=None, api_version="v2.0"): """ Update a IPFix Global prefix (v2.0) **Parameters:**: - **ipfixglobalprefix_id**: IPFix Global Prefix ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **description:** Type: string - **ipv4_prefixes:** [Type: string] - **name:** Type: string - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def ipfixprofiles(
self, ipfixprofile_id, data, tenant_id=None, api_version='v2.0')
Update a IPFix Profile (v2.0)
Parameters::
- ipfixprofile_id: IPFix Profile ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Payload Attributes:
- collector_config:
- host: Type: string
- host_port: Type: integer
- ipfixcollectorcontext_id: Type: string
- max_message_size: Type: integer
- protocol: Type: string
- description: Type: string
- export_cache_timeout: Type: integer
- filters:
- app_def_ids: [Type: string]
- dst_ports:
- end: Type: string
- start: Type: string
- dst_prefixes_id: Type: string
- ipfixfiltercontext_ids: [Type: string]
- priority_traffic_types: [Type: string]
- protocols: [Type: string]
- rtp_transport_type: Type: string
- src_ports:
- end: Type: string
- start: Type: string
- src_prefixes_id: Type: string
- wan_path_direction: Type: string
- ipfixtemplate_id: Type: string
- name: Type: string
- sampler:
- algorithm: Type: string
- time_interval: Type: integer
- time_spacing: Type: integer
- tags: [Type: string]
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def ipfixprofiles(self, ipfixprofile_id, data, tenant_id=None, api_version="v2.0"): """ Update a IPFix Profile (v2.0) **Parameters:**: - **ipfixprofile_id**: IPFix Profile ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **collector_config:** - **host:** Type: string - **host_port:** Type: integer - **ipfixcollectorcontext_id:** Type: string - **max_message_size:** Type: integer - **protocol:** Type: string - **description:** Type: string - **export_cache_timeout:** Type: integer - **filters:** - **app_def_ids:** [Type: string] - **dst_ports:** - **end:** Type: string - **start:** Type: string - **dst_prefixes_id:** Type: string - **ipfixfiltercontext_ids:** [Type: string] - **priority_traffic_types:** [Type: string] - **protocols:** [Type: string] - **rtp_transport_type:** Type: string - **src_ports:** - **end:** Type: string - **start:** Type: string - **src_prefixes_id:** Type: string - **wan_path_direction:** Type: string - **ipfixtemplate_id:** Type: string - **name:** Type: string - **sampler:** - **algorithm:** Type: string - **time_interval:** Type: integer - **time_spacing:** Type: integer - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def ipfixtemplates(
self, ipfixtemplate_id, data, tenant_id=None, api_version='v2.0')
Update a IPFix template (v2.0)
Parameters::
- ipfixtemplate_id: IPFix Template ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Payload Attributes:
- description: Type: string
- flow_fields: [Type: string]
- generate_biflow: Type: boolean
- name: Type: string
- option_export_timeout: Type: integer
- options: [Type: string]
- tags: [Type: string]
- template_export_timeout: Type: integer
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def ipfixtemplates(self, ipfixtemplate_id, data, tenant_id=None, api_version="v2.0"): """ Update a IPFix template (v2.0) **Parameters:**: - **ipfixtemplate_id**: IPFix Template ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **description:** Type: string - **flow_fields:** [Type: string] - **generate_biflow:** Type: boolean - **name:** Type: string - **option_export_timeout:** Type: integer - **options:** [Type: string] - **tags:** [Type: string] - **template_export_timeout:** Type: integer **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def ipsecprofiles(
self, ipsecprofile_id, data, tenant_id=None, api_version='v2.1')
Update a IPSECProfile (v2.1)
Parameters::
- ipsecprofile_id: IPSEC Profile ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.1)
Payload Attributes:
- authentication:
- certificate: Type: string
- certificate_profile_id: Type: string
- comment: Type: string
- ikev1_params:
- xauth_id: Type: string
- xauth_secret: Type: string
- xauth_secret_encrypted: Type: string
- xauth_secret_hash: Type: string
- xauth_type: Type: string
- local_ca_certificate: Type: string
- local_id: Type: string
- local_id_custom: Type: string
- local_pa_certificate_id: Type: string
- pa_master_key_id: Type: string
- passphrase: Type: string
- passphrase_encrypted: Type: string
- peer_id_check: Type: string
- permit_peer_id_mismatch: Type: boolean
- private_key: Type: string
- private_key_encrypted: Type: string
- remote_ca_certificate: Type: string
- remote_id: Type: string
- secret: Type: string
- secret_encrypted: Type: string
- secret_hash: Type: string
- strict_validation_peer_extended_key_use: Type: boolean
- type: Type: string
- x509Objects:
- certHolder: Type: object
- certificate: Type: string
- is_local_ca_cert_set: Type: boolean
- is_remote_ca_cert_set: Type: boolean
- keyPair: Type: object
- local_ca_certificate: Type: string
- local_ca_certs_set: [Type: object]
- passphrase: Type: string
- private_key: Type: string
- remote_ca_certificate: Type: string
- remote_ca_certs_set: [Type: object]
- description: Type: string
- dpd_delay: Type: integer
- dpd_enable: Type: boolean
- dpd_timeout: Type: integer
- esp_group:
- force_encapsulation: Type: boolean
- lifesize:
- units: Type: string
- value: Type: integer
- lifetime: Type: integer
- lifetime_units: Type: string
- mode: Type: string
- proposals:
- dh_groups: Type: string
- encryption: Type: string
- hash: Type: string
- responder_sase_proposals:
- dh_group: [Type: string]
- encryption: [Type: string]
- hash: [Type: string]
- ike_group:
- aggressive: Type: boolean
- authentication_multiple: Type: integer
- key_exchange: Type: string
- lifetime: Type: integer
- lifetime_units: Type: string
- port: Type: integer
- proposals:
- dh_groups: Type: string
- encryption: Type: string
- hash: Type: string
- reauth: Type: boolean
- name: Type: string
- tags: [Type: string]
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def ipsecprofiles(self, ipsecprofile_id, data, tenant_id=None, api_version="v2.1"): """ Update a IPSECProfile (v2.1) **Parameters:**: - **ipsecprofile_id**: IPSEC Profile ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Payload Attributes:** - **authentication:** - **certificate:** Type: string - **certificate_profile_id:** Type: string - **comment:** Type: string - **ikev1_params:** - **xauth_id:** Type: string - **xauth_secret:** Type: string - **xauth_secret_encrypted:** Type: string - **xauth_secret_hash:** Type: string - **xauth_type:** Type: string - **local_ca_certificate:** Type: string - **local_id:** Type: string - **local_id_custom:** Type: string - **local_pa_certificate_id:** Type: string - **pa_master_key_id:** Type: string - **passphrase:** Type: string - **passphrase_encrypted:** Type: string - **peer_id_check:** Type: string - **permit_peer_id_mismatch:** Type: boolean - **private_key:** Type: string - **private_key_encrypted:** Type: string - **remote_ca_certificate:** Type: string - **remote_id:** Type: string - **secret:** Type: string - **secret_encrypted:** Type: string - **secret_hash:** Type: string - **strict_validation_peer_extended_key_use:** Type: boolean - **type:** Type: string - **x509Objects:** - **certHolder:** Type: object - **certificate:** Type: string - **is_local_ca_cert_set:** Type: boolean - **is_remote_ca_cert_set:** Type: boolean - **keyPair:** Type: object - **local_ca_certificate:** Type: string - **local_ca_certs_set:** [Type: object] - **passphrase:** Type: string - **private_key:** Type: string - **remote_ca_certificate:** Type: string - **remote_ca_certs_set:** [Type: object] - **description:** Type: string - **dpd_delay:** Type: integer - **dpd_enable:** Type: boolean - **dpd_timeout:** Type: integer - **esp_group:** - **force_encapsulation:** Type: boolean - **lifesize:** - **units:** Type: string - **value:** Type: integer - **lifetime:** Type: integer - **lifetime_units:** Type: string - **mode:** Type: string - **proposals:** - **dh_groups:** Type: string - **encryption:** Type: string - **hash:** Type: string - **responder_sase_proposals:** - **dh_group:** [Type: string] - **encryption:** [Type: string] - **hash:** [Type: string] - **ike_group:** - **aggressive:** Type: boolean - **authentication_multiple:** Type: integer - **key_exchange:** Type: string - **lifetime:** Type: integer - **lifetime_units:** Type: string - **port:** Type: integer - **proposals:** - **dh_groups:** Type: string - **encryption:** Type: string - **hash:** Type: string - **reauth:** Type: boolean - **name:** Type: string - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def lannetworks(
self, site_id, lannetwork_id, data, tenant_id=None, api_version='v3.3')
Update an existing LAN (v3.3)
Parameters::
- site_id: Site ID
- lannetwork_id: LAN Network ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v3.3)
Payload Attributes:
- description: Type: string
- ipv4_config:
- default_routers: [Type: string]
- dhcp_relay:
- enabled: Type: boolean
- option_82:
- circuit_id: Type: string
- enabled: Type: boolean
- reforwarding_policy: Type: string
- remote_id: Type: string
- server_ips: [Type: string]
- source_interface: Type: string
- dhcp_server:
- broadcast_address: Type: string
- custom_options:
- option_definition: Type: string
- option_value: Type: string
- default_lease_time: Type: integer
- description: Type: string
- disabled: Type: boolean
- dns_servers: [Type: string]
- domain_name: Type: string
- gateway: Type: string
- id: Type: string
- ip_ranges:
- end_ip: Type: string
- start_ip: Type: string
- max_lease_time: Type: integer
- network_context_id: Type: string
- static_mappings:
- ip_address: Type: string
- mac: Type: string
- name: Type: string
- subnet: Type: string
- tags: [Type: string]
- prefixes: [Type: string]
- ipv6_config:
- default_routers: [Type: string]
- prefixes: [Type: string]
- name: Type: string
- network_context_id: Type: string
- scope: Type: string
- tags: [Type: string]
- vrf_context_id: Type: string
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def lannetworks(self, site_id, lannetwork_id, data, tenant_id=None, api_version="v3.3"): """ Update an existing LAN (v3.3) **Parameters:**: - **site_id**: Site ID - **lannetwork_id**: LAN Network ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v3.3) **Payload Attributes:** - **description:** Type: string - **ipv4_config:** - **default_routers:** [Type: string] - **dhcp_relay:** - **enabled:** Type: boolean - **option_82:** - **circuit_id:** Type: string - **enabled:** Type: boolean - **reforwarding_policy:** Type: string - **remote_id:** Type: string - **server_ips:** [Type: string] - **source_interface:** Type: string - **dhcp_server:** - **broadcast_address:** Type: string - **custom_options:** - **option_definition:** Type: string - **option_value:** Type: string - **default_lease_time:** Type: integer - **description:** Type: string - **disabled:** Type: boolean - **dns_servers:** [Type: string] - **domain_name:** Type: string - **gateway:** Type: string - **id:** Type: string - **ip_ranges:** - **end_ip:** Type: string - **start_ip:** Type: string - **max_lease_time:** Type: integer - **network_context_id:** Type: string - **static_mappings:** - **ip_address:** Type: string - **mac:** Type: string - **name:** Type: string - **subnet:** Type: string - **tags:** [Type: string] - **prefixes:** [Type: string] - **ipv6_config:** - **default_routers:** [Type: string] - **prefixes:** [Type: string] - **name:** Type: string - **network_context_id:** Type: string - **scope:** Type: string - **tags:** [Type: string] - **vrf_context_id:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def localprefixfilters(
self, localprefixfilter_id, data, tenant_id=None, api_version='v2.0')
Update a new local prefix filter. (v2.0)
Parameters::
- localprefixfilter_id: Local Prefix Filter ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Payload Attributes:
- description: Type: string
- name: Type: string
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def localprefixfilters(self, localprefixfilter_id, data, tenant_id=None, api_version="v2.0"): """ Update a new local prefix filter. (v2.0) **Parameters:**: - **localprefixfilter_id**: Local Prefix Filter ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **description:** Type: string - **name:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def machine_cellular_modules_firmware(
self, machine_id, cellular_module_id, data, tenant_id=None, api_version='v2.0')
Update cellular module firmware configuration (v2.0)
Parameters::
- machine_id: Machine ID
- cellular_module_id: Cellular Module ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Payload Attributes:
- cellular_module_image_ids: [Type: string]
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def machine_cellular_modules_firmware(self, machine_id, cellular_module_id, data, tenant_id=None, api_version="v2.0"): """ Update cellular module firmware configuration (v2.0) **Parameters:**: - **machine_id**: Machine ID - **cellular_module_id**: Cellular Module ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **cellular_module_image_ids:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_id. raise TypeError("tenant_id is required but not set or cached.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/machines/{}/cellular_modules/{}/firmware".format(api_version, tenant_id, machine_id, cellular_module_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "put", data=data)
def mstp_instances(
self, site_id, element_id, mstp_instance_id, data, tenant_id=None, api_version='v2.0')
Update a MSTP Instance (v2.0)
Parameters::
- site_id: Site ID
- element_id: Element (Device) ID
- mstp_instance_id: MSTP Instance ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Payload Attributes:
- description: Type: string
- instance_number: Type: integer
- instance_priority: Type: integer
- name: Type: string
- tags: [Type: string]
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def mstp_instances(self, site_id, element_id, mstp_instance_id, data, tenant_id=None, api_version="v2.0"): """ Update a MSTP Instance (v2.0) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **mstp_instance_id**: MSTP Instance ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **description:** Type: string - **instance_number:** Type: integer - **instance_priority:** Type: integer - **name:** Type: string - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def multicastglobalconfigs(
self, site_id, element_id, multicastglobalconfig_id, data, tenant_id=None, api_version='v2.1')
Update Multicast config (v2.1)
Parameters::
- site_id: Site ID
- element_id: Element (Device) ID
- multicastglobalconfig_id: Multicast Global Config ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.1)
Payload Attributes:
- bsm_enabled: Type: boolean
- dr_priority: Type: integer
- igmp_protocol_parameters:
- last_member_query_count: Type: integer
- last_member_query_interval: Type: integer
- query_interval: Type: integer
- query_max_response_time: Type: integer
- pim_protocol_parameters:
- hello_hold_time: Type: integer
- hello_interval: Type: integer
- join_prune_interval: Type: integer
- spt_switchover_enabled: Type: boolean
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def multicastglobalconfigs(self, site_id, element_id, multicastglobalconfig_id, data, tenant_id=None, api_version="v2.1"): """ Update Multicast config (v2.1) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **multicastglobalconfig_id**: Multicast Global Config ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Payload Attributes:** - **bsm_enabled:** Type: boolean - **dr_priority:** Type: integer - **igmp_protocol_parameters:** - **last_member_query_count:** Type: integer - **last_member_query_interval:** Type: integer - **query_interval:** Type: integer - **query_max_response_time:** Type: integer - **pim_protocol_parameters:** - **hello_hold_time:** Type: integer - **hello_interval:** Type: integer - **join_prune_interval:** Type: integer - **spt_switchover_enabled:** Type: boolean **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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/{}/multicastglobalconfigs/{}".format(api_version, tenant_id, site_id, element_id, multicastglobalconfig_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "put", data=data)
def multicastpeergroups(
self, multicastpeergroup_id, data, tenant_id=None, api_version='v2.1')
Update multicast peer group (v2.1)
Parameters::
- multicastpeergroup_id: Multicast Peer Group ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.1)
Payload Attributes:
- description: Type: string
- is_source_site_receiver: Type: boolean
- name: Type: string
- peer_sites:
- peer_site_id: Type: string
- tags: [Type: string]
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def multicastpeergroups(self, multicastpeergroup_id, data, tenant_id=None, api_version="v2.1"): """ Update multicast peer group (v2.1) **Parameters:**: - **multicastpeergroup_id**: Multicast Peer Group ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Payload Attributes:** - **description:** Type: string - **is_source_site_receiver:** Type: boolean - **name:** Type: string - **peer_sites:** - **peer_site_id:** Type: string - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def multicastrps(
self, site_id, element_id, multicastrp_id, data, tenant_id=None, api_version='v2.0')
Updates Multicast RP config (v2.0)
Parameters::
- site_id: Site ID
- element_id: Element (Device) ID
- multicastrp_id: Multicast RP ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Payload Attributes:
- description: Type: string
- groups:
- ipv4_prefix: Type: string
- is_active_rp: Type: boolean
- ipv4_address: Type: string
- name: Type: string
- tags: [Type: string]
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def multicastrps(self, site_id, element_id, multicastrp_id, data, tenant_id=None, api_version="v2.0"): """ Updates Multicast RP config (v2.0) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **multicastrp_id**: Multicast RP ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **description:** Type: string - **groups:** - **ipv4_prefix:** Type: string - **is_active_rp:** Type: boolean - **ipv4_address:** Type: string - **name:** Type: string - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def multicastsourcesiteconfigs(
self, site_id, multicastsourcesiteconfig_id, data, tenant_id=None, api_version='v2.0')
Update multicast source site config (v2.0)
Parameters::
- site_id: Site ID
- multicastsourcesiteconfig_id: Multicast Source Site Config ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Payload Attributes:
- site_configs:
- group_ipv4_prefix: Type: string
- source_ipv4_address: Type: string
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def multicastsourcesiteconfigs(self, site_id, multicastsourcesiteconfig_id, data, tenant_id=None, api_version="v2.0"): """ Update multicast source site config (v2.0) **Parameters:**: - **site_id**: Site ID - **multicastsourcesiteconfig_id**: Multicast Source Site Config ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **site_configs:** - **group_ipv4_prefix:** Type: string - **source_ipv4_address:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def natglobalprefixes(
self, natglobalprefix_id, data, tenant_id=None, api_version='v2.0')
Update an existing NAT prefix. (v2.0)
Parameters::
- natglobalprefix_id: NAT Global Prefix ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Payload Attributes:
- description: Type: string
- ipv4_prefixes: [Type: string]
- name: Type: string
- tags: [Type: string]
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def natglobalprefixes(self, natglobalprefix_id, data, tenant_id=None, api_version="v2.0"): """ Update an existing NAT prefix. (v2.0) **Parameters:**: - **natglobalprefix_id**: NAT Global Prefix ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **description:** Type: string - **ipv4_prefixes:** [Type: string] - **name:** Type: string - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def natlocalprefixes(
self, natlocalprefix_id, data, tenant_id=None, api_version='v2.0')
Update a NAT local prefix. (v2.0)
Parameters::
- natlocalprefix_id: NAT Local Prefix ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Payload Attributes:
- description: Type: string
- name: Type: string
- tags: [Type: string]
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def natlocalprefixes(self, natlocalprefix_id, data, tenant_id=None, api_version="v2.0"): """ Update a NAT local prefix. (v2.0) **Parameters:**: - **natlocalprefix_id**: NAT Local Prefix ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **description:** Type: string - **name:** Type: string - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def natpolicypools(
self, natpolicypool_id, data, tenant_id=None, api_version='v2.0')
Update a NAT Policy Pool. (v2.0)
Parameters::
- natpolicypool_id: NAT Policy Pool ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Payload Attributes:
- description: Type: string
- name: Type: string
- tags: [Type: string]
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def natpolicypools(self, natpolicypool_id, data, tenant_id=None, api_version="v2.0"): """ Update a NAT Policy Pool. (v2.0) **Parameters:**: - **natpolicypool_id**: NAT Policy Pool ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **description:** Type: string - **name:** Type: string - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def natpolicyrules(
self, natpolicyset_id, natpolicyrule_id, data, tenant_id=None, api_version='v2.0')
Update policy rule of tenant. (v2.0)
Parameters::
- natpolicyset_id: NAT Policy Set ID
- natpolicyrule_id: NAT Policy Rule ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Payload Attributes:
- actions:
- nat_pool_id: Type: string
- port: Type: integer
- protocols: [Type: string]
- type: Type: string
- description: Type: string
- destination_ports:
- from: Type: integer
- to: Type: integer
- destination_prefixes:
- description: Type: string
- id: Type: string
- ipv4_prefixes: [Type: string]
- ipv6_prefixes: [Type: string]
- name: Type: string
- tags: [Type: string]
- destination_prefixes_id: Type: string
- destination_zone:
- default_for_public_interfaces: Type: boolean
- description: Type: string
- disabled: Type: boolean
- disabled_reason: Type: string
- id: Type: string
- inactive: Type: boolean
- inactive_reason: Type: string
- name: Type: string
- region: Type: string
- tags: [Type: string]
- tenant_id: Type: string
- destination_zone_id: Type: string
- disabled: Type: boolean
- disabled_reason: Type: string
- enabled: Type: boolean
- inactive: Type: boolean
- inactive_reason: Type: string
- name: Type: string
- natpolicypools:
- description: Type: string
- id: Type: string
- name: Type: string
- tags: [Type: string]
- policyset_id: Type: string
- protocol: Type: integer
- region: Type: string
- source_ports:
- from: Type: integer
- to: Type: integer
- source_prefixes:
- description: Type: string
- id: Type: string
- ipv4_prefixes: [Type: string]
- ipv6_prefixes: [Type: string]
- name: Type: string
- tags: [Type: string]
- source_prefixes_id: Type: string
- source_zone:
- default_for_public_interfaces: Type: boolean
- description: Type: string
- disabled: Type: boolean
- disabled_reason: Type: string
- id: Type: string
- inactive: Type: boolean
- inactive_reason: Type: string
- name: Type: string
- region: Type: string
- tags: [Type: string]
- tenant_id: Type: string
- source_zone_id: Type: string
- tags: [Type: string]
- tenant_id: Type: string
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def natpolicyrules(self, natpolicyset_id, natpolicyrule_id, data, tenant_id=None, api_version="v2.0"): """ Update policy rule of tenant. (v2.0) **Parameters:**: - **natpolicyset_id**: NAT Policy Set ID - **natpolicyrule_id**: NAT Policy Rule ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **actions:** - **nat_pool_id:** Type: string - **port:** Type: integer - **protocols:** [Type: string] - **type:** Type: string - **description:** Type: string - **destination_ports:** - **from:** Type: integer - **to:** Type: integer - **destination_prefixes:** - **description:** Type: string - **id:** Type: string - **ipv4_prefixes:** [Type: string] - **ipv6_prefixes:** [Type: string] - **name:** Type: string - **tags:** [Type: string] - **destination_prefixes_id:** Type: string - **destination_zone:** - **default_for_public_interfaces:** Type: boolean - **description:** Type: string - **disabled:** Type: boolean - **disabled_reason:** Type: string - **id:** Type: string - **inactive:** Type: boolean - **inactive_reason:** Type: string - **name:** Type: string - **region:** Type: string - **tags:** [Type: string] - **tenant_id:** Type: string - **destination_zone_id:** Type: string - **disabled:** Type: boolean - **disabled_reason:** Type: string - **enabled:** Type: boolean - **inactive:** Type: boolean - **inactive_reason:** Type: string - **name:** Type: string - **natpolicypools:** - **description:** Type: string - **id:** Type: string - **name:** Type: string - **tags:** [Type: string] - **policyset_id:** Type: string - **protocol:** Type: integer - **region:** Type: string - **source_ports:** - **from:** Type: integer - **to:** Type: integer - **source_prefixes:** - **description:** Type: string - **id:** Type: string - **ipv4_prefixes:** [Type: string] - **ipv6_prefixes:** [Type: string] - **name:** Type: string - **tags:** [Type: string] - **source_prefixes_id:** Type: string - **source_zone:** - **default_for_public_interfaces:** Type: boolean - **description:** Type: string - **disabled:** Type: boolean - **disabled_reason:** Type: string - **id:** Type: string - **inactive:** Type: boolean - **inactive_reason:** Type: string - **name:** Type: string - **region:** Type: string - **tags:** [Type: string] - **tenant_id:** Type: string - **source_zone_id:** Type: string - **tags:** [Type: string] - **tenant_id:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def natpolicysets(
self, natpolicyset_id, data, tenant_id=None, api_version='v2.0')
Update NAT policy set. (v2.0)
Parameters::
- natpolicyset_id: NAT Policy Set ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Payload Attributes:
- clone_from: Type: string
- description: Type: string
- destination_zone_policyrule_order: [Type: string]
- disabled: Type: boolean
- disabled_reason: Type: string
- inactive: Type: boolean
- inactive_reason: Type: string
- name: Type: string
- policy_req_version: Type: string
- policy_rules:
- actions:
- nat_pool_id: Type: string
- port: Type: integer
- protocols: [Type: string]
- type: Type: string
- description: Type: string
- destination_ports:
- from: Type: integer
- to: Type: integer
- destination_prefixes:
- description: Type: string
- id: Type: string
- ipv4_prefixes: [Type: string]
- ipv6_prefixes: [Type: string]
- name: Type: string
- tags: [Type: string]
- destination_prefixes_id: Type: string
- destination_zone:
- default_for_public_interfaces: Type: boolean
- description: Type: string
- disabled: Type: boolean
- disabled_reason: Type: string
- id: Type: string
- inactive: Type: boolean
- inactive_reason: Type: string
- name: Type: string
- region: Type: string
- tags: [Type: string]
- tenant_id: Type: string
- destination_zone_id: Type: string
- disabled: Type: boolean
- disabled_reason: Type: string
- enabled: Type: boolean
- id: Type: string
- inactive: Type: boolean
- inactive_reason: Type: string
- name: Type: string
- natpolicypools:
- description: Type: string
- id: Type: string
- name: Type: string
- tags: [Type: string]
- policyset_id: Type: string
- protocol: Type: integer
- region: Type: string
- source_ports:
- from: Type: integer
- to: Type: integer
- source_prefixes:
- description: Type: string
- id: Type: string
- ipv4_prefixes: [Type: string]
- ipv6_prefixes: [Type: string]
- name: Type: string
- tags: [Type: string]
- source_prefixes_id: Type: string
- source_zone:
- default_for_public_interfaces: Type: boolean
- description: Type: string
- disabled: Type: boolean
- disabled_reason: Type: string
- id: Type: string
- inactive: Type: boolean
- inactive_reason: Type: string
- name: Type: string
- region: Type: string
- tags: [Type: string]
- tenant_id: Type: string
- source_zone_id: Type: string
- tags: [Type: string]
- tenant_id: Type: string
- actions:
- region: Type: string
- send_to_element: Type: boolean
- source_zone_policyrule_order: [Type: string]
- tags: [Type: string]
- tenant_id: Type: string
- update_order: Type: boolean
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def natpolicysets(self, natpolicyset_id, data, tenant_id=None, api_version="v2.0"): """ Update NAT policy set. (v2.0) **Parameters:**: - **natpolicyset_id**: NAT Policy Set ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **clone_from:** Type: string - **description:** Type: string - **destination_zone_policyrule_order:** [Type: string] - **disabled:** Type: boolean - **disabled_reason:** Type: string - **inactive:** Type: boolean - **inactive_reason:** Type: string - **name:** Type: string - **policy_req_version:** Type: string - **policy_rules:** - **actions:** - **nat_pool_id:** Type: string - **port:** Type: integer - **protocols:** [Type: string] - **type:** Type: string - **description:** Type: string - **destination_ports:** - **from:** Type: integer - **to:** Type: integer - **destination_prefixes:** - **description:** Type: string - **id:** Type: string - **ipv4_prefixes:** [Type: string] - **ipv6_prefixes:** [Type: string] - **name:** Type: string - **tags:** [Type: string] - **destination_prefixes_id:** Type: string - **destination_zone:** - **default_for_public_interfaces:** Type: boolean - **description:** Type: string - **disabled:** Type: boolean - **disabled_reason:** Type: string - **id:** Type: string - **inactive:** Type: boolean - **inactive_reason:** Type: string - **name:** Type: string - **region:** Type: string - **tags:** [Type: string] - **tenant_id:** Type: string - **destination_zone_id:** Type: string - **disabled:** Type: boolean - **disabled_reason:** Type: string - **enabled:** Type: boolean - **id:** Type: string - **inactive:** Type: boolean - **inactive_reason:** Type: string - **name:** Type: string - **natpolicypools:** - **description:** Type: string - **id:** Type: string - **name:** Type: string - **tags:** [Type: string] - **policyset_id:** Type: string - **protocol:** Type: integer - **region:** Type: string - **source_ports:** - **from:** Type: integer - **to:** Type: integer - **source_prefixes:** - **description:** Type: string - **id:** Type: string - **ipv4_prefixes:** [Type: string] - **ipv6_prefixes:** [Type: string] - **name:** Type: string - **tags:** [Type: string] - **source_prefixes_id:** Type: string - **source_zone:** - **default_for_public_interfaces:** Type: boolean - **description:** Type: string - **disabled:** Type: boolean - **disabled_reason:** Type: string - **id:** Type: string - **inactive:** Type: boolean - **inactive_reason:** Type: string - **name:** Type: string - **region:** Type: string - **tags:** [Type: string] - **tenant_id:** Type: string - **source_zone_id:** Type: string - **tags:** [Type: string] - **tenant_id:** Type: string - **region:** Type: string - **send_to_element:** Type: boolean - **source_zone_policyrule_order:** [Type: string] - **tags:** [Type: string] - **tenant_id:** Type: string - **update_order:** Type: boolean **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def natpolicysetstacks(
self, natpolicysetstack_id, data, tenant_id=None, api_version='v2.0')
Update NAT Policy Set Stack. (v2.0)
Parameters::
- natpolicysetstack_id: NAT Policy Set Stack ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Payload Attributes:
- default_policysetstack: Type: boolean
- description: Type: string
- name: Type: string
- policyset_ids: [Type: string]
- tags: [Type: string]
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def natpolicysetstacks(self, natpolicysetstack_id, data, tenant_id=None, api_version="v2.0"): """ Update NAT Policy Set Stack. (v2.0) **Parameters:**: - **natpolicysetstack_id**: NAT Policy Set Stack ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **default_policysetstack:** Type: boolean - **description:** Type: string - **name:** Type: string - **policyset_ids:** [Type: string] - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def natzones(
self, natzone_id, data, tenant_id=None, api_version='v2.0')
Update a Nat Policy Zone. (v2.0)
Parameters::
- natzone_id: NAT Zone ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Payload Attributes:
- default_for_public_interfaces: Type: boolean
- description: Type: string
- disabled: Type: boolean
- disabled_reason: Type: string
- inactive: Type: boolean
- inactive_reason: Type: string
- name: Type: string
- region: Type: string
- tags: [Type: string]
- tenant_id: Type: string
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def natzones(self, natzone_id, data, tenant_id=None, api_version="v2.0"): """ Update a Nat Policy Zone. (v2.0) **Parameters:**: - **natzone_id**: NAT Zone ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **default_for_public_interfaces:** Type: boolean - **description:** Type: string - **disabled:** Type: boolean - **disabled_reason:** Type: string - **inactive:** Type: boolean - **inactive_reason:** Type: string - **name:** Type: string - **region:** Type: string - **tags:** [Type: string] - **tenant_id:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def networkcontexts(
self, networkcontext_id, data, tenant_id=None, api_version='v2.0')
Update LAN segment (v2.0)
Parameters::
- networkcontext_id: Network Context ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Payload Attributes:
- description: Type: string
- name: Type: string
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def networkcontexts(self, networkcontext_id, data, tenant_id=None, api_version="v2.0"): """ Update LAN segment (v2.0) **Parameters:**: - **networkcontext_id**: Network Context ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **description:** Type: string - **name:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def networkpolicyglobalprefixes(
self, networkpolicyglobalprefix_id, data, tenant_id=None, api_version='v2.1')
Update a Network global prefix. (v2.1)
Parameters::
- networkpolicyglobalprefix_id: Network Policy Global Prefix ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.1)
Payload Attributes:
- description: Type: string
- ipv4_prefixes: [Type: string]
- ipv6_prefixes: [Type: string]
- name: Type: string
- tags: [Type: string]
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def networkpolicyglobalprefixes(self, networkpolicyglobalprefix_id, data, tenant_id=None, api_version="v2.1"): """ Update a Network global prefix. (v2.1) **Parameters:**: - **networkpolicyglobalprefix_id**: Network Policy Global Prefix ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Payload Attributes:** - **description:** Type: string - **ipv4_prefixes:** [Type: string] - **ipv6_prefixes:** [Type: string] - **name:** Type: string - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def networkpolicyrules(
self, networkpolicyset_id, networkpolicyrule_id, data, tenant_id=None, api_version='v2.2')
Update network policy rule of tenant. (v2.2)
Parameters::
- networkpolicyset_id: Network Policy Set ID
- networkpolicyrule_id: Network Policy Rule ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.2)
Payload Attributes:
- app_def_ids: [Type: string]
- description: Type: string
- destination_prefixes_id: Type: string
- enabled: Type: boolean
- name: Type: string
- network_context_id: Type: string
- order_number: Type: integer
- paths_allowed:
- active_paths:
- label: Type: string
- path_type: Type: string
- backup_paths:
- label: Type: string
- path_type: Type: string
- l3_failure_paths:
- label: Type: string
- path_type: Type: string
- active_paths:
- service_context:
- active_service_label_id: Type: string
- active_service_label_type: Type: string
- backup_service_label_id: Type: string
- backup_service_label_type: Type: string
- type: Type: string
- source_prefixes_id: Type: string
- tags: [Type: string]
- user_or_group:
- user_group_ids: [Type: string]
- user_ids: [Type: string]
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def networkpolicyrules(self, networkpolicyset_id, networkpolicyrule_id, data, tenant_id=None, api_version="v2.2"): """ Update network policy rule of tenant. (v2.2) **Parameters:**: - **networkpolicyset_id**: Network Policy Set ID - **networkpolicyrule_id**: Network Policy Rule ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.2) **Payload Attributes:** - **app_def_ids:** [Type: string] - **description:** Type: string - **destination_prefixes_id:** Type: string - **enabled:** Type: boolean - **name:** Type: string - **network_context_id:** Type: string - **order_number:** Type: integer - **paths_allowed:** - **active_paths:** - **label:** Type: string - **path_type:** Type: string - **backup_paths:** - **label:** Type: string - **path_type:** Type: string - **l3_failure_paths:** - **label:** Type: string - **path_type:** Type: string - **service_context:** - **active_service_label_id:** Type: string - **active_service_label_type:** Type: string - **backup_service_label_id:** Type: string - **backup_service_label_type:** Type: string - **type:** Type: string - **source_prefixes_id:** Type: string - **tags:** [Type: string] - **user_or_group:** - **user_group_ids:** [Type: string] - **user_ids:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def networkpolicysets(
self, networkpolicyset_id, data, tenant_id=None, api_version='v2.0')
Update Network Policy Set. (v2.0)
Parameters::
- networkpolicyset_id: Network Policy Set ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Payload Attributes:
- clone_from: Type: string
- defaultrule_policyset: Type: boolean
- description: Type: string
- disabled: Type: boolean
- disabled_reason: Type: string
- inactive: Type: boolean
- inactive_reason: Type: string
- name: Type: string
- policy_req_version: Type: string
- policy_rules:
- app_def_ids: [Type: string]
- description: Type: string
- destination_prefixes_id: Type: string
- enabled: Type: boolean
- id: Type: string
- name: Type: string
- network_context_id: Type: string
- order_number: Type: integer
- paths_allowed:
- active_paths:
- label: Type: string
- path_type: Type: string
- backup_paths:
- label: Type: string
- path_type: Type: string
- l3_failure_paths:
- label: Type: string
- path_type: Type: string
- active_paths:
- service_context:
- active_service_label_id: Type: string
- active_service_label_type: Type: string
- backup_service_label_id: Type: string
- backup_service_label_type: Type: string
- type: Type: string
- source_prefixes_id: Type: string
- tags: [Type: string]
- region: Type: string
- send_to_element: Type: boolean
- tags: [Type: string]
- tenant_id: Type: string
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def networkpolicysets(self, networkpolicyset_id, data, tenant_id=None, api_version="v2.0"): """ Update Network Policy Set. (v2.0) **Parameters:**: - **networkpolicyset_id**: Network Policy Set ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **clone_from:** Type: string - **defaultrule_policyset:** Type: boolean - **description:** Type: string - **disabled:** Type: boolean - **disabled_reason:** Type: string - **inactive:** Type: boolean - **inactive_reason:** Type: string - **name:** Type: string - **policy_req_version:** Type: string - **policy_rules:** - **app_def_ids:** [Type: string] - **description:** Type: string - **destination_prefixes_id:** Type: string - **enabled:** Type: boolean - **id:** Type: string - **name:** Type: string - **network_context_id:** Type: string - **order_number:** Type: integer - **paths_allowed:** - **active_paths:** - **label:** Type: string - **path_type:** Type: string - **backup_paths:** - **label:** Type: string - **path_type:** Type: string - **l3_failure_paths:** - **label:** Type: string - **path_type:** Type: string - **service_context:** - **active_service_label_id:** Type: string - **active_service_label_type:** Type: string - **backup_service_label_id:** Type: string - **backup_service_label_type:** Type: string - **type:** Type: string - **source_prefixes_id:** Type: string - **tags:** [Type: string] - **region:** Type: string - **send_to_element:** Type: boolean - **tags:** [Type: string] - **tenant_id:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def networkpolicysetstacks(
self, networkpolicysetstack_id, data, tenant_id=None, api_version='v2.0')
Update a NetworkPolicySetStack (v2.0)
Parameters::
- networkpolicysetstack_id: Network Policy Set Stack ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Payload Attributes:
- default_policysetstack: Type: boolean
- defaultrule_policyset:
- clone_from: Type: string
- defaultrule_policyset: Type: boolean
- description: Type: string
- disabled: Type: boolean
- disabled_reason: Type: string
- id: Type: string
- inactive: Type: boolean
- inactive_reason: Type: string
- name: Type: string
- policy_req_version: Type: string
- policy_rules:
- app_def_ids: [Type: string]
- description: Type: string
- destination_prefixes_id: Type: string
- enabled: Type: boolean
- id: Type: string
- name: Type: string
- network_context_id: Type: string
- order_number: Type: integer
- paths_allowed:
- active_paths:
- label: Type: string
- path_type: Type: string
- backup_paths:
- label: Type: string
- path_type: Type: string
- l3_failure_paths:
- label: Type: string
- path_type: Type: string
- active_paths:
- service_context:
- active_service_label_id: Type: string
- active_service_label_type: Type: string
- backup_service_label_id: Type: string
- backup_service_label_type: Type: string
- type: Type: string
- source_prefixes_id: Type: string
- tags: [Type: string]
- region: Type: string
- send_to_element: Type: boolean
- tags: [Type: string]
- tenant_id: Type: string
- defaultrule_policyset_id: Type: string
- description: Type: string
- disabled: Type: boolean
- disabled_reason: Type: string
- inactive: Type: boolean
- inactive_reason: Type: string
- legacy_policystack: Type: boolean
- name: Type: string
- policyset_ids: [Type: string]
- policysets:
- clone_from: Type: string
- description: Type: string
- disabled: Type: boolean
- disabled_reason: Type: string
- id: Type: string
- inactive: Type: boolean
- inactive_reason: Type: string
- name: Type: string
- policy_rules:
- description: Type: string
- disabled: Type: boolean
- disabled_reason: Type: string
- id: Type: string
- inactive: Type: boolean
- inactive_reason: Type: string
- name: Type: string
- policyset_id: Type: string
- region: Type: string
- tags: [Type: string]
- tenant_id: Type: string
- region: Type: string
- send_to_element: Type: boolean
- tags: [Type: string]
- tenant_id: Type: string
- region: Type: string
- tags: [Type: string]
- tenant_id: Type: string
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def networkpolicysetstacks(self, networkpolicysetstack_id, data, tenant_id=None, api_version="v2.0"): """ Update a NetworkPolicySetStack (v2.0) **Parameters:**: - **networkpolicysetstack_id**: Network Policy Set Stack ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **default_policysetstack:** Type: boolean - **defaultrule_policyset:** - **clone_from:** Type: string - **defaultrule_policyset:** Type: boolean - **description:** Type: string - **disabled:** Type: boolean - **disabled_reason:** Type: string - **id:** Type: string - **inactive:** Type: boolean - **inactive_reason:** Type: string - **name:** Type: string - **policy_req_version:** Type: string - **policy_rules:** - **app_def_ids:** [Type: string] - **description:** Type: string - **destination_prefixes_id:** Type: string - **enabled:** Type: boolean - **id:** Type: string - **name:** Type: string - **network_context_id:** Type: string - **order_number:** Type: integer - **paths_allowed:** - **active_paths:** - **label:** Type: string - **path_type:** Type: string - **backup_paths:** - **label:** Type: string - **path_type:** Type: string - **l3_failure_paths:** - **label:** Type: string - **path_type:** Type: string - **service_context:** - **active_service_label_id:** Type: string - **active_service_label_type:** Type: string - **backup_service_label_id:** Type: string - **backup_service_label_type:** Type: string - **type:** Type: string - **source_prefixes_id:** Type: string - **tags:** [Type: string] - **region:** Type: string - **send_to_element:** Type: boolean - **tags:** [Type: string] - **tenant_id:** Type: string - **defaultrule_policyset_id:** Type: string - **description:** Type: string - **disabled:** Type: boolean - **disabled_reason:** Type: string - **inactive:** Type: boolean - **inactive_reason:** Type: string - **legacy_policystack:** Type: boolean - **name:** Type: string - **policyset_ids:** [Type: string] - **policysets:** - **clone_from:** Type: string - **description:** Type: string - **disabled:** Type: boolean - **disabled_reason:** Type: string - **id:** Type: string - **inactive:** Type: boolean - **inactive_reason:** Type: string - **name:** Type: string - **policy_rules:** - **description:** Type: string - **disabled:** Type: boolean - **disabled_reason:** Type: string - **id:** Type: string - **inactive:** Type: boolean - **inactive_reason:** Type: string - **name:** Type: string - **policyset_id:** Type: string - **region:** Type: string - **tags:** [Type: string] - **tenant_id:** Type: string - **region:** Type: string - **send_to_element:** Type: boolean - **tags:** [Type: string] - **tenant_id:** Type: string - **region:** Type: string - **tags:** [Type: string] - **tenant_id:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def ngfwsecuritypolicyglobalprefixes(
self, ngfwsecuritypolicyglobalprefix_id, data, tenant_id=None, api_version='v2.1')
Update an existing Security Policy V2 Global Prefix (v2.1)
Parameters::
- ngfwsecuritypolicyglobalprefix_id: NGFW Security Policy Global Prefix ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.1)
Payload Attributes:
- description: Type: string
- ipv4_prefixes: [Type: string]
- ipv6_prefixes: [Type: string]
- name: Type: string
- tags: [Type: string]
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def ngfwsecuritypolicyglobalprefixes(self, ngfwsecuritypolicyglobalprefix_id, data, tenant_id=None, api_version="v2.1"): """ Update an existing Security Policy V2 Global Prefix (v2.1) **Parameters:**: - **ngfwsecuritypolicyglobalprefix_id**: NGFW Security Policy Global Prefix ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Payload Attributes:** - **description:** Type: string - **ipv4_prefixes:** [Type: string] - **ipv6_prefixes:** [Type: string] - **name:** Type: string - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def ngfwsecuritypolicylocalprefixes(
self, ngfwsecuritypolicylocalprefix_id, data, tenant_id=None, api_version='v2.0')
Update an existing Security Policy V2 Local Prefix (v2.0)
Parameters::
- ngfwsecuritypolicylocalprefix_id: NGFW Security Policy Local Prefix ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Payload Attributes:
- description: Type: string
- name: Type: string
- tags: [Type: string]
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def ngfwsecuritypolicylocalprefixes(self, ngfwsecuritypolicylocalprefix_id, data, tenant_id=None, api_version="v2.0"): """ Update an existing Security Policy V2 Local Prefix (v2.0) **Parameters:**: - **ngfwsecuritypolicylocalprefix_id**: NGFW Security Policy Local Prefix ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **description:** Type: string - **name:** Type: string - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def ngfwsecuritypolicyrules(
self, ngfwsecuritypolicyset_id, ngfwsecuritypolicyrule_id, data, tenant_id=None, api_version='v2.1')
Update 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
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.1)
Payload Attributes:
- action: Type: string
- app_def_ids: [Type: string]
- description: Type: string
- destination_prefix_ids: [Type: string]
- destination_zone_ids: [Type: string]
- enabled: Type: boolean
- name: Type: string
- services:
- destination_ports:
- from: Type: integer
- to: Type: integer
- protocol: Type: integer
- source_ports:
- from: Type: integer
- to: Type: integer
- destination_ports:
- source_prefix_ids: [Type: string]
- source_zone_ids: [Type: string]
- tags: [Type: string]
- user_or_group:
- user_group_ids: [Type: string]
- user_ids: [Type: string]
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def ngfwsecuritypolicyrules(self, ngfwsecuritypolicyset_id, ngfwsecuritypolicyrule_id, data, tenant_id=None, api_version="v2.1"): """ Update 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 - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Payload Attributes:** - **action:** Type: string - **app_def_ids:** [Type: string] - **description:** Type: string - **destination_prefix_ids:** [Type: string] - **destination_zone_ids:** [Type: string] - **enabled:** Type: boolean - **name:** Type: string - **services:** - **destination_ports:** - **from:** Type: integer - **to:** Type: integer - **protocol:** Type: integer - **source_ports:** - **from:** Type: integer - **to:** Type: integer - **source_prefix_ids:** [Type: string] - **source_zone_ids:** [Type: string] - **tags:** [Type: string] - **user_or_group:** - **user_group_ids:** [Type: string] - **user_ids:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def ngfwsecuritypolicysets(
self, ngfwsecuritypolicyset_id, data, tenant_id=None, api_version='v2.0')
Update an existing Security Policy V2 Set (v2.0)
Parameters::
- ngfwsecuritypolicyset_id: NGFW Security Policy Set ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Payload Attributes:
- clone_from: Type: string
- defaultrule_policyset: Type: boolean
- description: Type: string
- name: Type: string
- policyrule_order: [Type: string]
- tags: [Type: string]
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def ngfwsecuritypolicysets(self, ngfwsecuritypolicyset_id, data, tenant_id=None, api_version="v2.0"): """ Update an existing Security Policy V2 Set (v2.0) **Parameters:**: - **ngfwsecuritypolicyset_id**: NGFW Security Policy Set ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **clone_from:** Type: string - **defaultrule_policyset:** Type: boolean - **description:** Type: string - **name:** Type: string - **policyrule_order:** [Type: string] - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def ngfwsecuritypolicysetstacks(
self, ngfwsecuritypolicysetstack_id, data, tenant_id=None, api_version='v2.0')
Update an existing Security Policy V2 Set Stack (v2.0)
Parameters::
- ngfwsecuritypolicysetstack_id: NGFW Security Policy Set Stack ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Payload Attributes:
- defaultrule_policyset_id: Type: string
- description: Type: string
- name: Type: string
- policyset_ids: [Type: string]
- tags: [Type: string]
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def ngfwsecuritypolicysetstacks(self, ngfwsecuritypolicysetstack_id, data, tenant_id=None, api_version="v2.0"): """ Update an existing Security Policy V2 Set Stack (v2.0) **Parameters:**: - **ngfwsecuritypolicysetstack_id**: NGFW Security Policy Set Stack ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **defaultrule_policyset_id:** Type: string - **description:** Type: string - **name:** Type: string - **policyset_ids:** [Type: string] - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def ntp(
self, element_id, ntp_id, data, tenant_id=None, api_version='v2.0')
Update an existing element NTP. (v2.0)
Parameters::
- element_id: Element (Device) ID
- ntp_id: NTP Configuration ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Payload Attributes:
- description: Type: string
- name: Type: string
- ntp_servers:
- host: Type: string
- max_poll: Type: integer
- min_poll: Type: integer
- version: Type: integer
- source_interface_ids: [Type: string]
- tags: [Type: string]
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def ntp(self, element_id, ntp_id, data, tenant_id=None, api_version="v2.0"): """ Update an existing element NTP. (v2.0) **Parameters:**: - **element_id**: Element (Device) ID - **ntp_id**: NTP Configuration ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **description:** Type: string - **name:** Type: string - **ntp_servers:** - **host:** Type: string - **max_poll:** Type: integer - **min_poll:** Type: integer - **version:** Type: integer - **source_interface_ids:** [Type: string] - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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/{}/ntp/{}".format(api_version, tenant_id, element_id, ntp_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "put", data=data)
def otpaccessconfigs(
self, otpaccessconfig_id, data, tenant_id=None, api_version='v2.0')
Update an OTP Access for all elements under an Tenant. (v2.0)
Parameters::
- otpaccessconfig_id: OTP Access configuration ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Payload Attributes:
- otp_attempts: Type: integer
- otp_validity_minutes: Type: integer
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def otpaccessconfigs(self, otpaccessconfig_id, data, tenant_id=None, api_version="v2.0"): """ Update an OTP Access for all elements under an Tenant. (v2.0) **Parameters:**: - **otpaccessconfig_id**: OTP Access configuration ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **otp_attempts:** Type: integer - **otp_validity_minutes:** Type: integer **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_id. raise TypeError("tenant_id is required but not set or cached.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/otpaccessconfigs/{}".format(api_version, tenant_id, otpaccessconfig_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "put", data=data)
def pathgroups(
self, pathgroup_id, data, tenant_id=None, api_version='v2.1')
Update A Path Group of a tenant. (v2.1)
Parameters::
- pathgroup_id: Path Group ID (for network service/DC routing)
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.1)
Payload Attributes:
- description: Type: string
- name: Type: string
- paths:
- label: Type: string
- path_type: Type: string
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def pathgroups(self, pathgroup_id, data, tenant_id=None, api_version="v2.1"): """ Update A Path Group of a tenant. (v2.1) **Parameters:**: - **pathgroup_id**: Path Group ID (for network service/DC routing) - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Payload Attributes:** - **description:** Type: string - **name:** Type: string - **paths:** - **label:** Type: string - **path_type:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def perfmgmtpolicysets(
self, perfmgmtpolicyset_id, data, tenant_id=None, api_version='v2.0')
PUT Perfmgmtpolicysets API Function
Parameters::
- perfmgmtpolicyset_id: Performance Management Policy Set ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Payload Attributes:
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def perfmgmtpolicysets(self, perfmgmtpolicyset_id, data, tenant_id=None, api_version="v2.0"): """ PUT Perfmgmtpolicysets API Function **Parameters:**: - **perfmgmtpolicyset_id**: Performance Management Policy Set ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def perfmgmtpolicysets_perfmgmtpolicyrules(
self, perfmgmtpolicyset_id, perfmgmtpolicyrule_id, data, tenant_id=None, api_version='v2.0')
PUT Perfmgmtpolicysets_Perfmgmtpolicyrules API Function
Parameters::
- perfmgmtpolicyset_id: Performance Management Policy Set ID
- perfmgmtpolicyrule_id: Performance Management Policy Rule ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Payload Attributes:
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def perfmgmtpolicysets_perfmgmtpolicyrules(self, perfmgmtpolicyset_id, perfmgmtpolicyrule_id, data, tenant_id=None, api_version="v2.0"): """ PUT Perfmgmtpolicysets_Perfmgmtpolicyrules API Function **Parameters:**: - **perfmgmtpolicyset_id**: Performance Management Policy Set ID - **perfmgmtpolicyrule_id**: Performance Management Policy Rule ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def perfmgmtpolicysetstacks(
self, perfmgmtpolicysetstack_id, data, tenant_id=None, api_version='v2.0')
PUT Perfmgmtpolicysetstacks API Function
Parameters::
- perfmgmtpolicysetstack_id: Performance Management Policy Set Stack ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Payload Attributes:
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def perfmgmtpolicysetstacks(self, perfmgmtpolicysetstack_id, data, tenant_id=None, api_version="v2.0"): """ PUT Perfmgmtpolicysetstacks API Function **Parameters:**: - **perfmgmtpolicysetstack_id**: Performance Management Policy Set Stack ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def perfmgmtthresholdprofiles(
self, perfmgmtthresholdprofile_id, data, tenant_id=None, api_version='v2.0')
PUT Perfmgmtthresholdprofiles API Function
Parameters::
- perfmgmtthresholdprofile_id: Performance Management Policy Threshold Profile ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Payload Attributes:
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def perfmgmtthresholdprofiles(self, perfmgmtthresholdprofile_id, data, tenant_id=None, api_version="v2.0"): """ PUT Perfmgmtthresholdprofiles API Function **Parameters:**: - **perfmgmtthresholdprofile_id**: Performance Management Policy Threshold Profile ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def policyrules(
self, policyset_id, policyrule_id, data, tenant_id=None, api_version='v3.1')
Update policy rule of tenant. (v3.1)
Parameters::
- policyset_id: Policy Set ID
- policyrule_id: Policy Rule ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v3.1)
Payload Attributes:
- app_def_id: Type: string
- description: Type: string
- name: Type: string
- network_context_id: Type: string
- paths_allowed:
- active_paths:
- label: Type: string
- path_type: Type: string
- backup_paths:
- label: Type: string
- path_type: Type: string
- l3_failure_paths:
- label: Type: string
- path_type: Type: string
- active_paths:
- priority_num: Type: integer
- service_context:
- active_service_label_id: Type: string
- active_service_label_type: Type: string
- backup_service_label_id: Type: string
- backup_service_label_type: Type: string
- type: Type: string
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def policyrules(self, policyset_id, policyrule_id, data, tenant_id=None, api_version="v3.1"): """ Update policy rule of tenant. (v3.1) **Parameters:**: - **policyset_id**: Policy Set ID - **policyrule_id**: Policy Rule ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v3.1) **Payload Attributes:** - **app_def_id:** Type: string - **description:** Type: string - **name:** Type: string - **network_context_id:** Type: string - **paths_allowed:** - **active_paths:** - **label:** Type: string - **path_type:** Type: string - **backup_paths:** - **label:** Type: string - **path_type:** Type: string - **l3_failure_paths:** - **label:** Type: string - **path_type:** Type: string - **priority_num:** Type: integer - **service_context:** - **active_service_label_id:** Type: string - **active_service_label_type:** Type: string - **backup_service_label_id:** Type: string - **backup_service_label_type:** Type: string - **type:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def policysets(
self, policyset_id, data, tenant_id=None, api_version='v3.0')
Update policy set. (v3.0)
Parameters::
- policyset_id: Policy Set ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v3.0)
Payload Attributes:
- bandwidth_allocation_schemes:
- bandwidth_range:
- high: Type: number
- low: Type: number
- business_priorities:
- bandwidth_allocation: Type: number
- bandwidth_split_per_type:
- bulk: Type: number
- rt_audio: Type: number
- rt_video: Type: number
- transactional: Type: number
- priority_num: Type: integer
- bandwidth_range:
- business_priority_names:
- priority_name: Type: string
- priority_num: Type: integer
- default_policy: Type: boolean
- description: Type: string
- name: Type: string
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def policysets(self, policyset_id, data, tenant_id=None, api_version="v3.0"): """ Update policy set. (v3.0) **Parameters:**: - **policyset_id**: Policy Set ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v3.0) **Payload Attributes:** - **bandwidth_allocation_schemes:** - **bandwidth_range:** - **high:** Type: number - **low:** Type: number - **business_priorities:** - **bandwidth_allocation:** Type: number - **bandwidth_split_per_type:** - **bulk:** Type: number - **rt_audio:** Type: number - **rt_video:** Type: number - **transactional:** Type: number - **priority_num:** Type: integer - **business_priority_names:** - **priority_name:** Type: string - **priority_num:** Type: integer - **default_policy:** Type: boolean - **description:** Type: string - **name:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def prefixfilters(
self, site_id, prefixfilter_id, data, tenant_id=None, api_version='v2.0')
Update an existing security prefix filter (v2.0)
Parameters::
- site_id: Site ID
- prefixfilter_id: Prefix Filter ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Payload Attributes:
- filters:
- type: Type: string
- prefix_filter_id: Type: string
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def prefixfilters(self, site_id, prefixfilter_id, data, tenant_id=None, api_version="v2.0"): """ Update an existing security prefix filter (v2.0) **Parameters:**: - **site_id**: Site ID - **prefixfilter_id**: Prefix Filter ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **filters:** - **type:** Type: string - **prefix_filter_id:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def prioritypolicyglobalprefixes(
self, prioritypolicyglobalprefix_id, data, tenant_id=None, api_version='v2.1')
Update a Priority global prefix. (v2.1)
Parameters::
- prioritypolicyglobalprefix_id: Priority Policy Global Prefix ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.1)
Payload Attributes:
- description: Type: string
- ipv4_prefixes: [Type: string]
- ipv6_prefixes: [Type: string]
- name: Type: string
- tags: [Type: string]
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def prioritypolicyglobalprefixes(self, prioritypolicyglobalprefix_id, data, tenant_id=None, api_version="v2.1"): """ Update a Priority global prefix. (v2.1) **Parameters:**: - **prioritypolicyglobalprefix_id**: Priority Policy Global Prefix ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Payload Attributes:** - **description:** Type: string - **ipv4_prefixes:** [Type: string] - **ipv6_prefixes:** [Type: string] - **name:** Type: string - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def prioritypolicyrules(
self, prioritypolicyset_id, prioritypolicyrule_id, data, tenant_id=None, api_version='v2.1')
Update priority policy rule of tenant. (v2.1)
Parameters::
- prioritypolicyset_id: Priority Policy Set ID
- prioritypolicyrule_id: Priority Policy Rule ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.1)
Payload Attributes:
- app_def_ids: [Type: string]
- description: Type: string
- destination_prefixes_id: Type: string
- dscp:
- value: Type: integer
- enabled: Type: boolean
- name: Type: string
- network_context_id: Type: string
- order_number: Type: integer
- priority_number: Type: integer
- source_prefixes_id: Type: string
- tags: [Type: string]
- user_or_group:
- user_group_ids: [Type: string]
- user_ids: [Type: string]
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def prioritypolicyrules(self, prioritypolicyset_id, prioritypolicyrule_id, data, tenant_id=None, api_version="v2.1"): """ Update priority policy rule of tenant. (v2.1) **Parameters:**: - **prioritypolicyset_id**: Priority Policy Set ID - **prioritypolicyrule_id**: Priority Policy Rule ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Payload Attributes:** - **app_def_ids:** [Type: string] - **description:** Type: string - **destination_prefixes_id:** Type: string - **dscp:** - **value:** Type: integer - **enabled:** Type: boolean - **name:** Type: string - **network_context_id:** Type: string - **order_number:** Type: integer - **priority_number:** Type: integer - **source_prefixes_id:** Type: string - **tags:** [Type: string] - **user_or_group:** - **user_group_ids:** [Type: string] - **user_ids:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def prioritypolicysets(
self, prioritypolicyset_id, data, tenant_id=None, api_version='v2.0')
Update Priority Policy Set. (v2.0)
Parameters::
- prioritypolicyset_id: Priority Policy Set ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Payload Attributes:
- bandwidth_allocation_schemes:
- bandwidth_range:
- high: Type: number
- low: Type: number
- business_priorities:
- bandwidth_allocation: Type: number
- bandwidth_split_per_type:
- bulk: Type: number
- rt_audio: Type: number
- rt_video: Type: number
- transactional: Type: number
- priority_number: Type: integer
- bandwidth_range:
- business_priority_names:
- priority_name: Type: string
- priority_num: Type: integer
- clone_from: Type: string
- default_rule_dscp_mappings:
- dscp: [Type: integer]
- priority_number: Type: integer
- transfer_type: Type: string
- defaultrule_policyset: Type: boolean
- description: Type: string
- name: Type: string
- tags: [Type: string]
- template: Type: boolean
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def prioritypolicysets(self, prioritypolicyset_id, data, tenant_id=None, api_version="v2.0"): """ Update Priority Policy Set. (v2.0) **Parameters:**: - **prioritypolicyset_id**: Priority Policy Set ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **bandwidth_allocation_schemes:** - **bandwidth_range:** - **high:** Type: number - **low:** Type: number - **business_priorities:** - **bandwidth_allocation:** Type: number - **bandwidth_split_per_type:** - **bulk:** Type: number - **rt_audio:** Type: number - **rt_video:** Type: number - **transactional:** Type: number - **priority_number:** Type: integer - **business_priority_names:** - **priority_name:** Type: string - **priority_num:** Type: integer - **clone_from:** Type: string - **default_rule_dscp_mappings:** - **dscp:** [Type: integer] - **priority_number:** Type: integer - **transfer_type:** Type: string - **defaultrule_policyset:** Type: boolean - **description:** Type: string - **name:** Type: string - **tags:** [Type: string] - **template:** Type: boolean **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def prioritypolicysetstacks(
self, prioritypolicysetstack_id, data, tenant_id=None, api_version='v2.0')
Update a PriorityPolicySetStack (v2.0)
Parameters::
- prioritypolicysetstack_id: Priority Policy Stack ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Payload Attributes:
- default_policysetstack: Type: boolean
- defaultrule_policyset_id: Type: string
- description: Type: string
- name: Type: string
- policyset_ids: [Type: string]
- tags: [Type: string]
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def prioritypolicysetstacks(self, prioritypolicysetstack_id, data, tenant_id=None, api_version="v2.0"): """ Update a PriorityPolicySetStack (v2.0) **Parameters:**: - **prioritypolicysetstack_id**: Priority Policy Stack ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **default_policysetstack:** Type: boolean - **defaultrule_policyset_id:** Type: string - **description:** Type: string - **name:** Type: string - **policyset_ids:** [Type: string] - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def prismaaccess_configs(
self, site_id, prismaaccess_config_id, data, tenant_id=None, api_version='v2.0')
Update 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
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Payload Attributes:
- remote_networks:
- edge_location_display: Type: string
- edge_location_value: Type: string
- remote_network_names: [Type: string]
- service_link_ids: [Type: string]
- spn_name: Type: string
- site_id: Type: string
- tenant_id: Type: string
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def prismaaccess_configs(self, site_id, prismaaccess_config_id, data, tenant_id=None, api_version="v2.0"): """ Update 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 - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **remote_networks:** - **edge_location_display:** Type: string - **edge_location_value:** Type: string - **remote_network_names:** [Type: string] - **service_link_ids:** [Type: string] - **spn_name:** Type: string - **site_id:** Type: string - **tenant_id:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def prismasase_connections(
self, site_id, prismasase_connection_id, data, tenant_id=None, api_version='v2.0')
PUT Prismasase_Connections API Function
Parameters::
- site_id: Site ID
- prismasase_connection_id: Prisma SASE Connection ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Payload Attributes:
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def prismasase_connections(self, site_id, prismasase_connection_id, data, tenant_id=None, api_version="v2.0"): """ PUT Prismasase_Connections API Function **Parameters:**: - **site_id**: Site ID - **prismasase_connection_id**: Prisma SASE Connection ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def prismasase_connections_configs(
self, data, tenant_id=None, api_version='v2.0')
PUT Prismasase_Connections_Configs API Function
Parameters::
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Payload Attributes:
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def prismasase_connections_configs(self, data, tenant_id=None, api_version="v2.0"): """ PUT Prismasase_Connections_Configs API Function **Parameters:**: - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def radii(
self, element_id, radii_id, data, tenant_id=None, api_version='v2.0')
Used for element radius configuration updates (v2.0)
Parameters::
- element_id: Element (Device) ID
- radii_id: Radii ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Payload Attributes:
- description: Type: string
- name: Type: string
- override_indicator: [Type: string]
- radius_configuration:
- accounting_port: Type: integer
- authentication_port: Type: integer
- ip_version: Type: integer
- priority: Type: integer
- retain_shared_secret: Type: boolean
- server_ip_address: Type: string
- shared_secret: Type: string
- shared_secret_encrypted: Type: string
- radius_profile_id: Type: string
- source_interface_id: Type: string
- tags: [Type: string]
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def radii(self, element_id, radii_id, data, tenant_id=None, api_version="v2.0"): """ Used for element radius configuration updates (v2.0) **Parameters:**: - **element_id**: Element (Device) ID - **radii_id**: Radii ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **description:** Type: string - **name:** Type: string - **override_indicator:** [Type: string] - **radius_configuration:** - **accounting_port:** Type: integer - **authentication_port:** Type: integer - **ip_version:** Type: integer - **priority:** Type: integer - **retain_shared_secret:** Type: boolean - **server_ip_address:** Type: string - **shared_secret:** Type: string - **shared_secret_encrypted:** Type: string - **radius_profile_id:** Type: string - **source_interface_id:** Type: string - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def recovery_tokens(
self, machine_id, recovery_token_id, data, tenant_id=None, api_version='v2.1')
Update Recovery Token for Fips change mode (v2.1)
Parameters::
- machine_id: Machine ID
- recovery_token_id: Recovery Token ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.1)
Payload Attributes:
- token_validity_in_hour: Type: integer
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def recovery_tokens(self, machine_id, recovery_token_id, data, tenant_id=None, api_version="v2.1"): """ Update Recovery Token for Fips change mode (v2.1) **Parameters:**: - **machine_id**: Machine ID - **recovery_token_id**: Recovery Token ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Payload Attributes:** - **token_validity_in_hour:** Type: integer **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_id. raise TypeError("tenant_id is required but not set or cached.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/machines/{}/recovery_tokens/{}".format(api_version, tenant_id, machine_id, recovery_token_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "put", data=data)
def roles(
self, role_id, data, tenant_id=None, api_version='v2.1')
Update a custom role (v2.1)
Parameters::
- role_id: Role ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.1)
Payload Attributes:
- custom_permissions:
- allowed_after_ms: Type: integer
- allowed_before_ms: Type: integer
- disabled: Type: boolean
- disabled_reason: Type: string
- disallow_permission: Type: boolean
- id: Type: string
- inactive: Type: boolean
- inactive_reason: Type: string
- region: Type: string
- tenant_id: Type: string
- value: Type: string
- description: Type: string
- disabled: Type: boolean
- disabled_reason: Type: string
- disallow_permissions:
- value: Type: string
- inactive: Type: boolean
- inactive_reason: Type: string
- is_system_owned: Type: boolean
- name: Type: string
- permissions:
- value: Type: string
- region: Type: string
- roles:
- name: Type: string
- tenant_id: Type: string
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def roles(self, role_id, data, tenant_id=None, api_version="v2.1"): """ Update a custom role (v2.1) **Parameters:**: - **role_id**: Role ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Payload Attributes:** - **custom_permissions:** - **allowed_after_ms:** Type: integer - **allowed_before_ms:** Type: integer - **disabled:** Type: boolean - **disabled_reason:** Type: string - **disallow_permission:** Type: boolean - **id:** Type: string - **inactive:** Type: boolean - **inactive_reason:** Type: string - **region:** Type: string - **tenant_id:** Type: string - **value:** Type: string - **description:** Type: string - **disabled:** Type: boolean - **disabled_reason:** Type: string - **disallow_permissions:** - **value:** Type: string - **inactive:** Type: boolean - **inactive_reason:** Type: string - **is_system_owned:** Type: boolean - **name:** Type: string - **permissions:** - **value:** Type: string - **region:** Type: string - **roles:** - **name:** Type: string - **tenant_id:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def routing_aspathaccesslists(
self, site_id, element_id, routing_aspathaccesslist_id, data, tenant_id=None, api_version='v2.1')
Updates Access List (v2.1)
Parameters::
- site_id: Site ID
- element_id: Element (Device) ID
- routing_aspathaccesslist_id: Routing AS-PATH Access List ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.1)
Payload Attributes:
- as_path_regex_list:
- as_path_regex: Type: string
- order: Type: integer
- permit: Type: boolean
- auto_generated: Type: boolean
- description: Type: string
- name: Type: string
- tags: [Type: string]
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def routing_aspathaccesslists(self, site_id, element_id, routing_aspathaccesslist_id, data, tenant_id=None, api_version="v2.1"): """ Updates Access List (v2.1) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **routing_aspathaccesslist_id**: Routing AS-PATH Access List ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Payload Attributes:** - **as_path_regex_list:** - **as_path_regex:** Type: string - **order:** Type: integer - **permit:** Type: boolean - **auto_generated:** Type: boolean - **description:** Type: string - **name:** Type: string - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def routing_ipcommunitylists(
self, site_id, element_id, routing_ipcommunitylist_id, data, tenant_id=None, api_version='v2.0')
Updates Community List (v2.0)
Parameters::
- site_id: Site ID
- element_id: Element (Device) ID
- routing_ipcommunitylist_id: Routing IP Community List ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Payload Attributes:
- auto_generated: Type: boolean
- community_list:
- community_str: Type: string
- permit: Type: boolean
- description: Type: string
- name: Type: string
- tags: [Type: string]
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def routing_ipcommunitylists(self, site_id, element_id, routing_ipcommunitylist_id, data, tenant_id=None, api_version="v2.0"): """ Updates Community List (v2.0) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **routing_ipcommunitylist_id**: Routing IP Community List ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **auto_generated:** Type: boolean - **community_list:** - **community_str:** Type: string - **permit:** Type: boolean - **description:** Type: string - **name:** Type: string - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def routing_prefixlists(
self, site_id, element_id, routing_prefixlist_id, data, tenant_id=None, api_version='v2.1')
Updates Prefix List (v2.1)
Parameters::
- site_id: Site ID
- element_id: Element (Device) ID
- routing_prefixlist_id: Routing IP Prefix List ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.1)
Payload Attributes:
- auto_generated: Type: boolean
- description: Type: string
- name: Type: string
- prefix_filter_list:
- ge: Type: integer
- ipv6_prefix: Type: string
- le: Type: integer
- order: Type: integer
- permit: Type: boolean
- prefix: Type: string
- tags: [Type: string]
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def routing_prefixlists(self, site_id, element_id, routing_prefixlist_id, data, tenant_id=None, api_version="v2.1"): """ Updates Prefix List (v2.1) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **routing_prefixlist_id**: Routing IP Prefix List ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Payload Attributes:** - **auto_generated:** Type: boolean - **description:** Type: string - **name:** Type: string - **prefix_filter_list:** - **ge:** Type: integer - **ipv6_prefix:** Type: string - **le:** Type: integer - **order:** Type: integer - **permit:** Type: boolean - **prefix:** Type: string - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def routing_routemaps(
self, site_id, element_id, routing_routemap_id, data, tenant_id=None, api_version='v2.2')
Updates Route Map (v2.2)
Parameters::
- site_id: Site ID
- element_id: Element (Device) ID
- routing_routemap_id: Routing Route Map ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.2)
Payload Attributes:
- auto_generated: Type: boolean
- description: Type: string
- name: Type: string
- route_map_entries:
- continue_entry: Type: string
- match:
- as_path_id: Type: string
- community_list_id: Type: string
- ip_next_hop_id: Type: string
- ip_prefix_list_id: Type: string
- tag: Type: integer
- order: Type: integer
- permit: Type: boolean
- set:
- as_path_prepend: Type: string
- community: Type: string
- ip_next_hop: Type: string
- local_preference: Type: integer
- tag: Type: integer
- weight: Type: integer
- tags: [Type: string]
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def routing_routemaps(self, site_id, element_id, routing_routemap_id, data, tenant_id=None, api_version="v2.2"): """ Updates Route Map (v2.2) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **routing_routemap_id**: Routing Route Map ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.2) **Payload Attributes:** - **auto_generated:** Type: boolean - **description:** Type: string - **name:** Type: string - **route_map_entries:** - **continue_entry:** Type: string - **match:** - **as_path_id:** Type: string - **community_list_id:** Type: string - **ip_next_hop_id:** Type: string - **ip_prefix_list_id:** Type: string - **tag:** Type: integer - **order:** Type: integer - **permit:** Type: boolean - **set:** - **as_path_prepend:** Type: string - **community:** Type: string - **ip_next_hop:** Type: string - **local_preference:** Type: integer - **tag:** Type: integer - **weight:** Type: integer - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def sdwanapps_configs(
self, sdwanapp_id, config_id, data, tenant_id=None, api_version='v2.0')
PUT Sdwanapps_Configs API Function
Parameters::
- sdwanapp_id: SDWAN Application ID
- config_id: SDWAN App Config ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Payload Attributes:
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def sdwanapps_configs(self, sdwanapp_id, config_id, data, tenant_id=None, api_version="v2.0"): """ PUT Sdwanapps_Configs API Function **Parameters:**: - **sdwanapp_id**: SDWAN Application ID - **config_id**: SDWAN App Config ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def securitypolicyrules(
self, securitypolicyset_id, securitypolicyrule_id, data, tenant_id=None, api_version='v2.0')
Update a tenant security policy rule. (v2.0)
Parameters::
- securitypolicyset_id: Security Policy Set ID
- securitypolicyrule_id: Security Policy Rule ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Payload Attributes:
- action: Type: string
- application_ids: [Type: string]
- description: Type: string
- destination_filter_ids: [Type: string]
- destination_zone_ids: [Type: string]
- disabled_flag: Type: boolean
- name: Type: string
- source_filter_ids: [Type: string]
- source_zone_ids: [Type: string]
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def securitypolicyrules(self, securitypolicyset_id, securitypolicyrule_id, data, tenant_id=None, api_version="v2.0"): """ Update a tenant security policy rule. (v2.0) **Parameters:**: - **securitypolicyset_id**: Security Policy Set ID - **securitypolicyrule_id**: Security Policy Rule ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **action:** Type: string - **application_ids:** [Type: string] - **description:** Type: string - **destination_filter_ids:** [Type: string] - **destination_zone_ids:** [Type: string] - **disabled_flag:** Type: boolean - **name:** Type: string - **source_filter_ids:** [Type: string] - **source_zone_ids:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def securitypolicysets(
self, securitypolicyset_id, data, tenant_id=None, api_version='v2.0')
Update a tenant security policy set. (v2.0)
Parameters::
- securitypolicyset_id: Security Policy Set ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Payload Attributes:
- description: Type: string
- name: Type: string
- policyrule_order: [Type: string]
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def securitypolicysets(self, securitypolicyset_id, data, tenant_id=None, api_version="v2.0"): """ Update a tenant security policy set. (v2.0) **Parameters:**: - **securitypolicyset_id**: Security Policy Set ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **description:** Type: string - **name:** Type: string - **policyrule_order:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def securityzones(
self, securityzone_id, data, tenant_id=None, api_version='v2.0')
Update an existing security zone (v2.0)
Parameters::
- securityzone_id: Security Zone (ZBFW) ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Payload Attributes:
- description: Type: string
- name: Type: string
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def securityzones(self, securityzone_id, data, tenant_id=None, api_version="v2.0"): """ Update an existing security zone (v2.0) **Parameters:**: - **securityzone_id**: Security Zone (ZBFW) ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **description:** Type: string - **name:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def servicebindingmaps(
self, servicebindingmap_id, data, tenant_id=None, api_version='v2.1')
Update a ServiceBindingMap (v2.1)
Parameters::
- servicebindingmap_id: Service Binding Map ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.1)
Payload Attributes:
- description: Type: string
- is_default: Type: boolean
- name: Type: string
- service_bindings:
- service_endpoint_ids: [Type: string]
- service_label_id: Type: string
- tags: [Type: string]
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def servicebindingmaps(self, servicebindingmap_id, data, tenant_id=None, api_version="v2.1"): """ Update a ServiceBindingMap (v2.1) **Parameters:**: - **servicebindingmap_id**: Service Binding Map ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Payload Attributes:** - **description:** Type: string - **is_default:** Type: boolean - **name:** Type: string - **service_bindings:** - **service_endpoint_ids:** [Type: string] - **service_label_id:** Type: string - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def serviceendpoints(
self, serviceendpoint_id, data, tenant_id=None, api_version='v2.4')
Update a ServiceEndpoint (v2.4)
Parameters::
- serviceendpoint_id: Service Endpoint ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.4)
Payload Attributes:
- address:
- city: Type: string
- country: Type: string
- post_code: Type: string
- state: Type: string
- street: Type: string
- street2: Type: string
- admin_up: Type: boolean
- allow_enterprise_traffic: Type: boolean
- description: Type: string
- disable_tunnel_reoptimization: Type: boolean
- liveliness_probe:
- http:
- failure_count: Type: integer
- http_status_codes: [Type: integer]
- interval: Type: integer
- url: Type: string
- icmp_ping:
- failure_count: Type: integer
- interval: Type: integer
- ip_addresses: [Type: string]
- http:
- location:
- description: Type: string
- latitude: Type: number
- longitude: Type: number
- name: Type: string
- sase_properties:
- allocated_bandwidth_mbps: Type: integer
- allocated_sc_count: Type: integer
- pa_compute_region_oid: Type: string
- total_sc_bandwidth_mbps: Type: integer
- service_link_peers:
- hostnames: [Type: string]
- ip_addresses: [Type: string]
- site_id: Type: string
- tags: [Type: string]
- type: Type: string
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def serviceendpoints(self, serviceendpoint_id, data, tenant_id=None, api_version="v2.4"): """ Update a ServiceEndpoint (v2.4) **Parameters:**: - **serviceendpoint_id**: Service Endpoint ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.4) **Payload Attributes:** - **address:** - **city:** Type: string - **country:** Type: string - **post_code:** Type: string - **state:** Type: string - **street:** Type: string - **street2:** Type: string - **admin_up:** Type: boolean - **allow_enterprise_traffic:** Type: boolean - **description:** Type: string - **disable_tunnel_reoptimization:** Type: boolean - **liveliness_probe:** - **http:** - **failure_count:** Type: integer - **http_status_codes:** [Type: integer] - **interval:** Type: integer - **url:** Type: string - **icmp_ping:** - **failure_count:** Type: integer - **interval:** Type: integer - **ip_addresses:** [Type: string] - **location:** - **description:** Type: string - **latitude:** Type: number - **longitude:** Type: number - **name:** Type: string - **sase_properties:** - **allocated_bandwidth_mbps:** Type: integer - **allocated_sc_count:** Type: integer - **pa_compute_region_oid:** Type: string - **total_sc_bandwidth_mbps:** Type: integer - **service_link_peers:** - **hostnames:** [Type: string] - **ip_addresses:** [Type: string] - **site_id:** Type: string - **tags:** [Type: string] - **type:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def servicelabels(
self, servicelabel_id, data, tenant_id=None, api_version='v2.1')
Update a ServiceLabel (v2.1)
Parameters::
- servicelabel_id: Service Label ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.1)
Payload Attributes:
- description: Type: string
- name: Type: string
- sase_properties:
- active_sase_label: Type: boolean
- tags: [Type: string]
- type: Type: string
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def servicelabels(self, servicelabel_id, data, tenant_id=None, api_version="v2.1"): """ Update a ServiceLabel (v2.1) **Parameters:**: - **servicelabel_id**: Service Label ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Payload Attributes:** - **description:** Type: string - **name:** Type: string - **sase_properties:** - **active_sase_label:** Type: boolean - **tags:** [Type: string] - **type:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def site_admin_state(
self, site_id, data, tenant_id=None, api_version='v3.0')
Update an existing site (v3.0)
Parameters::
- site_id: Site ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v3.0)
Payload Attributes:
- address:
- city: Type: string
- country: Type: string
- post_code: Type: string
- state: Type: string
- street: Type: string
- street2: Type: string
- admin_state: Type: string
- description: Type: string
- element_cluster_role: Type: string
- location:
- description: Type: string
- latitude: Type: number
- longitude: Type: number
- name: Type: string
- policy_set_id: Type: string
- security_policyset_id: Type: string
- service_binding: Type: string
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def site_admin_state(self, site_id, data, tenant_id=None, api_version="v3.0"): """ Update an existing site (v3.0) **Parameters:**: - **site_id**: Site ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v3.0) **Payload Attributes:** - **address:** - **city:** Type: string - **country:** Type: string - **post_code:** Type: string - **state:** Type: string - **street:** Type: string - **street2:** Type: string - **admin_state:** Type: string - **description:** Type: string - **element_cluster_role:** Type: string - **location:** - **description:** Type: string - **latitude:** Type: number - **longitude:** Type: number - **name:** Type: string - **policy_set_id:** Type: string - **security_policyset_id:** Type: string - **service_binding:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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/{}/admin_state".format(api_version, tenant_id, site_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "put", data=data)
def site_extensions(
self, site_id, extension_id, data, tenant_id=None, api_version='v2.0')
Update site level extension configuration (v2.0)
Parameters::
- site_id: Site ID
- extension_id: Extension ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Payload Attributes:
- conf: Type: object
- disabled: Type: boolean
- entity_id: Type: string
- name: Type: string
- namespace: Type: string
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def site_extensions(self, site_id, extension_id, data, tenant_id=None, api_version="v2.0"): """ Update site level extension configuration (v2.0) **Parameters:**: - **site_id**: Site ID - **extension_id**: Extension ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **conf:** Type: object - **disabled:** Type: boolean - **entity_id:** Type: string - **name:** Type: string - **namespace:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def site_ipfixlocalprefixes(
self, site_id, ipfixlocalprefix_id, data, tenant_id=None, api_version='v2.0')
Update a IPFix site prefix association (v2.0)
Parameters::
- site_id: Site ID
- ipfixlocalprefix_id: IPFix Local Prefix ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Payload Attributes:
- ipv4_prefixes: [Type: string]
- prefix_id: Type: string
- tags: [Type: string]
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def site_ipfixlocalprefixes(self, site_id, ipfixlocalprefix_id, data, tenant_id=None, api_version="v2.0"): """ Update a IPFix site prefix association (v2.0) **Parameters:**: - **site_id**: Site ID - **ipfixlocalprefix_id**: IPFix Local Prefix ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **ipv4_prefixes:** [Type: string] - **prefix_id:** Type: string - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def site_natlocalprefixes(
self, site_id, natlocalprefix_id, data, tenant_id=None, api_version='v2.0')
Update an existing Site NAT Local prefix Association (v2.0)
Parameters::
- site_id: Site ID
- natlocalprefix_id: NAT Local Prefix ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Payload Attributes:
- ipv4_prefixes: [Type: string]
- prefix_id: Type: string
- tags: [Type: string]
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def site_natlocalprefixes(self, site_id, natlocalprefix_id, data, tenant_id=None, api_version="v2.0"): """ Update an existing Site NAT Local prefix Association (v2.0) **Parameters:**: - **site_id**: Site ID - **natlocalprefix_id**: NAT Local Prefix ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **ipv4_prefixes:** [Type: string] - **prefix_id:** Type: string - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def site_networkpolicylocalprefixes(
self, site_id, networkpolicylocalprefix_id, data, tenant_id=None, api_version='v2.1')
Update an existing Site Network policy local prefix (v2.1)
Parameters::
- site_id: Site ID
- networkpolicylocalprefix_id: Network Policy Local Prefix ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.1)
Payload Attributes:
- ipv4_prefixes: [Type: string]
- ipv6_prefixes: [Type: string]
- prefix_id: Type: string
- tags: [Type: string]
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def site_networkpolicylocalprefixes(self, site_id, networkpolicylocalprefix_id, data, tenant_id=None, api_version="v2.1"): """ Update an existing Site Network policy local prefix (v2.1) **Parameters:**: - **site_id**: Site ID - **networkpolicylocalprefix_id**: Network Policy Local Prefix ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Payload Attributes:** - **ipv4_prefixes:** [Type: string] - **ipv6_prefixes:** [Type: string] - **prefix_id:** Type: string - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def site_ngfwsecuritypolicylocalprefixes(
self, site_id, ngfwsecuritypolicylocalprefix_id, data, tenant_id=None, api_version='v2.1')
Update an existing security policy V2 local prefix site association (v2.1)
Parameters::
- site_id: Site ID
- ngfwsecuritypolicylocalprefix_id: NGFW Security Policy Local Prefix ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.1)
Payload Attributes:
- ipv4_prefixes: [Type: string]
- ipv6_prefixes: [Type: string]
- prefix_id: Type: string
- tags: [Type: string]
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def site_ngfwsecuritypolicylocalprefixes(self, site_id, ngfwsecuritypolicylocalprefix_id, data, tenant_id=None, api_version="v2.1"): """ Update an existing security policy V2 local prefix site association (v2.1) **Parameters:**: - **site_id**: Site ID - **ngfwsecuritypolicylocalprefix_id**: NGFW Security Policy Local Prefix ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Payload Attributes:** - **ipv4_prefixes:** [Type: string] - **ipv6_prefixes:** [Type: string] - **prefix_id:** Type: string - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def site_prioritypolicylocalprefixes(
self, site_id, prioritypolicylocalprefix_id, data, tenant_id=None, api_version='v2.1')
Update an existing Site Priority policy local prefix (v2.1)
Parameters::
- site_id: Site ID
- prioritypolicylocalprefix_id: Priority Policy Local Prefix ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.1)
Payload Attributes:
- ipv4_prefixes: [Type: string]
- ipv6_prefixes: [Type: string]
- prefix_id: Type: string
- tags: [Type: string]
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def site_prioritypolicylocalprefixes(self, site_id, prioritypolicylocalprefix_id, data, tenant_id=None, api_version="v2.1"): """ Update an existing Site Priority policy local prefix (v2.1) **Parameters:**: - **site_id**: Site ID - **prioritypolicylocalprefix_id**: Priority Policy Local Prefix ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Payload Attributes:** - **ipv4_prefixes:** [Type: string] - **ipv6_prefixes:** [Type: string] - **prefix_id:** Type: string - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def siteciphers(
self, site_id, data, tenant_id=None, api_version='v2.0')
Update site cipher (v2.0)
Parameters::
- site_id: Site ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Payload Attributes:
- controller_connection_cipher: Type: string
- site_id: Type: string
- tenant_id: Type: string
- vpn_ciphers: [Type: string]
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def siteciphers(self, site_id, data, tenant_id=None, api_version="v2.0"): """ Update site cipher (v2.0) **Parameters:**: - **site_id**: Site ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **controller_connection_cipher:** Type: string - **site_id:** Type: string - **tenant_id:** Type: string - **vpn_ciphers:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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/{}/siteciphers".format(api_version, tenant_id, site_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "put", data=data)
def sites(
self, site_id, data, tenant_id=None, api_version='v4.9')
Update an existing site (v4.9)
Parameters::
- site_id: Site ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v4.9)
Payload Attributes:
- address:
- city: Type: string
- country: Type: string
- post_code: Type: string
- state: Type: string
- street: Type: string
- street2: Type: string
- admin_state: Type: string
- description: Type: string
- element_cluster_role: Type: string
- extended_tags:
- key: Type: string
- value: Type: string
- value_type: Type: string
- location:
- description: Type: string
- latitude: Type: number
- longitude: Type: number
- multicast_peer_group_id: Type: string
- name: Type: string
- nat_policysetstack_id: Type: string
- network_policysetstack_id: Type: string
- perfmgmt_policysetstack_id: Type: string
- policy_set_id: Type: string
- priority_policysetstack_id: Type: string
- security_policyset_id: Type: string
- security_policysetstack_id: Type: string
- service_binding: Type: string
- tags: [Type: string]
- vrf_context_profile_id: Type: string
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def sites(self, site_id, data, tenant_id=None, api_version="v4.9"): """ Update an existing site (v4.9) **Parameters:**: - **site_id**: Site ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v4.9) **Payload Attributes:** - **address:** - **city:** Type: string - **country:** Type: string - **post_code:** Type: string - **state:** Type: string - **street:** Type: string - **street2:** Type: string - **admin_state:** Type: string - **description:** Type: string - **element_cluster_role:** Type: string - **extended_tags:** - **key:** Type: string - **value:** Type: string - **value_type:** Type: string - **location:** - **description:** Type: string - **latitude:** Type: number - **longitude:** Type: number - **multicast_peer_group_id:** Type: string - **name:** Type: string - **nat_policysetstack_id:** Type: string - **network_policysetstack_id:** Type: string - **perfmgmt_policysetstack_id:** Type: string - **policy_set_id:** Type: string - **priority_policysetstack_id:** Type: string - **security_policyset_id:** Type: string - **security_policysetstack_id:** Type: string - **service_binding:** Type: string - **tags:** [Type: string] - **vrf_context_profile_id:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def sitesecurityzones(
self, site_id, sitesecurityzone_id, data, tenant_id=None, api_version='v2.0')
Update an existing security zone (v2.0)
Parameters::
- site_id: Site ID
- sitesecurityzone_id: Site Security Zone ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Payload Attributes:
- networks:
- network_id: Type: string
- network_type: Type: string
- zone_id: Type: string
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def sitesecurityzones(self, site_id, sitesecurityzone_id, data, tenant_id=None, api_version="v2.0"): """ Update an existing security zone (v2.0) **Parameters:**: - **site_id**: Site ID - **sitesecurityzone_id**: Site Security Zone ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **networks:** - **network_id:** Type: string - **network_type:** Type: string - **zone_id:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def snmpagents(
self, site_id, element_id, snmpagent_id, data, tenant_id=None, api_version='v2.1')
Update SNMP Agent (v2.1)
Parameters::
- site_id: Site ID
- element_id: Element (Device) ID
- snmpagent_id: SNMP Agent ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.1)
Payload Attributes:
- description: Type: string
- system_contact: Type: string
- system_location: Type: string
- tags: [Type: string]
- v2_config:
- community: Type: string
- v3_config:
- user_access:
- auth_phrase: Type: string
- auth_type: Type: string
- enc_phrase: Type: string
- enc_type: Type: string
- engine_id: Type: string
- security_level: Type: string
- user_name: Type: string
- user_access:
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def snmpagents(self, site_id, element_id, snmpagent_id, data, tenant_id=None, api_version="v2.1"): """ Update SNMP Agent (v2.1) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **snmpagent_id**: SNMP Agent ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Payload Attributes:** - **description:** Type: string - **system_contact:** Type: string - **system_location:** Type: string - **tags:** [Type: string] - **v2_config:** - **community:** Type: string - **v3_config:** - **user_access:** - **auth_phrase:** Type: string - **auth_type:** Type: string - **enc_phrase:** Type: string - **enc_type:** Type: string - **engine_id:** Type: string - **security_level:** Type: string - **user_name:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def snmptraps(
self, site_id, element_id, snmptrap_id, data, tenant_id=None, api_version='v2.0')
Update SNMP Trap (v2.0)
Parameters::
- site_id: Site ID
- element_id: Element (Device) ID
- snmptrap_id: SNMP Trap ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Payload Attributes:
- description: Type: string
- enabled: Type: boolean
- server_ip: Type: string
- source_interface: Type: string
- tags: [Type: string]
- v2_config:
- community: Type: string
- v3_config:
- user_access:
- auth_phrase: Type: string
- auth_type: Type: string
- enc_phrase: Type: string
- enc_type: Type: string
- engine_id: Type: string
- security_level: Type: string
- user_name: Type: string
- user_access:
- version: Type: string
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def snmptraps(self, site_id, element_id, snmptrap_id, data, tenant_id=None, api_version="v2.0"): """ Update SNMP Trap (v2.0) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **snmptrap_id**: SNMP Trap ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **description:** Type: string - **enabled:** Type: boolean - **server_ip:** Type: string - **source_interface:** Type: string - **tags:** [Type: string] - **v2_config:** - **community:** Type: string - **v3_config:** - **user_access:** - **auth_phrase:** Type: string - **auth_type:** Type: string - **enc_phrase:** Type: string - **enc_type:** Type: string - **engine_id:** Type: string - **security_level:** Type: string - **user_name:** Type: string - **version:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def software(
self, machine_id, software_id, data, tenant_id=None, api_version='v2.0')
Update Machine Software (v2.0)
Parameters::
- machine_id: Machine ID
- software_id: Software ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Payload Attributes:
- scheduled_upgrade: Type: string
- tenant_id: Type: string
- upgrade_interval: Type: integer
- upgrade_version: Type: string
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def software(self, machine_id, software_id, data, tenant_id=None, api_version="v2.0"): """ Update Machine Software (v2.0) **Parameters:**: - **machine_id**: Machine ID - **software_id**: Software ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **scheduled_upgrade:** Type: string - **tenant_id:** Type: string - **upgrade_interval:** Type: integer - **upgrade_version:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_id. raise TypeError("tenant_id is required but not set or cached.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/machines/{}/software/{}".format(api_version, tenant_id, machine_id, software_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "put", data=data)
def software_state(
self, element_id, data, tenant_id=None, api_version='v2.0')
Upgrade an element (v2.0)
Parameters::
- element_id: Element (Device) ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Payload Attributes:
- download_interval: Type: integer
- image_id: Type: string
- interface_ids: [Type: string]
- scheduled_download: Type: string
- scheduled_upgrade: Type: string
- upgrade_interval: Type: integer
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def software_state(self, element_id, data, tenant_id=None, api_version="v2.0"): """ Upgrade an element (v2.0) **Parameters:**: - **element_id**: Element (Device) ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **download_interval:** Type: integer - **image_id:** Type: string - **interface_ids:** [Type: string] - **scheduled_download:** Type: string - **scheduled_upgrade:** Type: string - **upgrade_interval:** Type: integer **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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/{}/software/state".format(api_version, tenant_id, element_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "put", data=data)
def spokeclusters(
self, site_id, spokecluster_id, data, tenant_id=None, api_version='v2.0')
Update Spoke Cluster (v2.0)
Parameters::
- site_id: Site ID
- spokecluster_id: Spoke Cluster ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Payload Attributes:
- advertisement_interval: Type: number
- description: Type: string
- name: Type: string
- preempt: Type: boolean
- tags: [Type: string]
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def spokeclusters(self, site_id, spokecluster_id, data, tenant_id=None, api_version="v2.0"): """ Update Spoke Cluster (v2.0) **Parameters:**: - **site_id**: Site ID - **spokecluster_id**: Spoke Cluster ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **advertisement_interval:** Type: number - **description:** Type: string - **name:** Type: string - **preempt:** Type: boolean - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def staticroutes(
self, site_id, element_id, staticroute_id, data, tenant_id=None, api_version='v2.3')
Update static route (v2.3)
Parameters::
- site_id: Site ID
- element_id: Element (Device) ID
- staticroute_id: Static Route ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.3)
Payload Attributes:
- address_family: Type: string
- description: Type: string
- destination_prefix: Type: string
- name: Type: string
- network_context_id: Type: string
- nexthop_reachability_probe: Type: boolean
- nexthops:
- admin_distance: Type: integer
- nexthop_interface_id: Type: string
- nexthop_ip: Type: string
- self: Type: boolean
- scope: Type: string
- tags: [Type: string]
- vrf_context_id: Type: string
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def staticroutes(self, site_id, element_id, staticroute_id, data, tenant_id=None, api_version="v2.3"): """ Update static route (v2.3) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **staticroute_id**: Static Route ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.3) **Payload Attributes:** - **address_family:** Type: string - **description:** Type: string - **destination_prefix:** Type: string - **name:** Type: string - **network_context_id:** Type: string - **nexthop_reachability_probe:** Type: boolean - **nexthops:** - **admin_distance:** Type: integer - **nexthop_interface_id:** Type: string - **nexthop_ip:** Type: string - **self:** Type: boolean - **scope:** Type: string - **tags:** [Type: string] - **vrf_context_id:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def syslogserverprofiles(
self, syslogserverprofile_id, data, tenant_id=None, api_version='v2.0')
Update Syslog Server Profile (v2.0)
Parameters::
- syslogserverprofile_id: Sys Log Server Profile ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Payload Attributes:
- description: Type: string
- enable_flow_logging: Type: boolean
- name: Type: string
- protocol: Type: string
- remote_ca_certificate: Type: string
- server_fqdn: Type: string
- server_ip: Type: string
- server_port: Type: integer
- severity_level: Type: string
- tags: [Type: string]
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def syslogserverprofiles(self, syslogserverprofile_id, data, tenant_id=None, api_version="v2.0"): """ Update Syslog Server Profile (v2.0) **Parameters:**: - **syslogserverprofile_id**: Sys Log Server Profile ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **description:** Type: string - **enable_flow_logging:** Type: boolean - **name:** Type: string - **protocol:** Type: string - **remote_ca_certificate:** Type: string - **server_fqdn:** Type: string - **server_ip:** Type: string - **server_port:** Type: integer - **severity_level:** Type: string - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def syslogservers(
self, site_id, element_id, syslogserver_id, data, tenant_id=None, api_version='v2.2')
Update Syslog Server (v2.2)
Parameters::
- site_id: Site ID
- element_id: Element (Device) ID
- syslogserver_id: SYSLOG server ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.2)
Payload Attributes:
- description: Type: string
- enable_flow_logging: Type: boolean
- enabled: Type: boolean
- name: Type: string
- protocol: Type: string
- remote_ca_certificate: Type: string
- server_fqdn: Type: string
- server_ip: Type: string
- server_port: Type: integer
- severity_level: Type: string
- source_interface: Type: string
- syslog_profile_id: Type: string
- tags: [Type: string]
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def syslogservers(self, site_id, element_id, syslogserver_id, data, tenant_id=None, api_version="v2.2"): """ Update Syslog Server (v2.2) **Parameters:**: - **site_id**: Site ID - **element_id**: Element (Device) ID - **syslogserver_id**: SYSLOG server ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.2) **Payload Attributes:** - **description:** Type: string - **enable_flow_logging:** Type: boolean - **enabled:** Type: boolean - **name:** Type: string - **protocol:** Type: string - **remote_ca_certificate:** Type: string - **server_fqdn:** Type: string - **server_ip:** Type: string - **server_port:** Type: integer - **severity_level:** Type: string - **source_interface:** Type: string - **syslog_profile_id:** Type: string - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def templates_ntp(
self, ntp_id, data, tenant_id=None, api_version='v2.0')
Update an existing NTP Template (v2.0)
Parameters::
- ntp_id: NTP Configuration ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Payload Attributes:
- default_template: Type: boolean
- description: Type: string
- name: Type: string
- ntp_servers:
- host: Type: string
- max_poll: Type: integer
- min_poll: Type: integer
- version: Type: integer
- tags: [Type: string]
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def templates_ntp(self, ntp_id, data, tenant_id=None, api_version="v2.0"): """ Update an existing NTP Template (v2.0) **Parameters:**: - **ntp_id**: NTP Configuration ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **default_template:** Type: boolean - **description:** Type: string - **name:** Type: string - **ntp_servers:** - **host:** Type: string - **max_poll:** Type: integer - **min_poll:** Type: integer - **version:** Type: integer - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def tenant_anynetlinks(
self, anynetlink_id, data, tenant_id=None, api_version='v3.4')
PUT Tenant_Anynetlinks API Function
Parameters::
- anynetlink_id: Anynet (Secure Fabric) Link ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v3.4)
Payload Attributes:
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def tenant_anynetlinks(self, anynetlink_id, data, tenant_id=None, api_version="v3.4"): """ PUT Tenant_Anynetlinks API Function **Parameters:**: - **anynetlink_id**: Anynet (Secure Fabric) Link ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v3.4) **Payload Attributes:** **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def tenant_ipfixlocalprefixes(
self, ipfixlocalprefix_id, data, tenant_id=None, api_version='v2.0')
Update a IPFix local prefix (v2.0)
Parameters::
- ipfixlocalprefix_id: IPFix Local Prefix ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Payload Attributes:
- description: Type: string
- name: Type: string
- tags: [Type: string]
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def tenant_ipfixlocalprefixes(self, ipfixlocalprefix_id, data, tenant_id=None, api_version="v2.0"): """ Update a IPFix local prefix (v2.0) **Parameters:**: - **ipfixlocalprefix_id**: IPFix Local Prefix ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **description:** Type: string - **name:** Type: string - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def tenant_networkpolicylocalprefixes(
self, networkpolicylocalprefix_id, data, tenant_id=None, api_version='v2.0')
Update a Network Policy local prefix. (v2.0)
Parameters::
- networkpolicylocalprefix_id: Network Policy Local Prefix ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Payload Attributes:
- description: Type: string
- name: Type: string
- tags: [Type: string]
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def tenant_networkpolicylocalprefixes(self, networkpolicylocalprefix_id, data, tenant_id=None, api_version="v2.0"): """ Update a Network Policy local prefix. (v2.0) **Parameters:**: - **networkpolicylocalprefix_id**: Network Policy Local Prefix ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **description:** Type: string - **name:** Type: string - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def tenant_operators(
self, operator_id, data, tenant_id=None, api_version='v2.2')
Update a tenant operator (v2.2)
Parameters::
- operator_id: Operator ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.2)
Payload Attributes:
- addresses:
- city: Type: string
- country: Type: string
- post_code: Type: string
- state: Type: string
- street: Type: string
- street2: Type: string
- custom_roles:
- custom_permissions:
- allowed_after_ms: Type: integer
- allowed_before_ms: Type: integer
- disabled: Type: boolean
- disabled_reason: Type: string
- disallow_permission: Type: boolean
- id: Type: string
- inactive: Type: boolean
- inactive_reason: Type: string
- region: Type: string
- tenant_id: Type: string
- value: Type: string
- description: Type: string
- disabled: Type: boolean
- disabled_reason: Type: string
- disallow_permissions:
- value: Type: string
- id: Type: string
- inactive: Type: boolean
- inactive_reason: Type: string
- is_system_owned: Type: boolean
- name: Type: string
- permissions:
- value: Type: string
- region: Type: string
- roles:
- name: Type: string
- tenant_id: Type: string
- custom_permissions:
- disable_idp_login: Type: boolean
- disabled: Type: boolean
- disabled_reason: Type: string
- email: Type: string
- email_iam: Type: string
- email_validated: Type: boolean
- enable_session_ip_lock: Type: boolean
- first_name: Type: string
- from_esp: Type: boolean
- from_esp_name: Type: string
- from_esp_tenant_id: Type: string
- inactive: Type: boolean
- inactive_reason: Type: string
- ipv4_list:
- ipv4: Type: string
- is_locked: Type: boolean
- is_system_owned: Type: boolean
- last_login: Type: string
- last_name: Type: string
- linked_accounts:
- disabled: Type: boolean
- disabled_reason: Type: string
- failed_login_attempts: Type: integer
- id: Type: string
- inactive: Type: boolean
- inactive_reason: Type: string
- provider_key: Type: string
- provider_value: Type: string
- provider_value_updated_on: Type: integer
- region: Type: string
- tenant_id: Type: string
- migration_state:
- phone_numbers:
- country_code: Type: integer
- local_extension: Type: integer
- number: Type: integer
- types:
- value: Type: string
- region: Type: string
- roles:
- name: Type: string
- secondary_emails:
- email: Type: string
- settings: Type: string
- tenant_id: Type: string
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def tenant_operators(self, operator_id, data, tenant_id=None, api_version="v2.2"): """ Update a tenant operator (v2.2) **Parameters:**: - **operator_id**: Operator ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.2) **Payload Attributes:** - **addresses:** - **city:** Type: string - **country:** Type: string - **post_code:** Type: string - **state:** Type: string - **street:** Type: string - **street2:** Type: string - **custom_roles:** - **custom_permissions:** - **allowed_after_ms:** Type: integer - **allowed_before_ms:** Type: integer - **disabled:** Type: boolean - **disabled_reason:** Type: string - **disallow_permission:** Type: boolean - **id:** Type: string - **inactive:** Type: boolean - **inactive_reason:** Type: string - **region:** Type: string - **tenant_id:** Type: string - **value:** Type: string - **description:** Type: string - **disabled:** Type: boolean - **disabled_reason:** Type: string - **disallow_permissions:** - **value:** Type: string - **id:** Type: string - **inactive:** Type: boolean - **inactive_reason:** Type: string - **is_system_owned:** Type: boolean - **name:** Type: string - **permissions:** - **value:** Type: string - **region:** Type: string - **roles:** - **name:** Type: string - **tenant_id:** Type: string - **disable_idp_login:** Type: boolean - **disabled:** Type: boolean - **disabled_reason:** Type: string - **email:** Type: string - **email_iam:** Type: string - **email_validated:** Type: boolean - **enable_session_ip_lock:** Type: boolean - **first_name:** Type: string - **from_esp:** Type: boolean - **from_esp_name:** Type: string - **from_esp_tenant_id:** Type: string - **inactive:** Type: boolean - **inactive_reason:** Type: string - **ipv4_list:** - **ipv4:** Type: string - **is_locked:** Type: boolean - **is_system_owned:** Type: boolean - **last_login:** Type: string - **last_name:** Type: string - **linked_accounts:** - **disabled:** Type: boolean - **disabled_reason:** Type: string - **failed_login_attempts:** Type: integer - **id:** Type: string - **inactive:** Type: boolean - **inactive_reason:** Type: string - **provider_key:** Type: string - **provider_value:** Type: string - **provider_value_updated_on:** Type: integer - **region:** Type: string - **tenant_id:** Type: string - **migration_state:** - **phone_numbers:** - **country_code:** Type: integer - **local_extension:** Type: integer - **number:** Type: integer - **types:** - **value:** Type: string - **region:** Type: string - **roles:** - **name:** Type: string - **secondary_emails:** - **email:** Type: string - **settings:** Type: string - **tenant_id:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def tenant_permissions(
self, permission_id, data, tenant_id=None, api_version='v2.0')
Update a custom permission (v2.0)
Parameters::
- permission_id: Permission ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Payload Attributes:
- allowed_after_ms: Type: integer
- allowed_before_ms: Type: integer
- disabled: Type: boolean
- disabled_reason: Type: string
- disallow_permission: Type: boolean
- inactive: Type: boolean
- inactive_reason: Type: string
- region: Type: string
- tenant_id: Type: string
- value: Type: string
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def tenant_permissions(self, permission_id, data, tenant_id=None, api_version="v2.0"): """ Update a custom permission (v2.0) **Parameters:**: - **permission_id**: Permission ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **allowed_after_ms:** Type: integer - **allowed_before_ms:** Type: integer - **disabled:** Type: boolean - **disabled_reason:** Type: string - **disallow_permission:** Type: boolean - **inactive:** Type: boolean - **inactive_reason:** Type: string - **region:** Type: string - **tenant_id:** Type: string - **value:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def tenant_prioritypolicylocalprefixes(
self, prioritypolicylocalprefix_id, data, tenant_id=None, api_version='v2.0')
Update a Priority Policy local prefix. (v2.0)
Parameters::
- prioritypolicylocalprefix_id: Priority Policy Local Prefix ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Payload Attributes:
- description: Type: string
- name: Type: string
- tags: [Type: string]
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def tenant_prioritypolicylocalprefixes(self, prioritypolicylocalprefix_id, data, tenant_id=None, api_version="v2.0"): """ Update a Priority Policy local prefix. (v2.0) **Parameters:**: - **prioritypolicylocalprefix_id**: Priority Policy Local Prefix ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **description:** Type: string - **name:** Type: string - **tags:** [Type: string] **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def tenants(
self, data, tenant_id=None, api_version='v2.8')
Update tenant (v2.8)
Parameters::
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.8)
Payload Attributes:
- : Type: string
- address:
- city: Type: string
- country: Type: string
- post_code: Type: string
- state: Type: string
- street: Type: string
- street2: Type: string
- canonical_name: Type: string
- clients: [Type: string]
- csp_tenant_id: Type: string
- description: Type: string
- disabled: Type: string
- disabled_reason: Type: string
- inactive: Type: string
- inactive_reason: Type: string
- ipv4_list:
- ipv4: Type: string
- is_esp: Type: boolean
- is_oneapp_ready: Type: boolean
- is_pa_iot_security_license: Type: boolean
- is_support: Type: boolean
- name: Type: string
- operator:
- addresses:
- city: Type: string
- country: Type: string
- post_code: Type: string
- state: Type: string
- street: Type: string
- street2: Type: string
- custom_roles:
- custom_permissions:
- allowed_after_ms: Type: integer
- allowed_before_ms: Type: integer
- disabled: Type: boolean
- disabled_reason: Type: string
- disallow_permission: Type: boolean
- id: Type: string
- inactive: Type: boolean
- inactive_reason: Type: string
- region: Type: string
- tenant_id: Type: string
- value: Type: string
- disabled: Type: boolean
- disallow_permissions:
- value: Type: string
- id: Type: string
- inactive: Type: boolean
- name: Type: string
- permissions:
- value: Type: string
- roles:
- name: Type: string
- custom_permissions:
- disable_idp_login: Type: boolean
- disabled: Type: boolean
- disabled_reason: Type: string
- email: Type: string
- email_iam: Type: string
- email_validated: Type: boolean
- enable_session_ip_lock: Type: boolean
- first_name: Type: string
- from_esp: Type: boolean
- from_esp_name: Type: string
- from_esp_tenant_id: Type: string
- id: Type: string
- inactive: Type: boolean
- inactive_reason: Type: string
- ipv4_list:
- ipv4: Type: string
- is_locked: Type: boolean
- is_system_owned: Type: boolean
- last_login: Type: string
- last_name: Type: string
- linked_accounts:
- disabled: Type: boolean
- disabled_reason: Type: string
- failed_login_attempts: Type: integer
- id: Type: string
- inactive: Type: boolean
- inactive_reason: Type: string
- provider_key: Type: string
- provider_value: Type: string
- provider_value_updated_on: Type: integer
- region: Type: string
- tenant_id: Type: string
- migration_state:
- name: Type: string
- phone_numbers:
- country_code: Type: integer
- local_extension: Type: integer
- number: Type: integer
- types:
- value: Type: string
- region: Type: string
- roles:
- name: Type: string
- secondary_emails:
- email: Type: string
- settings: Type: string
- tenant_id: Type: string
- addresses:
- pan_account_id: Type: string
- pan_tenant_id: Type: string
- password_policy:
- enable_failed_login_attempts: Type: boolean
- enable_failed_login_time_delay: Type: boolean
- enable_maximum_password_length: Type: boolean
- enable_minimum_password_length: Type: boolean
- enable_password_aging: Type: boolean
- enable_password_identity_difference: Type: boolean
- enable_password_no_reuse_count: Type: boolean
- enable_session_ip_lock: Type: boolean
- enable_two_lower_case_letters: Type: boolean
- enable_two_numbers: Type: boolean
- enable_two_special_characters: Type: boolean
- enable_two_upper_case_letters: Type: boolean
- failed_login_attempts: Type: integer
- maximum_password_length: Type: integer
- minimum_password_length: Type: integer
- password_aging_days: Type: integer
- password_aging_notification: Type: integer
- password_no_reuse_count: Type: integer
- special_characters: Type: string
- special_characters_regex: Type: string
- phone_numbers:
- country_code: Type: integer
- local_extension: Type: integer
- number: Type: integer
- types:
- value: Type: string
- prisma_access_tenant_id: Type: string
- provider_data:
- certificate:
- certificate: Type: string
- certificate_expiry_utc: Type: integer
- certificate_type: Type: string
- disabled: Type: boolean
- disabled_reason: Type: string
- id: Type: string
- inactive: Type: boolean
- inactive_reason: Type: string
- issued_by:
- common_name: Type: string
- country: Type: string
- location: Type: string
- organization: Type: string
- organization_unit: Type: string
- state: Type: string
- issued_to:
- common_name: Type: string
- country: Type: string
- location: Type: string
- organization: Type: string
- organization_unit: Type: string
- state: Type: string
- parent_id:
- region: Type: string
- serial_number: Type: string
- tenant_id: Type: string
- version: Type: string
- password_hash: Type: string
- provider:
- canonical_name: Type: string
- description: Type: string
- disabled: Type: boolean
- disabled_reason: Type: string
- id: Type: string
- inactive: Type: boolean
- inactive_reason: Type: string
- map_external_group: Type: object
- name: Type: string
- protocol:
- region: Type: string
- template: Type: string
- tenant_id: Type: string
- salt: Type: string
- security: Type: string
- certificate:
- region: Type: string
- sase_at: Type: string
- telemetry_region: Type: string
- tenant_id: Type: string
- tsg_id: Type: string
- tsg_instances:
- app_id: Type: string
- region: Type: string
- tenant_id: Type: string
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def tenants(self, data, tenant_id=None, api_version="v2.8"): """ Update tenant (v2.8) **Parameters:**: - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.8) **Payload Attributes:** - **:** Type: string - **address:** - **city:** Type: string - **country:** Type: string - **post_code:** Type: string - **state:** Type: string - **street:** Type: string - **street2:** Type: string - **canonical_name:** Type: string - **clients:** [Type: string] - **csp_tenant_id:** Type: string - **description:** Type: string - **disabled:** Type: string - **disabled_reason:** Type: string - **inactive:** Type: string - **inactive_reason:** Type: string - **ipv4_list:** - **ipv4:** Type: string - **is_esp:** Type: boolean - **is_oneapp_ready:** Type: boolean - **is_pa_iot_security_license:** Type: boolean - **is_support:** Type: boolean - **name:** Type: string - **operator:** - **addresses:** - **city:** Type: string - **country:** Type: string - **post_code:** Type: string - **state:** Type: string - **street:** Type: string - **street2:** Type: string - **custom_roles:** - **custom_permissions:** - **allowed_after_ms:** Type: integer - **allowed_before_ms:** Type: integer - **disabled:** Type: boolean - **disabled_reason:** Type: string - **disallow_permission:** Type: boolean - **id:** Type: string - **inactive:** Type: boolean - **inactive_reason:** Type: string - **region:** Type: string - **tenant_id:** Type: string - **value:** Type: string - **disabled:** Type: boolean - **disallow_permissions:** - **value:** Type: string - **id:** Type: string - **inactive:** Type: boolean - **name:** Type: string - **permissions:** - **value:** Type: string - **roles:** - **name:** Type: string - **disable_idp_login:** Type: boolean - **disabled:** Type: boolean - **disabled_reason:** Type: string - **email:** Type: string - **email_iam:** Type: string - **email_validated:** Type: boolean - **enable_session_ip_lock:** Type: boolean - **first_name:** Type: string - **from_esp:** Type: boolean - **from_esp_name:** Type: string - **from_esp_tenant_id:** Type: string - **id:** Type: string - **inactive:** Type: boolean - **inactive_reason:** Type: string - **ipv4_list:** - **ipv4:** Type: string - **is_locked:** Type: boolean - **is_system_owned:** Type: boolean - **last_login:** Type: string - **last_name:** Type: string - **linked_accounts:** - **disabled:** Type: boolean - **disabled_reason:** Type: string - **failed_login_attempts:** Type: integer - **id:** Type: string - **inactive:** Type: boolean - **inactive_reason:** Type: string - **provider_key:** Type: string - **provider_value:** Type: string - **provider_value_updated_on:** Type: integer - **region:** Type: string - **tenant_id:** Type: string - **migration_state:** - **name:** Type: string - **phone_numbers:** - **country_code:** Type: integer - **local_extension:** Type: integer - **number:** Type: integer - **types:** - **value:** Type: string - **region:** Type: string - **roles:** - **name:** Type: string - **secondary_emails:** - **email:** Type: string - **settings:** Type: string - **tenant_id:** Type: string - **pan_account_id:** Type: string - **pan_tenant_id:** Type: string - **password_policy:** - **enable_failed_login_attempts:** Type: boolean - **enable_failed_login_time_delay:** Type: boolean - **enable_maximum_password_length:** Type: boolean - **enable_minimum_password_length:** Type: boolean - **enable_password_aging:** Type: boolean - **enable_password_identity_difference:** Type: boolean - **enable_password_no_reuse_count:** Type: boolean - **enable_session_ip_lock:** Type: boolean - **enable_two_lower_case_letters:** Type: boolean - **enable_two_numbers:** Type: boolean - **enable_two_special_characters:** Type: boolean - **enable_two_upper_case_letters:** Type: boolean - **failed_login_attempts:** Type: integer - **maximum_password_length:** Type: integer - **minimum_password_length:** Type: integer - **password_aging_days:** Type: integer - **password_aging_notification:** Type: integer - **password_no_reuse_count:** Type: integer - **special_characters:** Type: string - **special_characters_regex:** Type: string - **phone_numbers:** - **country_code:** Type: integer - **local_extension:** Type: integer - **number:** Type: integer - **types:** - **value:** Type: string - **prisma_access_tenant_id:** Type: string - **provider_data:** - **certificate:** - **certificate:** Type: string - **certificate_expiry_utc:** Type: integer - **certificate_type:** Type: string - **disabled:** Type: boolean - **disabled_reason:** Type: string - **id:** Type: string - **inactive:** Type: boolean - **inactive_reason:** Type: string - **issued_by:** - **common_name:** Type: string - **country:** Type: string - **location:** Type: string - **organization:** Type: string - **organization_unit:** Type: string - **state:** Type: string - **issued_to:** - **common_name:** Type: string - **country:** Type: string - **location:** Type: string - **organization:** Type: string - **organization_unit:** Type: string - **state:** Type: string - **parent_id:** - **region:** Type: string - **serial_number:** Type: string - **tenant_id:** Type: string - **version:** Type: string - **password_hash:** Type: string - **provider:** - **canonical_name:** Type: string - **description:** Type: string - **disabled:** Type: boolean - **disabled_reason:** Type: string - **id:** Type: string - **inactive:** Type: boolean - **inactive_reason:** Type: string - **map_external_group:** Type: object - **name:** Type: string - **protocol:** - **region:** Type: string - **template:** Type: string - **tenant_id:** Type: string - **salt:** Type: string - **security:** Type: string - **region:** Type: string - **sase_at:** Type: string - **telemetry_region:** Type: string - **tenant_id:** Type: string - **tsg_id:** Type: string - **tsg_instances:** - **app_id:** Type: string - **region:** Type: string - **tenant_id:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_id. raise TypeError("tenant_id is required but not set or cached.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}".format(api_version, tenant_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "put", data=data)
def useridagents(
self, useridagent_id, data, tenant_id=None, api_version='v2.0')
PUT Useridagents API Function
Parameters::
- useridagent_id: User Id Agent ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Payload Attributes:
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def useridagents(self, useridagent_id, data, tenant_id=None, api_version="v2.0"): """ PUT Useridagents API Function **Parameters:**: - **useridagent_id**: User Id Agent ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def users(
self, user_id, data, tenant_id=None, api_version='v2.0')
Put an user identity. (v2.0)
Parameters::
- user_id: User ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Payload Attributes:
- disabled: Type: boolean
- disabled_reason: Type: string
- first_name: Type: string
- inactive: Type: boolean
- inactive_reason: Type: string
- last_name: Type: string
- middle_name: Type: string
- region: Type: string
- tenant_id: Type: string
- user_dn: Type: string
- user_fqn: Type: string
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def users(self, user_id, data, tenant_id=None, api_version="v2.0"): """ Put an user identity. (v2.0) **Parameters:**: - **user_id**: User ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **disabled:** Type: boolean - **disabled_reason:** Type: string - **first_name:** Type: string - **inactive:** Type: boolean - **inactive_reason:** Type: string - **last_name:** Type: string - **middle_name:** Type: string - **region:** Type: string - **tenant_id:** Type: string - **user_dn:** Type: string - **user_fqn:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def vfflicense_tokens(
self, vfflicense_id, token_id, data, tenant_id=None, api_version='v2.0')
Update Tenant Vff License Token (v2.0)
Parameters::
- vfflicense_id: Virtual Form Factor License ID
- token_id: Token ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Payload Attributes:
- ion_key: Type: string
- is_expired: Type: boolean
- is_multiuse: Type: boolean
- is_revoked: Type: boolean
- is_used: Type: boolean
- secret_key: Type: string
- valid_till_secs: Type: integer
- vfflicense_id: Type: string
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def vfflicense_tokens(self, vfflicense_id, token_id, data, tenant_id=None, api_version="v2.0"): """ Update Tenant Vff License Token (v2.0) **Parameters:**: - **vfflicense_id**: Virtual Form Factor License ID - **token_id**: Token ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **ion_key:** Type: string - **is_expired:** Type: boolean - **is_multiuse:** Type: boolean - **is_revoked:** Type: boolean - **is_used:** Type: boolean - **secret_key:** Type: string - **valid_till_secs:** Type: integer - **vfflicense_id:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_id. raise TypeError("tenant_id is required but not set or cached.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/vfflicenses/{}/tokens/{}".format(api_version, tenant_id, vfflicense_id, token_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "put", data=data)
def vpnlinks_state(
self, vpnlink_id, data, tenant_id=None, api_version='v2.0')
Change the VPNLink admin state (v2.0)
Parameters::
- vpnlink_id: VPN Link ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Payload Attributes:
- al_id: Type: string
- enabled: Type: boolean
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def vpnlinks_state(self, vpnlink_id, data, tenant_id=None, api_version="v2.0"): """ Change the VPNLink admin state (v2.0) **Parameters:**: - **vpnlink_id**: VPN Link ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **al_id:** Type: string - **enabled:** Type: boolean **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_id. raise TypeError("tenant_id is required but not set or cached.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/vpnlinks/{}/state".format(api_version, tenant_id, vpnlink_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "put", data=data)
def vrfcontextprofiles(
self, vrfcontextprofile_id, data, tenant_id=None, api_version='v2.0')
PUT Vrfcontextprofiles API Function
Parameters::
- vrfcontextprofile_id: VRF Context Profile ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Payload Attributes:
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def vrfcontextprofiles(self, vrfcontextprofile_id, data, tenant_id=None, api_version="v2.0"): """ PUT Vrfcontextprofiles API Function **Parameters:**: - **vrfcontextprofile_id**: VRF Context Profile ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def vrfcontexts(
self, vrfcontext_id, data, tenant_id=None, api_version='v2.0')
PUT Vrfcontexts API Function
Parameters::
- vrfcontext_id: VRF Context UD
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Payload Attributes:
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def vrfcontexts(self, vrfcontext_id, data, tenant_id=None, api_version="v2.0"): """ PUT Vrfcontexts API Function **Parameters:**: - **vrfcontext_id**: VRF Context UD - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def waninterfacelabels(
self, waninterfacelabel_id, data, tenant_id=None, api_version='v2.4')
Update specific WAN interface label (v2.4)
Parameters::
- waninterfacelabel_id: WAN Interface Label ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.4)
Payload Attributes:
- bwc_enabled: Type: boolean
- description: Type: string
- label: Type: string
- lqm_enabled: Type: boolean
- name: Type: string
- tags: [Type: string]
- use_for_application_reachability_probes: Type: boolean
- use_for_controller_connections: Type: boolean
- use_lqm_for_non_hub_paths: Type: boolean
- vpnlink_configuration:
- keep_alive_failure_count: Type: integer
- keep_alive_interval: Type: integer
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def waninterfacelabels(self, waninterfacelabel_id, data, tenant_id=None, api_version="v2.4"): """ Update specific WAN interface label (v2.4) **Parameters:**: - **waninterfacelabel_id**: WAN Interface Label ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.4) **Payload Attributes:** - **bwc_enabled:** Type: boolean - **description:** Type: string - **label:** Type: string - **lqm_enabled:** Type: boolean - **name:** Type: string - **tags:** [Type: string] - **use_for_application_reachability_probes:** Type: boolean - **use_for_controller_connections:** Type: boolean - **use_lqm_for_non_hub_paths:** Type: boolean - **vpnlink_configuration:** - **keep_alive_failure_count:** Type: integer - **keep_alive_interval:** Type: integer **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_id. raise TypeError("tenant_id is required but not set or cached.") cur_ctlr = self._parent_class.controller url = str(cur_ctlr) + "/{}/api/tenants/{}/waninterfacelabels/{}".format(api_version, tenant_id, waninterfacelabel_id) api_logger.debug("URL = %s", url) return self._parent_class.rest_call(url, "put", data=data)
def waninterfaces(
self, site_id, waninterface_id, data, tenant_id=None, api_version='v2.7')
Update the Site WAN interface (v2.7)
Parameters::
- site_id: Site ID
- waninterface_id: WAN Interface ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.7)
Payload Attributes:
- bfd_mode: Type: string
- bw_config_mode: Type: string
- bwc_enabled: Type: boolean
- cost: Type: integer
- description: Type: string
- label_id: Type: string
- link_bw_down: Type: number
- link_bw_up: Type: number
- lqm_config:
- hub_site_ids: [Type: string]
- inter_packet_gap: Type: integer
- statistic: Type: string
- lqm_enabled: Type: boolean
- name: Type: string
- network_id: Type: string
- tags: [Type: string]
- type: Type: string
- use_for_application_reachability_probes: Type: boolean
- use_for_controller_connections: Type: boolean
- use_lqm_for_non_hub_paths: Type: boolean
- vpnlink_configuration:
- keep_alive_failure_count: Type: integer
- keep_alive_interval: Type: integer
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def waninterfaces(self, site_id, waninterface_id, data, tenant_id=None, api_version="v2.7"): """ Update the Site WAN interface (v2.7) **Parameters:**: - **site_id**: Site ID - **waninterface_id**: WAN Interface ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.7) **Payload Attributes:** - **bfd_mode:** Type: string - **bw_config_mode:** Type: string - **bwc_enabled:** Type: boolean - **cost:** Type: integer - **description:** Type: string - **label_id:** Type: string - **link_bw_down:** Type: number - **link_bw_up:** Type: number - **lqm_config:** - **hub_site_ids:** [Type: string] - **inter_packet_gap:** Type: integer - **statistic:** Type: string - **lqm_enabled:** Type: boolean - **name:** Type: string - **network_id:** Type: string - **tags:** [Type: string] - **type:** Type: string - **use_for_application_reachability_probes:** Type: boolean - **use_for_controller_connections:** Type: boolean - **use_lqm_for_non_hub_paths:** Type: boolean - **vpnlink_configuration:** - **keep_alive_failure_count:** Type: integer - **keep_alive_interval:** Type: integer **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def wannetworks(
self, wannetwork_id, data, tenant_id=None, api_version='v2.1')
Update an existing WAN (v2.1)
Parameters::
- wannetwork_id: WAN Network ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.1)
Payload Attributes:
- description: Type: string
- name: Type: string
- provider_as_numbers: [Type: integer]
- tags: [Type: string]
- type: Type: string
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def wannetworks(self, wannetwork_id, data, tenant_id=None, api_version="v2.1"): """ Update an existing WAN (v2.1) **Parameters:**: - **wannetwork_id**: WAN Network ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.1) **Payload Attributes:** - **description:** Type: string - **name:** Type: string - **provider_as_numbers:** [Type: integer] - **tags:** [Type: string] - **type:** Type: string **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def wanoverlays(
self, wanoverlay_id, data, tenant_id=None, api_version='v2.0')
Update app/wan context (v2.0)
Parameters::
- wanoverlay_id: WAN Overlay ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Payload Attributes:
- description: Type: string
- name: Type: string
- vni: Type: integer
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def wanoverlays(self, wanoverlay_id, data, tenant_id=None, api_version="v2.0"): """ Update app/wan context (v2.0) **Parameters:**: - **wanoverlay_id**: WAN Overlay ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** - **description:** Type: string - **name:** Type: string - **vni:** Type: integer **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)
def ws_extensions(
self, extension_id, data, tenant_id=None, api_version='v2.0')
PUT Ws_Extensions API Function
Parameters::
- extension_id: Extension ID
- data: Dictionary containing data to PUT as JSON
- tenant_id: Tenant ID
- api_version: API version to use (default v2.0)
Payload Attributes:
Returns: requests.Response object extended with cgx_status and cgx_content properties.
def ws_extensions(self, extension_id, data, tenant_id=None, api_version="v2.0"): """ PUT Ws_Extensions API Function **Parameters:**: - **extension_id**: Extension ID - **data**: Dictionary containing data to PUT as JSON - **tenant_id**: Tenant ID - **api_version**: API version to use (default v2.0) **Payload Attributes:** **Returns:** requests.Response object extended with cgx_status and cgx_content properties. """ if tenant_id is None and self._parent_class.tenant_id: # Pull tenant_id from parent namespace cache. tenant_id = self._parent_class.tenant_id elif not tenant_id: # No value for tenant_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, "put", data=data)