BandwidthControlRule
Bandwidth Control Rule resource for Zscaler Internet Access.
This resource supports the following standard methods: create(), load(), update(), delete(). They operate on the instance state — set properties with dot notation, then call the method with no arguments.
Quick Start
import zssdk
import logging
# Enable debug logging for BandwidthControlRule
logging.getLogger('zssdk.zia').setLevel(logging.DEBUG)
logging.basicConfig(level=logging.DEBUG)
session = zssdk.Session(
vanity_domain="your-vanity-domain",
client_id="your-client-id",
client_secret="your-client-secret",
)
# Get a specific BandwidthControlRule
resource = session.zia.BandwidthControlRule(id="your-resource-id")
resource.load()
print(resource)
# Debug output shows HTTP request/response details
Identifiers
| Name | Type | Description |
|---|---|---|
id | string | Unique identifier |
Actions
create()
Creates a new BandwidthControlRule. Set properties on the resource instance, then call create() — this method takes no arguments.
Properties for creation:
| Name | Type | Required | Description |
|---|---|---|---|
access_control | string | No | - |
bandwidth_classes | EntityReferenceWrapperCollection | No | - |
default_rule | boolean | No | - |
description | string | No | - |
device_groups | EntityReferenceWrapperCollection | No | - |
device_trust_levels | DeviceTrustLevelsEnumCollection | No | - |
devices | EntityReferenceWrapperCollection | No | - |
labels | EntityReferenceWrapperCollection | No | - |
last_modified_by | EntityReference | No | - |
last_modified_time | integer | No | - |
location_groups | EntityReferenceWrapperCollection | No | - |
locations | EntityReferenceWrapperCollection | No | - |
max_bandwidth | integer | No | - |
min_bandwidth | integer | No | - |
name | string | Yes | - |
order | integer | Yes | - |
protocols | BandwidthControlRuleProtocolsEnumCollection | Yes | - |
rank | integer | No | - |
state | string | No | - |
time_windows | EntityReferenceWrapperCollection | No | - |
Returns: BandwidthControlRule
Example:
resource = session.zia.BandwidthControlRule()
resource.name = "example-name"
resource.order = 3600
resource.protocols = ["value"]
resource.create()
print(f"Created with ID: {resource.id}")
delete()
Deletes a BandwidthControlRule by id. Only the id identifier is required; delete() takes no other arguments.
Example:
resource = session.zia.BandwidthControlRule(id="your-resource-id")
resource.delete()
load()
Fetches an existing BandwidthControlRule by id. Only the id identifier is required; load() takes no other arguments.
Returns: BandwidthControlRule
Example:
resource = session.zia.BandwidthControlRule(id="your-resource-id")
resource.load()
print(resource.name)
update()
Updates an existing BandwidthControlRule. Call load() first, modify properties, then call update() — this method takes no arguments.
Properties for update:
| Name | Type | Required | Description |
|---|---|---|---|
access_control | string | No | - |
bandwidth_classes | EntityReferenceWrapperCollection | No | - |
default_rule | boolean | No | - |
description | string | No | - |
device_groups | EntityReferenceWrapperCollection | No | - |
device_trust_levels | DeviceTrustLevelsEnumCollection | No | - |
devices | EntityReferenceWrapperCollection | No | - |
labels | EntityReferenceWrapperCollection | No | - |
last_modified_by | EntityReference | No | - |
last_modified_time | integer | No | - |
location_groups | EntityReferenceWrapperCollection | No | - |
locations | EntityReferenceWrapperCollection | No | - |
max_bandwidth | integer | No | - |
min_bandwidth | integer | No | - |
name | string | Yes | - |
order | integer | Yes | - |
protocols | BandwidthControlRuleProtocolsEnumCollection | Yes | - |
rank | integer | No | - |
state | string | No | - |
time_windows | EntityReferenceWrapperCollection | No | - |
Returns: BandwidthControlRule
Example:
resource = session.zia.BandwidthControlRule(id="your-resource-id")
resource.load()
resource.name = "Updated value"
resource.update()
Attributes
| Name | Type | Required | Description |
|---|---|---|---|
access_control | string | No | - |
bandwidth_classes | EntityReferenceWrapperCollection | No | - |
default_rule | boolean | No | - |
description | string | No | - |
device_groups | EntityReferenceWrapperCollection | No | - |
device_trust_levels | DeviceTrustLevelsEnumCollection | No | - |
devices | EntityReferenceWrapperCollection | No | - |
id | integer | Yes | - |
labels | EntityReferenceWrapperCollection | No | - |
last_modified_by | EntityReference | No | - |
last_modified_time | integer | No | - |
location_groups | EntityReferenceWrapperCollection | No | - |
locations | EntityReferenceWrapperCollection | No | - |
max_bandwidth | integer | No | - |
min_bandwidth | integer | No | - |
name | string | Yes | - |
order | integer | Yes | - |
protocols | BandwidthControlRuleProtocolsEnumCollection | Yes | - |
rank | integer | No | - |
state | string | No | - |
time_windows | EntityReferenceWrapperCollection | No | - |
Related
- BandwidthControlRule - Data structure definition
- Logging guide - enable verbose logs while debugging this resource