L2DomainTemplate

An L2 Domain is a distributed logical switch that enables L2 communication. An L2 Domain template is a model that can be instantiated as often as required, thereby creating real, functioning L2 Domains.

Overview

address string filterable   orderable  
associatedMulticastChannelMapID string
creationDate string read only   autogenerated   orderable  
description string filterable  
DHCPManaged boolean filterable   orderable  
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) filterable  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
entityState enum (MARKED_FOR_DELETION | UNDER_CONSTRUCTION)
externalID string filterable   orderable   locally unique  
gateway string filterable   orderable  
IPType enum (DUALSTACK | IPV4 | IPV6) filterable   orderable  
IPv6Address string filterable   orderable  
IPv6Gateway string filterable   orderable  
lastUpdatedBy string autogenerated  
lastUpdatedDate string read only   autogenerated   orderable  
multicast enum (DISABLED | ENABLED | INHERITED) filterable  
name string required   filterable   orderable  
netmask string filterable   orderable  
owner string autogenerated  
policyChangeStatus enum (APPLIED | DISCARDED | STARTED) filterable  
useGlobalMAC enum (DISABLED | ENABLED) filterable  

API Resource

/l2domaintemplates/id
delete get put

Parents

/enterprises/id/l2domaintemplates
get post

Children

/l2domaintemplates/id/l2domains
get
/l2domaintemplates/id/addressranges
get post
/l2domaintemplates/id/redirectiontargettemplates
get post
/l2domaintemplates/id/permissions
get post
/l2domaintemplates/id/metadatas
get post
/l2domaintemplates/id/pgexpressiontemplates
get post
/l2domaintemplates/id/egressacltemplates
get post
/l2domaintemplates/id/egressadvfwdtemplates
get post
/l2domaintemplates/id/virtualfirewallpolicies
get post
/l2domaintemplates/id/globalmetadatas
get post put
/l2domaintemplates/id/ingressacltemplates
get post
/l2domaintemplates/id/ingressadvfwdtemplates
get post
/l2domaintemplates/id/jobs
post
/l2domaintemplates/id/policygrouptemplates
get post
/l2domaintemplates/id/qos
get post
/l2domaintemplates/id/groups
get put
/l2domaintemplates/id/eventlogs
get
/l2domaintemplates/id/overlaymirrordestinationtemplates
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

creationDate string read only   autogenerated   orderable  
Discussion

Time stamp when this object was created.

Charateristics

SDK attribute: creationDate

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

SDK attribute: DHCPManaged

DPI enum filterable   orderable  
Discussion

determines whether or not Deep packet inspection is enabled

Charateristics

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

dualStackDynamicIPAllocation boolean filterable   orderable  
Discussion

This value indicates whether dynamic address allocation is enabled or not. This will be applicable when L2 Domain is managed and 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

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

Charateristics

Default value: true
SDK attribute: enableDHCPv4

enableDHCPv6 boolean filterable   orderable  
Discussion

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

Charateristics

Default value: false
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

gateway string filterable   orderable  
Discussion

The IP address of the gateway of this l2 domain

Charateristics

Format: free
SDK attribute: gateway

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

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

multicast enum filterable  
Discussion

Indicates multicast policy on L2Domain template.

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

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