Skip to main content

ZTVm Schema

Data structure for Z T Vm objects.

Fields​

FieldTypeRequiredDescriptionNotes
auto_scalebooleanNo-API field: auto_scale
build_versionstringNo-API field: build_version
cc_role_namestringNo-API field: cc_role_name
city_geo_idintegerNo-API field: city_geo_id
deploy_as_gatewaybooleanNo-API field: deploy_as_gateway
dns_cachebooleanNo-API field: dns_cache
ec_instancesEcInstanceWrapperCollectionNo-API field: ec_instances
fail_openbooleanNo-API field: fail_open
form_factorstringNo-API field: form_factor
ha_statusstringNo-API field: ha_status
idintegerYes--
lan_dnsEcDnsNo-API field: lan_dns
last_template_config_push_failedbooleanNo-API field: last_template_config_push_failed
last_upgrade_timeintegerNo-API field: last_upgrade_time
management_nwEcNetworkNo-API field: management_nw
meta_configEcVmMetaConfigNo-API field: meta_config
namestringYes--
nat_ipstringNo-API field: nat_ip
operational_statusstringNo-API field: operational_status
statusEcVMStatusEnumCollectionNo--
traffic_distributionstringNo-API field: traffic_distribution
upgrade_day_of_weekintegerNo-API field: upgrade_day_of_week
upgrade_end_timeintegerNo-API field: upgrade_end_time
upgrade_start_timeintegerNo-API field: upgrade_start_time
upgrade_statusintegerNo-API field: upgrade_status
use_wan_dnsbooleanNo-API field: use_wan_dns
used_for_ztpbooleanNo-API field: used_for_ztp
zero_trust_vmbooleanNo-API field: zero_trust_vm
zia_gatewaystringNo-API field: zia_gateway
zia_gatewaysstringCollectionNo-API field: zia_gateways
zpa_brokerstringNo-API field: zpa_broker
zpa_brokersstringCollectionNo-API field: zpa_brokers

Example​

{
"auto_scale": true,
"build_version": "string",
"cc_role_name": "string",
"city_geo_id": 123,
"deploy_as_gateway": true,
"dns_cache": true,
"ec_instances": [
{
"ec_instance_type": "string",
"flags": "string",
"id": 123
}
],
"fail_open": true
}
// ... more fields