Tool name:
AddInterfaceOffline

Description:
Adds a new interface to an offline realm.

Usage:
runUMTool AddInterfaceOffline -dirname=<dirname> -protocol=<protocol>
-adapter=<adapter> -port=<port> [optional_args]

Examples:
AddInterfaceOffline -dirname=~/realmDirectories/realm0/data/ -protocol=socket
-adapter=0.0.0.0 -port=11000

Required arguments:

dirname :
Data directory of the realm to add interface to.

protocol :
Protocol for the interface to use.

adapter :
Adapter the interface wants setting to.

port :
Port that the interface will listen on.

Optional Parameters:

interface :
Name of the interface to be created.

autostart :
Whether or not the interface should be autostarted when the realm
starts.

canadvertise :
Whether or not the interface will be advertised.

authtimeout :
Number of milliseconds for authorisation timeout.

interrealm :
Whether or not this interface should be used for inter-realm
communication.

clientconnections :
Whether or not this interface should be used for client
connections.

username :
Your Universal Messaging server username.

password :
Your Universal Messaging server password.

Tool name:
DeleteInterfaceOffline

Description:
Removes an interface from an offline realm using config data.

Usage:
runUMTool DeleteInterfaceOffline -dirname=<dirname> -interface=<interface>
[optional_args]

Examples:
DeleteInterfaceOffline -dirname=~/realmDirectories/realm0/data/ -interface=nhp0

Required arguments:

dirname :
Data directory of the realm to dump interfaces for.

interface :
Name of the interface to be removed.

Optional Parameters:

username :
Your Universal Messaging server username.

password :
Your Universal Messaging server password.

Tool name:
DumpInterfacesOffline

Description:
Dumps the list of interfaces for a specified offline realm.

Usage:
runUMTool DumpInterfacesOffline -dirname=<dirname> [optional_args]

Examples:
DumpInterfacesOffline -dirname=~/realmDirectories/realm0/data/

Required arguments:

dirname :
Data directory of the realm to dump interfaces for.

Optional Parameters:

username :
Your Universal Messaging server username.

password :
Your Universal Messaging server password.

Tool name:
ModifyInterfaceOffline

Description:
Modifies and interface of an offline realm.

Usage:
runUMTool ModifyInterfaceOffline -dirname=<dirname> -interface=<interface>
[optional_args]

Examples:
ModifyInterfaceOffline -dirname=~/realmDirectories/realm0/data/
-interface=nhp0 -port=11000

Required arguments:

dirname :
Data directory of the realm to dump interfaces for.

interface :
Name of the interface to be modified.

Optional Parameters:

adapter :
Adapter the interface wants setting to.

port :
Port that the interface will be set to.

autostart :
Whether or not the interface should be autostarted when the
realm starts.

canadvertise :
Whether or not the interface will be advertised.

authtimeout :
Number of milliseconds for authorisation timeout.

interrealm :
Whether or not this interface should be used for inter-realm
communication.

clientconnections :
Whether or not this interface should be used for client
connections.

username :
Your Universal Messaging server username.

password :
Your Universal Messaging server password.

Tool name:
ModifyPrimeFlagOffline

Description:
Modifies the prime flag of a site while a realm is offline.

Usage:
runUMTool ModifyPrimeFlagOffline -datadirectory=<datadirectory> [optional_args]

Examples:
ModifyPrimeFlagOffline -datadirectory=~/realmDirectories/realm0/data/
(This will show current state of prime flag per cluster sites)

ModifyPrimeFlagOffline -datadirectory=~/realmDirectories/realm0/data/
-Site1=true -Site2=false
(This will set prime flag to true on site1 and to false on site 2 in
directory ~/realmDirectories/realm0/data/ )


Required arguments:

datadirectory :
Data directory of the realm to be modified.

Optional Parameters:

force :
Skip confirmation step before modifying cluster sites.

NOTE - if you want to edit the prime flag for sites inside a cluster you need to
specify it like an optional parameter :
-<site_name>=<new_value>.
You need to specify the value of the flag for all sites inside the cluster.
For example, if you want to set the prime flag to true on Site1 and you have
another site called Site2, the optional parameter will look like :
-Site1=true -Site2=false

username :
Your Universal Messaging server username.

password :
Your Universal Messaging server password.