man/man8/tipc-bearer.8

   1 .TH TIPC-BEARER 8 "02 Jun 2015" "iproute2" "Linux"
   2
   3 .\" For consistency, please keep padding right aligned.
   4 .\" For example '.B "foo " bar' and not '.B foo " bar"'
   5
   6 .SH NAME
   7 tipc-bearer \- show or modify TIPC bearers
   8
   9 .SH SYNOPSIS
  10 .ad l
  11 .in +8
  12
  13 .ti -8
  14 .B tipc bearer enable
  15 .RB "[ " domain
  16 .IR DOMAIN " ]"
  17 .RB "[ " priority
  18 .IR PRIORITY " ]"
  19 .BR media
  20 .br
  21 .RB "{ { " eth " | " ib " } " device
  22 .IR "DEVICE" " }"
  23 .RB "|"
  24 .br
  25 .RB     "{ " udp
  26 .B name
  27 .IR NAME
  28 .B localip
  29 .IR LOCALIP
  30 .RB "[ " localport
  31 .IR LOCALPORT " ]"
  32 .RB "[ " remoteip
  33 .IR REMOTEIP " ]"
  34 .RB "[ " remoteport
  35 .IR REMOTEPORT " ] }"
  36 .br
  37
  38 .ti -8
  39 .B tipc bearer disable media
  40 .br
  41 .RB "{ { " eth " | " ib " } " device
  42 .IR DEVICE
  43 .RB "|"
  44 .br
  45 .RB "{ " udp
  46 .B name
  47 .IR NAME
  48 .B localip
  49 .IR LOCALIP " } }"
  50 .br
  51
  52 .ti -8
  53 .B tipc bearer set
  54 .RB "{ " "priority "
  55 .IR PRIORITY
  56 .RB "| " tolerance
  57 .IR TOLERANCE
  58 .RB "| " window
  59 .IR WINDOW
  60 .RB "} " media
  61 .br
  62 .RB "{ { " eth " | " ib " } " device
  63 .IR "DEVICE" " }"
  64 .RB "|"
  65 .br
  66 .RB "{ " udp
  67 .B name
  68 .IR NAME
  69 .B localip
  70 .IR LOCALIP " } }"
  71 .br
  72
  73 .ti -8
  74 .B tipc bearer get
  75 .RB "{ " "priority" " | " tolerance " | " window " } " media
  76 .br
  77 .RB "{ { " eth " | " ib " } " device
  78 .IR "DEVICE" " }"
  79 .RB "|"
  80 .br
  81 .RB "{ " udp
  82 .B name
  83 .IR NAME
  84 .B localip
  85 .IR LOCALIP " } }"
  86 .br
  87
  88 .ti -8
  89 .B tipc bearer list
  90 .br
  91
  92 .SH OPTIONS
  93 Options (flags) that can be passed anywhere in the command chain.
  94 .TP
  95 .BR "\-h" , " --help"
  96 Show help about last valid command. For example
  97 .B tipc bearer --help
  98 will show bearer help and
  99 .B tipc --help
 100 will show general help. The position of the option in the string is irrelevant.
 101 .SH DESCRIPTION
 102
 103 .SS Bearer identification
 104 .TP
 105 .BI "media " MEDIA
 106 .br
 107 Specifies the TIPC media type for a particular bearer to operate on.
 108 Different media types have different ways of identifying a unique bearer.
 109 For example,
 110 .BR "ib " "and " eth
 111 identify a bearer with a
 112 .I DEVICE
 113 while
 114 .B udp
 115 identify a bearer with a
 116 .IR "LOCALIP " "and a " NAME
 117
 118 .B ib
 119 - Infiniband
 120 .sp
 121 .B eth
 122 - Ethernet
 123 .sp
 124 .B udp
 125 - User Datagram Protocol (UDP)
 126 .sp
 127
 128 .TP
 129 .BI "name " NAME
 130 .br
 131 Logical bearer identifier valid for bearers on
 132 .B udp
 133 media.
 134
 135 .TP
 136 .BI "device " DEVICE
 137 .br
 138 Physical bearer device valid for bearers on
 139 .B eth
 140 and
 141 .B ib
 142 media.
 143
 144 .SS Bearer properties
 145
 146 .TP
 147 .B domain
 148 .br
 149 The addressing domain (region) in which a bearer will establish links and accept
 150 link establish requests.
 151
 152 .TP
 153 .B priority
 154 .br
 155 Default link priority inherited by all links subsequently established over a
 156 bearer. A single bearer can only host one link to a particular node. This means
 157 the default link priority for a bearer typically affects which bearer to use
 158 when communicating with a particular node in an multi bearer setup. For more
 159 info about link priority see
 160 .BR tipc-link (8)
 161
 162 .TP
 163 .B tolerance
 164 .br
 165 Default link tolerance inherited by all links subsequently established over a
 166 bearer. For more info about link tolerance see
 167 .BR tipc-link (8)
 168
 169 .TP
 170 .B window
 171 .br
 172 Default link window inherited by all links subsequently established over a
 173 bearer. For more info about the link window size see
 174 .BR tipc-link (8)
 175
 176 .SS UDP bearer options
 177
 178 .TP
 179 .BI "localip " LOCALIP
 180 .br
 181 Specify a local IP v4/v6 address for a
 182 .B udp
 183 bearer.
 184
 185 .TP
 186 .BI "localport " LOCALPORT
 187 .br
 188 Specify the local port for a
 189 .B udp
 190 bearer. The default port 6118 is used if no port is specified.
 191
 192 .TP
 193 .BI "remoteip " REMOTEIP
 194 .br
 195 Specify a remote IP for a
 196 .B udp
 197 bearer. If no remote IP is specified a
 198 .B udp
 199 bearer runs in multicast mode and tries to auto-discover its neighbours.
 200 The multicast IP address is generated based on the TIPC network ID. If a remote
 201 IP is specified the
 202 .B udp
 203 bearer runs in point-to-point mode.
 204
 205 .TP
 206 .BI "remoteport " REMOTEPORT
 207 .br
 208 Specify the remote port for a
 209 .B udp
 210 bearer. The default port 6118 is used if no port is specified.
 211
 212 .SH EXIT STATUS
 213 Exit status is 0 if command was successful or a positive integer upon failure.
 214
 215 .SH SEE ALSO
 216 .BR tipc (8),
 217 .BR tipc-link (8),
 218 .BR tipc-media (8),
 219 .BR tipc-nametable (8),
 220 .BR tipc-node (8),
 221 .BR tipc-peer (8),
 222 .BR tipc-socket (8)
 223 .br
 224 .SH REPORTING BUGS
 225 Report any bugs to the Network Developers mailing list
 226 .B <netdev@vger.kernel.org>
 227 where the development and maintenance is primarily done.
 228 You do not have to be subscribed to the list to send a message there.
 229
 230 .SH AUTHOR
 231 Richard Alpe <richard.alpe@ericsson.com>