L2Domain

This is the definition of a l2 domain associated with a Enterprise.

Overview

address string filterable   orderable  
associatedMulticastChannelMapID string
associatedSharedNetworkResourceID string
associatedUnderlayID string
color integer
creationDate string read only   autogenerated   orderable  
customerID integer
description string filterable  
DHCPManaged boolean filterable   orderable  
DPI enum (DISABLED | ENABLED) filterable   orderable  
dualStackDynamicIPAllocation boolean read only   filterable   orderable  
embeddedMetadata list read only   autogenerated  
enableDHCPv4 boolean read only   filterable   orderable  
enableDHCPv6 boolean read only   filterable   orderable  
encryption enum (DISABLED | ENABLED) filterable  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
entityState enum (MARKED_FOR_DELETION | UNDER_CONSTRUCTION)
externalID string filterable   orderable   locally unique  
flowCollectionEnabled enum (DISABLED | ENABLED | INHERITED) filterable   orderable  
gateway string filterable   orderable  
gatewayMACAddress string
ingressReplicationEnabled boolean filterable   orderable  
IPType enum (DUALSTACK | IPV4 | IPV6) filterable   orderable  
IPv6Address string filterable   orderable  
IPv6Gateway string filterable   orderable  
l2EncapType enum (MPLSoUDP | VXLAN)
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  
owner string autogenerated  
policyChangeStatus enum (APPLIED | DISCARDED | STARTED) filterable  
routeDistinguisher string filterable   orderable  
routedVPLSEnabled boolean filterable   orderable  
routeTarget string filterable   orderable  
serviceID integer filterable   orderable  
stretched boolean
templateID string
uplinkPreference enum (PRIMARY | PRIMARY_SECONDARY | SECONDARY | SECONDARY_PRIMARY | SYMMETRIC)
useGlobalMAC enum (DISABLED | ENABLED) filterable  
vnId integer
VXLANECMPEnabled boolean orderable  

API Resource

/l2domains/id
delete get put

Parents

/enterprises/id/l2domains
get post
/redundancygroups/id/l2domains
get
/l2domains
get
/netconfgateways/id/l2domains
get
/gateways/id/l2domains
get
/l2domaintemplates/id/l2domains
get

Children

/l2domains/id/gateways
get
/l2domains/id/tcas
get post
/l2domains/id/addressranges
get
/l2domains/id/redirectiontargets
get post
/l2domains/id/redundancygroups
get
/l2domains/id/deploymentfailures
get post put
/l2domains/id/permissions
get post
/l2domains/id/metadatas
get post
/l2domains/id/networkperformancebindings
get post
/l2domains/id/pgexpressions
get post
/l2domains/id/egressaclentrytemplates
get
/l2domains/id/egressacltemplates
get post
/l2domains/id/egressadvfwdtemplates
get post
/l2domains/id/dhcpoptions
get post
/l2domains/id/dhcpv6options
get post
/l2domains/id/mirrordestinationgroups
get post
/l2domains/id/virtualfirewallpolicies
get post
/l2domains/id/virtualfirewallrules
get
/l2domains/id/alarms
get
/l2domains/id/globalmetadatas
get post put
/l2domains/id/vms
get
/l2domains/id/vminterfaces
get
/l2domains/id/ingressaclentrytemplates
get
/l2domains/id/ingressacltemplates
get post
/l2domains/id/ingressadvfwdtemplates
get post
/l2domains/id/jobs
post
/l2domains/id/policygroups
get post
/l2domains/id/containers
get
/l2domains/id/containerinterfaces
get
/l2domains/id/qos
get post
/l2domains/id/hostinterfaces
get
/l2domains/id/uplinkroutedistinguishers
get
/l2domains/id/vpnconnections
get post
/l2domains/id/vports
get post
/l2domains/id/applications
get
/l2domains/id/applicationperformancemanagementbindings
get post
/l2domains/id/bridgeinterfaces
get
/l2domains/id/groups
get put
/l2domains/id/proxyarpfilters
get
/l2domains/id/nsgatewayssummaries
get
/l2domains/id/staticroutes
get post
/l2domains/id/statistics
get
/l2domains/id/statisticspolicies
get post
/l2domains/id/eventlogs
get
/l2domains/id/overlaymirrordestinations
get post

Members

This object has no members.

Attributes documentation

address string filterable   orderable  
Discussion

Network address of the L2Domain / L2Domain template defined.

Charateristics

Format: free
SDK attribute: address

associatedMulticastChannelMapID string
Discussion

The ID of the Multi Cast Channel Map this L2Domain / L2Domain template 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 the L2 Domain that this L2 Domain object is pointing to

Charateristics

Format: free
SDK attribute: associatedSharedNetworkResourceID

associatedUnderlayID string
Discussion

The ID of the Underlay entity to which this L2 Domain is associated.

Charateristics

Format: free
SDK attribute: associatedUnderlayID

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 selected l2EncapType is MPLSoUDP. Valid range is 1 - 4294967295. 0 for other Tunnel Types.

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 L2Domain / L2Domain template.

Charateristics

Format: free
SDK attribute: description

DHCPManaged boolean filterable   orderable  
Discussion

decides whether L2Domain / L2Domain template DHCP is managed by VSD

Charateristics

Format: free
SDK attribute: DHCPManaged

DPI enum filterable   orderable  
Discussion

determines whether or not Deep packet inspection is enabled

Charateristics

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

dualStackDynamicIPAllocation boolean read only   filterable   orderable  
Discussion

This read-only value indicates whether dynamic address allocation is enabled or not at template. This will be applicable when L2 Domain is managed and in dual stack mode

Charateristics

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 read only   filterable   orderable  
Discussion

This read-only value indicates whether IPv4 DHCP is enabled or not. This is applicable in case the L2 Domain is DUALSTACK or IPv4

Charateristics

SDK attribute: enableDHCPv4

enableDHCPv6 boolean read only   filterable   orderable  
Discussion

This read-only value indicates whether IPv6 DHCP is enabled or not. This is applicable in case the L2 Domain is DUALSTACK or IPv6

Charateristics

SDK attribute: enableDHCPv6

encryption enum filterable  
Discussion

Determines whether IPSEC is enabled Possible values are ENABLED, DISABLED, .

Charateristics

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

flowCollectionEnabled enum filterable   orderable  
Discussion

Determines whether or not flow collection is enabled.

Charateristics

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

gateway string filterable   orderable  
Discussion

The IP address of the gateway of this l2 domain

Charateristics

Format: free
SDK attribute: gateway

gatewayMACAddress string
Discussion

The MAC address of the Gateway.

Charateristics

Format: free
SDK attribute: gatewayMACAddress

ingressReplicationEnabled boolean filterable   orderable  
Discussion

Enables ingress replication for the VNI.

Charateristics

Default value: false
SDK attribute: ingressReplicationEnabled

IPType enum filterable   orderable  
Discussion

IPv4, DUALSTACK or IPv6

Charateristics

Allowed values: DUALSTACK, IPV4, IPV6
SDK attribute: IPType

IPv6Address string filterable   orderable  
Discussion

IPV6 address of the route - Optional

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

l2EncapType enum
Discussion

Default Domain Tunnel Type

Charateristics

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

maintenanceMode enum
Discussion

maintenanceMode is an enum that indicates if the L2Domain is accepting VM activation requests. Possible values are DISABLED, ENABLED and ENABLED_INHERITED Possible values are .

Charateristics

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

multicast enum filterable  
Discussion

Indicates multicast policy on L2Domain.

Charateristics

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

name string required   filterable   orderable  
Discussion

Name of the L2Domain / L2Domain template,has to be unique within a Enterprise. 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 L2Domain / L2Domain template 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

policyChangeStatus enum filterable  
Discussion

None

Charateristics

Allowed values: APPLIED, DISCARDED, STARTED
Format: free
SDK attribute: policyChangeStatus

routeDistinguisher string filterable   orderable  
Discussion

Route distinguisher 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

routedVPLSEnabled boolean filterable   orderable  
Discussion

Determines whether routed VPLS services are enabled on this domain.

Charateristics

Default value: false
SDK attribute: routedVPLSEnabled

routeTarget string filterable   orderable  
Discussion

Route target 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

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

stretched boolean
Discussion

Indicates whether this domain is streched,if so remote VM resolutions will be allowed

Charateristics

Format: free
SDK attribute: stretched

templateID string
Discussion

The ID of the L2 Domain template that this L2 Domain object was derived from

Charateristics

Format: free
SDK attribute: templateID

uplinkPreference enum
Discussion

Indicates the preferencial path selection for network traffic in this domain - Default is Primary 1 and Secondary 2. Possible values are PRIMARY_SECONDARY, SECONDARY_PRIMARY, PRIMARY, SECONDARY, SYMMETRIC, .

Charateristics

Allowed values: PRIMARY, PRIMARY_SECONDARY, SECONDARY, SECONDARY_PRIMARY, SYMMETRIC
Format: free
SDK attribute: uplinkPreference

useGlobalMAC enum filterable  
Discussion

Enable this flag to use system configured globalMACAddress as the gateway mac address for managed l2 domains

Charateristics

Allowed values: DISABLED, ENABLED
Default value: DISABLED
SDK attribute: useGlobalMAC

vnId integer
Discussion

Current network's globally unique VXLAN network identifier

Charateristics

Format: free
SDK attribute: vnId

VXLANECMPEnabled boolean orderable  
Discussion

Determines whether VXLAN-ECMP are enabled on this domain.

Charateristics

Default value: false
SDK attribute: VXLANECMPEnabled