Blame man/man8/devlink-trap.8

Packit Service 3880ab
.TH DEVLINK\-TRAP 8 "2 August 2019" "iproute2" "Linux"
Packit Service 3880ab
.SH NAME
Packit Service 3880ab
devlink-trap \- devlink trap configuration
Packit Service 3880ab
.SH SYNOPSIS
Packit Service 3880ab
.sp
Packit Service 3880ab
.ad l
Packit Service 3880ab
.in +8
Packit Service 3880ab
.ti -8
Packit Service 3880ab
.B devlink
Packit Service 3880ab
.RI "[ " OPTIONS " ]"
Packit Service 3880ab
.B trap
Packit Service 3880ab
.RI "{ " COMMAND " |"
Packit Service 3880ab
.BR help " }"
Packit Service 3880ab
.sp
Packit Service 3880ab
Packit Service 3880ab
.ti -8
Packit Service 3880ab
.IR OPTIONS " := { "
Packit Service 3880ab
\fB\-v\fR[\fIerbose\fR] |
Packit Service 3880ab
\fB\-s\fR[\fItatistics\fR] }
Packit Service 3880ab
Packit Service 3880ab
.ti -8
Packit Service 3880ab
.B "devlink trap show"
Packit Service 3880ab
.RI "[ " DEV
Packit Service 3880ab
.B trap
Packit Service 3880ab
.IR TRAP " ]"
Packit Service 3880ab
Packit Service 3880ab
.ti -8
Packit Service 3880ab
.BI "devlink trap set " DEV " trap " TRAP
Packit Service 3880ab
.RB "[ " action " { " trap " | " drop " | " mirror " } ]"
Packit Service 3880ab
Packit Service 3880ab
.ti -8
Packit Service 3880ab
.B "devlink trap group show"
Packit Service 3880ab
.RI "[ " DEV
Packit Service 3880ab
.B group
Packit Service 3880ab
.IR GROUP " ]"
Packit Service 3880ab
Packit Service 3880ab
.ti -8
Packit Service 3880ab
.BI "devlink trap group set " DEV " group " GROUP
Packit Service 3880ab
.RB "[ " action " { " trap " | " drop " | " mirror " } ]"
Packit Service 3880ab
.br
Packit Service 3880ab
.RB "[ " policer
Packit Service 3880ab
.IB "POLICER " ]
Packit Service 3880ab
.RB "[ " nopolicer " ]"
Packit Service 3880ab
Packit Service 3880ab
.ti -8
Packit Service 3880ab
.BI "devlink trap policer set " DEV " policer " POLICER
Packit Service 3880ab
.RB "[ " rate
Packit Service 3880ab
.IR "RATE " ]
Packit Service 3880ab
.RB "[ " burst
Packit Service 3880ab
.IR "BURST " ]
Packit Service 3880ab
Packit Service 3880ab
.ti -8
Packit Service 3880ab
.B devlink trap help
Packit Service 3880ab
Packit Service 3880ab
.SH "DESCRIPTION"
Packit Service 3880ab
.SS devlink trap show - display available packet traps and their attributes
Packit Service 3880ab
Packit Service 3880ab
.PP
Packit Service 3880ab
.I "DEV"
Packit Service 3880ab
- specifies the devlink device from which to show packet traps.
Packit Service 3880ab
If this argument is omitted all packet traps of all devices are listed.
Packit Service 3880ab
Packit Service 3880ab
.PP
Packit Service 3880ab
.BI "trap " TRAP
Packit Service 3880ab
- specifies the packet trap.
Packit Service 3880ab
Only applicable if a devlink device is also specified.
Packit Service 3880ab
Packit Service 3880ab
.SS devlink trap set - set attributes of a packet trap
Packit Service 3880ab
Packit Service 3880ab
.PP
Packit Service 3880ab
.I "DEV"
Packit Service 3880ab
- specifies the devlink device the packet trap belongs to.
Packit Service 3880ab
Packit Service 3880ab
.PP
Packit Service 3880ab
.BI "trap " TRAP
Packit Service 3880ab
- specifies the packet trap.
Packit Service 3880ab
Packit Service 3880ab
.TP
Packit Service 3880ab
.BR action " { " trap " | " drop " | " mirror " } "
Packit Service 3880ab
packet trap action.
Packit Service 3880ab
Packit Service 3880ab
.I trap
Packit Service 3880ab
- the sole copy of the packet is sent to the CPU.
Packit Service 3880ab
Packit Service 3880ab
.I drop
Packit Service 3880ab
- the packet is dropped by the underlying device and a copy is not sent to the CPU.
Packit Service 3880ab
Packit Service 3880ab
.I mirror
Packit Service 3880ab
- the packet is forwarded by the underlying device and a copy is sent to the CPU.
Packit Service 3880ab
Packit Service 3880ab
.SS devlink trap group show - display available packet trap groups and their attributes
Packit Service 3880ab
Packit Service 3880ab
.PP
Packit Service 3880ab
.I "DEV"
Packit Service 3880ab
- specifies the devlink device from which to show packet trap groups.
Packit Service 3880ab
If this argument is omitted all packet trap groups of all devices are listed.
Packit Service 3880ab
Packit Service 3880ab
.PP
Packit Service 3880ab
.BI "group " GROUP
Packit Service 3880ab
- specifies the packet trap group.
Packit Service 3880ab
Only applicable if a devlink device is also specified.
Packit Service 3880ab
Packit Service 3880ab
.SS devlink trap group set - set attributes of a packet trap group
Packit Service 3880ab
Packit Service 3880ab
.PP
Packit Service 3880ab
.I "DEV"
Packit Service 3880ab
- specifies the devlink device the packet trap group belongs to.
Packit Service 3880ab
Packit Service 3880ab
.PP
Packit Service 3880ab
.BI "group " GROUP
Packit Service 3880ab
- specifies the packet trap group.
Packit Service 3880ab
Packit Service 3880ab
.TP
Packit Service 3880ab
.BR action " { " trap " | " drop " | " mirror " } "
Packit Service 3880ab
packet trap action. The action is set for all the packet traps member in the
Packit Service 3880ab
trap group. The actions of non-drop traps cannot be changed and are thus
Packit Service 3880ab
skipped.
Packit Service 3880ab
Packit Service 3880ab
.TP
Packit Service 3880ab
.BI policer " POLICER"
Packit Service 3880ab
packet trap policer. The policer to bind to the packet trap group. A value of
Packit Service 3880ab
"0" will unbind the currently bound policer.
Packit Service 3880ab
Packit Service 3880ab
.TP
Packit Service 3880ab
.B nopolicer
Packit Service 3880ab
Unbind packet trap policer from the packet trap group.
Packit Service 3880ab
Packit Service 3880ab
.SS devlink trap policer set - set attributes of packet trap policer
Packit Service 3880ab
Packit Service 3880ab
.PP
Packit Service 3880ab
.I "DEV"
Packit Service 3880ab
- specifies the devlink device the packet trap policer belongs to.
Packit Service 3880ab
Packit Service 3880ab
.PP
Packit Service 3880ab
.BI "policer " POLICER
Packit Service 3880ab
- specifies the packet trap policer.
Packit Service 3880ab
Packit Service 3880ab
.PP
Packit Service 3880ab
.BI rate " RATE "
Packit Service 3880ab
- packet trap policer rate in packets per second.
Packit Service 3880ab
Packit Service 3880ab
.PP
Packit Service 3880ab
.BI burst " BURST "
Packit Service 3880ab
- packet trap policer burst size in packets.
Packit Service 3880ab
Packit Service 3880ab
.SH "EXAMPLES"
Packit Service 3880ab
.PP
Packit Service 3880ab
devlink trap show
Packit Service 3880ab
.RS 4
Packit Service 3880ab
List available packet traps.
Packit Service 3880ab
.RE
Packit Service 3880ab
.PP
Packit Service 3880ab
devlink trap group show
Packit Service 3880ab
.RS 4
Packit Service 3880ab
List available packet trap groups.
Packit Service 3880ab
.RE
Packit Service 3880ab
.PP
Packit Service 3880ab
devlink -vs trap show pci/0000:01:00.0 trap source_mac_is_multicast
Packit Service 3880ab
.RS 4
Packit Service 3880ab
Show attributes and statistics of a specific packet trap.
Packit Service 3880ab
.RE
Packit Service 3880ab
.PP
Packit Service 3880ab
devlink -s trap group show pci/0000:01:00.0 group l2_drops
Packit Service 3880ab
.RS 4
Packit Service 3880ab
Show attributes and statistics of a specific packet trap group.
Packit Service 3880ab
.RE
Packit Service 3880ab
.PP
Packit Service 3880ab
devlink trap set pci/0000:01:00.0 trap source_mac_is_multicast action trap
Packit Service 3880ab
.RS 4
Packit Service 3880ab
Set the action of a specific packet trap to 'trap'.
Packit Service 3880ab
.RE
Packit Service 3880ab
.PP
Packit Service 3880ab
devlink trap policer show
Packit Service 3880ab
.RS 4
Packit Service 3880ab
List available packet trap policers.
Packit Service 3880ab
.RE
Packit Service 3880ab
.PP
Packit Service 3880ab
devlink -s trap policer show pci/0000:01:00.0 policer 1
Packit Service 3880ab
.RS 4
Packit Service 3880ab
Show attributes and statistics of a specific packet trap policer.
Packit Service 3880ab
.RE
Packit Service 3880ab
.PP
Packit Service 3880ab
devlink trap policer set pci/0000:01:00.0 policer 1 rate 1000 burst 128
Packit Service 3880ab
.RS 4
Packit Service 3880ab
Set the rate and burst size of a specific packet trap policer.
Packit Service 3880ab
.RE
Packit Service 3880ab
Packit Service 3880ab
.SH SEE ALSO
Packit Service 3880ab
.BR devlink (8),
Packit Service 3880ab
.BR devlink-dev (8),
Packit Service 3880ab
.BR devlink-monitor (8),
Packit Service 3880ab
.br
Packit Service 3880ab
Packit Service 3880ab
.SH AUTHOR
Packit Service 3880ab
Ido Schimmel <idosch@mellanox.com>