VPortMirror

VPort Mirror represents the relationship between a vport and a mirror destination.

Overview

attachedNetworkType string read only  
creationDate string read only   autogenerated   orderable  
domainName string read only  
embeddedMetadata list read only   autogenerated  
enterpiseName string read only  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
externalID string filterable   orderable   locally unique  
lastUpdatedBy string autogenerated  
lastUpdatedDate string read only   autogenerated   orderable  
mirrorDestinationID string required  
mirrorDestinationName string read only  
mirrorDirection enum (BOTH | EGRESS | INGRESS)
networkName string read only  
owner string autogenerated  
vportId string read only  
vportName string read only  

API Resource

/vportmirrors/id
delete get put

Parents

/mirrordestinations/id/vportmirrors
get
/vports/id/vportmirrors
get post

Children

/vportmirrors/id/permissions
delete get post put
/vportmirrors/id/metadatas
get post
/vportmirrors/id/globalmetadatas
get post put

Members

This object has no members.

Attributes documentation

attachedNetworkType string read only  
Discussion

Type of the network attached - L2/L3


Charateristics

Format: free
SDK attribute: attachedNetworkType

creationDate string read only   autogenerated   orderable  
Discussion

Time stamp when this object was created.


Charateristics

SDK attribute: creationDate

domainName string read only  
Discussion

Domain name of the vport associated with the mirror destination


Charateristics

Format: free
SDK attribute: domainName

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

enterpiseName string read only  
Discussion

Enterprise to which the vport associated with the mirror destination belongs to.


Charateristics

Format: free
SDK attribute: enterpiseName

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

mirrorDestinationID string required  
Discussion

Destination ID of the mirror destination object.


Charateristics

Format: free
SDK attribute: mirrorDestinationID

mirrorDestinationName string read only  
Discussion

Name of the mirror destination


Charateristics

Format: free
SDK attribute: mirrorDestinationName

mirrorDirection enum
Discussion

Describes what type of traffic needs to be mirrored.


Charateristics

Allowed values: BOTH, EGRESS, INGRESS
Default value: BOTH
SDK attribute: mirrorDirection

networkName string read only  
Discussion

Name of the network to which the vport belongs to


Charateristics

Format: free
SDK attribute: networkName

owner string autogenerated  
Discussion

Identifies the user that has created this object.


Charateristics

Format: free
SDK attribute: owner

vportId string read only  
Discussion

Id of the vport to which the mirror destination is associated with.


Charateristics

Format: free
SDK attribute: vportId

vportName string read only  
Discussion

Name of the vport to which the mirror destination is associated with.


Charateristics

Format: free
SDK attribute: vportName