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  
aggregatedL2DomainID string creation only   orderable  
aggregatedL2DomainName string read only   orderable  
aggregatedL2DomainRT string read only   orderable  
aggregatedL2DomainVNID integer read only   orderable  
associatedMasterNetconfGatewayId string orderable  
associatedMulticastChannelMapID string
associatedSharedNetworkResourceID string
color integer
creationDate string read only   autogenerated   orderable  
customerID integer
description string filterable  
DHCPRelayStatus enum (DISABLED | ENABLED | OVERRIDE) filterable   orderable  
domainServiceLabel string
DPI enum (DISABLED | ENABLED | INHERITED) filterable   orderable  
dualStackDynamicIPAllocation boolean filterable   orderable  
embeddedMetadata list read only   autogenerated  
enableDHCPv4 boolean filterable   orderable  
enableDHCPv6 boolean filterable   orderable  
encryption enum (DISABLED | ENABLED | INHERITED) filterable   orderable  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
entityState enum (MARKED_FOR_DELETION | UNDER_CONSTRUCTION)
EVPNEnabled boolean creation only   filterable   orderable  
externalID string filterable   orderable   locally unique  
gateway string filterable   orderable  
gatewayMACAddress string
ingressReplicationEnabled boolean filterable   orderable  
interfaceID integer read only   autogenerated   filterable   orderable  
IPType enum (DUALSTACK | IPV4 | IPV6) filterable   orderable  
IPv6Address string filterable   orderable  
IPv6Gateway string filterable   orderable  
irbSubInterfaceID integer read only   autogenerated  
l2EncapType enum (MPLS | MPLSoUDP | VLAN | VXLAN)
lastUpdatedBy string autogenerated  
lastUpdatedDate string read only   autogenerated   orderable  
linkLocalAddress string filterable   orderable  
maintenanceMode enum (DISABLED | ENABLED | ENABLED_INHERITED)
multicast enum (DISABLED | ENABLED | INHERITED) filterable  
multiHomeEnabled boolean filterable   orderable  
name string required   filterable   orderable  
netmask string filterable   orderable  
owner string autogenerated  
PATEnabled enum (DISABLED | ENABLED | INHERITED) filterable   orderable  
policyGroupID integer filterable  
primaryDHCPServerAddress string
proxyARP boolean filterable   orderable  
public boolean
resourceType enum (FLOATING | NSG_VNF | PUBLIC | STANDARD) filterable   orderable  
routeDistinguisher string filterable   orderable  
routeTarget string filterable   orderable  
secondaryDHCPServerAddress string
serviceID integer filterable   orderable  
splitSubnet boolean filterable   orderable  
subnetVLANID integer filterable   orderable  
templateID string
underlay boolean read only   filterable  
underlayEnabled enum (DISABLED | ENABLED | INHERITED) filterable   orderable  
useGlobalMAC enum (DISABLED | ENABLED | ENTERPRISE_DEFAULT) filterable  
vnId integer
vrrpIPv6BackupAddress string filterable   orderable  
vrrpPriority integer orderable  
wbxDisableMacMove boolean filterable   orderable  

API Resource

/subnets/id
delete get put

Parents

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

Children

/subnets/id/gateways
get
/subnets/id/patipentries
get
/subnets/id/tcas
get post
/subnets/id/addressranges
get post
/subnets/id/defaultgateways
get
/subnets/id/deploymentfailures
get post
/subnets/id/permissions
delete get post put
/subnets/id/resync
get post
/subnets/id/metadatas
get post
/subnets/id/bgpneighbors
get post
/subnets/id/dhcpoptions
get post
/subnets/id/dhcpv6options
get post
/subnets/id/virtualips
get
/subnets/id/floatingips
get
/subnets/id/globalmetadatas
get post put
/subnets/id/vms
get
/subnets/id/vminterfaces
get
/subnets/id/vmipreservations
delete get post
/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/routingpolicyassociations
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/netconfgateways
get put
/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

aggregatedL2DomainID string creation only   orderable  
Discussion

ID of the Aggregated L2 Domain

Charateristics

Format: free
Max length: 255
SDK attribute: aggregatedL2DomainID

aggregatedL2DomainName string read only   orderable  
Discussion

Name of the Aggregated L2 Domain

Charateristics

Format: free
Max length: 255
SDK attribute: aggregatedL2DomainName

aggregatedL2DomainRT string read only   orderable  
Discussion

Route Target of the Aggregated L2 Domain

Charateristics

Format: free
Max length: 255
SDK attribute: aggregatedL2DomainRT

aggregatedL2DomainVNID integer read only   orderable  
Discussion

VNID of the Aggregated L2 Domain

Charateristics

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

associatedMasterNetconfGatewayId string orderable  
Discussion

The ID of associated master Netconf gateway

Charateristics

Format: free
Max length: 255
SDK attribute: associatedMasterNetconfGatewayId

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

color integer
Discussion

The color encoded with a traffic engineering constraint such as minimum latency, hops, maximum bandwidth, etc. This is used for NFIX(Network Function Interconnect). Color is applicable only when the associated Domain's Tunnel Type is MPLSoUDP. Valid range is 1 - 4294967295. If 0 is provided, color will be derived from the associated Domain.

Charateristics

Default value: 0
Max value: 4294967295
SDK attribute: color

creationDate string read only   autogenerated   orderable  
Discussion

Time stamp when this object was created.

Charateristics

SDK attribute: creationDate

customerID integer
Discussion

CustomerID that is used by NETCONF MANAGER to identify this enterprise. This can be configured by root user.

Charateristics

Min value: 10000
Max value: 2147483647
SDK attribute: customerID

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, OVERRIDE
SDK attribute: DHCPRelayStatus

domainServiceLabel string
Discussion

Service ID or external label given to Domain

Charateristics

Format: free
Min length: 1
Max length: 32
SDK attribute: domainServiceLabel

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

dualStackDynamicIPAllocation boolean filterable   orderable  
Discussion

This value indicates whether dynamic address allocation is enabled or not. This will be applicable when subnet is in dual stack mode.

Charateristics

Default value: true
SDK attribute: dualStackDynamicIPAllocation

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

enableDHCPv4 boolean filterable   orderable  
Discussion

Turn on or off DHCP for of IPV4 Addresses

Charateristics

Default value: true
SDK attribute: enableDHCPv4

enableDHCPv6 boolean filterable   orderable  
Discussion

Turn on or off DHCP for IPv6 Addresses

Charateristics

Default value: false
SDK attribute: enableDHCPv6

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

entityState enum
Discussion

Intermediate State of L2 Domain.

Charateristics

Allowed values: MARKED_FOR_DELETION, UNDER_CONSTRUCTION
SDK attribute: entityState

EVPNEnabled boolean creation only   filterable   orderable  
Discussion

Indicates if EVPN capabilities are enabled for this subnet.

Charateristics

Default value: true
SDK attribute: EVPNEnabled

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

ingressReplicationEnabled boolean filterable   orderable  
Discussion

Enables ingress replication for the VNI.

Charateristics

Default value: false
SDK attribute: ingressReplicationEnabled

interfaceID integer read only   autogenerated   filterable   orderable  
Discussion

SRLinux Interface ID for Subnet configuration

Charateristics

Max value: 255
SDK attribute: interfaceID

IPType enum filterable   orderable  
Discussion

IPv4, DUALSTACK or IPv6

Charateristics

Allowed values: DUALSTACK, IPV4, IPV6
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

irbSubInterfaceID integer read only   autogenerated  
Discussion

The IRB sub interface identifies subnet on SRLinux devices.

Charateristics

Min value: 1
Max value: 9999
SDK attribute: irbSubInterfaceID

l2EncapType enum
Discussion

Subnet Tunnel Type, possible values are MPLS, MPLSoUDP, VLAN and VXLAN.

Charateristics

Allowed values: MPLS, MPLSoUDP, VLAN, VXLAN
Default value: VXLAN
SDK attribute: l2EncapType

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

linkLocalAddress string filterable   orderable  
Discussion

IPv6 unicast address. Valid range is fe80::/64.

Charateristics

Default value: fe80::1
Format: free
Min length: 7
Max length: 39
SDK attribute: linkLocalAddress

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

multiHomeEnabled boolean filterable   orderable  
Discussion

Boolean flag to indicate whether this is a Multi-homed subnet or not.

Charateristics

Default value: false
SDK attribute: multiHomeEnabled

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

owner string autogenerated  
Discussion

Identifies the user that has created this object.

Charateristics

Format: free
SDK attribute: owner

PATEnabled enum filterable   orderable  
Discussion

Indicates whether PAT is enabled for the subnets in this domain - ENABLED/DISABLED. Possible values are ENABLED, DISABLED. OR INHERITED

Charateristics

Allowed values: DISABLED, ENABLED, INHERITED
Default value: INHERITED
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

primaryDHCPServerAddress string
Discussion

Primary DHCP Server address when the Domain DHCP Behaviour is OVERLAY Relay and status is OVERRIDE

Charateristics

Format: free
SDK attribute: primaryDHCPServerAddress

proxyARP boolean filterable   orderable  
Discussion

When set, VRS will act as ARP Proxy

Charateristics

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

Route distinguisher for this subnet that is used by the BGP-EVPN protocol in VSC. Supported formats are: [2-byte ASN]:[4-byte value] or [4-byte ASN]:[2-byte value]

Charateristics

Format: free
Max length: 255
SDK attribute: routeDistinguisher

routeTarget string filterable   orderable  
Discussion

Route target for this subnet that is used by the BGP-EVPN protocol in VSC. Supported formats are: [2-byte ASN]:[4-byte value] or [4-byte ASN]:[2-byte value]

Charateristics

Format: free
Max length: 255
SDK attribute: routeTarget

secondaryDHCPServerAddress string
Discussion

Secondary DHCP Server address when the Domain DHCP Behaviour is OVERLAY Relay and status is OVERRIDE

Charateristics

Format: free
SDK attribute: secondaryDHCPServerAddress

serviceID integer filterable   orderable  
Discussion

The service ID used by the VSCs to identify this subnet

Charateristics

Min value: 20001
Max value: 2147483648
SDK attribute: serviceID

splitSubnet boolean filterable   orderable  
Discussion

Block subnet routes

Charateristics

SDK attribute: splitSubnet

subnetVLANID integer filterable   orderable  
Discussion

Determines the VLANID for this associated Subnet.

Charateristics

Min value: 1
Max value: 4096
SDK attribute: subnetVLANID

templateID string
Discussion

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

Charateristics

Format: free
SDK attribute: templateID

underlay boolean read only   filterable  
Discussion

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

Charateristics

SDK attribute: underlay

underlayEnabled enum filterable   orderable  
Discussion

Indicates whether UNDERLAY is enabled for the subnets in this domain

Charateristics

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

useGlobalMAC enum filterable  
Discussion

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

Charateristics

Allowed values: DISABLED, ENABLED, ENTERPRISE_DEFAULT
Default value: ENTERPRISE_DEFAULT
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

vrrpIPv6BackupAddress string filterable   orderable  
Discussion

7x50 VRRP IPv6 Backup Address. Valid range is fe80::/64.

Charateristics

Default value: fe80::ffff:ffff:ffff:ffff
Format: free
Min length: 7
Max length: 39
SDK attribute: vrrpIPv6BackupAddress

vrrpPriority integer orderable  
Discussion

VRRP Priority of Master Netconf Gateway.

Charateristics

Min value: 1
Max value: 254
SDK attribute: vrrpPriority

wbxDisableMacMove boolean filterable   orderable  
Discussion

Disable MAC Move on WBX nodes.

Charateristics

Default value: false
SDK attribute: wbxDisableMacMove