mirror commands

configure 
mirror 
apply-groups reference
apply-groups-exclude reference
global-sampling-rate number
mirror-dest string 
admin-state keyword
apply-groups reference
apply-groups-exclude reference
description string
encap 
layer-3-encap 
apply-groups reference
apply-groups-exclude reference
direction-bit boolean
gateway 
apply-groups reference
apply-groups-exclude reference
ip-address 
destination string
source string
udp-port 
destination number
source number
header-type keyword
router-instance string
endpoint string 
apply-groups reference
apply-groups-exclude reference
description string
revert-time (number | keyword)
fc keyword
pcap string 
apply-groups reference
apply-groups-exclude reference
file-url string
per-lag-hashing boolean
remote-source 
far-end string 
apply-groups reference
apply-groups-exclude reference
icb boolean
ing-vc-label number
label-signaling keyword
vc-id number
spoke-sdp string 
admin-state keyword
apply-groups reference
apply-groups-exclude reference
control-word boolean
egress 
vc-label number
endpoint 
icb boolean
name reference
ingress 
l2tpv3 
cookie 
cookie1 string
cookie2 string
vc-label number
sampling-rate number
sap string 
apply-groups reference
apply-groups-exclude reference
egress 
ip-mirror 
mac 
destination string
source string
qos 
sap-egress 
policy-name reference
port-redirect-group 
group-name reference
instance number
endpoint reference
service-id number
slice-size number
spoke-sdp string 
admin-state keyword
apply-groups reference
apply-groups-exclude reference
control-word boolean
egress 
l2tpv3 
cookie string
vc-label number
endpoint 
icb boolean
name reference
precedence (number | keyword)
ingress 
vc-label number
type keyword
use-global-sampling-rate boolean
mirror-source string 
admin-state keyword
apply-groups reference
apply-groups-exclude reference
ip-filter reference 
apply-groups reference
apply-groups-exclude reference
entry number 
ipv6-filter reference 
apply-groups reference
apply-groups-exclude reference
entry number 
mac-filter reference 
apply-groups reference
apply-groups-exclude reference
entry number 
port string 
apply-groups reference
apply-groups-exclude reference
egress boolean
ingress boolean
sap string 
apply-groups reference
apply-groups-exclude reference
egress boolean
ingress boolean
subscriber string 
apply-groups reference
apply-groups-exclude reference
egress boolean
fc keyword
host-type keyword
ingress boolean
ip-address string
ip-family keyword
mac-address string
sap-id string
sla-profile string

mirror command descriptions

mirror

Synopsis Enter the mirror context
Context configure mirror
Treemirror
Introduced16.0.R1

Platforms

All

global-sampling-rate number

Synopsis System wide global sampling rate
Context configure mirror global-sampling-rate number
Treeglobal-sampling-rate

Description

This command configures the global sampling rate. The global sampling rate provides a higher sampling rate than the sampling rate specified on the mirror destination. When set, this command applies to all mirror destination services that have the use-global-sampling-rate command configured.

The global sampling rate takes precedence over the rate specified on the mirror destination. This means that when this command and the configure mirror mirror-dest sampling-rate are configured under the same mirror destination, the system automatically samples using the higher rate configured with this command and ignores the lower rate configured with the sampling-rate command.

When unconfigured, no mirror destinations are associated to a global sampling rate and all mirror destinations mirror at the full rate, which means every packet is mirrored unless a mirror destination rate is specified.

Range0 | 2 to 255
Default0
Introduced 22.10.R1

Platforms

All

mirror-dest [service-name] string

Synopsis Enter the mirror-dest list instance
Contextconfigure mirror mirror-dest string
Treemirror-dest

Description

Commands in this context set up a packet mirroring service to allow mirrored packets to be directed locally (within the same router) or remotely (over the core of the network and with a far-end decode mirror encapsulation).

The mirror destination service is composed of destination options that define where the mirrored packets are sent. It also specifies whether the defined service will receive mirrored packets from a far-end router over the network core.

The mirror destination services are persistent between boots of the router and are included in the configuration saves.

Max. Instances255
Introduced16.0.R1

Platforms

All

[service-name] string
Synopsis Administrative service name
Context configure mirror mirror-dest string
Treemirror-dest
String Length1 to 64

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

admin-state keyword
Synopsis Administrative state of the service
Context configure mirror mirror-dest string admin-state keyword
Treeadmin-state
Optionsenable, disable
Default disable
Introduced16.0.R1

Platforms

All

encap
Synopsis Enter the encap context
Context configure mirror mirror-dest string encap
Treeencap
Introduced16.0.R1

Platforms

All

layer-3-encap
Synopsis Enable the layer-3-encap context
Contextconfigure mirror mirror-dest string encap layer-3-encap
Treelayer-3-encap
Introduced16.0.R1

Platforms

All

gateway
Synopsis Enable the gateway context
Context configure mirror mirror-dest string encap layer-3-encap gateway
Treegateway
Introduced16.0.R1

Platforms

All

ip-address
Synopsis Enter the ip-address context
Context configure mirror mirror-dest string encap layer-3-encap gateway ip-address
Treeip-address
Introduced16.0.R1

Platforms

All

udp-port
Synopsis Enter the udp-port context
Context configure mirror mirror-dest string encap layer-3-encap gateway udp-port
Treeudp-port
Introduced16.0.R1

Platforms

All

header-type keyword
WARNING:

Modifying this element recreates the parent element automatically for the new value to take effect.

SynopsisHeader type for Layer 3 encapsulation
Contextconfigure mirror mirror-dest string encap layer-3-encap header-type keyword
Treeheader-type
Optionsip-udp-shim, ip-gre, ip-udp-shim-sampled

Notes

This element is mandatory.

Introduced16.0.R1

Platforms

All

endpoint [name] string
Synopsis Enter the endpoint list instance
Contextconfigure mirror mirror-dest string endpoint string
Treeendpoint
Max. Instances2
Introduced16.0.R1

Platforms

All

[name] string
Synopsis Service endpoint name
Context configure mirror mirror-dest string endpoint string
Treeendpoint
String Length1 to 32

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

revert-time (number | keyword)
Synopsis Time to wait before reverting back to primary spoke SDP
Contextconfigure mirror mirror-dest string endpoint string revert-time (number | keyword)
Treerevert-time
Range1 to 600
Unitsseconds
Options never, immediate
Defaultimmediate
Introduced16.0.R1

Platforms

All

fc keyword
Synopsis Forwarding class for destination traffic
Contextconfigure mirror mirror-dest string fc keyword
Treefc
Optionsbe, l2, af, l1, h2, ef, h1, nc
Default be
Introduced16.0.R1

Platforms

All

pcap [session-name] string
Synopsis Enter the pcap list instance
Context configure mirror mirror-dest string pcap string
Treepcap
Max. Instances1
Introduced16.0.R1

Platforms

All

[session-name] string
Synopsis PCAP session name
Context configure mirror mirror-dest string pcap string
Treepcap
String Length1 to 32

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

file-url string
Synopsis URL and file name for packet capture transfer
Contextconfigure mirror mirror-dest string pcap string file-url string
Treefile-url
String Length1 to 180
Introduced16.0.R1

Platforms

All

per-lag-hashing boolean
Synopsis Enable per-LAG hashing on the mirror destination
Contextconfigure mirror mirror-dest string per-lag-hashing boolean
Treeper-lag-hashing

Description

When configured to true, the router enables the use of all link members of the mirror destination SAP or SDP of type LAG. The hashing to link members are based on IP flows.

When configured to false, the router disables per-LAG hashing. All mirrored packets sent to a SAP or SDP of type LAG, are sent to only one of the LAG link members. If the link member to which the mirrored packets are being sent fails, another link member takes over and provides mirrored packet forwarding. Although no hashing is performed, resiliency is still provided by this next link member.

Defaultfalse
Introduced23.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

remote-source
Synopsis Enable the remote-source context
Contextconfigure mirror mirror-dest string remote-source
Treeremote-source
Introduced16.0.R1

Platforms

All

far-end [far-end-addr] string
Synopsis Enter the far-end list instance
Contextconfigure mirror mirror-dest string remote-source far-end string
Treefar-end
Introduced16.0.R1

Platforms

All

vc-id number
Synopsis Virtual circuit ID associated with the remote source
Contextconfigure mirror mirror-dest string remote-source far-end string vc-id number
Treevc-id
Range1 to 4294967295

Notes

This element is mandatory.

Introduced16.0.R1

Platforms

All

spoke-sdp [sdp-bind-id] string
Synopsis Enter the spoke-sdp list instance
Contextconfigure mirror mirror-dest string remote-source spoke-sdp string
Treespoke-sdp
Introduced16.0.R1

Platforms

All

control-word boolean
Synopsis Enable the PW control word on spoke SDPs
Contextconfigure mirror mirror-dest string remote-source spoke-sdp string control-word boolean
Treecontrol-word

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.

Defaultfalse
Introduced16.0.R1

Platforms

All

egress
Synopsis Enter the egress context
Context configure mirror mirror-dest string remote-source spoke-sdp string egress
Treeegress
Introduced16.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.

SynopsisMPLS VC label that sends packets to the far end device
Contextconfigure mirror mirror-dest string remote-source spoke-sdp string egress vc-label number
Treevc-label
Range16 to 1048575
Introduced16.0.R1

Platforms

All

endpoint
Synopsis Enter the endpoint context
Context configure mirror mirror-dest string remote-source spoke-sdp string endpoint
Treeendpoint
Introduced16.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.

SynopsisBind the SDP as the Inter-Chassis Backup (ICB) type
Contextconfigure mirror mirror-dest string remote-source spoke-sdp string endpoint icb boolean
Treeicb
Defaultfalse
Introduced16.0.R1

Platforms

All

ingress
Synopsis Enter the ingress context
Context configure mirror mirror-dest string remote-source spoke-sdp string ingress
Treeingress
Introduced16.0.R1

Platforms

All

l2tpv3
Synopsis Enter the l2tpv3 context
Context configure mirror mirror-dest string remote-source spoke-sdp string ingress l2tpv3
Treel2tpv3
Introduced16.0.R1

Platforms

All

cookie
Synopsis Enter the cookie context
Context configure mirror mirror-dest string remote-source spoke-sdp string ingress l2tpv3 cookie
Treecookie
Introduced16.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.

SynopsisMPLS VC label that sends packets to the far end device
Contextconfigure mirror mirror-dest string remote-source spoke-sdp string ingress vc-label number
Treevc-label
Range32 to 18431
Introduced16.0.R1

Platforms

All

sampling-rate number
Synopsis Sampling rate
Contextconfigure mirror mirror-dest string sampling-rate number
Treesampling-rate

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.

Range256 to 10000
Introduced20.7.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

sap [sap-id] string
Synopsis Enter the sap list instance
Context configure mirror mirror-dest string sap string
Treesap
Max. Instances1
Introduced16.0.R1

Platforms

All

[sap-id] string
Synopsis SAP ID
Contextconfigure mirror mirror-dest string sap string
Treesap
String Length1 to 45

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

egress
Synopsis Enter the egress context
Context configure mirror mirror-dest string sap string egress
Treeegress
Introduced16.0.R1

Platforms

All

ip-mirror
Synopsis Enter the ip-mirror context
Context configure mirror mirror-dest string sap string egress ip-mirror
Treeip-mirror
Introduced16.0.R1

Platforms

All

mac
Synopsis Enter the mac context
Context configure mirror mirror-dest string sap string egress ip-mirror mac
Treemac
Introduced16.0.R1

Platforms

All

qos
Synopsis Enter the qos context
Context configure mirror mirror-dest string sap string egress qos
Treeqos
Introduced16.0.R1

Platforms

All

sap-egress
Synopsis Enter the sap-egress context
Context configure mirror mirror-dest string sap string egress qos sap-egress
Treesap-egress
Introduced16.0.R1

Platforms

All

port-redirect-group
Synopsis Enter the port-redirect-group context
Contextconfigure mirror mirror-dest string sap string egress qos sap-egress port-redirect-group
Treeport-redirect-group
Introduced16.0.R1

Platforms

All

service-id number
WARNING:

Modifying this element recreates the parent element automatically for the new value to take effect.

SynopsisService ID
Contextconfigure mirror mirror-dest string service-id number
Treeservice-id
Range1 to 2147483647
Introduced16.0.R1

Platforms

All

slice-size number
Synopsis Maximum size of the transmitted mirrored frame
Contextconfigure mirror mirror-dest string slice-size number
Treeslice-size
Range0 | 128 to 9216
Default0
Introduced 16.0.R1

Platforms

All

spoke-sdp [sdp-bind-id] string
Synopsis Enter the spoke-sdp list instance
Contextconfigure mirror mirror-dest string spoke-sdp string
Treespoke-sdp
Introduced16.0.R1

Platforms

All

[sdp-bind-id] string
Synopsis SDP ID number
Contextconfigure mirror mirror-dest string spoke-sdp string
Treespoke-sdp
String Length3 to 16

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

admin-state keyword
Synopsis Administrative state of the service SDP binding
Contextconfigure mirror mirror-dest string spoke-sdp string admin-state keyword
Treeadmin-state
Optionsenable, disable
Default enable
Introduced16.0.R1

Platforms

All

control-word boolean
Synopsis Enable the PW control word on spoke SDPs
Contextconfigure mirror mirror-dest string spoke-sdp string control-word boolean
Treecontrol-word

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.

Defaultfalse
Introduced16.0.R1

Platforms

All

egress
Synopsis Enter the egress context
Context configure mirror mirror-dest string spoke-sdp string egress
Treeegress
Introduced16.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.

SynopsisMPLS VC label that sends packets to the far end device
Contextconfigure mirror mirror-dest string spoke-sdp string egress vc-label number
Treevc-label
Range16 to 1048575
Introduced16.0.R1

Platforms

All

endpoint
Synopsis Enter the endpoint context
Context configure mirror mirror-dest string spoke-sdp string endpoint
Treeendpoint
Introduced16.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.

SynopsisBind the SDP as the Inter-Chassis Backup (ICB) type
Contextconfigure mirror mirror-dest string spoke-sdp string endpoint icb boolean
Treeicb
Defaultfalse
Introduced16.0.R1

Platforms

All

precedence (number | keyword)
Synopsis Precedence when multiple SDP binds are on one endpoint
Contextconfigure mirror mirror-dest string spoke-sdp string endpoint precedence (number | keyword)
Treeprecedence
Range1 to 4
Optionsprimary
Default4
Introduced 16.0.R1

Platforms

All

ingress
Synopsis Enter the ingress context
Context configure mirror mirror-dest string spoke-sdp string ingress
Treeingress
Introduced16.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.

SynopsisMPLS VC label that sends packets to the far end device
Contextconfigure mirror mirror-dest string spoke-sdp string ingress vc-label number
Treevc-label
Range32 to 18431
Introduced16.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.

SynopsisMirror type information
Contextconfigure mirror mirror-dest string type keyword
Treetype
Optionsether, ip-only
Default ether
Introduced16.0.R1

Platforms

All

use-global-sampling-rate boolean
Synopsis Enables global sampling rate by mirror destination
Contextconfigure mirror mirror-dest string use-global-sampling-rate boolean
Treeuse-global-sampling-rate

Description

When configured to true, this command configures each mirror destination service to use the global sampling rate, which allows a single high sampling rate for the entire system.

When configured to false, the mirror destination mirrors at the full rate (all packets) or mirrors based on the sampling rate for the mirror destination if the sampling-rate command is configured.

Defaultfalse
Introduced22.10.R1

Platforms

All

mirror-source [service-name] string

Synopsis Enter the mirror-source list instance
Contextconfigure mirror mirror-source string
Treemirror-source
Introduced19.10.R1

Platforms

All

[service-name] string
Synopsis Administrative service name
Context configure mirror mirror-source string
Treemirror-source
String Length1 to 64

Notes

This element is part of a list key.

Introduced19.10.R1

Platforms

All

admin-state keyword
Synopsis Administrative state of the mirror service
Contextconfigure mirror mirror-source string admin-state keyword
Treeadmin-state
Optionsenable, disable
Default enable
Introduced19.10.R1

Platforms

All

ip-filter [filter-name] reference
Synopsis Enter the ip-filter list instance
Contextconfigure mirror mirror-source string ip-filter reference
Treeip-filter
Introduced19.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
Treeentry
Min. Instances1
Introduced19.10.R1

Platforms

All

[entry-id] number
Synopsis IP filter entry ID
Context configure mirror mirror-source string ip-filter reference entry number
Treeentry
Range1 to 2097151

Notes

This element is part of a list key.

Introduced19.10.R1

Platforms

All

ipv6-filter [filter-name] reference
Synopsis Enter the ipv6-filter list instance
Contextconfigure mirror mirror-source string ipv6-filter reference
Treeipv6-filter
Introduced19.10.R1

Platforms

All

mac-filter [filter-name] reference
Synopsis Enter the mac-filter list instance
Contextconfigure mirror mirror-source string mac-filter reference
Treemac-filter
Introduced19.10.R1

Platforms

All

port [port-id] string
Synopsis Enter the port list instance
Context configure mirror mirror-source string port string
Treeport
Introduced19.10.R1

Platforms

All

[port-id] string
Synopsis Port ID
Contextconfigure mirror mirror-source string port string
Treeport

Notes

This element is part of a list key.

Introduced19.10.R1

Platforms

All

egress boolean
Synopsis Mirror egress packets
Context configure mirror mirror-source string port string egress boolean
Treeegress

Description

When configured to true, egressing packets are mirrored. Egress packets are mirrored to the mirror destination after egress packet modification.

Defaultfalse
Introduced19.10.R1

Platforms

All

ingress boolean
Synopsis Mirror ingress packets
Context configure mirror mirror-source string port string ingress boolean
Treeingress

Description

When configured to true, ingressing packets are mirrored. Ingress packets are mirrored to the mirror destination before ingress packet modification.

Defaultfalse
Introduced19.10.R1

Platforms

All

sap [sap-id] string
Synopsis Enter the sap list instance
Context configure mirror mirror-source string sap string
Treesap
Introduced19.10.R1

Platforms

All

[sap-id] string
Synopsis SAP ID
Contextconfigure mirror mirror-source string sap string
Treesap
String Length1 to 45

Notes

This element is part of a list key.

Introduced19.10.R1

Platforms

All

egress boolean
Synopsis Mirror egress packets
Context configure mirror mirror-source string sap string egress boolean
Treeegress

Description

When configured to true, egressing packets are mirrored. Egress packets are mirrored to the mirror destination after egress packet modification.

Defaultfalse
Introduced19.10.R1

Platforms

All

ingress boolean
Synopsis Mirror ingress packets
Context configure mirror mirror-source string sap string ingress boolean
Treeingress

Description

When configured to true, ingressing packets are mirrored. Ingress packets are mirrored to the mirror destination before ingress packet modification.

Defaultfalse
Introduced19.10.R1

Platforms

All

subscriber [subscriber-id] string
Synopsis Enter the subscriber list instance
Contextconfigure mirror mirror-source string subscriber string
Treesubscriber
Introduced19.10.R1

Platforms

All

[subscriber-id] string
Synopsis Subscriber ID
Contextconfigure mirror mirror-source string subscriber string
Treesubscriber
String Length1 to 64

Notes

This element is part of a list key.

Introduced19.10.R1

Platforms

All

egress boolean
Synopsis Mirror egress packets
Context configure mirror mirror-source string subscriber string egress boolean
Treeegress

Description

When configured to true, egressing packets are mirrored. Egress packets are mirrored to the mirror destination after egress packet modification.

Defaultfalse
Introduced19.10.R1

Platforms

All

fc keyword
Synopsis The forwarding classes traffic which should be mirrored
Contextconfigure mirror mirror-source string subscriber string fc keyword
Treefc
Optionsbe, l2, af, l1, h2, ef, h1, nc
Max. Instances 8
Introduced19.10.R1

Platforms

All

ingress boolean
Synopsis Mirror ingress packets
Context configure mirror mirror-source string subscriber string ingress boolean
Treeingress

Description

When configured to true, ingressing packets are mirrored. Ingress packets are mirrored to the mirror destination before ingress packet modification.

Defaultfalse
Introduced19.10.R1

Platforms

All

ip-address string
Synopsis Service IP address of remote device sending LI traffic
Contextconfigure mirror mirror-source string subscriber string ip-address string
Treeip-address

Notes

The following elements are part of a choice: (ip-address, mac-address, and sap-id) or sla-profile.

Introduced19.10.R1

Platforms

All

mac-address string
Synopsis MAC address for the subscriber
Context configure mirror mirror-source string subscriber string mac-address string
Treemac-address

Notes

The following elements are part of a choice: (ip-address, mac-address, and sap-id) or sla-profile.

Introduced19.10.R1

Platforms

All

sap-id string
Synopsis Subscriber SAP ID
Context configure mirror mirror-source string subscriber string sap-id string
Treesap-id
String Length1 to 45

Notes

The following elements are part of a choice: (ip-address, mac-address, and sap-id) or sla-profile.

Introduced19.10.R1

Platforms

All

sla-profile string
Synopsis SLA profile name
Context configure mirror mirror-source string subscriber string sla-profile string
Treesla-profile
String Length1 to 32

Notes

The following elements are part of a choice: (ip-address, mac-address, and sap-id) or sla-profile.

Introduced19.10.R1

Platforms

All