Blame man/man8/ip-nexthop.8

Packit Service 3880ab
.TH IP\-NEXTHOP 8 "30 May 2019" "iproute2" "Linux"
Packit Service 3880ab
.SH "NAME"
Packit Service 3880ab
ip-nexthop \- nexthop object management
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 ip
Packit Service 3880ab
.RI "[ " ip-OPTIONS " ]"
Packit Service 3880ab
.B nexthop
Packit Service 3880ab
.RI " { " COMMAND " | "
Packit Service 3880ab
.BR help " }"
Packit Service 3880ab
.sp
Packit Service 3880ab
.ti -8
Packit Service 3880ab
Packit Service 3880ab
.ti -8
Packit Service 3880ab
.BR "ip nexthop" " { "
Packit Service 3880ab
.BR show " | " flush " } "
Packit Service 3880ab
.I  SELECTOR
Packit Service 3880ab
Packit Service 3880ab
.ti -8
Packit Service 3880ab
.BR "ip nexthop" " { " add " | " replace " } id "
Packit Service 3880ab
.I ID
Packit Service 3880ab
.IR  NH
Packit Service 3880ab
Packit Service 3880ab
.ti -8
Packit Service 3880ab
.BR "ip nexthop" " { " get " | " del " } id "
Packit Service 3880ab
.I  ID
Packit Service 3880ab
Packit Service 3880ab
.ti -8
Packit Service 3880ab
.IR SELECTOR " := "
Packit Service 3880ab
.RB "[ " id
Packit Service 3880ab
.IR ID " ] [ "
Packit Service 3880ab
.B  dev
Packit Service 3880ab
.IR DEV " ] [ "
Packit Service 3880ab
.B  vrf
Packit Service 3880ab
.IR NAME " ] [ "
Packit Service 3880ab
.B  master
Packit Service 3880ab
.IR DEV " ] [ "
Packit Service 3880ab
.BR  groups " ] [ "
Packit Service 3880ab
.BR  fdb " ]"
Packit Service 3880ab
Packit Service 3880ab
.ti -8
Packit Service 3880ab
.IR NH " := { "
Packit Service 3880ab
.BR blackhole " | [ "
Packit Service 3880ab
.B  via
Packit Service 3880ab
.IR ADDRESS " ] [ "
Packit Service 3880ab
.B  dev
Packit Service 3880ab
.IR DEV " ] [ "
Packit Service 3880ab
.BR onlink " ] [ "
Packit Service 3880ab
.B encap
Packit Service 3880ab
.IR ENCAP " ] [ "
Packit Service 3880ab
.BR fdb " ] | "
Packit Service 3880ab
.B  group
Packit Service 3880ab
.IR GROUP " [ "
Packit Service 3880ab
.BR fdb " ] } "
Packit Service 3880ab
Packit Service 3880ab
.ti -8
Packit Service 3880ab
.IR ENCAP " := [ "
Packit Service 3880ab
.IR ENCAP_MPLS " ] "
Packit Service 3880ab
Packit Service 3880ab
.ti -8
Packit Service 3880ab
.IR ENCAP_MPLS " := "
Packit Service 3880ab
.BR mpls " [ "
Packit Service 3880ab
.IR LABEL " ] ["
Packit Service 3880ab
.B  ttl
Packit Service 3880ab
.IR TTL " ]"
Packit Service 3880ab
Packit Service 3880ab
.ti -8
Packit Service 3880ab
.IR GROUP " := "
Packit Service 3880ab
.BR id "[," weight "[/...]"
Packit Service 3880ab
Packit Service 3880ab
.SH DESCRIPTION
Packit Service 3880ab
.B ip nexthop
Packit Service 3880ab
is used to manipulate entries in the kernel's nexthop tables.
Packit Service 3880ab
.TP
Packit Service 3880ab
ip nexthop add id ID
Packit Service 3880ab
add new nexthop entry
Packit Service 3880ab
.TP
Packit Service 3880ab
ip nexthop replace id ID
Packit Service 3880ab
change the configuration of a nexthop or add new one
Packit Service 3880ab
.RS
Packit Service 3880ab
.TP
Packit Service 3880ab
.BI via " [ FAMILY ] ADDRESS"
Packit Service 3880ab
the address of the nexthop router, in the address family FAMILY.
Packit Service 3880ab
Address family must match address family of nexthop instance.
Packit Service 3880ab
.TP
Packit Service 3880ab
.BI dev " NAME"
Packit Service 3880ab
is the output device.
Packit Service 3880ab
.TP
Packit Service 3880ab
.B onlink
Packit Service 3880ab
pretend that the nexthop is directly attached to this link,
Packit Service 3880ab
even if it does not match any interface prefix.
Packit Service 3880ab
.TP
Packit Service 3880ab
.BI encap " ENCAPTYPE ENCAPHDR"
Packit Service 3880ab
attach tunnel encapsulation attributes to this route.
Packit Service 3880ab
.sp
Packit Service 3880ab
.I ENCAPTYPE
Packit Service 3880ab
is a string specifying the supported encapsulation type. Namely:
Packit Service 3880ab
Packit Service 3880ab
.in +8
Packit Service 3880ab
.BI mpls
Packit Service 3880ab
- encapsulation type MPLS
Packit Service 3880ab
.sp
Packit Service 3880ab
.in -8
Packit Service 3880ab
.I ENCAPHDR
Packit Service 3880ab
is a set of encapsulation attributes specific to the
Packit Service 3880ab
.I ENCAPTYPE.
Packit Service 3880ab
Packit Service 3880ab
.in +8
Packit Service 3880ab
.B mpls
Packit Service 3880ab
.in +2
Packit Service 3880ab
.I MPLSLABEL
Packit Service 3880ab
- mpls label stack with labels separated by
Packit Service 3880ab
.I "/"
Packit Service 3880ab
.sp
Packit Service 3880ab
Packit Service 3880ab
.B ttl
Packit Service 3880ab
.I TTL
Packit Service 3880ab
- TTL to use for MPLS header or 0 to inherit from IP header
Packit Service 3880ab
.in -2
Packit Service 3880ab
Packit Service 3880ab
.TP
Packit Service 3880ab
.BI group " GROUP"
Packit Service 3880ab
create a nexthop group. Group specification is id with an optional
Packit Service 3880ab
weight (id,weight) and a '/' as a separator between entries.
Packit Service 3880ab
.TP
Packit Service 3880ab
.B blackhole
Packit Service 3880ab
create a blackhole nexthop
Packit Service 3880ab
.TP
Packit Service 3880ab
.B fdb
Packit Service 3880ab
nexthop and nexthop groups for use with layer-2 fdb entries.
Packit Service 3880ab
A fdb nexthop group can only have fdb nexthops.
Packit Service 3880ab
Example: Used to represent a vxlan remote vtep ip. layer-2 vxlan
Packit Service 3880ab
fdb entry pointing to an ecmp nexthop group containing multiple
Packit Service 3880ab
remote vtep ips.
Packit Service 3880ab
.RE
Packit Service 3880ab
Packit Service 3880ab
.TP
Packit Service 3880ab
ip nexthop delete id ID
Packit Service 3880ab
delete nexthop with given id.
Packit Service 3880ab
Packit Service 3880ab
.TP
Packit Service 3880ab
ip nexthop show
Packit Service 3880ab
show the contents of the nexthop table or the nexthops
Packit Service 3880ab
selected by some criteria.
Packit Service 3880ab
.RS
Packit Service 3880ab
.TP
Packit Service 3880ab
.BI dev " DEV "
Packit Service 3880ab
show the nexthops using the given device.
Packit Service 3880ab
.TP
Packit Service 3880ab
.BI vrf " NAME "
Packit Service 3880ab
show the nexthops using devices associated with the vrf name
Packit Service 3880ab
.TP
Packit Service 3880ab
.BI master " DEV "
Packit Service 3880ab
show the nexthops using devices enslaved to given master device
Packit Service 3880ab
.TP
Packit Service 3880ab
.BI groups
Packit Service 3880ab
show only nexthop groups
Packit Service 3880ab
.TP
Packit Service 3880ab
.BI fdb
Packit Service 3880ab
show only fdb nexthops and nexthop groups
Packit Service 3880ab
.RE
Packit Service 3880ab
.TP
Packit Service 3880ab
ip nexthop flush
Packit Service 3880ab
flushes nexthops selected by some criteria. Criteria options are the same
Packit Service 3880ab
as show.
Packit Service 3880ab
Packit Service 3880ab
.TP
Packit Service 3880ab
ip nexthop get id ID
Packit Service 3880ab
get a single nexthop by id
Packit Service 3880ab
Packit Service 3880ab
.SH EXAMPLES
Packit Service 3880ab
.PP
Packit Service 3880ab
ip nexthop ls
Packit Service 3880ab
.RS 4
Packit Service 3880ab
Show all nexthop entries in the kernel.
Packit Service 3880ab
.RE
Packit Service 3880ab
.PP
Packit Service 3880ab
ip nexthop add id 1 via 192.168.1.1 dev eth0
Packit Service 3880ab
.RS 4
Packit Service 3880ab
Adds an IPv4 nexthop with id 1 using the gateway 192.168.1.1 out device eth0.
Packit Service 3880ab
.RE
Packit Service 3880ab
.PP
Packit Service 3880ab
ip nexthop add id 2 encap mpls 200/300 via 10.1.1.1 dev eth0
Packit Service 3880ab
.RS 4
Packit Service 3880ab
Adds an IPv4 nexthop with mpls encapsulation attributes attached to it.
Packit Service 3880ab
.RE
Packit Service 3880ab
.PP
Packit Service 3880ab
ip nexthop add id 3 group 1/2
Packit Service 3880ab
.RS 4
Packit Service 3880ab
Adds a nexthop with id 3. The nexthop is a group using nexthops with ids
Packit Service 3880ab
1 and 2 at equal weight.
Packit Service 3880ab
.RE
Packit Service 3880ab
.PP
Packit Service 3880ab
ip nexthop add id 4 group 1,5/2,11
Packit Service 3880ab
.RS 4
Packit Service 3880ab
Adds a nexthop with id 4. The nexthop is a group using nexthops with ids
Packit Service 3880ab
1 and 2 with nexthop 1 at weight 5 and nexthop 2 at weight 11.
Packit Service 3880ab
.RE
Packit Service 3880ab
.PP
Packit Service 3880ab
ip nexthop add id 5 via 192.168.1.2 fdb
Packit Service 3880ab
.RS 4
Packit Service 3880ab
Adds a fdb nexthop with id 5.
Packit Service 3880ab
.RE
Packit Service 3880ab
.PP
Packit Service 3880ab
ip nexthop add id 7 group 5/6 fdb
Packit Service 3880ab
.RS 4
Packit Service 3880ab
Adds a fdb nexthop group with id 7. A fdb nexthop group can only have
Packit Service 3880ab
fdb nexthops.
Packit Service 3880ab
.RE
Packit Service 3880ab
.SH SEE ALSO
Packit Service 3880ab
.br
Packit Service 3880ab
.BR ip (8)
Packit Service 3880ab
Packit Service 3880ab
.SH AUTHOR
Packit Service 3880ab
Original Manpage by David Ahern <dsahern@kernel.org>