User Configuration Commands
You can perform the following user configuration tasks on a Universal Messaging server instance from the command line interface:
List the path and the users existing in the user repository using the
sagcc get configuration instances node_alias Universal-Messaging-umserver command.
Retrieve information about a specific user using the
sagcc get configuration instances node_alias Universal-Messaging-umserver COMMON-LOCAL-USERS-user name command.
Add new users to the user repository using the
sagcc create configuration data node_alias Universal-Messaging-umserver COMMON-LOCAL-USERS --input absolute path to the XML file containing the user ID and password command.
Update or change the password of an existing user using the
sagcc update configuration data node_alias Universal-Messaging-umserver COMMON-LOCAL-USERS-user name --input absolute path to the XML file containing new password command.
Delete existing users from the user repository using the
sagcc delete configuration data node_alias Universal-Messaging-umserver COMMON-LOCAL-USERS-user name command.
Information to authenticate the users of a Universal Messaging server instance is stored in the user repository (users.txt file) of the Universal Messaging server instance. The users.txt file is generated only after you create a new internal user. While creating the user repository, if you specify a relative path in the jaas.conf file, the users.txt file will be created in a directory relative to the bin directory of the Universal Messaging server instance.
The path to the users.txt file is added in the jaas.conf file present in <InstallDir>/UniversalMessaging/server/<InstanceName>/bin/jaas.conf. If you specify a relative path in the jaas.conf file, the users.txt file will be created in a directory relative to the bin directory of the Universal Messaging server instance.
Examples
To list the path of the user repository and the users of a
Universal Messaging server instance:
sagcc get configuration instances sag01 Universal-Messaging-umserver
where umserver is the name of the Universal Messaging server instance and sag01 is the alias name of the installation where umserver is running.
To retrieve information of a
Universal Messaging server instance user:
sagcc get configuration instances sag01 Universal-Messaging-umserver
COMMON-LOCAL-USERS-user1
where umserver is the name of the Universal Messaging server instance, sag01 is the alias name of the installation where umserver is running, and user1 is the user ID of the user.
To add a user to a
Universal Messaging server instance:
sagcc create configuration data sag01 Universal-Messaging-umserver
COMMON-LOCAL-USERS --input c:\inputxmls\user2.xml
where umserver is the name of the Universal Messaging server instance, sag01 is the alias name of the installation where umserver is running, and user2.xml is file that contains the user ID and the password of the new user.
The user2.xml file has the following format:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<User id="user2">
<Password>test</Password>
</User>
To update the password of a
Universal Messaging server instance user:
sagcc update configuration data sag01 Universal-Messaging-umserver
COMMON-LOCAL-USERS-user2 --input c:\inputxmls\user2.xml
where umserver is the name of the Universal Messaging server instance, sag01 is the alias name of the installation where umserver is running, and user2.xml is the file that contains the new password of the specified user.
To delete a
Universal Messaging server instance user:
sagcc delete configuration data sag01 Universal-Messaging-umserver
COMMON-LOCAL-USERS-user2
where umserver is the name of the Universal Messaging server instance and sag01 is the alias name of the installation where umserver is running.