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  
associatedMulticastChannelMapID string
creationDate string read only   autogenerated   orderable  
description string filterable  
DPI enum (DISABLED | ENABLED | INHERITED) filterable   orderable  
dynamicIpv6Address boolean filterable   orderable  
embeddedMetadata list read only   autogenerated  
encryption enum (DISABLED | ENABLED | INHERITED) filterable   orderable  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
externalID string filterable   orderable   locally unique  
IPType enum (IPV4 | IPV6) filterable   orderable  
IPv6Address string filterable   orderable  
lastUpdatedBy string autogenerated  
lastUpdatedDate string read only   autogenerated   orderable  
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  
owner string autogenerated  
policyGroupID integer filterable   orderable  
publicZone boolean filterable   orderable  
templateID string

API Resource

/zones/id
delete get put

Parents

/zones
get
/domains/id/zones
get post
/aggregateddomains/id/zones
get post

Children

/zones/id/tcas
get post
/zones/id/permissions
get post
/zones/id/metadatas
get post
/zones/id/dhcpoptions
get post
/zones/id/dhcpv6options
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

IPv4 address range of the zone. This is an optional field that allows users to allocate an address range to a zone. The VSD will auto-assign IP ranges to subnets from this range if an IP range is not defined for a subnet.

Charateristics

Format: free
SDK attribute: address

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

creationDate string read only   autogenerated   orderable  
Discussion

Time stamp when this object was created.

Charateristics

SDK attribute: creationDate

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

dynamicIpv6Address boolean filterable   orderable  
Discussion

Turn on or off dynamic allocation of IPV6 address

Charateristics

SDK attribute: dynamicIpv6Address

embeddedMetadata list read only   autogenerated  
Discussion

Metadata objects associated with this entity. This will contain a list of Metadata objects if the API request is made using the special flag to enable the embedded Metadata feature. Only a maximum of Metadata objects is returned based on the value set in the system configuration.

Charateristics

SDK attribute: embeddedMetadata

encryption enum filterable   orderable  
Discussion

Determines whether or not IPSEC is enabled.

Charateristics

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

entityScope enum autogenerated  
Discussion

Specify if scope of entity is Data center or Enterprise level

Charateristics

Allowed values: ENTERPRISE, GLOBAL
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

IPv6Address string filterable   orderable  
Discussion

IPv6 address range of the zone. This is an optional field that allows users to allocate an address range to a zone. The VSD will auto-assign IP ranges to subnets from this range if an IP range is not defined for a subnet.

Charateristics

Format: free
SDK attribute: IPv6Address

lastUpdatedBy string autogenerated  
Discussion

ID of the user who last updated the object.

Charateristics

Format: free
SDK attribute: lastUpdatedBy

lastUpdatedDate string read only   autogenerated   orderable  
Discussion

Time stamp when this object was last updated.

Charateristics

SDK attribute: lastUpdatedDate

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: 255
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

SDK attribute: numberOfHostsInSubnets

owner string autogenerated  
Discussion

Identifies the user that has created this object.

Charateristics

Format: free
SDK attribute: owner

policyGroupID integer filterable   orderable  
Discussion

PG ID for the subnet. This is unique per domain.

Charateristics

Min value: 1
Max value: 2147483647
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

SDK attribute: publicZone

templateID string
Discussion

The ID of the template that this zone was derived from

Charateristics

Format: free
SDK attribute: templateID