nat_control_policy¶

The following methods allow for interaction with the ZIA NAT Control Policy API endpoints.

Methods are accessible via zia.nat_control_policy

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 NatControlPolicyAPI¶

Bases: APIClient

add_rule(**kwargs)¶

Adds a new nat control rules rule.

Parameters:

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

Keyword Arguments:

description (str) – Additional information about the rule
order (str) – The order of the rule, defaults to adding rule to bottom of list.
rank (int) – The admin rank of the rule. Supported values 1-7
redirect_ip (str) – IP address to which the traffic is redirected to when the DNAT rule is triggered
redirect_fqdn (str) – FQDN to which the traffic is redirected to when the DNAT rule is triggered
redirect_port (int) – Port to which the traffic is redirected to when the DNAT rule is triggered
enabled (bool) – The rule state.
dest_ip_groups (list) – The IDs for the destination IP groups that this rule applies to.
dest_ipv6_groups (list) – The IDs for the destination IPV6 groups that this rule applies to.
dest_countries (list) – Destination countries for the rule.
dest_addresses (list) – Destination IPs for the rule. Accepts IP addresses or CIDR.
src_ips (list) – Source IPs for the rule. Accepts IP addresses or CIDR.
src_ip_groups (list) – The IDs for the source IP groups that this rule applies to.
src_ipv6_groups (list) – The IDs for the source IPV6 groups that this rule applies to.
dest_ip_categories (list) – IP address categories for the rule.
groups (list) – The IDs for the groups that this rule applies to.
users (list) – The IDs for the users that this rule applies to.
res_categories (list) – Resolved categories of destination for which the DNAT rule is applicable.
labels (list) – The IDs for the labels that this rule applies to.
locations (list) – The IDs for the locations that this rule applies to.
location_groups (list) – The IDs for the location groups that this rule applies to.
time_windows (list) – IDs for time windows the rule applies to.
nw_services (list) – The IDs for the network services that this rule applies to.
nw_service_groups (list) – The IDs for the network service groups that this rule applies to.

Returns:

New nat control rule resource record.

Return type:

tuple

Example

Add a new nat control rule:

>>> added_rule, _, error = client.zia.nat_control_policy.add_rule(
...     name=f"NewRule {random.randint(1000, 10000)}",
...     description=f"NewRule {random.randint(1000, 10000)}",
...     enabled=True,
...     order=1,
...     rank=7,
...     redirect_port='2000',
...     redirect_ip='1.1.1.1',
...     src_ips=['192.168.100.0/24', '192.168.200.1'],
...     dest_addresses=['3.217.228.0-3.217.231.255', 'server1.acme.com', '*.acme.com'],
... )
>>> 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 nat control rule.

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

Examples

>>> zia.nat_control_policy.delete_rule('278454')

get_rule(rule_id)¶

Returns information for the specified nat control rule.

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

Example

Retrieve a nat control rules rule by its ID:

>>> fetched_rule, response, error = client.zia.nat_control_policy.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 nat control rules in your organization. If the search parameter is provided, the function filters the rules client-side.

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 nat control rules instances, Response, error).
Return type:: tuple

Example

List all nat control rules:

>>> rules_list, response, error = client.zia.nat_control_policy.list_rules()
... if error:
...    print(f"Error listing nat 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.nat_control_policy.list_rules(
    query_params={"search": Rule01}
)
... if error:
...    print(f"Error listing nat 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 nat control rule.

Parameters:

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

Keyword Arguments:

name (str) – Name of the rule, max 31 chars.
description (str) – Additional information about the rule
order (str) – The order of the rule, defaults to adding rule to bottom of list.
rank (int) – The admin rank of the rule. Supported values 1-7
redirect_ip (str) – IP address to which the traffic is redirected to when the DNAT rule is triggered
redirect_fqdn (str) – FQDN to which the traffic is redirected to when the DNAT rule is triggered
redirect_port (int) – Port to which the traffic is redirected to when the DNAT rule is triggered
enabled (bool) – The rule state.
dest_ip_groups (list) – The IDs for the destination IP groups that this rule applies to.
dest_ipv6_groups (list) – The IDs for the destination IPV6 groups that this rule applies to.
dest_countries (list) – Destination countries for the rule.
dest_addresses (list) – Destination IPs for the rule. Accepts IP addresses or CIDR.
src_ips (list) – Source IPs for the rule. Accepts IP addresses or CIDR.
src_ip_groups (list) – The IDs for the source IP groups that this rule applies to.
src_ipv6_groups (list) – The IDs for the source IPV6 groups that this rule applies to.
dest_ip_categories (list) – IP address categories for the rule.
groups (list) – The IDs for the groups that this rule applies to.
users (list) – The IDs for the users that this rule applies to.
res_categories (list) – Resolved categories of destination for which the DNAT rule is applicable.
labels (list) – The IDs for the labels that this rule applies to.
locations (list) – The IDs for the locations that this rule applies to.
location_groups (list) – The IDs for the location groups that this rule applies to.
time_windows (list) – IDs for time windows the rule applies to.
nw_services (list) – The IDs for the network services that this rule applies to.
nw_service_groups (list) – The IDs for the network service groups that this rule applies to.

Returns:

Updated nat control rule resource record.

Return type:

tuple

Example

Update an existing nat control rule:

>>> updated_rule, _, error = client.zia.nat_control_policy.add_rule(
...     rule_id='877846',
...     name=f"UpdateNewRule {random.randint(1000, 10000)}",
...     description=f"NewRule {random.randint(1000, 10000)}",
...     enabled=True,
...     order=1,
...     rank=7,
...     redirect_port='2000',
...     redirect_ip='1.1.1.1',
...     src_ips=['192.168.100.0/24', '192.168.200.1'],
...     dest_addresses=['3.217.228.0-3.217.231.255', 'server1.acme.com', '*.acme.com'],
... )
>>> if error:
...     print(f"Error adding rule: {error}")
...     return
... print(f"Rule added successfully: {updated_rule.as_dict()}")