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 defined, as in the IceStorm server configuration.
The following command-line options are supported:
$ icestormadmin -h Usage: icestormadmin [options] Options: -h, --help Show this message. -v, --version Display the Ice version. -e COMMANDS Execute COMMANDS. -d, --debug Print debug messages.
If one or more -e
options are specified, the tool executes the given commands and exits, 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
AddTOPICS
.
destroy TOPICS
RemoveTOPICS
.
link
FROM TO
[COST]
LinkFROM
toTO
with the optionalCOST
.
unlink
FROM TO
UnlinkTO
fromFROM
.
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 nameINSTANCE-NAME
. The proxy of the corresponding topic manager must be specified by setting anIceStormAdmin.TopicManager.name
property. Without an argument, the command shows the current topic manager.
replica
[INSTANCE-NAME]
Display replication information for the givenINSTANCE-NAME
.
subscribers TOPICS
Displays the identities of the subscribers for each of theTOPICS
.
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 IceStormAdmin.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 IceStormAdmin.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
.
See Also