File: tipc-config.8

package info (click to toggle)
tipcutils 1.0.4-5
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 220 kB
  • ctags: 211
  • sloc: ansic: 1,588; sh: 251; makefile: 59
file content (344 lines) | stat: -rw-r--r-- 10,402 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
.\" Copyright:
.\"
.\" this manpage was initially created 2006 by
.\" Martin Peylo <debian@izac.de>, based on the online help of
.\" tipc-config v1.0.1, the "TIPC Users Guide" by Allan Stephens and comments
.\" on the tipc-discussion mailinglist.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions are met:
.\"
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. Neither the names of the copyright holders nor the names of its
.\"    contributors may be used to endorse or promote products derived from
.\"    this software without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
.\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
.\" LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
.\" POSSIBILITY OF SUCH DAMAGE.
.\"
.TH TIPC-CONFIG 8 "14 Okt 2008" "Martin Peylo" "tipc-config 1.0.4"
.SH NAME
tipc-config \- TIPC configuration tool
.SH SYNOPSIS
.nf
\fBtipc-config\fP [\fB-v\fP] [\fB-i\fP] [\fB-netid\fP[=\fIvalue\fP]] [\fB-addr\fP[=\fIvalue\fP]] [\fB-be\fP=\fIbname\fP[/\fIscope\fP[/\fIpriority\fP]]] [\fB-mng\fP[=enable|disable]
.br
\fBtipc-config\fP [\fB-v\fP] [\fB-i\fP] [\fB-dest\fP=\fIaddr\fP] option [option ...]
.br
\fBtipc-config\fP option [option ...]
.br
\fBtipc-config\fP -help
.br
.SH DESCRIPTION
\fItipc-config\fP is a tool to configure and manage the TIPC kernel module.
.fi
.br

.SH CONVENTIONS
.TP
.B \fIaddr\fP
network address, specified using the syntax: Z.C.N
.PP
.TP
.B \fIbname\fP
bearer name (eg. eth:eth0)
.PP
.TP
.B \fIlname\fP
link name (eg. 1.1.10:eth3-1.1.17:eth2)
.PP

.SH GOOD TO KNOW
.TP
\fItipc-config\fP processes options in the order they are given. The options \fB-v\fP and \fB-i\fP add their functionality to each of the other given options.
.br
For example the comandline
.br
\fItipc-config\fP -v -i -netid=4711 -addr=1.2.3
.br
is processed as if the following two comandlines would be given:
.br
\fItipc-config\fP -v -i -netid=4711
.br
\fItipc-config\fP -v -i -addr=1.2.3
.PP
.TP
Some of the options of \fItipc-config\fP set other options to default values if they were not set before.
.br
For example the network ID is set to default value if it is not set before the network address.
.PP
.TP
All options can be abbreviated as long as they aren\'t ambiguous.
.br
For example \fB-addr\fP can be abbreviated to \fB-ad\fP or \fB-a\fP, and \fB-log\fP can be abbreviated to \fB-lo\fP
(but not \fB-l\fP, since this is the full name of a different option).
.PP


.SH OPTIONS
\fItipc-config\fP understands the following command line options:
.TP
.B -v
Print verbose messages
.PP
.TP
.B -i
Enable "interactive" mode: prompt for confirmation before attempting to change the configuration of TIPC.
.PP
.TP
.B -help
Print usage listing
.PP
.TP
.B -dest=\fIaddr\fP
Redirect configuration options to the specified node. (Note that some options will be refused if requested remotely.)
.PP
.TP
.B -addr[=\fIaddr\fP]
Set the network address of the node
.br
If \fIaddr\fP is omitted, the current network address is displayed.
.br
Setting the network address without setting the network ID before sets the network ID to the default value.
.PP
.TP
.B -netid[=\fIvalue\fP]
Set the network ID of the node to \fIvalue\fP; if \fIvalue\fP is omitted, the current network address is displayed.
.br
The network ID is set to the default value if it is not set before the network address.
.br
This option makes it possible to define private clusters on a LAN whose nodes will not interact with each other. This parameter is set to a default value if not set before the network address.
.PP
.TP
.B -mng[=enable|disable]
Allow or disallow remote management of the node.
.br
If no value is given, the current remote management status is displayed.
.PP
.TP
.B -nt[=[\fIdepth\fP,]\fItype\fP[,\fIlow\fP[,\fIup\fP]]]
Displays the requested name table information known by TIPC on the node.

.PP
.RS
.PD 0
Specify \fIdepth\fP to control how much info is displayed:
.RS
.TP
\fBtypes\fP
type info only
.TP
\fBnames\fP
type and instance info (i.e. name info)
.TP
\fBports\fP
type, instance, and port info
.TP
\fBall\fP
type, instance, port, and publication info
.RE
.PP
If \fIdepth\fP is omitted, all info is displayed.
.RE
.PD 1

.PP
.RS
.PD 0
Specify \fItype\fP,\fIlow\fP,\fIup\fP to control which name table entries are displayed:
.RS
.TP
\fItype\fP
all entries for the specified type
.TP
\fItype\fP,\fIlow\fP
all entries overlapping the specified name
.TP
\fItype\fP,\fIlow\fP,\fIup\fP
all entries overlapping the specified name sequence
.RE
.PP
If \fItype\fP is omitted, all name table entries are displayed.
.RE
.PD 1

.PP
.TP
.B -p
List all ports known by TIPC on the node.
.PP
.TP
.B -ps=\fIport\fP
Get port statistics
.PP
.TP
.B -psr=\fIport\fP
Reset port statistics.
.PP
.TP
.B -m
List all media known by TIPC on the node.
.PP
.TP
.B -b
List all bearers known by TIPC on the node.
.PP
.TP
.B -be=\fIbname\fP[/\fIscope\fP[/\fIpriority\fP]]]
Enable the specified bearer by having TIPC attach to the interface \fIbname\fP.
.PP
.RS
The bearer name has the form \fImedia\fP:\fIifname\fP, denoting the media type used by the interface and the interface's name. (For example, "eth:eth0".) Once enabled, TIPC starts broadcasting messages to detect other nodes in the network.
.PP
The optional \fIscope\fP value is of type \fIaddr\fP and specifes a "neighbour detection domain" which restricts the set of nodes that TIPC will automatically set up links to. For example, <0.0.0> (the default) means that TIPC should contact all nodes it can find, <1.1.0> tells TIPC to only look for nodes within cluster <1.1>.
.PP
More than one interface may be enabled at a time by specifing multiple bearers in a comma separated list (e.g. \fB-be\fP=eth:eth0,eth:eth1).
.RE
.PP
.TP
.B -bd=\fIbname\fP
Disable the specified bearer.
.PP
.RS
More than one interface may be enabled at a time by specifing multiple bearers in a comma separated list (e.g. \fB-bd\fP=eth:eth0,eth:eth1).
.PP
An "\fI?\fP" is used as wildcard. For example:
.br
\fItipc-config\fP -bd=?        [disable all bearers]
.br
\fItipc-config\fP -bd=?eth:    [disable all Ethernet bearers]
.RE
.PP
.TP
.B -n[=\fIaddr\fP]
List all nodes known by the node within the specified network domain. If
\fIaddr\fP is omitted, the domain <0.0.0> (i.e. the entire network) is used.
.PP
.TP
.B -l[=\fIaddr\fP]
List all links used by the node within the specified network domain. If
\fIaddr\fP is omitted, the domain <0.0.0> (i.e. the entire network) is used.
.PP
.TP
.B -ls=\fIlinkname\fP
Display status and statistics information about the specified link.
.PP
.RS
An "\fI?\fP" is used as wildcard. For example:
.br
\fItipc-config\fP -ls          [get stats for all links]
.br
\fItipc-config\fP -ls=?        [get stats for all links]
.br
\fItipc-config\fP -ls=?eth:    [get stats for all links Ethernet bearers]
.br
\fItipc-config\fP -ls=?-1.1.3: [get stats for all links to node <1.1.3>]
.RE
.PP
.TP
.B -lsr=\fIlinkname\fP
Reset the statistics counters for the specified link.
.PP
.TP
.B -lp=\fIlinkname\fP/\fIval\fP
Sets the priority of the specified link to \fIvalue\fP.
.PP
.TP
.B -lw=\fIlinkname\fP/\fIval\fP
Sets the window of the specified link to \fIvalue\fP messages.
.PP
.TP
.B -lt=\fIlinkname\fP/\fIval\fP
Sets the tolerance of the specified link to \fIvalue\fP milliseconds.
.PP
.TP
.B -max_ports[=\fIvalue\fP]
Sets the maximum number of ports allowed by the node to \fIvalue\fP; if \fIvalue\fP is omitted, the current setting is displayed.
.PP
.TP
.B -max_publ[=\fIvalue\fP]
Sets the maximum number of publications allowed by the node to \fIvalue\fP; if \fIvalue\fP is omitted, the current setting is displayed.
.PP
.TP
.B -max_subscr[=\fIvalue\fP]
Sets the maximum number of subscriptions allowed by the node to \fIvalue\fP; if \fIvalue\fP is omitted, the current setting is displayed.
.PP
.TP
.B -max_zones[=\fIvalue\fP]
Sets the largest allowed zone number allowed by the node to \fIvalue\fP; if \fIvalue\fP is omitted, the current setting is displayed.
.PP
.TP
.B -max_clusters[=\fIvalue\fP]
Currently unsupported.
.PP
.TP
.B -max_nodes[=\fIvalue\fP]
Sets the largest allowed node number allowed by the node to \fIvalue\fP; if \fIvalue\fP is omitted, the current setting is displayed.
.PP
.TP
.B -max_slaves[=\fIvalue\fP]
Currently unsupported.
.PP
.TP
.B -log[=\fIsize\fP]
Sets the size of TIPC's system log to the specified number of bytes. If \fIsize\fP is omitted, the contents of the system log are displayed and the log is reset to empty.
.PP
.br

.SH EXAMPLES
.TP
.B tipc-config -netid=1234 -addr=1.1.1 -be=eth:eth0
Set up TIPC with network id 1234 and address 1.1.1 on eth0
.PP
.TP
.B tipc-config -nt
Display the name table
.PP
.br

.SH KNOWN LIMITATIONS
.TP
A TIPC node can not change following settings once set up
\fB-netid\fP=\fIvalue\fP network id
.br
\fB-addr\fP=\fIvalue\fP node address
.PP
.TP
There is no way to unconfigure a TIPC node once set up other than unloading the kernel module.
.PP
.br

.SH KNOWN BUGS
.TP
none
.PP
.br

.SH AUTHOR
\fItipc-config\fP was written by:
.RS
Jon Maloy <Jon.Maloy@ericsson.com>
.br
Allan Stephens <allan.stephens@windriver.com>
.br
Per Linden <per.liden@ericsson.com>
.RE
.PP
The homepage of the TIPC project is http://tipc.sourceforge.net
.PP
This manual page was initially created by Martin Peylo <debian@izac.de> for the Debian Project based on the TIPC Users Guide by \fBAllan Stephens\fP, but may be used by others.
.br