33. mirror commands
33.1. mirror command descriptions
mirror
Synopsis
Enter the mirror context
Tree
Introduced
16.0.R1
Platforms
All
mirror-dest [service-name] string
Synopsis
Enter the mirror-dest list instance
Context
configure mirror mirror-dest string
Tree
Max. Elements
255
Introduced
16.0.R1
Platforms
All
[service-name] string
Synopsis
Administrative service name
Context
configure mirror mirror-dest string
String Length
1 to 64
Notes
This element is part of a list key.
Introduced
16.0.R1
Platforms
All
admin-state keyword
Synopsis
Administrative state of the service
Context
configure mirror mirror-dest string admin-state keyword
Tree
Default
disable
Options
enable, disable
Introduced
16.0.R1
Platforms
All
description string
Synopsis
Text description
Context
configure mirror mirror-dest string description string
Tree
String Length
1 to 80
Introduced
16.0.R1
Platforms
All
encap
Synopsis
Enter the encap context
Context
configure mirror mirror-dest string encap
Tree
Introduced
16.0.R1
Platforms
All
layer-3-encap
Synopsis
Enable the layer-3-encap context
Context
configure mirror mirror-dest string encap layer-3-encap
Tree
Introduced
16.0.R1
Platforms
All
direction-bit boolean
Synopsis
Use the highest bit to specify traffic flow direction
Context
configure mirror mirror-dest string encap layer-3-encap direction-bit boolean
Tree
Default
false
Introduced
16.0.R1
Platforms
All
gateway
Synopsis
Enable the gateway context
Context
Tree
Introduced
16.0.R1
Platforms
All
ip-address
Synopsis
Enter the ip-address context
Context
Tree
Introduced
16.0.R1
Platforms
All
destination string
Synopsis
IPv4 destination address for the gateway
Context
configure mirror mirror-dest string encap layer-3-encap gateway ip-address destination string
Tree
Introduced
16.0.R1
Platforms
All
source string
Synopsis
IPv4 source address for the gateway
Context
configure mirror mirror-dest string encap layer-3-encap gateway ip-address source string
Tree
Introduced
16.0.R1
Platforms
All
udp-port
Synopsis
Enter the udp-port context
Context
Tree
Introduced
16.0.R1
Platforms
All
destination number
Synopsis
UDP destination port to use with the gateway
Context
configure mirror mirror-dest string encap layer-3-encap gateway udp-port destination number
Tree
Range
0 | 1 to 65535
Default
0
Introduced
16.0.R1
Platforms
All
source number
Synopsis
UDP source port to use with the gateway
Context
configure mirror mirror-dest string encap layer-3-encap gateway udp-port source number
Tree
Range
0 | 1 to 65535
Default
0
Introduced
16.0.R1
Platforms
All
header-type keyword
 | Warning: Modifying this element recreates the parent element automatically for the new value to take effect. |
Synopsis
Header type for Layer 3 encapsulation
Context
configure mirror mirror-dest string encap layer-3-encap header-type keyword
Tree
Options
ip-udp-shim, ip-gre, ip-udp-shim-sampled
Notes
This element is mandatory.
Introduced
16.0.R1
Platforms
All
router-instance string
Synopsis
Router instance to use with routed encapsulation
Context
configure mirror mirror-dest string encap layer-3-encap router-instance string
Tree
Default
Base
Introduced
16.0.R1
Platforms
All
endpoint [name] string
Synopsis
Enter the endpoint list instance
Context
configure mirror mirror-dest string endpoint string
Tree
Max. Elements
2
Introduced
16.0.R1
Platforms
All
[name] string
Synopsis
Service endpoint name
Context
configure mirror mirror-dest string endpoint string
String Length
1 to 32
Notes
This element is part of a list key.
Introduced
16.0.R1
Platforms
All
description string
Synopsis
Text description
Context
configure mirror mirror-dest string endpoint string description string
Tree
String Length
1 to 80
Introduced
16.0.R1
Platforms
All
revert-time (number | keyword)
Synopsis
Time to wait before reverting back to primary spoke SDP
Context
configure mirror mirror-dest string endpoint string revert-time (number | keyword)
Tree
Range
1 to 600
Default
immediate
Units
seconds
Options
never, immediate
Introduced
16.0.R1
Platforms
All
fc keyword
Synopsis
Forwarding class for destination traffic
Context
configure mirror mirror-dest string fc keyword
Tree
Default
be
Options
be, l2, af, l1, h2, ef, h1, nc
Introduced
16.0.R1
Platforms
All
include-port-id boolean
Synopsis
Include the system port ID in the packet
Context
configure mirror mirror-dest string include-port-id boolean
Tree
Default
false
Introduced
16.0.R1
Platforms
All
pcap [session-name] string
Synopsis
Enter the pcap list instance
Context
configure mirror mirror-dest string pcap string
Tree
Max. Elements
1
Introduced
16.0.R1
Platforms
All
[session-name] string
Synopsis
PCAP session name
Context
configure mirror mirror-dest string pcap string
String Length
1 to 32
Notes
This element is part of a list key.
Introduced
16.0.R1
Platforms
All
file-url string
Synopsis
URL and file name for packet capture transfer
Context
configure mirror mirror-dest string pcap string file-url string
Tree
String Length
1 to 180
Introduced
16.0.R1
Platforms
All
remote-source
Synopsis
Enable the remote-source context
Context
configure mirror mirror-dest string remote-source
Tree
Introduced
16.0.R1
Platforms
All
far-end [far-end-addr] string
Synopsis
Enter the far-end list instance
Context
configure mirror mirror-dest string remote-source far-end string
Tree
Introduced
16.0.R1
Platforms
All
[far-end-addr] string
Synopsis
Far end IP address
Context
configure mirror mirror-dest string remote-source far-end string
Notes
This element is part of a list key.
Introduced
16.0.R1
Platforms
All
icb boolean
Synopsis
Remote source as an inter-chassis backup
Context
configure mirror mirror-dest string remote-source far-end string icb boolean
Tree
Default
false
Introduced
16.0.R1
Platforms
All
ing-vc-label number
Synopsis
Ingress virtual circuit label
Context
configure mirror mirror-dest string remote-source far-end string ing-vc-label number
Tree
Range
32 to 18431
Notes
The following elements are part of a choice: ing-vc-label or label-signaling.
Introduced
16.0.R1
Platforms
All
label-signaling keyword
Synopsis
Protocol to obtain the ingress labels
Context
configure mirror mirror-dest string remote-source far-end string label-signaling keyword
Tree
Default
tldp
Options
tldp
Notes
This element is the default part of a choice.
The following elements are part of a choice: ing-vc-label or label-signaling.
Introduced
16.0.R1
Platforms
All
vc-id number
Synopsis
Virtual circuit ID associated with the remote source
Context
configure mirror mirror-dest string remote-source far-end string vc-id number
Tree
Range
1 to 4294967295
Notes
This element is mandatory.
Introduced
16.0.R1
Platforms
All
spoke-sdp [sdp-bind-id] string
Synopsis
Enter the spoke-sdp list instance
Context
configure mirror mirror-dest string remote-source spoke-sdp string
Tree
Introduced
16.0.R1
Platforms
All
[sdp-bind-id] string
Synopsis
SDP ID number
Context
configure mirror mirror-dest string remote-source spoke-sdp string
String Length
3 to 16
Notes
This element is part of a list key.
Introduced
16.0.R1
Platforms
All
admin-state keyword
Synopsis
Administrative state of the service SDP binding
Context
configure mirror mirror-dest string remote-source spoke-sdp string admin-state keyword
Tree
Default
enable
Options
enable, disable
Introduced
16.0.R1
Platforms
All
control-word boolean
Synopsis
Enable the PW control word on spoke SDPs
Context
configure mirror mirror-dest string remote-source spoke-sdp string control-word boolean
Tree
Description
When configured to true, this command enables the PW control word on spoke SDPs that are part of a mirror destination. The control word must be enabled to allow MPLS-TP OAM on spoke SDP and is only valid for spoke SDPs that are part of a mirror service of type ether.
When configured to false, this command disables the PW control word.
Default
false
Introduced
16.0.R1
Platforms
All
egress
Synopsis
Enter the egress context
Context
configure mirror mirror-dest string remote-source spoke-sdp string egress
Tree
Introduced
16.0.R1
Platforms
All
vc-label number
| Warning: Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect. |
Synopsis
MPLS VC label that sends packets to the far end device
Context
configure mirror mirror-dest string remote-source spoke-sdp string egress vc-label number
Tree
Range
16 to 1048575
Introduced
16.0.R1
Platforms
All
endpoint
Synopsis
Enter the endpoint context
Context
configure mirror mirror-dest string remote-source spoke-sdp string endpoint
Tree
Introduced
16.0.R1
Platforms
All
icb boolean
| Warning: Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect. |
Synopsis
Bind the SDP as the Inter-Chassis Backup (ICB) type
Context
configure mirror mirror-dest string remote-source spoke-sdp string endpoint icb boolean
Tree
Default
false
Introduced
16.0.R1
Platforms
All
name reference
Synopsis
SAP-associated endpoint name
Context
configure mirror mirror-dest string remote-source spoke-sdp string endpoint name reference
Tree
Reference
configure mirror mirror-dest string endpoint string
Introduced
16.0.R1
Platforms
All
ingress
Synopsis
Enter the ingress context
Context
configure mirror mirror-dest string remote-source spoke-sdp string ingress
Tree
Introduced
16.0.R1
Platforms
All
l2tpv3
Synopsis
Enter the l2tpv3 context
Context
configure mirror mirror-dest string remote-source spoke-sdp string ingress l2tpv3
Tree
Introduced
16.0.R1
Platforms
All
cookie
Synopsis
Enter the cookie context
Context
configure mirror mirror-dest string remote-source spoke-sdp string ingress l2tpv3 cookie
Tree
Introduced
16.0.R1
Platforms
All
cookie1 string
Synopsis
Value of the first cookie for the tunnel
Context
configure mirror mirror-dest string remote-source spoke-sdp string ingress l2tpv3 cookie cookie1 string
Tree
String Length
18 to 23
Introduced
16.0.R1
Platforms
All
cookie2 string
Synopsis
Value of the second cookie for the tunnel
Context
configure mirror mirror-dest string remote-source spoke-sdp string ingress l2tpv3 cookie cookie2 string
Tree
String Length
18 to 23
Introduced
16.0.R1
Platforms
All
vc-label number
| Warning: Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect. |
Synopsis
MPLS VC label that sends packets to the far end device
Context
configure mirror mirror-dest string remote-source spoke-sdp string ingress vc-label number
Tree
Range
32 to 18431
Introduced
16.0.R1
Platforms
All
sampling-rate number
Synopsis
Sampling rate
Context
configure mirror mirror-dest string sampling-rate number
Tree
Description
This command configures the packet sampling rate value for mirrored traffic and is supported with mirror source configurations. The sampling rate is common to all endpoints on a given line card FP per mirror destination service.
Range
256 to 10000
Introduced
20.7.R1
Platforms
All
sap [sap-id] string
Synopsis
Enter the sap list instance
Context
configure mirror mirror-dest string sap string
Tree
Max. Elements
1
Introduced
16.0.R1
Platforms
All
[sap-id] string
Synopsis
SAP ID
Context
configure mirror mirror-dest string sap string
String Length
1 to 45
Notes
This element is part of a list key.
Introduced
16.0.R1
Platforms
All
egress
Synopsis
Enter the egress context
Context
configure mirror mirror-dest string sap string egress
Tree
Introduced
16.0.R1
Platforms
All
ip-mirror
Synopsis
Enter the ip-mirror context
Tree
Introduced
16.0.R1
Platforms
All
mac
Synopsis
Enter the mac context
Tree
Introduced
16.0.R1
Platforms
All
destination string
Synopsis
Destination MAC address
Context
configure mirror mirror-dest string sap string egress ip-mirror mac destination string
Tree
Introduced
16.0.R1
Platforms
All
source string
Synopsis
Source MAC address
Tree
Introduced
16.0.R1
Platforms
All
qos
Synopsis
Enter the qos context
Tree
Introduced
16.0.R1
Platforms
All
sap-egress
Synopsis
Enter the sap-egress context
Context
configure mirror mirror-dest string sap string egress qos sap-egress
Tree
Introduced
16.0.R1
Platforms
All
policy-name reference
Synopsis
Policy ID to associate with SAP for mirrored service
Context
configure mirror mirror-dest string sap string egress qos sap-egress policy-name reference
Tree
Reference
configure qos sap-egress string
Introduced
16.0.R1
Platforms
All
port-redirect-group
Synopsis
Enter the port-redirect-group context
Context
configure mirror mirror-dest string sap string egress qos sap-egress port-redirect-group
Tree
Introduced
16.0.R1
Platforms
All
group-name reference
Synopsis
Name of the queue group redirect list policy
Context
configure mirror mirror-dest string sap string egress qos sap-egress port-redirect-group group-name reference
Tree
Reference
Introduced
16.0.R1
Platforms
All
instance number
Synopsis
Port queue group instance
Context
configure mirror mirror-dest string sap string egress qos sap-egress port-redirect-group instance number
Tree
Range
1 to 65535
Introduced
16.0.R1
Platforms
All
endpoint reference
Synopsis
Service endpoint name
Context
configure mirror mirror-dest string sap string endpoint reference
Tree
Reference
configure mirror mirror-dest string endpoint string
Introduced
16.0.R1
Platforms
All
service-id number
| Warning: Modifying this element recreates the parent element automatically for the new value to take effect. |
Synopsis
Service ID
Context
configure mirror mirror-dest string service-id number
Tree
Range
1 to 2147483647
Introduced
16.0.R1
Platforms
All
slice-size number
Synopsis
Maximum size of the transmitted mirrored frame
Context
configure mirror mirror-dest string slice-size number
Tree
Range
0 | 128 to 9216
Default
0
Introduced
16.0.R1
Platforms
All
spoke-sdp [sdp-bind-id] string
Synopsis
Enter the spoke-sdp list instance
Context
configure mirror mirror-dest string spoke-sdp string
Tree
Introduced
16.0.R1
Platforms
All
[sdp-bind-id] string
Synopsis
SDP ID number
Context
configure mirror mirror-dest string spoke-sdp string
String Length
3 to 16
Notes
This element is part of a list key.
Introduced
16.0.R1
Platforms
All
admin-state keyword
Synopsis
Administrative state of the service SDP binding
Context
configure mirror mirror-dest string spoke-sdp string admin-state keyword
Tree
Default
enable
Options
enable, disable
Introduced
16.0.R1
Platforms
All
control-word boolean
Synopsis
Enable the PW control word on spoke SDPs
Context
configure mirror mirror-dest string spoke-sdp string control-word boolean
Tree
Description
When configured to true, this command enables the PW control word on spoke SDPs that are part of a mirror destination. The control word must be enabled to allow MPLS-TP OAM on spoke SDP and is only valid for spoke SDPs that are part of a mirror service of type ether.
When configured to false, this command disables the PW control word.
Default
false
Introduced
16.0.R1
Platforms
All
egress
Synopsis
Enter the egress context
Context
configure mirror mirror-dest string spoke-sdp string egress
Tree
Introduced
16.0.R1
Platforms
All
l2tpv3
Synopsis
Enter the l2tpv3 context
Tree
Introduced
16.0.R1
Platforms
All
cookie string
Synopsis
RX or TX cookie for L2TPv3 spoke SDPs
Tree
String Length
18 to 23
Introduced
16.0.R1
Platforms
All
vc-label number
| Warning: Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect. |
Synopsis
MPLS VC label that sends packets to the far end device
Tree
Range
16 to 1048575
Introduced
16.0.R1
Platforms
All
endpoint
Synopsis
Enter the endpoint context
Context
configure mirror mirror-dest string spoke-sdp string endpoint
Tree
Introduced
16.0.R1
Platforms
All
icb boolean
| Warning: Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect. |
Synopsis
Bind the SDP as the Inter-Chassis Backup (ICB) type
Tree
Default
false
Introduced
16.0.R1
Platforms
All
name reference
Synopsis
Endpoint name associated with the SAP
Tree
Reference
configure mirror mirror-dest string endpoint string
Introduced
16.0.R1
Platforms
All
precedence (number | keyword)
Synopsis
SDP bind precedence when there are multiple SDP binds
Context
configure mirror mirror-dest string spoke-sdp string endpoint precedence (number | keyword)
Tree
Range
1 to 4
Default
4
Options
primary
Introduced
16.0.R1
Platforms
All
ingress
Synopsis
Enter the ingress context
Context
configure mirror mirror-dest string spoke-sdp string ingress
Tree
Introduced
16.0.R1
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS
vc-label number
| Warning: Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect. |
Synopsis
MPLS VC label that sends packets to the far end device
Tree
Range
32 to 18431
Introduced
16.0.R1
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS
type keyword
| Warning: Modifying this element recreates the parent element automatically for the new value to take effect. |
Synopsis
Mirror type information
Context
configure mirror mirror-dest string type keyword
Tree
Default
ether
Options
ether, ip-only
Introduced
16.0.R1
Platforms
All
mirror-source [service-name] string
Synopsis
Enter the mirror-source list instance
Context
configure mirror mirror-source string
Tree
Introduced
19.10.R1
Platforms
All
[service-name] string
Synopsis
Administrative service name
Context
configure mirror mirror-source string
String Length
1 to 64
Notes
This element is part of a list key.
Introduced
19.10.R1
Platforms
All
admin-state keyword
Synopsis
Administrative state of the mirror service
Context
configure mirror mirror-source string admin-state keyword
Tree
Default
enable
Options
enable, disable
Introduced
19.10.R1
Platforms
All
ip-filter [filter-name] reference
Synopsis
Enter the ip-filter list instance
Context
configure mirror mirror-source string ip-filter reference
Tree
Introduced
19.10.R1
Platforms
All
[filter-name] reference
Synopsis
IP filter name
Context
configure mirror mirror-source string ip-filter reference
Notes
This element is part of a list key.
Introduced
19.10.R1
Platforms
All
entry [entry-id] number
Synopsis
Add a list entry for entry
Context
configure mirror mirror-source string ip-filter reference entry number
Tree
Min. Elements
1
Introduced
19.10.R1
Platforms
All
[entry-id] number
Synopsis
IP filter entry ID
Context
configure mirror mirror-source string ip-filter reference entry number
Range
1 to 2097151
Notes
This element is part of a list key.
Introduced
19.10.R1
Platforms
All
ipv6-filter [filter-name] reference
Synopsis
Enter the ipv6-filter list instance
Context
configure mirror mirror-source string ipv6-filter reference
Tree
Introduced
19.10.R1
Platforms
All
[filter-name] reference
Synopsis
IPv6 filter name
Context
configure mirror mirror-source string ipv6-filter reference
Reference
configure filter ipv6-filter string
Notes
This element is part of a list key.
Introduced
19.10.R1
Platforms
All
entry [entry-id] number
Synopsis
Add a list entry for entry
Context
configure mirror mirror-source string ipv6-filter reference entry number
Tree
Min. Elements
1
Introduced
19.10.R1
Platforms
All
[entry-id] number
Synopsis
IPv6 filter entry ID
Context
configure mirror mirror-source string ipv6-filter reference entry number
Range
1 to 2097151
Notes
This element is part of a list key.
Introduced
19.10.R1
Platforms
All
mac-filter [filter-name] reference
Synopsis
Enter the mac-filter list instance
Context
configure mirror mirror-source string mac-filter reference
Tree
Introduced
19.10.R1
Platforms
All
[filter-name] reference
Synopsis
MAC filter name
Context
configure mirror mirror-source string mac-filter reference
Reference
configure filter mac-filter string
Notes
This element is part of a list key.
Introduced
19.10.R1
Platforms
All
entry [entry-id] number
Synopsis
Add a list entry for entry
Context
configure mirror mirror-source string mac-filter reference entry number
Tree
Min. Elements
1
Introduced
19.10.R1
Platforms
All
[entry-id] number
Synopsis
MAC filter entry ID
Context
configure mirror mirror-source string mac-filter reference entry number
Range
1 to 2097151
Notes
This element is part of a list key.
Introduced
19.10.R1
Platforms
All
port [port-id] string
Synopsis
Enter the port list instance
Context
configure mirror mirror-source string port string
Tree
Introduced
19.10.R1
Platforms
All
[port-id] string
Synopsis
Port ID
Context
configure mirror mirror-source string port string
Notes
This element is part of a list key.
Introduced
19.10.R1
Platforms
All
egress boolean
Synopsis
Mirror egress packets
Context
configure mirror mirror-source string port string egress boolean
Tree
Default
false
Introduced
19.10.R1
Platforms
All
ingress boolean
Synopsis
Mirror ingress packets
Context
configure mirror mirror-source string port string ingress boolean
Tree
Default
false
Introduced
19.10.R1
Platforms
All
sap [sap-id] string
Synopsis
Enter the sap list instance
Context
configure mirror mirror-source string sap string
Tree
Introduced
19.10.R1
Platforms
All
[sap-id] string
Synopsis
SAP ID
Context
configure mirror mirror-source string sap string
String Length
1 to 45
Notes
This element is part of a list key.
Introduced
19.10.R1
Platforms
All
egress boolean
Synopsis
Mirror egress packets
Context
configure mirror mirror-source string sap string egress boolean
Tree
Default
false
Introduced
19.10.R1
Platforms
All
ingress boolean
Synopsis
Mirror ingress packets
Context
configure mirror mirror-source string sap string ingress boolean
Tree
Default
false
Introduced
19.10.R1
Platforms
All
subscriber [subscriber-id] string
Synopsis
Enter the subscriber list instance
Context
configure mirror mirror-source string subscriber string
Tree
Introduced
19.10.R1
Platforms
All
[subscriber-id] string
Synopsis
Subscriber ID
Context
configure mirror mirror-source string subscriber string
String Length
1 to 64
Notes
This element is part of a list key.
Introduced
19.10.R1
Platforms
All
egress boolean
Synopsis
Mirror egress packets
Context
configure mirror mirror-source string subscriber string egress boolean
Tree
Default
false
Introduced
19.10.R1
Platforms
All
fc keyword
Synopsis
The forwarding classes traffic which should be mirrored
Context
configure mirror mirror-source string subscriber string fc keyword
Tree
Options
be, l2, af, l1, h2, ef, h1, nc
Max. Elements
8
Introduced
19.10.R1
Platforms
All
host-type keyword
Synopsis
Host type for mirroring
Context
configure mirror mirror-source string subscriber string host-type keyword
Tree
Options
ipoe, ppp
Introduced
19.10.R1
Platforms
All
ingress boolean
Synopsis
Mirror ingress packets
Context
configure mirror mirror-source string subscriber string ingress boolean
Tree
Default
false
Introduced
19.10.R1
Platforms
All
ip-address string
Synopsis
Service IP address of remote device sending LI traffic
Context
configure mirror mirror-source string subscriber string ip-address string
Tree
Notes
The following elements are part of a choice: (ip-address, mac-address, and sap-id) or sla-profile.
Introduced
19.10.R1
Platforms
All
ip-family keyword
Synopsis
IP family for mirroring
Context
configure mirror mirror-source string subscriber string ip-family keyword
Tree
Options
ipv4, ipv6
Introduced
19.10.R1
Platforms
All
mac-address string
Synopsis
MAC address for the subscriber
Context
configure mirror mirror-source string subscriber string mac-address string
Tree
Notes
The following elements are part of a choice: (ip-address, mac-address, and sap-id) or sla-profile.
Introduced
19.10.R1
Platforms
All
sap-id string
Synopsis
Subscriber SAP ID
Context
configure mirror mirror-source string subscriber string sap-id string
Tree
String Length
1 to 45
Notes
The following elements are part of a choice: (ip-address, mac-address, and sap-id) or sla-profile.
Introduced
19.10.R1
Platforms
All
sla-profile string
Synopsis
SLA profile name
Context
configure mirror mirror-source string subscriber string sla-profile string
Tree
String Length
1 to 32
Notes
The following elements are part of a choice: (ip-address, mac-address, and sap-id) or sla-profile.
Introduced
19.10.R1
Platforms
All