MirrorDestination

Mirror Destinations are underlay-reachable IP addresses to which the mirrored traffic will be sent. On the server identified by the IP, a tool like Wireshark can be used to capture and analyse the traffic going through a VPort. The mirrored traffic is sent to the collector using GRE encapsulation.

Overview

destinationIp string required  
embeddedMetadata list read only   autogenerated  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
externalID string filterable   orderable   locally unique  
lastUpdatedBy string autogenerated  
name string required   filterable   orderable  
serviceId integer

API Resource

/mirrordestinations/id
delete get put

Parents

/mirrordestinations
get post
/mirrordestinationgroups/id/mirrordestinations
get put

Children

/mirrordestinations/id/permissions
delete get post put
/mirrordestinations/id/metadatas
get post
/mirrordestinations/id/egressaclentrytemplates
get
/mirrordestinations/id/globalmetadatas
get post put
/mirrordestinations/id/ingressaclentrytemplates
get
/mirrordestinations/id/ingressadvfwdentrytemplates
get
/mirrordestinations/id/vportmirrors
get

Members

This object has no members.

Attributes documentation

destinationIp string required  
Discussion

IP address of the destination server where you want your traffic to be mirrored.


Charateristics

Format: free
SDK attribute: destinationIp

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

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 the mirror destination. Valid characters are alphabets, numbers, space and hyphen( - ).


Charateristics

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

serviceId integer
Discussion

Service ID of the mirror destination.


Charateristics

SDK attribute: serviceId