You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
100 lines
2.8 KiB
100 lines
2.8 KiB
.TH IP\-VRF 8 "7 Dec 2016" "iproute2" "Linux"
|
|
.SH NAME
|
|
ip-vrf \- run a command against a vrf
|
|
.SH SYNOPSIS
|
|
.sp
|
|
.ad l
|
|
.in +8
|
|
.ti -8
|
|
.B ip
|
|
.B vrf
|
|
.RI " { " COMMAND " | "
|
|
.BR help " }"
|
|
.sp
|
|
|
|
.ti -8
|
|
.BR "ip vrf show"
|
|
.RI "[ " NAME " ]"
|
|
|
|
.ti -8
|
|
.BR "ip vrf identify"
|
|
.RI "[ " PID " ]"
|
|
|
|
.ti -8
|
|
.BR "ip vrf pids"
|
|
.I NAME
|
|
|
|
.ti -8
|
|
.BR "ip vrf exec "
|
|
.RI "[ " NAME " ] " command ...
|
|
|
|
.SH DESCRIPTION
|
|
A VRF provides traffic isolation at layer 3 for routing, similar to how a
|
|
VLAN is used to isolate traffic at layer 2. Fundamentally, a VRF is a separate
|
|
routing table. Network devices are associated with a VRF by enslaving the
|
|
device to the VRF. At that point network addresses assigned to the device are
|
|
local to the VRF with host and connected routes moved to the table associated
|
|
with the VRF.
|
|
|
|
A process can specify a VRF using several APIs -- binding the socket to the
|
|
VRF device using SO_BINDTODEVICE, setting the VRF association using
|
|
IP_UNICAST_IF or IPV6_UNICAST_IF, or specifying the VRF for a specific message
|
|
using IP_PKTINFO or IPV6_PKTINFO.
|
|
|
|
By default a process is not bound to any VRF. An association can be set
|
|
explicitly by making the program use one of the APIs mentioned above or
|
|
implicitly using a helper to set SO_BINDTODEVICE for all IPv4 and IPv6
|
|
sockets (AF_INET and AF_INET6) when the socket is created. This ip-vrf command
|
|
is a helper to run a command against a specific VRF with the VRF association
|
|
inherited parent to child.
|
|
|
|
.TP
|
|
.B ip vrf show [ NAME ] - Show all configured VRF
|
|
.sp
|
|
This command lists all VRF and their corresponding table ids. If NAME is
|
|
given, then only that VRF and table id is shown. The latter command is
|
|
useful for scripting where the table id for a VRF is needed.
|
|
|
|
.TP
|
|
.B ip vrf exec [ NAME ] cmd ... - Run cmd against the named VRF
|
|
.sp
|
|
This command allows applications that are VRF unaware to be run against
|
|
a VRF other than the default VRF (main table). A command can be run against
|
|
the default VRF by passing the "default" as the VRF name. This is useful if
|
|
the current shell is associated with another VRF (e.g, Management VRF).
|
|
|
|
.TP
|
|
.B ip vrf identify [PID] - Report VRF association for process
|
|
.sp
|
|
This command shows the VRF association of the specified process. If PID is
|
|
not specified then the id of the current process is used.
|
|
|
|
.TP
|
|
.B ip vrf pids NAME - Report processes associated with the named VRF
|
|
.sp
|
|
This command shows all process ids that are associated with the given
|
|
VRF.
|
|
|
|
.SH CAVEATS
|
|
This command requires a kernel compiled with CGROUPS and CGROUP_BPF enabled.
|
|
|
|
The VRF helper *only* affects network layer sockets.
|
|
|
|
.SH EXAMPLES
|
|
.PP
|
|
ip vrf exec red ssh 10.100.1.254
|
|
.RS
|
|
Executes ssh to 10.100.1.254 against the VRF red table.
|
|
.RE
|
|
|
|
.SH SEE ALSO
|
|
.br
|
|
.BR ip (8),
|
|
.BR ip-link (8),
|
|
.BR ip-address (8),
|
|
.BR ip-route (8),
|
|
.BR ip-neighbor (8)
|
|
|
|
.SH AUTHOR
|
|
Original Manpage by David Ahern
|