General Properties Configuration

Get Configuration Properties

Retrieves the configuration properties for a specific configuration property group.

For information about the configuration properties that the Universal Messaging server supports, see General Properties.

Syntax

sagcc get configuration data nodeAlias Universal-Messaging-instanceName    
COMMON-SYSPROPS-propertyGroupName

Arguments and Options

nodeAlias
Required. The alias name of the installation in which the Universal Messaging server instance is installed.
Universal-Messaging-instanceName
Required. The ID of the Universal Messaging server instance for which you want to retrieve configuration property information.
COMMON-SYSPROPS-propertyGroupName
Required. The ID of the configuration type and the name of the property group for which you want to retrieve information.

Usage Notes

When the name of the property group contains two or more words, you must join each word by an underscore (_) when you specify propertyGroupName. For example, for the Cluster Config property group, you will type COMMON-SYSPROPS-Cluster_Config.

Examples

To retrieve the configuration properties for the Cluster Config property group of the server instance with ID "Universal-Messaging-umserver" installed in the installation with alias "sag01":

sagcc get configuration data sag01 Universal-Messaging-umserver    
COMMON-SYSPROPS-Cluster_Config

Update Configuration Properties

Updates the configuration properties for a specific configuration property group.

For information about the configuration properties that the Universal Messaging server supports, see General Properties.

Syntax

sagcc update configuration data nodeAlias Universal-Messaging-instanceName    
COMMON-SYSPROPS-propertyGroupName {--input|-i} file.properties

Arguments and Options

nodeAlias
Required. The alias name of the installation in which the Universal Messaging server instance is installed.
Universal-Messaging-instanceName
Required. The ID of the Universal Messaging server instance for which you want to update the configuration properties.
COMMON-SYSPROPS-propertyGroupName
Required. The ID of the configuration type and the name of the property group for which you want to update the configuration properties.
{--input|-i} file.properties
Required. The absolute path to the properties file that contains the modified configuration properties.

Usage Notes

  • When the name of the property group contains two or more words, you must join each word by an underscore (_) when you specify propertyGroupName. For example, for the Cluster Config property group, you will type COMMON-SYSPROPS-Cluster_Config.
  • Configuration parameter names are case-sensitive. For parameter values of the enumeration type, specify values ranging from 0 to n to map to the corresponding enumeration values in the Command Central user interface.
  • The sagcc update configuration data command exits and displays an error when it first meets an incorrectly defined parameter. For example, the command will exit and display an error if the MonitorTimer property has a string value.

Examples

To modify configuration properties in the Cluster Config property group for the server instance with ID "Universal-Messaging-umserevr" installed in the installation with alias "sag01", using the properties file "clusterconfig.properties":

sagcc update configuration data sag01 Universal-Messaging-umserver    
COMMON-SYSPROPS-Cluster_Config --input c:\clusterconfig.properties