Blame man/man8/tipc-bearer.8

Packit Service 3880ab
.TH TIPC-BEARER 8 "02 Jun 2015" "iproute2" "Linux"
Packit Service 3880ab
Packit Service 3880ab
.\" For consistency, please keep padding right aligned.
Packit Service 3880ab
.\" For example '.B "foo " bar' and not '.B foo " bar"'
Packit Service 3880ab
Packit Service 3880ab
.SH NAME
Packit Service 3880ab
tipc-bearer \- show or modify TIPC bearers
Packit Service 3880ab
Packit Service 3880ab
.SH SYNOPSIS
Packit Service 3880ab
.ad l
Packit Service 3880ab
.in +8
Packit Service 3880ab
Packit Service 3880ab
.ti -8
Packit Service 3880ab
.B tipc bearer add media udp name
Packit Service 3880ab
.IB "NAME " "remoteip " REMOTEIP
Packit Service 3880ab
.br
Packit Service 3880ab
Packit Service 3880ab
.ti -8
Packit Service 3880ab
.B tipc bearer enable
Packit Service 3880ab
.RB "[ " domain
Packit Service 3880ab
.IR DOMAIN " ]"
Packit Service 3880ab
.RB "[ " priority
Packit Service 3880ab
.IR PRIORITY " ]"
Packit Service 3880ab
.BR media
Packit Service 3880ab
.br
Packit Service 3880ab
.RB "{ { " eth " | " ib " } " device
Packit Service 3880ab
.IR "DEVICE" " }"
Packit Service 3880ab
.RB "|"
Packit Service 3880ab
.br
Packit Service 3880ab
.RB	"{ " udp
Packit Service 3880ab
.B name
Packit Service 3880ab
.IR NAME
Packit Service 3880ab
.B localip
Packit Service 3880ab
.IR LOCALIP
Packit Service 3880ab
.RB "[ " localport
Packit Service 3880ab
.IR LOCALPORT " ]"
Packit Service 3880ab
.RB "[ " remoteip
Packit Service 3880ab
.IR REMOTEIP " ]"
Packit Service 3880ab
.RB "[ " remoteport
Packit Service 3880ab
.IR REMOTEPORT " ] }"
Packit Service 3880ab
.br
Packit Service 3880ab
Packit Service 3880ab
.ti -8
Packit Service 3880ab
.B tipc bearer disable media
Packit Service 3880ab
.br
Packit Service 3880ab
.RB "{ { " eth " | " ib " } " device
Packit Service 3880ab
.IR "DEVICE " }
Packit Service 3880ab
.RB "|"
Packit Service 3880ab
.br
Packit Service 3880ab
.RB "{ " udp
Packit Service 3880ab
.B name
Packit Service 3880ab
.IR NAME " }"
Packit Service 3880ab
.br
Packit Service 3880ab
Packit Service 3880ab
.ti -8
Packit Service 3880ab
.B tipc bearer set
Packit Service 3880ab
.RB "{ " "priority "
Packit Service 3880ab
.IR PRIORITY
Packit Service 3880ab
.RB "| " tolerance
Packit Service 3880ab
.IR TOLERANCE
Packit Service 3880ab
.RB "| " window
Packit Service 3880ab
.IR WINDOW
Packit Service 3880ab
.RB "} " media
Packit Service 3880ab
.br
Packit Service 3880ab
.RB "{ { " eth " | " ib " } " device
Packit Service 3880ab
.IR "DEVICE" " }"
Packit Service 3880ab
.RB "|"
Packit Service 3880ab
.br
Packit Service 3880ab
.RB "{ " udp
Packit Service 3880ab
.B name
Packit Service 3880ab
.IR NAME " }"
Packit Service 3880ab
.br
Packit Service 3880ab
Packit Service 3880ab
.ti -8
Packit Service 3880ab
.B tipc bearer get
Packit Service 3880ab
.RB "[ " "priority" " | " tolerance " | " window " ] " media
Packit Service 3880ab
.br
Packit Service 3880ab
.RB "{ { " eth " | " ib " } " device
Packit Service 3880ab
.IR "DEVICE" " }"
Packit Service 3880ab
.RB "|"
Packit Service 3880ab
.br
Packit Service 3880ab
.RB "{ " udp
Packit Service 3880ab
.B name
Packit Service 3880ab
.IR NAME
Packit Service 3880ab
.RB "[ " "localip " "| " "localport " "| " "remoteip " "| " "remoteport " "] }"
Packit Service 3880ab
.br
Packit Service 3880ab
Packit Service 3880ab
.ti -8
Packit Service 3880ab
.B tipc bearer list
Packit Service 3880ab
.br
Packit Service 3880ab
Packit Service 3880ab
.SH OPTIONS
Packit Service 3880ab
Options (flags) that can be passed anywhere in the command chain.
Packit Service 3880ab
.TP
Packit Service 3880ab
.BR "\-h" , " --help"
Packit Service 3880ab
Show help about last valid command. For example
Packit Service 3880ab
.B tipc bearer --help
Packit Service 3880ab
will show bearer help and
Packit Service 3880ab
.B tipc --help
Packit Service 3880ab
will show general help. The position of the option in the string is irrelevant.
Packit Service 3880ab
.SH DESCRIPTION
Packit Service 3880ab
Packit Service 3880ab
.SS Bearer identification
Packit Service 3880ab
.TP
Packit Service 3880ab
.BI "media " MEDIA
Packit Service 3880ab
.br
Packit Service 3880ab
Specifies the TIPC media type for a particular bearer to operate on.
Packit Service 3880ab
Different media types have different ways of identifying a unique bearer.
Packit Service 3880ab
For example,
Packit Service 3880ab
.BR "ib " "and " eth
Packit Service 3880ab
identify a bearer with a
Packit Service 3880ab
.I DEVICE
Packit Service 3880ab
while
Packit Service 3880ab
.B udp
Packit Service 3880ab
identify a bearer with a
Packit Service 3880ab
.IR "LOCALIP " "and a " NAME
Packit Service 3880ab
Packit Service 3880ab
.B ib
Packit Service 3880ab
- Infiniband
Packit Service 3880ab
.sp
Packit Service 3880ab
.B eth
Packit Service 3880ab
- Ethernet
Packit Service 3880ab
.sp
Packit Service 3880ab
.B udp
Packit Service 3880ab
- User Datagram Protocol (UDP)
Packit Service 3880ab
.sp
Packit Service 3880ab
Packit Service 3880ab
.TP
Packit Service 3880ab
.BI "name " NAME
Packit Service 3880ab
.br
Packit Service 3880ab
Logical bearer identifier valid for bearers on
Packit Service 3880ab
.B udp
Packit Service 3880ab
media.
Packit Service 3880ab
Packit Service 3880ab
.TP
Packit Service 3880ab
.BI "device " DEVICE
Packit Service 3880ab
.br
Packit Service 3880ab
Physical bearer device valid for bearers on
Packit Service 3880ab
.B eth
Packit Service 3880ab
and
Packit Service 3880ab
.B ib
Packit Service 3880ab
media.
Packit Service 3880ab
Packit Service 3880ab
.SS Bearer properties
Packit Service 3880ab
Packit Service 3880ab
.TP
Packit Service 3880ab
.B domain
Packit Service 3880ab
.br
Packit Service 3880ab
The addressing domain (region) in which a bearer will establish links and accept
Packit Service 3880ab
link establish requests.
Packit Service 3880ab
Packit Service 3880ab
.TP
Packit Service 3880ab
.B priority
Packit Service 3880ab
.br
Packit Service 3880ab
Default link priority inherited by all links subsequently established over a
Packit Service 3880ab
bearer. A single bearer can only host one link to a particular node. This means
Packit Service 3880ab
the default link priority for a bearer typically affects which bearer to use
Packit Service 3880ab
when communicating with a particular node in an multi bearer setup. For more
Packit Service 3880ab
info about link priority see
Packit Service 3880ab
.BR tipc-link (8)
Packit Service 3880ab
Packit Service 3880ab
.TP
Packit Service 3880ab
.B tolerance
Packit Service 3880ab
.br
Packit Service 3880ab
Default link tolerance inherited by all links subsequently established over a
Packit Service 3880ab
bearer. For more info about link tolerance see
Packit Service 3880ab
.BR tipc-link (8)
Packit Service 3880ab
Packit Service 3880ab
.TP
Packit Service 3880ab
.B window
Packit Service 3880ab
.br
Packit Service 3880ab
Default link window inherited by all links subsequently established over a
Packit Service 3880ab
bearer. For more info about the link window size see
Packit Service 3880ab
.BR tipc-link (8)
Packit Service 3880ab
Packit Service 3880ab
.SS UDP bearer options
Packit Service 3880ab
Packit Service 3880ab
.TP
Packit Service 3880ab
.BI "localip " LOCALIP
Packit Service 3880ab
.br
Packit Service 3880ab
Specify a local IP v4/v6 address for a
Packit Service 3880ab
.B udp
Packit Service 3880ab
bearer.
Packit Service 3880ab
Packit Service 3880ab
.TP
Packit Service 3880ab
.BI "localport " LOCALPORT
Packit Service 3880ab
.br
Packit Service 3880ab
Specify the local port for a
Packit Service 3880ab
.B udp
Packit Service 3880ab
bearer. The default port 6118 is used if no port is specified.
Packit Service 3880ab
Packit Service 3880ab
.TP
Packit Service 3880ab
.BI "remoteip " REMOTEIP
Packit Service 3880ab
.br
Packit Service 3880ab
Specify a remote IP for a
Packit Service 3880ab
.B udp
Packit Service 3880ab
bearer. If no remote IP is specified a
Packit Service 3880ab
.B udp
Packit Service 3880ab
bearer runs in multicast mode and tries to auto-discover its neighbours.
Packit Service 3880ab
The multicast IP address is generated based on the TIPC network ID. If a remote
Packit Service 3880ab
IP is specified the
Packit Service 3880ab
.B udp
Packit Service 3880ab
bearer runs in point-to-point mode.
Packit Service 3880ab
Packit Service 3880ab
Multiple
Packit Service 3880ab
.B remoteip
Packit Service 3880ab
addresses can be added via the
Packit Service 3880ab
.B bearer add
Packit Service 3880ab
command. Adding one or more unicast
Packit Service 3880ab
.B remoteip
Packit Service 3880ab
addresses to an existing
Packit Service 3880ab
.B udp
Packit Service 3880ab
bearer puts the bearer in replicast mode where IP
Packit Service 3880ab
multicast is emulated by sending multiple unicast messages to each configured
Packit Service 3880ab
.B remoteip.
Packit Service 3880ab
When a peer sees a TIPC discovery message from an unknown peer the peer address
Packit Service 3880ab
is automatically added to the
Packit Service 3880ab
.B remoteip
Packit Service 3880ab
(replicast) list, thus only one side of
Packit Service 3880ab
a link needs to be manually configured. A
Packit Service 3880ab
.B remoteip
Packit Service 3880ab
address cannot be added to a multicast bearer.
Packit Service 3880ab
Packit Service 3880ab
.TP
Packit Service 3880ab
.BI "remoteport " REMOTEPORT
Packit Service 3880ab
.br
Packit Service 3880ab
Specify the remote port for a
Packit Service 3880ab
.B udp
Packit Service 3880ab
bearer. The default port 6118 is used if no port is specified.
Packit Service 3880ab
Packit Service 3880ab
.SH EXIT STATUS
Packit Service 3880ab
Exit status is 0 if command was successful or a positive integer upon failure.
Packit Service 3880ab
Packit Service 3880ab
.SH SEE ALSO
Packit Service 3880ab
.BR tipc (8),
Packit Service 3880ab
.BR tipc-link (8),
Packit Service 3880ab
.BR tipc-media (8),
Packit Service 3880ab
.BR tipc-nametable (8),
Packit Service 3880ab
.BR tipc-node (8),
Packit Service 3880ab
.BR tipc-peer (8),
Packit Service 3880ab
.BR tipc-socket (8)
Packit Service 3880ab
.br
Packit Service 3880ab
.SH REPORTING BUGS
Packit Service 3880ab
Report any bugs to the Network Developers mailing list
Packit Service 3880ab
.B <netdev@vger.kernel.org>
Packit Service 3880ab
where the development and maintenance is primarily done.
Packit Service 3880ab
You do not have to be subscribed to the list to send a message there.
Packit Service 3880ab
Packit Service 3880ab
.SH AUTHOR
Packit Service 3880ab
Richard Alpe <richard.alpe@ericsson.com>