Zone Configuration Commands
Ensure that the Universal Messaging server instances are running before running the following commands.
Retrieve zone configuration information for a
Universal Messaging server instance using the
sagcc get configuration data node_alias Universal-Messaging-umserver UM-ZONE command.
Create a zone using the
sagcc create configuration data node_alias Universal-Messaging-umserver UM-ZONE -i=path to the XML file containing the zone configuration command.
Note: Provide the absolute path to the XML file if the XML file is not in the same directory from which the command is run.
Update a zone using the
sagcc update configuration data node_alias Universal-Messaging-umserver UM-ZONE -i=path to the XML file containing the updated zone configuration command.
Note: Provide the absolute path to the XML file if the XML file is not in the same directory from which the command is run.
Delete a zone using the
sagcc delete configuration data node_alias Universal-Messaging-umserver UM-ZONE command. The delete command deletes the zone in which
umserver belongs. You can remove specific server instances from a zone by removing the server instances in the updated zone configuration XML file, and then using the update zone command.
Examples
To retrieve zone configuration information for a
Universal Messaging server instance:
sagcc get configuration data sag01 Universal-Messaging-umserver UM-ZONE
sag01 is the alias name of the installation where Universal-Messaging-umserver server instance is running. UM-ZONE is the configuration type for zones.
To create a zone:
sagcc create configuration data sag01 Universal-Messaging-umserver UM-ZONE
-i=C:\zones\zone_create.xml
sag01 is the alias name of the installation where Universal-Messaging-umserver server instance is running. UM-ZONE is the configuration type for zones. And, c:\zones\zones_create.xml is the absolute path to the location where the zone configuration XML file is located.
Format of the zone_create.xml file for zone with realms:
<?xml version="1.0" encoding="UTF-8"?>
<Zone>
<name>RealmZone</name>
<type>Realm</type>
<realms>
<server name="um_realm1">
<url>nsp://localhost:9701</url>
</server>
<server name="um_realm2">
<url>nsp://localhost:9702</url>
</server>
</realms>
<clusters/>
</Zone>
Format of the zone_create.xml file for a zone with clusters:
<?xml version="1.0" encoding="UTF-8"?>
<Zone>
<name>ClusterZone</name>
<type>Cluster</type>
<realms />
<clusters>
<server name="um_cluster1">
<url>nsp://localhost:9704</url>
<clusterName />
<status />
</server>
<server name="um_cluster2">
<url>nsp://localhost:9705</url>
<clusterName />
<status />
</server>
</clusters>
</Zone>
To update a zone:
sagcc update configuration data sag01 Universal-Messaging-umserver UM-ZONE
-i=C:\zones\zone_update.xml
sag01 is the alias name of the installation where Universal-Messaging-umserver server instance is running. UM-ZONE is the configuration type for zones. And, c:\zones\zone_update.xml is the absolute path to the location where the zone configuration XML file is located.
Note: zone_update.xml file should be in the same format as the XML file used to create zones. You can substitute the updated configuration values in place of the old values.
To delete a zone:
sagcc delete configuration data local Universal-Messaging-umserver UM-ZONE
sag01 is the alias name of the installation where Universal-Messaging-umserver server instance is running. UM-ZONE is the configuration type for zones.