]>
Commit | Line | Data |
---|---|---|
dcd8d142 RA |
1 | .TH TIPC-BEARER 8 "02 Jun 2015" "iproute2" "Linux" |
2 | ||
85e3c87c VS |
3 | .\" For consistency, please keep padding right aligned. |
4 | .\" For example '.B "foo " bar' and not '.B foo " bar"' | |
dcd8d142 RA |
5 | |
6 | .SH NAME | |
7 | tipc-bearer \- show or modify TIPC bearers | |
8 | ||
9 | .SH SYNOPSIS | |
10 | .ad l | |
11 | .in +8 | |
12 | ||
f1f40cf7 RA |
13 | .ti -8 |
14 | .B tipc bearer add media udp name | |
15 | .IB "NAME " "remoteip " REMOTEIP | |
16 | .br | |
17 | ||
dcd8d142 RA |
18 | .ti -8 |
19 | .B tipc bearer enable | |
20 | .RB "[ " domain | |
21 | .IR DOMAIN " ]" | |
22 | .RB "[ " priority | |
23 | .IR PRIORITY " ]" | |
24 | .BR media | |
25 | .br | |
26 | .RB "{ { " eth " | " ib " } " device | |
27 | .IR "DEVICE" " }" | |
28 | .RB "|" | |
29 | .br | |
30 | .RB "{ " udp | |
31 | .B name | |
32 | .IR NAME | |
33 | .B localip | |
34 | .IR LOCALIP | |
35 | .RB "[ " localport | |
36 | .IR LOCALPORT " ]" | |
37 | .RB "[ " remoteip | |
38 | .IR REMOTEIP " ]" | |
39 | .RB "[ " remoteport | |
40 | .IR REMOTEPORT " ] }" | |
41 | .br | |
42 | ||
43 | .ti -8 | |
44 | .B tipc bearer disable media | |
45 | .br | |
46 | .RB "{ { " eth " | " ib " } " device | |
ff775579 | 47 | .IR "DEVICE " } |
dcd8d142 RA |
48 | .RB "|" |
49 | .br | |
50 | .RB "{ " udp | |
51 | .B name | |
ff775579 | 52 | .IR NAME " }" |
dcd8d142 RA |
53 | .br |
54 | ||
55 | .ti -8 | |
56 | .B tipc bearer set | |
57 | .RB "{ " "priority " | |
58 | .IR PRIORITY | |
59 | .RB "| " tolerance | |
60 | .IR TOLERANCE | |
61 | .RB "| " window | |
62 | .IR WINDOW | |
63 | .RB "} " media | |
64 | .br | |
65 | .RB "{ { " eth " | " ib " } " device | |
66 | .IR "DEVICE" " }" | |
67 | .RB "|" | |
68 | .br | |
69 | .RB "{ " udp | |
70 | .B name | |
ff775579 | 71 | .IR NAME " }" |
dcd8d142 RA |
72 | .br |
73 | ||
74 | .ti -8 | |
75 | .B tipc bearer get | |
ed81deab | 76 | .RB "[ " "priority" " | " tolerance " | " window " ] " media |
dcd8d142 RA |
77 | .br |
78 | .RB "{ { " eth " | " ib " } " device | |
79 | .IR "DEVICE" " }" | |
80 | .RB "|" | |
81 | .br | |
82 | .RB "{ " udp | |
83 | .B name | |
ed81deab RA |
84 | .IR NAME |
85 | .RB "[ " "localip " "| " "localport " "| " "remoteip " "| " "remoteport " "] }" | |
dcd8d142 RA |
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 | ||
f1f40cf7 RA |
205 | Multiple |
206 | .B remoteip | |
207 | addresses can be added via the | |
208 | .B bearer add | |
209 | command. Adding one or more unicast | |
210 | .B remoteip | |
211 | addresses to an existing | |
212 | .B udp | |
213 | bearer puts the bearer in replicast mode where IP | |
214 | multicast is emulated by sending multiple unicast messages to each configured | |
215 | .B remoteip. | |
216 | When a peer sees a TIPC discovery message from an unknown peer the peer address | |
217 | is automatically added to the | |
218 | .B remoteip | |
219 | (replicast) list, thus only one side of | |
220 | a link needs to be manually configured. A | |
221 | .B remoteip | |
222 | address cannot be added to a multicast bearer. | |
223 | ||
dcd8d142 RA |
224 | .TP |
225 | .BI "remoteport " REMOTEPORT | |
226 | .br | |
227 | Specify the remote port for a | |
228 | .B udp | |
229 | bearer. The default port 6118 is used if no port is specified. | |
230 | ||
231 | .SH EXIT STATUS | |
232 | Exit status is 0 if command was successful or a positive integer upon failure. | |
233 | ||
234 | .SH SEE ALSO | |
235 | .BR tipc (8), | |
236 | .BR tipc-link (8), | |
237 | .BR tipc-media (8), | |
238 | .BR tipc-nametable (8), | |
239 | .BR tipc-node (8), | |
535194a1 | 240 | .BR tipc-peer (8), |
dcd8d142 RA |
241 | .BR tipc-socket (8) |
242 | .br | |
243 | .SH REPORTING BUGS | |
244 | Report any bugs to the Network Developers mailing list | |
245 | .B <netdev@vger.kernel.org> | |
246 | where the development and maintenance is primarily done. | |
247 | You do not have to be subscribed to the list to send a message there. | |
248 | ||
249 | .SH AUTHOR | |
250 | Richard Alpe <richard.alpe@ericsson.com> |