L2Domain

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

Overview

address string filterable   orderable  
associatedMulticastChannelMapID string
associatedSharedNetworkResourceID string
description string filterable  
DHCPManaged boolean filterable   orderable  
DPI enum (DISABLED | ENABLED) filterable   orderable  
encryption enum (DISABLED | ENABLED) filterable  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated   filterable   orderable  
entityState enum (MARKED_FOR_DELETION | UNDER_CONSTRUCTION) filterable   orderable  
externalID string filterable   orderable   locally unique  
gateway string filterable   orderable  
gatewayMACAddress string
IPType enum (IPV4 | IPV6) filterable   orderable  
IPv6Address string filterable  
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  
policyChangeStatus enum (APPLIED | DISCARDED | STARTED) filterable  
routeDistinguisher string 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   orderable  
vnId integer

API Resource

/l2domains/id
delete get put

Parents

/enterprises/id/l2domains
get post
/l2domains
get
/l2domaintemplates/id/l2domains
get

Children

/l2domains/id/tcas
get post
/l2domains/id/addressranges
get
/l2domains/id/redirectiontargets
get post
/l2domains/id/permissions
get post
/l2domains/id/metadatas
get post
/l2domains/id/egressaclentrytemplates
get
/l2domains/id/egressacltemplates
get post
/l2domains/id/dhcpoptions
get post
/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/ingressexternalservicetemplates
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/applicationperformancemanagementbindings
get post
/l2domains/id/bridgeinterfaces
get
/l2domains/id/groups
get put
/l2domains/id/staticroutes
get post
/l2domains/id/statistics
get
/l2domains/id/statisticspolicies
get post
/l2domains/id/eventlogs
get

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

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

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

Specify if scope of entity is Data center or Enterprise level

Charateristics

Allowed values: ENTERPRISE, GLOBAL
Format: free
SDK attribute: entityScope

entityState enum filterable   orderable  
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 l2 domain

Charateristics

Format: free
SDK attribute: gateway

gatewayMACAddress string
Discussion

The MAC address of the Gateway.

Charateristics

Format: free
SDK attribute: gatewayMACAddress

IPType enum filterable   orderable  
Discussion

IPv4 or IPv6

Charateristics

Allowed values: IPV4, IPV6
SDK attribute: IPType

IPv6Address string filterable  
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

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

policyChangeStatus enum filterable  
Discussion

None

Charateristics

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

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

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

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

Charateristics

Allowed values: DISABLED , ENABLED
SDK attribute: useGlobalMAC

vnId integer
Discussion

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

Charateristics

Format: free
SDK attribute: vnId