OverlayMirrorDestinationTemplate

Overlay mirror destinations are pointed to by advanced forwarding policies as the destination for redirected traffic. Targets can be of two types, L3 or virtual wire. For L3 targets a virtual IP should be provided as it allows the system to track among which of the end-points belonging to the overlay mirror destination is the active one. For this type of redirect the packet's destination MAC address is changed to match that of the Virtual IP. For virtual-wire redirection targets, the packets are untouched and forwarded directly to the end-point.

Overview

description string
destinationType enum (OVERLAY_MIRROR_DESTINATION | REDIRECTION_TARGET)
embeddedMetadata list read only   autogenerated  
endPointType enum (NONE | VIRTUAL_WIRE) required  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
externalID string filterable   orderable   locally unique  
lastUpdatedBy string autogenerated  
name string required   filterable   orderable  
redundancyEnabled boolean
triggerType enum (GARP | NONE) read only  

API Resource

/overlaymirrordestinationtemplates/id
delete get put

Parents

/l2domaintemplates/id/overlaymirrordestinationtemplates
get post

Children

/overlaymirrordestinationtemplates/id/metadatas
get post
/overlaymirrordestinationtemplates/id/globalmetadatas
get post put

Members

This object has no members.

Attributes documentation

description string
Discussion

Description of this overlay mirror destination template

Charateristics

Format: free
SDK attribute: description

destinationType enum
Discussion

Determines the type of destination : redirection target or overlay mirror destination

Charateristics

Allowed values: OVERLAY_MIRROR_DESTINATION, REDIRECTION_TARGET
SDK attribute: destinationType

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

endPointType enum required  
Discussion

VPortTagEndPointType is an enum. It defines the type of header rewrite and forwarding performed by VRS when the endpoint is used as a overlay mirror destination. Possible value is VIRTUAL_WIRE.

Charateristics

Allowed values: NONE, VIRTUAL_WIRE
SDK attribute: endPointType

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

name string required   filterable   orderable  
Discussion

Name of this overlay mirror destination template

Charateristics

SDK attribute: name

redundancyEnabled boolean
Discussion

Allow/Disallow redundant appliances and VIP

Charateristics

SDK attribute: redundancyEnabled

triggerType enum read only  
Discussion

Trigger type, could be NONE/GARP - THIS IS READONLY

Charateristics

Allowed values: GARP, NONE
SDK attribute: triggerType