DomainTemplate

Domains in VSD are created from domain templates. This object provides the definition of the Domain Template.

Overview

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

API Resource

/domaintemplates/id
delete get put

Parents

/enterprises/id/domaintemplates
get post
/domains/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/egressfloatingipacltemplates
get post
/domaintemplates/id/globalmetadatas
get post put
/domaintemplates/id/ingressacltemplates
get post
/domaintemplates/id/ingressadvfwdtemplates
get post
/domaintemplates/id/ingressexternalservicetemplates
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 filterable  
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

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

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

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

policyChangeStatus enum filterable  
Discussion

None

Charateristics

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