Universal Messaging 10.3 | Administration Guide | Command Line Administration Tools | Syntax reference for command line tools | Syntax: Zone Tools
 
Syntax: Zone Tools
AddMemberToZone

Tool name:
AddMemberToZone

Description:
Adds a realm to a specified realm's zone.

Usage:
runUMTool AddMemberToZone -rname=<rname> -zonememberrname=<zonememberrname>
[optional_args]

Examples:
AddMemberToZone -rname=nsp://localhost:8080 -zonememberrname=nsp://localhost:9090

Required arguments:

rname :
URL of the realm you want to add to the zone.

zonememberrname :
URL of a realm in the zone you want to expand.

Optional Parameters:

username :
Your Universal Messaging server username.

password :
Your Universal Messaging server password.
CreateZone

Tool name:
CreateZone

Description:
Creates a zone with the specified name containing the specified realms.

Usage:
runUMTool CreateZone -rnames=<rnames> -zonename=<zonename> [optional_args]

Examples:
CreateZone -rnames=nsp://localhost:8080,nsp://localhost:9090 -zonename=zone0

Required arguments:

rnames :
Comma separated list of URLs of the realms which the zone will contain.

zonename :
Name of the zone to be created.

Optional Parameters:

username :
Your Universal Messaging server username.

password :
Your Universal Messaging server password.
DeleteZone

Tool name:
DeleteZone

Description:
Deletes a zone with the specified name on the specified realm.

Usage:
runUMTool DeleteZone -rname=<rname> [optional_args]

Examples:
DeleteZone -rname=nsp://localhost:8080
DeleteZone -rname=nsp://localhost:8080 -removejoins=true

Required arguments:

rname :
URL of a realm which belongs to the zone to be deleted.

Optional Parameters:

removejoins :
Whether to remove intra-zone connections when the zone
is deleted. Defaults to false.

username :
Your Universal Messaging server username.

password :
Your Universal Messaging server password.
RemoveMemberFromZone

Tool name:
RemoveMemberFromZone

Description:
Removes a realm from its current zone.

Usage:
runUMTool RemoveMemberFromZone -rname=<rname> [optional_args]

Examples:
RemoveMemberFromZone -rname=nsp://localhost:8080
RemoveMemberFromZone -rname=nsp://localhost:8080 -removejoins=true

Required arguments:

rname :
URL of the realm you want to remove from the zone.

Optional Parameters:

removejoins :
Whether or not to remove realm links with the former zone member.

username :
Your Universal Messaging server username.

password :
Your Universal Messaging server password.