41.8 IceStorm Administration

The IceStorm administration tool is a command-line program that provides administrative control of an IceStorm server. The tool requires that the IceStormAdmin.TopicManager.Default property be specified as described in Section 41.12.4.

The following command-line options are supported:

$ icestormadmin ‑h
Usage: icestormadmin [options] [file...]
Options:
‑h, ‑‑help Show this message.
‑v, ‑‑version Display the Ice version.
‑DNAME Define NAME as 1.
‑DNAME=DEF Define NAME as DEF.
‑UNAME Remove any definition for NAME.
‑IDIR Put DIR in the include file search path.
‑e COMMANDS Execute COMMANDS.
‑d, ‑‑debug Print debug messages.

The tool operates in three modes, depending on the command-line arguments:

1. If one or more ‑e options are specified, the tool executes the given commands and exits.

2. If one or more files are specified, the tool preprocesses each file with the C preprocessor, executes the commands in each file, and exits.

3. Otherwise, the tool enters an interactive session.

The help command displays the following usage information:

help

Print this message.

exit, quit

Exit this program.

create TOPICS

Add TOPICS.

destroy TOPICS

Remove TOPICS.

link FROM TO [COST]

Link FROM to TO with the optional COST.

unlink FROM TO

Unlink TO from FROM.

links [INSTANCE-NAME]

Without an argument, links displays the links of all topics in the current topic manager. You can specify a different topic manager by providing its instance name.

topics [INSTANCE-NAME]

Without an argument, topics displays the names of all topics in the current topic manager. You can specify a different topic manager by providing its instance name.

current [INSTANCE‑NAME]

Set the current topic manager to the topic manager with instance name INSTANCE-NAME. The proxy of the corresponding topic manager must be specified by setting an IceStormAdmin.TopicManager.name property. Without an argument, the command shows the current topic manager.

replica [INSTANCE‑NAME]

Display replication information for the given INSTANCE-NAME. See Section 41.7.2 for more details on this command.

Some of the commands accept one or more topic names (TOPICS) as arguments. Topic names containing white space or matching a command keyword must be enclosed in single or double quotes.

By default, icestormadmin uses the topic manager specified by the setting of the IceStorm.TopicManager.Default property, which specifies the proxy for the topic manager. For example, without additional arguments, the create command operates on that topic manager.

If you are using multiple topic managers, you can specify the proxies by setting the property IceStorm.TopicManager.name for each topic manager. For example:

IceStormAdmin.TopicManager.A=A/TopicManager:tcp -h x -p 9995
IceStormAdmin.TopicManager.B=Foo/TopicManager:tcp -h x -p 9996
IceStormAdmin.TopicManager.C=Bar/TopicManager:tcp -h z -p 9995

This sets the proxies for three topic managers. Note that name need not match the instance name of the corresponding topic manager—name simply serves as a tag. With these property settings, the icestormadmin commands that accept a topic can now specify a topic manager other than the default topic manager that is configured with IceStormAdmin.TopicManager.Default. For example:

current Foo
create myTopic
create Bar/myOtherTopic

This sets the current topic manager to the one with instance name Foo; the first create command then creates the topic within that topic manager, whereas the second create command uses the topic manager with instance name Bar.