bandwidth_control_rules¶

The following methods allow for interaction with the ZIA Bandwidth Control Rules API endpoints.

Methods are accessible via zia.bandwidth_control_rules

Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED “AS IS” AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

class BandwidthControlRulesAPI¶

Bases: APIClient

add_rule(**kwargs)¶

Adds a new cloud bandwidth control rule.

Note: This API endpoint can be accessed only through Zscaler OneAPI with the correct access token included in the request’s Authorization header.

Parameters:

name (str) – Name of the rule, max 31 chars.

Keyword Arguments:

order (str) – Rule order, defaults to bottom of the list.
rank (str) – Admin rank for the rule. Supported values 1-7.
enabled (bool) – Whether the rule is enabled or disabled.
description (str) – Additional description for the rule.
default_rule (bool) – Whether the rule is the default bandwidth control rule.
bandwidth_class_ids (list) – IDs of bandwidth classes this rule applies to.
max_bandwidth (int) – Maximum % of location bandwidth for each selected class (upload + download).
min_bandwidth (int) – Minimum % of location bandwidth guaranteed for each selected class (upload + download).
protocols (list) – Protocols to which the rule applies.
labels (list) – IDs of labels this rule applies to.
locations (list) – IDs of locations this rule applies to.
location_groups (list) – IDs of location groups this rule applies to.
time_windows (list) – IDs of time windows this rule applies to.

Returns:

New bandwidth control rule resource record.

Return type:

tuple

Example

Add a bandwidth control rule:

>>> added_rule, _, error = client.zia.bandwidth_control_rules.add_rule(
...     name=f"NewBWDRule_{random.randint(1000, 10000)}",
...     description=f"NewBWDRule_{random.randint(1000, 10000)}",
...     enabled=True,
...     order=1,
...     max_bandwidth='100',
...     min_bandwidth='20',
...     bandwidth_class_ids=['4', '8'],
...     protocols=[ "WEBSOCKETSSL_RULE", "WEBSOCKET_RULE", "DOHTTPS_RULE"],
    )
>>> if error:
...     print(f"Error adding rule: {error}")
...     return
... print(f"Rule added successfully: {added_rule.as_dict()}")

delete_rule(rule_id)¶

Deletes the specified bandwidth control rule.

Note: This API endpoint can be accessed only through Zscaler OneAPI with the correct access token included in the request’s Authorization header.

Parameters:: rule_id (str) – The unique identifier for the bandwidth control rule.
Returns:: The status code for the operation.
Return type:: int

Examples

Delete a Bandwidth rule:

>>> _, _, error = client.zia.bandwidth_control_rules.delete_delete_ruled_class('125454')
>>>     if error:
...         print(f"Error deleting Bandwidth rule: {error}")
...         return
...     print(f"Bandwidth rule with ID {'125454'} deleted successfully.")

get_rule(rule_id)¶

Returns information for the specified bandwidth control rule.

Note: This API endpoint can be accessed only through Zscaler OneAPI with the correct access token included in the request’s Authorization header.

Parameters:: rule_id (str) – The unique identifier for the bandwidth control rule.
Returns:: A tuple containing (bandwidth control rule instance, Response, error).
Return type:: tuple

Example

Retrieve a cloud bandwidth control rule by its ID:

>>> fetched_rule, response, error = client.zia.bandwidth_control_rules.get_rule('960061')
... if error:
...     print(f"Error fetching rule by ID: {error}")
...     return
... print(f"Fetched rule by ID: {fetched_rule.as_dict()}")

list_rules(query_params=None)¶

List bandwidth control rules in your organization. If the search parameter is provided, the function filters the rules client-side.

Note: This API endpoint can be accessed only through Zscaler OneAPI with the correct access token included in the request’s Authorization header.

Parameters:: {dict} (query_params) – Map of query parameters for the request. [query_params.search] {str}: Search string for filtering results by rule name.
Returns:: A tuple containing (list of sandbox rules instances, Response, error).
Return type:: tuple

Example

List all cloud bandwidth control rules:

>>> rules_list, response, error = client.zia.bandwidth_control_rules.list_rules()
... if error:
...    print(f"Error listing bandwidth control rules: {error}")
...    return
... print(f"Total rules found: {len(rules_list)}")
... for rule in rules_list:
...    print(rule.as_dict())

filtering rule results by rule name :

>>> rules_list, response, error = client.zia.bandwidth_control_rules.list_rules(
    query_params={"search": Rule01}
)
... if error:
...    print(f"Error listing bandwidth control rules: {error}")
...    return
... print(f"Total rules found: {len(rules_list)}")
... for rule in rules_list:
...    print(rule.as_dict())

list_rules_lite()¶

Fetches a specific bandwidth control rule lite.

Note: This API endpoint can be accessed only through Zscaler OneAPI with the correct access token included in the request’s Authorization header.

Parameters:: bwd_id (int) – The unique identifier for the Bandwidth control rule Lite.
Returns:: A tuple containing (Bandwidth Control Rules instance, Response, error).
Return type:: tuple

Example

List all cloud bandwidth control rules:

>>> rules_list, response, error = client.zia.bandwidth_control_rules.list_rules_lite()
... if error:
...    print(f"Error listing bandwidth control rules: {error}")
...    return
... print(f"Total rules found: {len(rules_list)}")
... for rule in rules_list:
...    print(rule.as_dict())

update_rule(rule_id, **kwargs)¶

Updates an existing bandwidth control rule.

Note: This API endpoint can be accessed only through Zscaler OneAPI with the correct access token included in the request’s Authorization header.

Parameters:

rule_id (str) – The unique ID for the rule that is being updated.
**kwargs – Optional keyword args.

Keyword Arguments:

order (str) – Rule order, defaults to bottom of the list.
rank (str) – Admin rank for the rule. Supported values 1-7.
enabled (bool) – Whether the rule is enabled or disabled.
description (str) – Additional description for the rule.
default_rule (bool) – Whether the rule is the default bandwidth control rule.
bandwidth_class_ids (list) – IDs of bandwidth classes this rule applies to.
max_bandwidth (int) – Maximum % of location bandwidth for each selected class (upload + download).
min_bandwidth (int) – Minimum % of location bandwidth guaranteed for each selected class (upload + download).
protocols (list) – Protocols to which the rule applies.
labels (list) – IDs of labels this rule applies to.
locations (list) – IDs of locations this rule applies to.
location_groups (list) – IDs of location groups this rule applies to.
time_windows (list) – IDs of time windows this rule applies to.

Returns:

Updated bandwidth control rule resource record.

Return type:

tuple

Example

Add a bandwidth control rule:

>>> updated_rule, _, error = client.zia.bandwidth_control_rules.add_rule(
...     rule_id='15545'
...     name=f"UpdateBWDRule_{random.randint(1000, 10000)}",
...     description=f"UpdateBWDRule_{random.randint(1000, 10000)}",
...     enabled=True,
...     order=1,
...     max_bandwidth='100',
...     min_bandwidth='20',
...     bandwidth_class_ids=['4', '8'],
...     protocols=[ "WEBSOCKETSSL_RULE", "WEBSOCKET_RULE", "DOHTTPS_RULE"],
    )
>>> if error:
...     print(f"Error adding rule: {error}")
...     return
... print(f"Rule added successfully: {updated_rule.as_dict()}")