create mirror

create mirror mirror_name {to [port port | port-list port_list loopback-port port] { remote-tag rtag } | remote-ip remote_ip_address {{ vr } {vr_name } {from [ source_ip_address | auto-source-ip]}{ping-check [on | off]} priority priority_value ]} {description mirror-desc}


Creates a named mirror instance with an optional description, and optional "to port" definition, or remote IP address destination.

Syntax Description

mirror_name Specifies the mirror name.
port Specifies the mirror output port.
port_list Specifies the list of ports where traffic is to be mirrored.
loopback-port Specifies an otherwise unused port required when mirroring to a port_list. The loopback-port is not available for switching user data traffic.
port Specifies a single loopback port that is used internally to provide this feature.
remote-tag Specifies the value of the This command is available on the ExtremeSwitching X440-G2, X450-G2, X460-G2, X465, X590, X620, X670-G2, X690, X695, X870, 5320, 5420, 5520 series switches. ID used by the mirrored packets when egressing the monitor port.
description Specifies a description of the named mirror instance.
mirror-desc The specified mirror description.
remote-ip Specifies to send mirrored packets to specified remote destination IP address.
remote_ip_address Specifies the destination remote IP address for mirrored packets.
vr Specifies a virtual router of the remote IP address.
vr_name Specifies the virtual router name. If not specified, VR of current command context is used.
from Configures source IP address of encapsulated mirrored packets.
source_ip_address Specifies the local source IPv4 address for encapsulated mirrored packets.
auto-source-ip Automatically use source IP address of egress VLAN to be used to reach remote IP address.
ping-check Configure ping health check for remote IP address.
on Only send mirrored packets to remote IP address if periodic pings to remote IP address are successful (default).
off Send mirrored packets to remote IP address without any ping health check, assuming MAC address and port of next hop IP address are static or learned.
priority Configures a unique priority value for each redundant remote IP address of a mirror instance.

Sets the unique priority value for the remote IP address.

The priority value must be unique for each remote IP address in the mirror instance.

The range is from 1 (least preferred) to 100 (most preferred). The default is 50.



Ping health check of the remote IP address is enabled unless otherwise specified.

If a VR is not specified, the VR of the current command context is used.

The default priority value is 50.

Usage Guidelines

Use this command to create a named mirror instance with an optional description and optional "to port" or remote IP address definitions. You can create 15 named instances (the instance "DefaultMirror" is created automatically).

For high availability, you can add up to four redundant remote IP addresses. When creating a mirror with this command, you can add one IP address. To add additional remote IP addresses, use the configure mirror mirror_name {to [port port | port-list port_list | loopback port port] | remote-ip {add} remote_ip_address {{vr} vr_name } {from [source_ip_address | auto-source-ip]} {ping-check [on | off]}] {remote-tag rtag | port none} {priority priority_value}command.


The following example creates a mirror instance on port 3, slot 4 :

create mirror to port 3:4


This command was first available in ExtremeXOS 15.3.

The remote IP address option was added in ExtremeXOS 22.4.

Redundant remote IP addresses capability was added in ExtremeXOS 30.4.

Platform Availability

This command is available on ExtremeSwitching X435, X440-G2, X450-G2, X460-G2, X465, X590, X620, X670-G2, X690, X695, X870, 5320, 5420, and 5520 series switches.