OverlayMirrorDestination

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)
endPointType enum (NONE | VIRTUAL_WIRE) required  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
ESI string
externalID string filterable   orderable   locally unique  
lastUpdatedBy string autogenerated  
name string filterable   orderable  
redundancyEnabled boolean
templateID string
triggerType enum (GARP | NONE) read only  
virtualNetworkID string

API Resource

/overlaymirrordestinations/id
delete get put

Parents

/overlaymirrordestinations
get
/l2domains/id/overlaymirrordestinations
get post

Children

/overlaymirrordestinations/id/metadatas
get post
/overlaymirrordestinations/id/globalmetadatas
get post put

Members

/overlaymirrordestinations/id/vports
get put

Attributes documentation

description string
Discussion

Description of this overlay mirror destination

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

endPointType enum required  
Discussion

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

Charateristics

Allowed values: NONE, VIRTUAL_WIRE
Default value: NONE
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

ESI string
Discussion

ESI id, globally unique

Charateristics

Format: free
SDK attribute: ESI

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

Name of this overlay mirror destination

Charateristics

Format: free
SDK attribute: name

redundancyEnabled boolean
Discussion

Allow/Disallow redundant appliances and VIP

Charateristics

SDK attribute: redundancyEnabled

templateID string
Discussion

Template to which this overlay mirror destination belongs to

Charateristics

Format: free
SDK attribute: templateID

triggerType enum read only  
Discussion

Trigger type, THIS IS READ ONLY. Possible values are NONE, GARP.

Charateristics

Allowed values: GARP, NONE
SDK attribute: triggerType

virtualNetworkID string
Discussion

Auto Generated by VSD. Each overlay mirror destination with redundancy=enable and EndpointType != none will have a globally unique ESI & VNID generated by VSD

Charateristics

Format: free
SDK attribute: virtualNetworkID