DomainTemplate

A domain is a distributed logical router that enables L2 and L3 communication. A domain template is a model that can be instantiated as often as required, thereby creating real, functioning domains.

Overview

associatedBGPProfileID string
associatedMulticastChannelMapID string
associatedPATMapperID string
creationDate string read only   autogenerated   orderable  
description string filterable   orderable  
DPI enum (DISABLED | ENABLED) filterable   orderable  
embeddedMetadata list read only   autogenerated  
encryption enum (DISABLED | ENABLED) filterable  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
externalID string filterable   orderable   locally unique  
lastUpdatedBy string autogenerated  
lastUpdatedDate string read only   autogenerated   orderable  
multicast enum (DISABLED | ENABLED | INHERITED) filterable  
name string required   filterable   orderable  
owner string autogenerated  
policyChangeStatus enum (APPLIED | DISCARDED | STARTED) filterable  

API Resource

/domaintemplates/id
delete get put

Parents

/enterprises/id/domaintemplates
get post
/domains/id/domaintemplates
get put
/aggregateddomains/id/domaintemplates
get put

Children

/domaintemplates/id/redirectiontargettemplates
get post
/domaintemplates/id/permissions
get post
/domaintemplates/id/metadatas
get post
/domaintemplates/id/pgexpressiontemplates
get post
/domaintemplates/id/egressacltemplates
get post
/domaintemplates/id/egressadvfwdtemplates
get post
/domaintemplates/id/egressdomainfloatingipacltemplates
get post
/domaintemplates/id/virtualfirewallpolicies
get post
/domaintemplates/id/globalmetadatas
get post put
/domaintemplates/id/ingressacltemplates
get post
/domaintemplates/id/ingressadvfwdtemplates
get post
/domaintemplates/id/jobs
post
/domaintemplates/id/policygrouptemplates
get post
/domaintemplates/id/zonetemplates
get post
/domaintemplates/id/qos
get post
/domaintemplates/id/groups
get put
/domaintemplates/id/subnettemplates
get
/domaintemplates/id/eventlogs
get

Members

/domaintemplates/id/domains
get put

Attributes documentation

associatedBGPProfileID string
Discussion

The ID of the associated BGP profile

Charateristics

Format: free
SDK attribute: associatedBGPProfileID

associatedMulticastChannelMapID string
Discussion

The ID of the Multi Cast Channel Map this domain template is associated with. This has to be set when enableMultiCast is set to ENABLED

Charateristics

Format: free
SDK attribute: associatedMulticastChannelMapID

associatedPATMapperID string
Discussion

The ID of the PatMapper entity to which this domain-template is associated to.

Charateristics

Format: free
SDK attribute: associatedPATMapperID

creationDate string read only   autogenerated   orderable  
Discussion

Time stamp when this object was created.

Charateristics

SDK attribute: creationDate

description string filterable   orderable  
Discussion

Domain template description provided by the user

Charateristics

Format: free
Max length: 255
SDK attribute: description

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

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

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

externalID string filterable   orderable   locally unique  
Discussion

External object ID. Used for integration with third party systems

Charateristics

Format: free
SDK attribute: externalID

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

Charateristics

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

name string required   filterable   orderable  
Discussion

The name of the domain template, that is unique within an enterprise. Valid characters are alphabets, numbers, space and hyphen( - ).

Charateristics

Format: free
Min length: 1
Max length: 255
SDK attribute: name

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