SYNOPSIS

tipc-config [-v] [-i] [-netid[=value]] [-addr[=value]] [-be=bname[/scope[/priority]]] [-mng[=enable|disable]
tipc-config [-v] [-i] [-dest=addr] option [option ...]
tipc-config option [option ...]
tipc-config -help

DESCRIPTION

tipc-config is a tool to configure and manage the TIPC kernel module.

CONVENTIONS

addr

network address, specified using the syntax: Z.C.N

bname

bearer name (eg. eth:eth0)

lname

link name (eg. 1.1.10:eth3-1.1.17:eth2)

GOOD TO KNOW

tipc-config processes options in the order they are given. The options -v and -i add their functionality to each of the other given options.

For example the comandline
tipc-config -v -i -netid=4711 -addr=1.2.3
is processed as if the following two comandlines would be given:
tipc-config -v -i -netid=4711
tipc-config -v -i -addr=1.2.3

Some of the options of tipc-config set other options to default values if they were not set before.

For example the network ID is set to default value if it is not set before the network address.

All options can be abbreviated as long as they aren't ambiguous.

For example -addr can be abbreviated to -ad or -a, and -log can be abbreviated to -lo (but not -l, since this is the full name of a different option).

OPTIONS

tipc-config understands the following command line options:

-v

Print verbose messages

-i

Enable "interactive" mode: prompt for confirmation before attempting to change the configuration of TIPC.

-help

Print usage listing

-dest=addr

Redirect configuration options to the specified node. (Note that some options will be refused if requested remotely.)

-addr[=addr]

Set the network address of the node
If addr is omitted, the current network address is displayed.
Setting the network address without setting the network ID before sets the network ID to the default value.

-netid[=value]

Set the network ID of the node to value; if value is omitted, the current network address is displayed.
The network ID is set to the default value if it is not set before the network address.
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.

-mng[=enable|disable]

Allow or disallow remote management of the node.
If no value is given, the current remote management status is displayed.

-nt[=[depth,]type[,low[,up]]]

Displays the requested name table information known by TIPC on the node.

Specify depth to control how much info is displayed:

types

type info only

names

type and instance info (i.e. name info)

ports

type, instance, and port info

all

type, instance, port, and publication info

If depth is omitted, all info is displayed.

Specify type,low,up to control which name table entries are displayed:

type

all entries for the specified type

type,low

all entries overlapping the specified name

type,low,up

all entries overlapping the specified name sequence

If type is omitted, all name table entries are displayed.

-p

List all ports known by TIPC on the node.

-ps=port

Get port statistics

-psr=port

Reset port statistics.

-m

List all media known by TIPC on the node.

-b

List all bearers known by TIPC on the node.

-be=bname[/scope[/priority]]]

Enable the specified bearer by having TIPC attach to the interface bname.

The bearer name has the form media:ifname, 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.

The optional scope value is of type addr 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>.

More than one interface may be enabled at a time by specifing multiple bearers in a comma separated list (e.g. -be=eth:eth0,eth:eth1).

-bd=bname

Disable the specified bearer.

More than one interface may be enabled at a time by specifing multiple bearers in a comma separated list (e.g. -bd=eth:eth0,eth:eth1).

An "?" is used as wildcard. For example:
tipc-config -bd=? [disable all bearers]
tipc-config -bd=?eth: [disable all Ethernet bearers]

-n[=addr]

List all nodes known by the node within the specified network domain. If addr is omitted, the domain <0.0.0> (i.e. the entire network) is used.

-l[=addr]

List all links used by the node within the specified network domain. If addr is omitted, the domain <0.0.0> (i.e. the entire network) is used.

-ls=linkname

Display status and statistics information about the specified link.

An "?" is used as wildcard. For example:
tipc-config -ls [get stats for all links]
tipc-config -ls=? [get stats for all links]
tipc-config -ls=?eth: [get stats for all links Ethernet bearers]
tipc-config -ls=?-1.1.3: [get stats for all links to node <1.1.3>]

-lsr=linkname

Reset the statistics counters for the specified link.

-lp=linkname/val

Sets the priority of the specified link to value.

-lw=linkname/val

Sets the window of the specified link to value messages.

-lt=linkname/val

Sets the tolerance of the specified link to value milliseconds.

-max_ports[=value]

Sets the maximum number of ports allowed by the node to value; if value is omitted, the current setting is displayed.

-max_publ[=value]

Sets the maximum number of publications allowed by the node to value; if value is omitted, the current setting is displayed.

-max_subscr[=value]

Sets the maximum number of subscriptions allowed by the node to value; if value is omitted, the current setting is displayed.

-max_zones[=value]

Sets the largest allowed zone number allowed by the node to value; if value is omitted, the current setting is displayed.

-max_clusters[=value]

Currently unsupported.

-max_nodes[=value]

Sets the largest allowed node number allowed by the node to value; if value is omitted, the current setting is displayed.

-max_slaves[=value]

Currently unsupported.

-log[=size]

Sets the size of TIPC's system log to the specified number of bytes. If size is omitted, the contents of the system log are displayed and the log is reset to empty.

EXAMPLES

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

tipc-config -nt

Display the name table

KNOWN LIMITATIONS

A TIPC node can not change following settings once set up

-netid=value network id
-addr=value node address

There is no way to unconfigure a TIPC node once set up other than unloading the kernel module.

KNOWN BUGS

none

AUTHOR

tipc-config was written by:

Jon Maloy <[email protected]>
Allan Stephens <[email protected]>
Per Linden <[email protected]>

The homepage of the TIPC project is http://tipc.sourceforge.net

This manual page was initially created by Martin Peylo <[email protected]> for the Debian Project based on the TIPC Users Guide by Allan Stephens, but may be used by others.