mirror_iproute2/man/man8/devlink-trap.8
Ido Schimmel a66af55693 devlink: Add devlink trap policer set and show commands
The trap policer set command allows the user to set the parameters of
the packet trap policer, such as rate and burst size. Example:

# devlink trap policer set netdevsim/netdevsim10 policer 1 rate 1000 burst 32

The trap policer show command allows the user to get the current
parameters of an individual policer or a dump of all policers in case
one is not specified. When '-s' is specified the policer's statistics
are shown. Example:

# devlink -jps trap policer show netdevsim/netdevsim10 policer 1
{
    "trap_policer": {
        "netdevsim/netdevsim10": [ {
                "policer": 1,
                "rate": 1000,
                "burst": 32,
                "stats": {
                    "rx": {
                        "dropped": 53
                    }
                }
            } ]
    }
}

Signed-off-by: Ido Schimmel <idosch@mellanox.com>
Reviewed-by: Jiri Pirko <jiri@mellanox.com>
Signed-off-by: David Ahern <dsahern@gmail.com>
2020-03-31 23:24:35 +00:00

180 lines
3.6 KiB
Groff

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