Table of Contents

Name

cmconfig - perform database configuration operations

Synopsis

cmconfig [-i] [-AlqV] [-L licenseString] [-a archiveDir] [-C megabytes] [-d dbDir]
cmconfig [-ip] [-lqV] [-h host] [-M size] [-C megabytes]

Description

cmconfig performs SnapshotCM database and server configuration operations. cmconfig configures both the SnapshotCM Repository Server database and server, and the SnapshotCM Proxy Server cache and server. cmconfig operates directly upon the database files so the server must not be running.

Use cmconfig to set the location where archive files are stored (repository server only), set the location where database files are located, configure the repository host (proxy server only), configure the cache size (proxy server only), configure the size of the database cache, reset the administrator account access and password in case administrator access is accidentally deleted (repository server only), and to install a new license into the repository database.

The only permission needed to run cmconfig is operating system access to the database and configuration files themselves. For this reason, it is important to exercise appropriate caution that the database and configuration files are appropriately protected from unauthorized access.

Options

-A
Reset the administrator account name, disable trusted access for the administrator account, set a new password and modify the server access control list (ACL) to give the administrator account permission to modify the server ACL. Repository server only option.
-apath
Specify the path prefix for storing archive files. Do not modify this path without also moving the archive files. Repository server only option.
-cKilobytes
-CMegabytes
Set the size of the server database memory cache. A larger cache generally results in better performance. Allocating 10 to 100 megabytes memory, depending on the size of your database and hosting machine, is not unreasonable.

Note: Memory for the cache is allocated only as needed. The actual memory used may be less than configured.

-dpath
Specify the directory holding the database. Do not modify this path without also moving the database files.
-hhost
Specify the repository server for which the proxy server will cache revisions. Once a proxy cache is used with a given repository, it cannot later be used with a different repository. The host field can be changed if the repository server is moved. However, if the repository is a different repository than initially used, the proxy server will refuse to run until the cache is reinitialized.
-i
-ip
Initialize new database files in the directory specified by the -d option, else the current directory. Use -i to initialize a repository server and -ip to initialize a proxy server database. If any database files are present, the command will fail. The database directory should be empty before running this command. The database directory should not be used for any other purpose.
-L licenseString
Install a new license into the database. Repository server only option.
-l
List the current configuration variables.
-Msize
Specify the maximum megabytes to keep in the revision cache. Proxy server only option.
-q
Quiet mode. Do not display informational messages on success.
-V
Print internal version.

Return Value

Exit status is 0 if the operation succeeded, 1 if there was an error performing the operation, and 2 if there was a bad option.

Examples

Initialize a repository database in /var/opt/snapshotcm/db, set the archive path to the same directory, and set the cache size to 40 MB:

mkdir /var/opt/snapshotcm/db
cd /var/opt/snapshotcm/db
cmconfig -i -d. -a. -C40 -l

Reset the administrator access:

cd /var/opt/snapshotcm/db
cmconfig -A

Initialize a proxy cache in C:ProxyDB:

cd C:\ProxyDB
cmconfig -ip -d. -h RepositoryHostName -l

Files

The database location and cache size configuration information is stored in the Windows Registry on windows systems, and in /etc/opt/SnapshotCM/config on unix systems. The server uses this information to initialize properly.

See Also

cmaccount(1) , cmacl(1) , cmadmin(1)


Table of Contents