SubnetTemplate

As domain and zone objects, subnet objects are created in VSD as derived by templates. This object describes the subnet template.

Overview

address string required   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  
gateway string filterable   orderable  
IPType enum (DUALSTACK | IPV4) filterable   orderable  
IPv6address string filterable   orderable  
IPv6Gateway string filterable   orderable  
lastUpdatedBy string autogenerated  
multicast enum (DISABLED | ENABLED | INHERITED) filterable  
name string required   filterable   orderable  
netmask string required   filterable   orderable  
proxyARP boolean filterable   orderable  
splitSubnet boolean filterable   orderable  
useGlobalMAC enum (DISABLED | ENABLED) filterable   orderable  

API Resource

/subnettemplates/id
delete get put

Parents

/zonetemplates/id/subnettemplates
get post
/domaintemplates/id/subnettemplates
get

Children

/subnettemplates/id/addressranges
get post
/subnettemplates/id/metadatas
get post
/subnettemplates/id/globalmetadatas
get post put
/subnettemplates/id/qos
get post
/subnettemplates/id/subnets
get
/subnettemplates/id/eventlogs
get

Members

This object has no members.

Attributes documentation

address string required   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

associatedMulticastChannelMapID string
Discussion

The ID of the Multi Cast Channel Map this Subnet/Subnet 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 field provided by the user that identifies the subnet

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. Possible values are INHERITED, ENABLED, DISABLED, .

Charateristics

Allowed values: DISABLED, ENABLED, INHERITED
Format: free
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

gateway string filterable   orderable  
Discussion

The IP address of the gateway of this subnet

Charateristics

Format: free
SDK attribute: gateway

IPType enum filterable   orderable  
Discussion

IPv4 or DUALSTACK

Charateristics

Allowed values: DUALSTACK, IPV4
SDK attribute: IPType

IPv6address string filterable   orderable  
Discussion

IPv6 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: IPv6address

IPv6Gateway string filterable   orderable  
Discussion

The IPv6 address of the gateway of this subnet

Charateristics

Format: free
SDK attribute: IPv6Gateway

lastUpdatedBy string autogenerated  
Discussion

ID of the user who last updated the object.

Charateristics

Format: free
SDK attribute: lastUpdatedBy

multicast enum filterable  
Discussion

Indicates multicast policy on Subnet/Subnet Template.

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 required   filterable   orderable  
Discussion

Netmask of the subnet defined

Charateristics

Format: free
SDK attribute: netmask

proxyARP boolean filterable   orderable  
Discussion

when set VRS will act as ARP Proxy

Charateristics

Format: free
SDK attribute: proxyARP

splitSubnet boolean filterable   orderable  
Discussion

Need to add correct description

Charateristics

Format: free
SDK attribute: splitSubnet

useGlobalMAC enum filterable   orderable  
Discussion

if this flag is enabled, the system configured globalMACAddress will be used as the gateway mac address

Charateristics

Allowed values: DISABLED, ENABLED
SDK attribute: useGlobalMAC