ApplianceInfo

Appliance Info resource for Zscaler Cloud & Branch Connector.

Resource operations

This resource supports the following standard methods: create(), load(), update(). They operate on the instance state — set properties with dot notation, then call the method with no arguments. Any other action listed below is a custom action that takes explicit keyword arguments and returns a value.

Quick Start

import zssdk
import logging

# Enable debug logging for ApplianceInfo
logging.getLogger('zssdk.ztw').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 ApplianceInfo
resource = session.ztw.ApplianceInfo(id="your-resource-id")
resource.load()
print(resource)

# Debug output shows HTTP request/response details

Identifiers

Name	Type	Description
`id`	string	Unique identifier

Actions

compute_ip_and_port()

Example:

resource = session.ztw.ApplianceInfo(id="your-resource-id")
result = resource.compute_ip_and_port(id=3600)
print(result)

create()

Creates a new ApplianceInfo. Set properties on the resource instance, then call create() — this method takes no arguments.

Properties for creation:

Name	Type	Required	Description
`create_time`	integer	No	-
`desc`	string	No	-
`flags`	integer	No	-
`last_mod_time`	integer	No	-
`last_mod_uid`	EntityReference	No	-
`location`	EntityReference	No	-
`model_type`	string	Yes	-
`name`	string	Yes	-
`prov_template`	EntityReference	No	-
`serial_number`	string	Yes	-
`start_support_tunnel`	boolean	No	-
`status`	string	No	-
`support_tunnel_ip`	string	No	-
`support_tunnel_port`	integer	No	-
`zia_support_tun_allow`	boolean	No	-
`cloud`	string	No	-
`deleted`	boolean	No	-

Returns: ApplianceInfo

Example:

resource = session.ztw.ApplianceInfo()
resource.model_type = "value"
resource.name = "example-name"
resource.serial_number = "value"
resource.create()
print(f"Created with ID: {resource.id}")

load()

Fetches an existing ApplianceInfo by id. Only the id identifier is required; load() takes no other arguments.

Returns: ApplianceInfo

Example:

resource = session.ztw.ApplianceInfo(id="your-resource-id")
resource.load()
print(resource.name)

update()

Updates an existing ApplianceInfo. Call load() first, modify properties, then call update() — this method takes no arguments.

Properties for update:

Name	Type	Required	Description
`create_time`	integer	No	-
`desc`	string	No	-
`flags`	integer	No	-
`last_mod_time`	integer	No	-
`last_mod_uid`	EntityReference	No	-
`location`	EntityReference	No	-
`model_type`	string	Yes	-
`name`	string	Yes	-
`prov_template`	EntityReference	No	-
`serial_number`	string	Yes	-
`start_support_tunnel`	boolean	No	-
`status`	string	No	-
`support_tunnel_ip`	string	No	-
`support_tunnel_port`	integer	No	-
`zia_support_tun_allow`	boolean	No	-
`cloud`	string	No	-
`deleted`	boolean	No	-

Returns: ApplianceInfo

Example:

resource = session.ztw.ApplianceInfo(id="your-resource-id")
resource.load()
resource.name = "Updated value"
resource.update()

Attributes

Name	Type	Required	Description
`create_time`	integer	No	-
`desc`	string	No	-
`flags`	integer	No	-
`id`	integer	Yes	-
`last_mod_time`	integer	No	-
`last_mod_uid`	EntityReference	No	-
`location`	EntityReference	No	-
`model_type`	string	Yes	-
`name`	string	Yes	-
`prov_template`	EntityReference	No	-
`serial_number`	string	Yes	-
`start_support_tunnel`	boolean	No	-
`status`	string	No	-
`support_tunnel_ip`	string	No	-
`support_tunnel_port`	integer	No	-
`zia_support_tun_allow`	boolean	No	-
`cloud`	string	No	-
`deleted`	boolean	No	-

ApplianceInfo - Data structure definition
Logging guide - enable verbose logs while debugging this resource

Quick Start​

Identifiers​

Actions​

compute_ip_and_port()​

create()​

load()​

update()​

Attributes​

Related​

Quick Start

Identifiers

Actions

compute_ip_and_port()

create()

load()

update()

Attributes

Related