Zone API Reference 4.0

Zone

The zone is a collection of subnets attached to a domain. The zone concept enables the definition of policies for collections of subnets.

Overview

address	string	filterable orderable
associatedApplicationID	string
associatedApplicationObjectID	string
associatedApplicationObjectType	enum (ACLENTRY_LOCATION \| ADDRESS_RANGE \| ADDRESS_RANGE_STATE \| ALARM \| APPD_APPLICATION \| APPD_EXTERNAL_APP_SERVICE \| APPD_FLOW \| APPD_FLOW_FORWARDING_POLICY \| APPD_FLOW_SECURITY_POLICY \| APPD_SERVICE \| APPD_TIER \| APPLICATION \| AUTO_DISC_GATEWAY \| BACK_HAUL_SERVICE_RESP \| BGP_DAMPENING_MED_RESPONSE \| BGP_NEIGHBOR \| BGP_NEIGHBOR_MED_RESPONSE \| BGP_PROFILE \| BGP_PROFILE_MED_RESPONSE \| BGPPEER \| BOOTSTRAP \| BOOTSTRAP_ACTIVATION \| BRIDGEINTERFACE \| CERTIFICATE \| CHILD_ENTITY_POLICY_CHANGE \| CLOUD_MGMT_SYSTEM \| CONTAINER_RESYNC \| CUSTOMER_VRF_SEQUENCENO \| DC_CONFIG \| DHCP_ALLOC_MESSAGE \| DHCP_CONFIG_RESP \| DHCP_OPTION \| DISKSTATS \| DOMAIN \| DOMAIN_CONFIG \| DOMAIN_CONFIG_RESP \| DOMAIN_FLOATING_IP_ACL_TEMPLATE \| DOMAIN_FLOATING_IP_ACL_TEMPLATE_ENTRY \| DOMAIN_TEMPLATE \| DSCP_FORWARDING_CLASS_MAPPING \| DSCP_FORWARDING_CLASS_TABLE \| EGRESS_ACL \| EGRESS_ACL_ENTRY \| EGRESS_ACL_TEMPLATE \| EGRESS_ACL_TEMPLATE_ENTRY \| EGRESS_QOS_MR \| EGRESS_QOS_PRIMITIVE \| EGRESS_QOS_QUEUE_MR \| ENDPOINT \| ENTERPRISE \| ENTERPRISE_CONFIG \| ENTERPRISE_CONFIG_RESP \| ENTERPRISE_NETWORK \| ENTERPRISE_PERMISSION \| ENTERPRISE_PROFILE \| ENTERPRISE_SECURED_DATA \| ENTERPRISE_SECURITY \| ENTITY_METADATA_BINDING \| ESI_SEQUENCENO \| EVENT_LOG \| EVPN_BGP_COMMUNITY_TAG_ENTRY \| EVPN_BGP_COMMUNITY_TAG_SEQ_NO \| EXPORTIMPORT \| EXTERNAL_SERVICE \| FLOATING_IP_ACL_TEMPLATE \| FLOATING_IP_ACL_TEMPLATE_ENTRY \| FLOATINGIP \| FLOATINGIP_ACL \| FLOATINGIP_ACL_ENTRY \| GATEWAY \| GATEWAY_CONFIG \| GATEWAY_CONFIG_RESP \| GATEWAY_SECURED_DATA \| GATEWAY_SECURITY \| GATEWAY_SECURITY_PROFILE_REQUEST \| GATEWAY_SECURITY_PROFILE_RESPONSE \| GATEWAY_SECURITY_REQUEST \| GATEWAY_SECURITY_RESPONSE \| GATEWAY_SERVICE_CONFIG \| GATEWAY_SERVICE_CONFIG_RESP \| GATEWAY_TEMPLATE \| GATEWAY_VPORT_CONFIG \| GATEWAY_VPORT_CONFIG_RESP \| GEO_VM_EVENT \| GEO_VM_REQ \| GEO_VM_RES \| GROUP \| GROUPKEY_ENCRYPTION_PROFILE \| HEALTH_REQ \| HOSTINTERFACE \| HSC \| IKE_CERTIFICATE \| IKE_ENCRYPTION_PROFILE \| IKE_GATEWAY \| IKE_GATEWAY_CONFIG \| IKE_GATEWAY_CONNECTION \| IKE_GATEWAY_PROFILE \| IKE_PSK \| IKE_SUBNET \| INFRASTRUCTURE_CONFIG \| INFRASTRUCTURE_GATEWAY_PROFILE \| INFRASTRUCTURE_PORT_PROFILE \| INFRASTRUCTURE_VSC_PROFILE \| INGRESS_ACL \| INGRESS_ACL_ENTRY \| INGRESS_ACL_TEMPLATE \| INGRESS_ACL_TEMPLATE_ENTRY \| INGRESS_ADV_FWD \| INGRESS_ADV_FWD_ENTRY \| INGRESS_ADV_FWD_TEMPLATE \| INGRESS_ADV_FWD_TEMPLATE_ENTRY \| INGRESS_EXT_SERVICE \| INGRESS_EXT_SERVICE_ENTRY \| INGRESS_EXT_SERVICE_TEMPLATE \| INGRESS_EXT_SERVICE_TEMPLATE_ENTRY \| IP_BINDING \| JOB \| KEYSERVER_MEMBER \| KEYSERVER_MONITOR \| KEYSERVER_MONITOR_ENCRYPTED_SEED \| KEYSERVER_MONITOR_SEED \| KEYSERVER_MONITOR_SEK \| KEYSERVER_NOTIFICATION \| L2DOMAIN \| L2DOMAIN_SHARED \| L2DOMAIN_TEMPLATE \| LDAP_CONFIG \| LIBVIRT_INTERFACE \| LICENSE \| LOCATION \| MC_CHANNEL_MAP \| MC_LIST \| MC_RANGE \| METADATA \| METADATA_TAG \| MIRROR_DESTINATION \| MONITORING_PORT \| MULTI_NIC_VPORT \| NATMAPENTRY \| NETWORK_ELEMENT \| NETWORK_LAYOUT \| NETWORK_MACRO_GROUP \| NETWORK_POLICY_GROUP \| NEXT_HOP_RESP \| NODE_EXECUTION_ERROR \| NS_REDUNDANT_PORT \| NSG_NOTIFICATION \| NSGATEWAY \| NSGATEWAY_CONFIG \| NSGATEWAY_TEMPLATE \| NSPORT \| NSPORT_STATIC_CONFIG \| NSPORT_TEMPLATE \| NSPORT_VLAN_CONFIG \| NSREDUNDANT_GW_GRP \| PATCONFIG_CONFIG_RESP \| PATNATPOOL \| PERMISSION \| PERMITTED_ACTION \| POLICING_POLICY \| POLICY_DECISION \| POLICY_GROUP \| POLICY_GROUP_TEMPLATE \| PORT \| PORT_MR \| PORT_PUSH \| PORT_TEMPLATE \| PORT_VLAN_CONFIG \| PORT_VLAN_CONFIG_RESPONSE \| PUBLIC_NETWORK \| QOS_PRIMITIVE \| RATE_LIMITER \| RD_SEQUENCENO \| REDUNDANT_GW_GRP \| ROUTING_POL_MED_RESPONSE \| ROUTING_POLICY \| RTRD_ENTITY \| RTRD_SEQUENCENO \| SERVICE_GATEWAY_RESPONSE \| SERVICE_VRF_SEQUENCENO \| SERVICES_GATEWAY_RESPONSE \| SHAPING_POLICY \| SHARED_RESOURCE \| SITE \| SITE_REQ \| SITE_RES \| STATIC_ROUTE \| STATIC_ROUTE_RESP \| STATISTICS \| STATS_COLLECTOR \| STATS_POLICY \| STATS_TCA \| STATSSERVER \| SUBNET \| SUBNET_ENTRY \| SUBNET_MAC_ENTRY \| SUBNET_POOL_ENTRY \| SUBNET_TEMPLATE \| SYSTEM_CONFIG \| SYSTEM_CONFIG_REQ \| SYSTEM_CONFIG_RESP \| SYSTEM_MONITORING \| UNSUPPORTED \| UPLINK_RD \| USER \| VIRTUAL_IP \| VIRTUAL_MACHINE \| VIRTUAL_MACHINE_REPORT \| VLAN \| VLAN_CONFIG_RESPONSE \| VLAN_TEMPLATE \| VM_DESCRIPTION \| VM_INTERFACE \| VM_RESYNC \| VMWARE_RELOAD_CONFIG \| VMWARE_VCENTER \| VMWARE_VCENTER_CLUSTER \| VMWARE_VCENTER_DATACENTER \| VMWARE_VCENTER_EAM_CONFIG \| VMWARE_VCENTER_HYPERVISOR \| VMWARE_VCENTER_VRS_BASE_CONFIG \| VMWARE_VCENTER_VRS_CONFIG \| VMWARE_VRS_ADDRESS_RANGE \| VNID_SEQUENCENO \| VPN_CONNECT \| VPORT \| VPORT_GATEWAY_RESPONSE \| VPORT_MEDIATION_REQUEST \| VPORT_MIRROR \| VPORT_TAG_BASE \| VPORTTAG \| VPORTTAGTEMPLATE \| VPRN_LABEL_SEQUENCENO \| VRS \| VSC \| VSD \| VSD_COMPONENT \| VSG_REDUNDANT_PORT \| VSP \| WAN_SERVICE \| ZONE \| ZONE_TEMPLATE)	filterable orderable
associatedMulticastChannelMapID	string
description	string	filterable
DPI	enum (DISABLED \| ENABLED \| INHERITED)	filterable orderable
encryption	enum (DISABLED \| ENABLED \| INHERITED)	filterable
entityScope	enum (ENTERPRISE \| GLOBAL)	autogenerated filterable orderable
externalID	string	filterable orderable locally unique
IPType	enum (IPV4 \| IPV6)	filterable orderable
lastUpdatedBy	string	autogenerated
maintenanceMode	enum (DISABLED \| ENABLED \| ENABLED_INHERITED)
multicast	enum (DISABLED \| ENABLED \| INHERITED)	filterable
name	string	required filterable orderable
netmask	string	filterable orderable
numberOfHostsInSubnets	integer	filterable orderable
policyGroupID	integer	filterable
publicZone	boolean	filterable orderable
templateID	string

API Resource

/zones/id

delete get put

Parents

/domains/id/zones

get post

/zones

get

Children

/zones/id/tcas

get post

/zones/id/permissions

get post

/zones/id/metadatas

get post

/zones/id/dhcpoptions

get post

/zones/id/globalmetadatas

get post put

/zones/id/vms

get

/zones/id/vminterfaces

get

/zones/id/containers

get

/zones/id/containerinterfaces

get

/zones/id/qos

get post

/zones/id/vports

get

/zones/id/groups

get put

/zones/id/statistics

get

/zones/id/statisticspolicies

get post

/zones/id/subnets

get post

/zones/id/eventlogs

get

Members

This object has no members.

Attributes documentation

address string filterable orderable

Discussion

IP address of the subnet defined. In case of zone, this is an optional field for and allows users to allocate an IP address range to a zone. The VSD will auto-assign IP addresses to subnets from this range if a specific IP address is not defined for the subnet

Charateristics

Format: free
SDK attribute: address

associatedApplicationID string

Discussion

The associated application ID.

Charateristics

Format: free
SDK attribute: associatedApplicationID

associatedApplicationObjectID string

Discussion

The associated application object ID.

Charateristics

Format: free
SDK attribute: associatedApplicationObjectID

associatedApplicationObjectType enum filterable orderable

Discussion

The associated application object type. Refer to API section for supported types.

Charateristics

Allowed values: ACLENTRY_LOCATION, ADDRESS_RANGE, ADDRESS_RANGE_STATE, ALARM, APPD_APPLICATION, APPD_EXTERNAL_APP_SERVICE, APPD_FLOW, APPD_FLOW_FORWARDING_POLICY, APPD_FLOW_SECURITY_POLICY, APPD_SERVICE, APPD_TIER, APPLICATION, AUTO_DISC_GATEWAY, BACK_HAUL_SERVICE_RESP, BGP_DAMPENING_MED_RESPONSE, BGP_NEIGHBOR, BGP_NEIGHBOR_MED_RESPONSE, BGP_PROFILE, BGP_PROFILE_MED_RESPONSE, BGPPEER, BOOTSTRAP, BOOTSTRAP_ACTIVATION, BRIDGEINTERFACE, CERTIFICATE, CHILD_ENTITY_POLICY_CHANGE, CLOUD_MGMT_SYSTEM, CONTAINER_RESYNC, CUSTOMER_VRF_SEQUENCENO, DC_CONFIG, DHCP_ALLOC_MESSAGE, DHCP_CONFIG_RESP, DHCP_OPTION, DISKSTATS, DOMAIN, DOMAIN_CONFIG, DOMAIN_CONFIG_RESP, DOMAIN_FLOATING_IP_ACL_TEMPLATE, DOMAIN_FLOATING_IP_ACL_TEMPLATE_ENTRY, DOMAIN_TEMPLATE, DSCP_FORWARDING_CLASS_MAPPING, DSCP_FORWARDING_CLASS_TABLE, EGRESS_ACL, EGRESS_ACL_ENTRY, EGRESS_ACL_TEMPLATE, EGRESS_ACL_TEMPLATE_ENTRY, EGRESS_QOS_MR, EGRESS_QOS_PRIMITIVE, EGRESS_QOS_QUEUE_MR, ENDPOINT, ENTERPRISE, ENTERPRISE_CONFIG, ENTERPRISE_CONFIG_RESP, ENTERPRISE_NETWORK, ENTERPRISE_PERMISSION, ENTERPRISE_PROFILE, ENTERPRISE_SECURED_DATA, ENTERPRISE_SECURITY, ENTITY_METADATA_BINDING, ESI_SEQUENCENO, EVENT_LOG, EVPN_BGP_COMMUNITY_TAG_ENTRY, EVPN_BGP_COMMUNITY_TAG_SEQ_NO, EXPORTIMPORT, EXTERNAL_SERVICE, FLOATING_IP_ACL_TEMPLATE, FLOATING_IP_ACL_TEMPLATE_ENTRY, FLOATINGIP, FLOATINGIP_ACL, FLOATINGIP_ACL_ENTRY, GATEWAY, GATEWAY_CONFIG, GATEWAY_CONFIG_RESP, GATEWAY_SECURED_DATA, GATEWAY_SECURITY, GATEWAY_SECURITY_PROFILE_REQUEST, GATEWAY_SECURITY_PROFILE_RESPONSE, GATEWAY_SECURITY_REQUEST, GATEWAY_SECURITY_RESPONSE, GATEWAY_SERVICE_CONFIG, GATEWAY_SERVICE_CONFIG_RESP, GATEWAY_TEMPLATE, GATEWAY_VPORT_CONFIG, GATEWAY_VPORT_CONFIG_RESP, GEO_VM_EVENT, GEO_VM_REQ, GEO_VM_RES, GROUP, GROUPKEY_ENCRYPTION_PROFILE, HEALTH_REQ, HOSTINTERFACE, HSC, IKE_CERTIFICATE, IKE_ENCRYPTION_PROFILE, IKE_GATEWAY, IKE_GATEWAY_CONFIG, IKE_GATEWAY_CONNECTION, IKE_GATEWAY_PROFILE, IKE_PSK, IKE_SUBNET, INFRASTRUCTURE_CONFIG, INFRASTRUCTURE_GATEWAY_PROFILE, INFRASTRUCTURE_PORT_PROFILE, INFRASTRUCTURE_VSC_PROFILE, INGRESS_ACL, INGRESS_ACL_ENTRY, INGRESS_ACL_TEMPLATE, INGRESS_ACL_TEMPLATE_ENTRY, INGRESS_ADV_FWD, INGRESS_ADV_FWD_ENTRY, INGRESS_ADV_FWD_TEMPLATE, INGRESS_ADV_FWD_TEMPLATE_ENTRY, INGRESS_EXT_SERVICE, INGRESS_EXT_SERVICE_ENTRY, INGRESS_EXT_SERVICE_TEMPLATE, INGRESS_EXT_SERVICE_TEMPLATE_ENTRY, IP_BINDING, JOB, KEYSERVER_MEMBER, KEYSERVER_MONITOR, KEYSERVER_MONITOR_ENCRYPTED_SEED, KEYSERVER_MONITOR_SEED, KEYSERVER_MONITOR_SEK, KEYSERVER_NOTIFICATION, L2DOMAIN, L2DOMAIN_SHARED, L2DOMAIN_TEMPLATE, LDAP_CONFIG, LIBVIRT_INTERFACE, LICENSE, LOCATION, MC_CHANNEL_MAP, MC_LIST, MC_RANGE, METADATA, METADATA_TAG, MIRROR_DESTINATION, MONITORING_PORT, MULTI_NIC_VPORT, NATMAPENTRY, NETWORK_ELEMENT, NETWORK_LAYOUT, NETWORK_MACRO_GROUP, NETWORK_POLICY_GROUP, NEXT_HOP_RESP, NODE_EXECUTION_ERROR, NS_REDUNDANT_PORT, NSG_NOTIFICATION, NSGATEWAY, NSGATEWAY_CONFIG, NSGATEWAY_TEMPLATE, NSPORT, NSPORT_STATIC_CONFIG, NSPORT_TEMPLATE, NSPORT_VLAN_CONFIG, NSREDUNDANT_GW_GRP, PATCONFIG_CONFIG_RESP, PATNATPOOL, PERMISSION, PERMITTED_ACTION, POLICING_POLICY, POLICY_DECISION, POLICY_GROUP, POLICY_GROUP_TEMPLATE, PORT, PORT_MR, PORT_PUSH, PORT_TEMPLATE, PORT_VLAN_CONFIG, PORT_VLAN_CONFIG_RESPONSE, PUBLIC_NETWORK, QOS_PRIMITIVE, RATE_LIMITER, RD_SEQUENCENO, REDUNDANT_GW_GRP, ROUTING_POL_MED_RESPONSE, ROUTING_POLICY, RTRD_ENTITY, RTRD_SEQUENCENO, SERVICE_GATEWAY_RESPONSE, SERVICE_VRF_SEQUENCENO, SERVICES_GATEWAY_RESPONSE, SHAPING_POLICY, SHARED_RESOURCE, SITE, SITE_REQ, SITE_RES, STATIC_ROUTE, STATIC_ROUTE_RESP, STATISTICS, STATS_COLLECTOR, STATS_POLICY, STATS_TCA, STATSSERVER, SUBNET, SUBNET_ENTRY, SUBNET_MAC_ENTRY, SUBNET_POOL_ENTRY, SUBNET_TEMPLATE, SYSTEM_CONFIG, SYSTEM_CONFIG_REQ, SYSTEM_CONFIG_RESP, SYSTEM_MONITORING, UNSUPPORTED, UPLINK_RD, USER, VIRTUAL_IP, VIRTUAL_MACHINE, VIRTUAL_MACHINE_REPORT, VLAN, VLAN_CONFIG_RESPONSE, VLAN_TEMPLATE, VM_DESCRIPTION, VM_INTERFACE, VM_RESYNC, VMWARE_RELOAD_CONFIG, VMWARE_VCENTER, VMWARE_VCENTER_CLUSTER, VMWARE_VCENTER_DATACENTER, VMWARE_VCENTER_EAM_CONFIG, VMWARE_VCENTER_HYPERVISOR, VMWARE_VCENTER_VRS_BASE_CONFIG, VMWARE_VCENTER_VRS_CONFIG, VMWARE_VRS_ADDRESS_RANGE, VNID_SEQUENCENO, VPN_CONNECT, VPORT, VPORT_GATEWAY_RESPONSE, VPORT_MEDIATION_REQUEST, VPORT_MIRROR, VPORT_TAG_BASE, VPORTTAG, VPORTTAGTEMPLATE, VPRN_LABEL_SEQUENCENO, VRS, VSC, VSD, VSD_COMPONENT, VSG_REDUNDANT_PORT, VSP, WAN_SERVICE, ZONE, ZONE_TEMPLATE
Format: free
SDK attribute: associatedApplicationObjectType

associatedMulticastChannelMapID string

Discussion

The ID of the Multi Cast Channel Map this zone/zone template is associated with. This has to be set when enableMultiCast is set to ENABLED

Charateristics

Format: free
SDK attribute: associatedMulticastChannelMapID

description string filterable

Discussion

A description of the zone

Charateristics

Format: free
Max length: 255
SDK attribute: description

DPI enum filterable orderable

Discussion

determines whether or not Deep packet inspection is enabled

Charateristics

Allowed values: DISABLED, ENABLED, INHERITED
Default value: INHERITED
SDK attribute: DPI

encryption enum filterable

Discussion

Determines whether or not IPSEC is enabled.

Charateristics

Allowed values: DISABLED, ENABLED, INHERITED
SDK attribute: encryption

entityScope enum autogenerated filterable orderable

Discussion

Specify if scope of entity is Data center or Enterprise level

Charateristics

Allowed values: ENTERPRISE, GLOBAL
Format: free
SDK attribute: entityScope

externalID string filterable orderable locally unique

Discussion

External object ID. Used for integration with third party systems

Charateristics

Format: free
SDK attribute: externalID

IPType enum filterable orderable

Discussion

IPv4 or IPv6

Charateristics

Allowed values: IPV4, IPV6
SDK attribute: IPType

lastUpdatedBy string autogenerated

Discussion

ID of the user who last updated the object.

Charateristics

Format: free
SDK attribute: lastUpdatedBy

maintenanceMode enum

Discussion

Indicates if the Zone is accepting VM activation requests.

Charateristics

Allowed values: DISABLED, ENABLED, ENABLED_INHERITED
SDK attribute: maintenanceMode

multicast enum filterable

Discussion

Indicates multicast policy on zone.

Charateristics

Allowed values: DISABLED, ENABLED, INHERITED
SDK attribute: multicast

name string required filterable orderable

Discussion

Name of the current entity(Zone or zone template or subnet etc..) Valid characters are alphabets, numbers, space and hyphen( - ).

Charateristics

Format: free
Min length: 1
Max length: 64
SDK attribute: name

netmask string filterable orderable

Discussion

Netmask of the subnet defined

Charateristics

Format: free
SDK attribute: netmask

numberOfHostsInSubnets integer filterable orderable

Discussion

Number of hosts in each of the subnets that can be created under a zone and are auto-assigned IP addresses

Charateristics

Format: free
SDK attribute: numberOfHostsInSubnets

policyGroupID integer filterable

Discussion

PG ID for the subnet. This is unique per domain and will be in the range 1-4095

Charateristics

Format: free
Min value: 1
Max value: 4095
SDK attribute: policyGroupID

publicZone boolean filterable orderable

Discussion

If a zone is marked as public, then it is lined to the public network associated with this data center

Charateristics

Format: free
SDK attribute: publicZone

templateID string

Discussion

The ID of the template that this zone was derived from

Charateristics

Format: free
SDK attribute: templateID