Subnet

This is the definition of a subnet associated with a Zone.

Overview

accessRestrictionEnabled boolean filterable   orderable  
address string filterable   orderable  
advertise boolean creation only   filterable   orderable  
associatedMulticastChannelMapID string
associatedSharedNetworkResourceID string
defaultAction enum (DROP_TRAFFIC | USE_UNDERLAY) filterable   orderable  
description string filterable  
DHCPRelayStatus enum (DISABLED | ENABLED) filterable   orderable  
DPI enum (DISABLED | ENABLED | INHERITED) filterable   orderable  
dynamicIpv6Address boolean filterable   orderable  
encryption enum (DISABLED | ENABLED | INHERITED) filterable  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
entityState enum (MARKED_FOR_DELETION | UNDER_CONSTRUCTION)
externalID string filterable   orderable   locally unique  
gateway string filterable   orderable  
gatewayMACAddress string
IPType enum (DUALSTACK | IPV4) filterable   orderable  
IPv6Address string filterable   orderable  
IPv6Gateway string 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  
PATEnabled enum (DISABLED | ENABLED | INHERITED) filterable  
policyGroupID integer filterable  
proxyARP boolean filterable   orderable  
public boolean
resourceType enum (FLOATING | NSG_VNF | PUBLIC | STANDARD) filterable   orderable  
routeDistinguisher string filterable   orderable  
routeTarget string filterable   orderable  
serviceID integer filterable   orderable  
splitSubnet boolean filterable   orderable  
templateID string
underlay boolean filterable  
underlayEnabled enum (DISABLED | ENABLED | INHERITED) filterable  
useGlobalMAC enum (DISABLED | ENABLED) filterable   orderable  
vnId integer

API Resource

/subnets/id
delete get put

Parents

/zones/id/subnets
get post
/subnettemplates/id/subnets
get
/ikegatewayconnections/id/subnets
get put
/domains/id/subnets
get
/subnets
get
/nsgateways/id/subnets
get
/patmappers/id/subnets
get

Children

/subnets/id/patipentries
get
/subnets/id/tcas
get post
/subnets/id/addressranges
get post
/subnets/id/resync
get post
/subnets/id/metadatas
get post
/subnets/id/bgpneighbors
get post
/subnets/id/dhcpoptions
get post
/subnets/id/virtualips
get
/subnets/id/globalmetadatas
get post put
/subnets/id/vms
get
/subnets/id/vminterfaces
get
/subnets/id/enterprisepermissions
get post
/subnets/id/containers
get
/subnets/id/containerinterfaces
get
/subnets/id/containerresync
get post
/subnets/id/qos
get post
/subnets/id/vports
get post
/subnets/id/ipreservations
get post
/subnets/id/proxyarpfilters
get post
/subnets/id/statistics
get
/subnets/id/statisticspolicies
get post
/subnets/id/eventlogs
get

Members

/subnets/id/ikegatewayconnections
get put

Attributes documentation

accessRestrictionEnabled boolean filterable   orderable  
Discussion

This attribute specifies whether subnet is enabled with access restrictions. Note: Applicable to shared infrastructure enterprise subnets.

Charateristics

Default value: false
SDK attribute: accessRestrictionEnabled

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

advertise boolean creation only   filterable   orderable  
Discussion

Subnet will be advertised in Overlay and WAN BGP

Charateristics

Default value: true
SDK attribute: advertise

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

associatedSharedNetworkResourceID string
Discussion

The ID of public subnet that is associated with this subnet

Charateristics

Format: free
SDK attribute: associatedSharedNetworkResourceID

defaultAction enum filterable   orderable  
Discussion

If PAT is disabled then this flag indicates what to do if routes don't exist in overlay, will default to drop | possible values USE_UNDERLAY, DROP_TRAFFIC Possible values are USE_UNDERLAY, DROP_TRAFFIC, .

Charateristics

Allowed values: DROP_TRAFFIC, USE_UNDERLAY
Format: free
SDK attribute: defaultAction

description string filterable  
Discussion

A description field provided by the user that identifies the subnet

Charateristics

Format: free
Max length: 255
SDK attribute: description

DHCPRelayStatus enum filterable   orderable  
Discussion

None

Charateristics

Allowed values: DISABLED, ENABLED
SDK attribute: DHCPRelayStatus

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

Default value: false
SDK attribute: dynamicIpv6Address

encryption enum filterable  
Discussion

Determines whether or not IPSEC is enabled.

Charateristics

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

entityState enum
Discussion

Intermediate State of L2 Domain.

Charateristics

Allowed values: MARKED_FOR_DELETION, UNDER_CONSTRUCTION
SDK attribute: entityState

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

gatewayMACAddress string
Discussion

None

Charateristics

Format: free
SDK attribute: gatewayMACAddress

IPType enum filterable   orderable  
Discussion

IPv4 or DUALSTACK

Charateristics

Allowed values: DUALSTACK, IPV4
SDK attribute: IPType

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

maintenanceMode enum
Discussion

maintenanceMode is an enum that indicates if the SubNetwork is accepting VM activation requests.

Charateristics

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

multicast enum filterable  
Discussion

multicast is enum that indicates multicast policy on Subnet/Subnet Template.

Charateristics

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

PATEnabled enum filterable  
Discussion

None

Charateristics

Allowed values: DISABLED, ENABLED, INHERITED
Format: free
SDK attribute: PATEnabled

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
SDK attribute: policyGroupID

proxyARP boolean filterable   orderable  
Discussion

when set VRS will act as ARP Proxy

Charateristics

Format: free
SDK attribute: proxyARP

public boolean
Discussion

when set to true means public subnet under a public zone

Charateristics

Format: free
SDK attribute: public

resourceType enum filterable   orderable  
Discussion

Defines the type of the subnet, PUBLIC,FLOATING,STANDARD OR NSG_VNF

Charateristics

Allowed values: FLOATING, NSG_VNF, PUBLIC, STANDARD
Default value: STANDARD
SDK attribute: resourceType

routeDistinguisher string filterable   orderable  
Discussion

The Route Distinguisher value assigned by VSD for this subnet that is used by the BGP-EVPN protocol in VSC

Charateristics

Format: free
Max length: 255
SDK attribute: routeDistinguisher

routeTarget string filterable   orderable  
Discussion

The Route Target value assigned by VSD for this subnet that is used by the BGP-EVPN protocol in VSC

Charateristics

Format: free
Max length: 255
SDK attribute: routeTarget

serviceID integer filterable   orderable  
Discussion

The service ID used by the VSCs to identify this subnet

Charateristics

Format: free
SDK attribute: serviceID

splitSubnet boolean filterable   orderable  
Discussion

Need to add correct description

Charateristics

Format: free
SDK attribute: splitSubnet

templateID string
Discussion

The ID of the subnet template that this subnet object was derived from

Charateristics

Format: free
SDK attribute: templateID

underlay boolean filterable  
Discussion

Read Only Boolean flag to indicate whether underlay is enabled directly or indirectly

Charateristics

SDK attribute: underlay

underlayEnabled enum filterable  
Discussion

Indicates whether UNDERLAY is enabled for the subnets in this domain

Charateristics

Allowed values: DISABLED, ENABLED, INHERITED
Format: free
SDK attribute: underlayEnabled

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

vnId integer
Discussion

Current Network's globally unique VXLAN network identifier generated by VSD

Charateristics

Min value: 1
Max value: 16777215
SDK attribute: vnId