.IR OPTIONS " := { "
\fB\-V\fR[\fIersion\fR] |
\fB\-s\fR[\fItatistics\fR] |
-\fB\-n\fR[\fIetns\fR] name }
+\fB\-n\fR[\fIetns\fR] name |
+\fB\-b\fR[\fIatch\fR] filename |
+\fB\-c\fR[\folor\fR] |
+\fB\-p\fR[\fIretty\fR] |
+\fB\-j\fR[\fIson\fR] |
+\fB\-o\fR[\fIneline\fr] }
.ti -8
.BR "bridge link set"
-.B dev
+.B dev
.IR DEV
.IR " [ "
-.B cost
+.B cost
.IR COST " ] [ "
-.B priority
-.IR PRIO " ] [ "
-.B state
-.IR STATE "] ["
+.B priority
+.IR PRIO " ] [ "
+.B state
+.IR STATE " ] [ "
.BR guard " { " on " | " off " } ] [ "
.BR hairpin " { " on " | " off " } ] [ "
.BR fastleave " { " on " | " off " } ] [ "
.BR learning_sync " { " on " | " off " } ] [ "
.BR flood " { " on " | " off " } ] [ "
.BR hwmode " { " vepa " | " veb " } ] [ "
-.BR self " ] [ " master " ] "
+.BR mcast_flood " { " on " | " off " } ] [ "
+.BR mcast_to_unicast " { " on " | " off " } ] [ "
+.BR neigh_suppress " { " on " | " off " } ] [ "
+.BR vlan_tunnel " { " on " | " off " } ] [ "
+.BR isolated " { " on " | " off " } ] [ "
+.B backup_port
+.IR DEVICE " ] ["
+.BR nobackup_port " ] [ "
+.BR self " ] [ " master " ]"
.ti -8
.BR "bridge link" " [ " show " ] [ "
-.B dev
+.B dev
.IR DEV " ]"
.ti -8
-.BR "bridge fdb" " { " add " | " append " | " del " } "
+.BR "bridge fdb" " { " add " | " append " | " del " | " replace " } "
.I LLADDR
-.B dev
+.B dev
.IR DEV " { "
-.BR local " | " temp " } { "
-.BR self " } { " router " } [ "
-.B dst
+.BR local " | " static " | " dynamic " } [ "
+.BR self " ] [ " master " ] [ " router " ] [ " use " ] [ " extern_learn " ] [ " sticky " ] [ "
+.B dst
.IR IPADDR " ] [ "
+.B src_vni
+.IR SRC_VNI " ] ["
.B vni
.IR VNI " ] ["
.B port
.ti -8
.BR "bridge fdb" " [ " show " ] [ "
-.B dev
-.IR DEV " ]"
+.B dev
+.IR DEV " ] [ "
+.B br
+.IR BRDEV " ] [ "
+.B brport
+.IR DEV " ] [ "
+.B vlan
+.IR VID " ] [ "
+.B state
+.IR STATE " ]"
.ti -8
.BR "bridge mdb" " { " add " | " del " } "
-.B dev
+.B dev
.IR DEV
.B port
.IR PORT
.B grp
.IR GROUP " [ "
-.BR permanent " | " temp " ]"
+.BR permanent " | " temp " ] [ "
+.B vid
+.IR VID " ] "
.ti -8
.BR "bridge mdb show " [ "
-.B dev
+.B dev
.IR DEV " ]"
.ti -8
.BR "bridge vlan" " { " add " | " del " } "
-.B dev
+.B dev
.IR DEV
-.B vid
+.B vid
.IR VID " [ "
-.BR pvid " ] [ " untagged " ] [ "
-.BR self " ] [ " master " ] "
+.BR tunnel_info
+.IR TUNNEL_ID " ] [ "
+.BR pvid " ] [ " untagged " ] [ "
+.BR self " ] [ " master " ] "
.ti -8
-.BR "bridge vlan" " [ " show " ] [ "
-.B dev
+.BR "bridge vlan" " [ " show " | " tunnelshow " ] [ "
+.B dev
.IR DEV " ]"
.ti -8
is given multiple times, the amount of information increases.
As a rule, the information is statistics or some time values.
+.TP
+.BR "\-d" , " \-details"
+print detailed information about MDB router ports.
+
.TP
.BR "\-n" , " \-net" , " \-netns " <NETNS>
switches
.RI "-n[etns] " NETNS " [ " OPTIONS " ] " OBJECT " { " COMMAND " | "
.BR help " }"
+.TP
+.BR "\-b", " \-batch " <FILENAME>
+Read commands from provided file or standard input and invoke them.
+First failure will cause termination of bridge command.
+
+.TP
+.BR "\-force"
+Don't terminate bridge command on errors in batch mode.
+If there were any errors during execution of the commands, the application
+return code will be non zero.
+
+.TP
+.BR \-c [ color ][ = { always | auto | never }
+Configure color output. If parameter is omitted or
+.BR always ,
+color output is enabled regardless of stdout state. If parameter is
+.BR auto ,
+stdout is checked to be a terminal before enabling color output. If parameter is
+.BR never ,
+color output is disabled. If specified multiple times, the last one takes
+precedence. This flag is ignored if
+.B \-json
+is also given.
+
+.TP
+.BR "\-j", " \-json"
+Output results in JavaScript Object Notation (JSON).
+
+.TP
+.BR "\-p", " \-pretty"
+When combined with -j generate a pretty JSON output.
+
+.TP
+.BR "\-o", " \-oneline"
+output each record on a single line, replacing line feeds
+with the
+.B '\e'
+character. This is convenient when you want to count records
+with
+.BR wc (1)
+or to
+.BR grep (1)
+the output.
+
.SH BRIDGE - COMMAND SYNTAX
- Bridge port.
.TP
-.B fdb
+.B fdb
- Forwarding Database entry.
.TP
.sp
.B 1
-- STP LISTENING state. Only valid if STP is enabled on the brige. In this
-state the port for list for STP BPDUs and drop all other traffic.
+- STP LISTENING state. Only valid if STP is enabled on the bridge. In this
+state the port listens for STP BPDUs and drops all other traffic frames.
.sp
.B 2
- STP LEARNING state. Only valid if STP is enabled on the bridge. In this
state the port will accept traffic only for the purpose of updating MAC
-adress tables.
+address tables.
.sp
.B 3
.TP
.BR "guard on " or " guard off "
-Controls whether STP BPUDs will be processed by the bridge port. By default,
+Controls whether STP BPDUs will be processed by the bridge port. By default,
the flag is turned off allowed BPDU processing. Turning this flag on will
cause the port to stop processing STP BPDUs.
bridge FDB.
.TP
-.BR "flooding on " or " flooding off "
+.BR "flood on " or " flood off "
Controls whether a given port will flood unicast traffic for which there is no FDB entry. By default this flag is on.
.TP
.B veb
- bridging happens in hardware.
+.TP
+.BR "mcast_flood on " or " mcast_flood off "
+Controls whether a given port will flood multicast traffic for which there is no MDB entry. By default this flag is on.
+
+.TP
+.BR "mcast_to_unicast on " or " mcast_to_unicast off "
+Controls whether a given port will replicate packets using unicast instead of multicast. By default this flag is off.
+
+.TP
+.BR "neigh_suppress on " or " neigh_suppress off "
+Controls whether neigh discovery (arp and nd) proxy and suppression is enabled on the port. By default this flag is off.
+
+.TP
+.BR "vlan_tunnel on " or " vlan_tunnel off "
+Controls whether vlan to tunnel mapping is enabled on the port. By default this flag is off.
+
+.TP
+.BR "isolated on " or " isolated off "
+Controls whether a given port will be isolated, which means it will be able to communicate with non-isolated ports only.
+By default this flag is off.
+
+.TP
+.BI backup_port " DEVICE"
+If the port loses carrier all traffic will be redirected to the configured backup port
+
+.TP
+.BR nobackup_port
+Removes the currently configured backup port
+
.TP
.BI self
link setting is configured on specified physical device
.BI master
link setting is configured on the software bridge (default)
+.TP
+.BR "\-t" , " \-timestamp"
+display current time when using monitor option.
.SS bridge link show - list bridge port configuration.
.SH bridge fdb - forwarding database management
.B fdb
-objects contain known Ethernet addresses on a link.
+objects contain known Ethernet addresses on a link.
.P
The corresponding commands display fdb entries, add new entries,
.BI dev " DEV"
the interface to which this address is associated.
+.B local
+- is a local permanent fdb entry
+.sp
+
+.B static
+- is a static (no arp) fdb entry
+.sp
+
+.B dynamic
+- is a dynamic reachable age-able fdb entry
+.sp
+
.B self
-- the address is associated with a software fdb (default)
+- the address is associated with the port drivers fdb. Usually hardware.
+.sp
+
+.B master
+- the address is associated with master devices fdb. Usually software (default).
.sp
.B router
route shortcircuit enabled.
.sp
+.B use
+- the address is in use. User space can use this option to
+indicate to the kernel that the fdb entry is in use.
+.sp
+
+.B extern_learn
+- this entry was learned externally. This option can be used to
+indicate to the kernel that an entry was hardware or user-space
+controller learnt dynamic entry. Kernel will not age such an entry.
+.sp
+
+.B sticky
+- this entry will not change its port due to learning.
+.sp
+
.in -8
The next command line parameters apply only
when the specified device
the IP address of the destination
VXLAN tunnel endpoint where the Ethernet MAC ADDRESS resides.
+.TP
+.BI src_vni " SRC VNI"
+the src VNI Network Identifier (or VXLAN Segment ID)
+this entry belongs to. Used only when the vxlan device is in
+external or collect metadata mode. If omitted the value specified at
+vxlan device creation will be used.
+
.TP
.BI vni " VNI"
the VXLAN VNI Network Identifier (or VXLAN Segment ID)
.BI via " DEVICE"
device name of the outgoing interface for the
VXLAN device driver to reach the
-remote VXLAN tunnel endpoint.
+remote VXLAN tunnel endpoint.
.SS bridge fdb append - append a forwarding database entry
This command adds a new fdb entry with an already known
.PP
The arguments are the same as with
-.BR "bridge fdb add" ,
+.BR "bridge fdb add" .
.SS bridge fdb delete - delete a forwarding database entry
This command removes an existing fdb entry.
.PP
The arguments are the same as with
-.BR "bridge fdb add" ,
+.BR "bridge fdb add" .
+
+.SS bridge fdb replace - replace a forwarding database entry
+If no matching entry is found, a new one will be created instead.
+
+.PP
+The arguments are the same as with
+.BR "bridge fdb add" .
.SS bridge fdb show - list forwarding entries.
- the mdb entry is temporary (default)
.sp
+.TP
+.BI vid " VID"
+the VLAN ID which is known to have members of this multicast group.
+
.in -8
.SS bridge mdb delete - delete a multicast group database entry
This command removes an existing mdb entry.
option, the command becomes verbose. It prints out the ports known to have
a connected router.
+.PP
+With the
+.B -statistics
+option, the command displays timer values for mdb and router port entries.
+
.SH bridge vlan - VLAN filter list
.B vlan
.BI vid " VID"
the VLAN ID that identifies the vlan.
+.TP
+.BI tunnel_info " TUNNEL_ID"
+the TUNNEL ID that maps to this vlan. The tunnel id is set in dst_metadata for
+every packet that belongs to this vlan (applicable to bridge ports with vlan_tunnel
+flag set).
+
.TP
.BI pvid
the vlan specified is to be considered a PVID at ingress.
.BI master
the vlan is configured on the software bridge (default).
-.SS bridge vlan delete - delete a forwarding database entry
-This command removes an existing fdb entry.
+.SS bridge vlan delete - delete a vlan filter entry
+This command removes an existing vlan filter entry.
.PP
The arguments are the same as with
This command displays the current VLAN filter table.
+.PP
+With the
+.B -statistics
+option, the command displays per-vlan traffic statistics.
+
+.SS bridge vlan tunnelshow - list vlan tunnel mapping.
+
+This command displays the current vlan tunnel info mapping.
+
.SH bridge monitor - state monitoring
The
.B bridge
-utility can monitor the state of devices and addresses
+utility can monitor the state of devices and addresses
continuously. This option has a slightly different format.
Namely, the
.B monitor
.I OBJECT-LIST
is the list of object types that we want to monitor.
It may contain
-.BR link ", " fdb ", and " mdb "."
+.BR link ", " fdb ", and " mdb "."
If no
.B file
argument is given,
.P
If a file name is given, it does not listen on RTNETLINK,
but opens the file containing RTNETLINK messages saved in binary format
-and dumps them. Such a history file can be generated with the
-
+and dumps them.
.SH NOTES
This command uses facilities added in Linux 3.0.
projects / mirror_iproute2.git / blobdiff