ccm.sh
The ccm.sh script is installed to the crystal directory of your installation. This script provides you with a command-line version of the CCM. This section lists the command-line options and provides some Examples.
Note:
- Arguments in square brackets [ ] are optional.
- Replace server with the complete name of the Crystal Enterprise server component that you want to configure. By default, servers are named with a hostname.servertype convention. If you are unsure of a server's name, look in the
ccm.config file, locate the server's launch string, and use the value that appears after the -name option.
- Arguments denoted by other authentication information are provided in the second table.
| CCM Option
| Valid Arguments
| Description
|
|---|
-help
| n/a
| Display command-line help.
|
-start
| all or server
| Start each server as a process.
|
-stop
| all or server
| Stop each server by terminating its Process ID.
|
-restart
| all or server
| Stop each server by terminating its Process ID; then each server is started.
|
-enable
| all or server [other authentication information]
| Enable a started server so that it registers with the system and starts listening on the appropriate port.
|
-disable
| all or server [other authentication information]
| Disable a server so that it stops responding to Crystal Enterprise requests but remains started as a process.
|
-display
| server <other authentication information>
| Reports the server's current status (enabled or disabled). The APS must be running before you can use this option.
|
-apsfriendlyname
-selectdb
-srcconn
-srcdbdriver
-copydb
-setcluster
-getcluster
-reinitialize
| Run ccm.sh -help for complete details.
| These options are used primarily by apsdbsetup.sh. Although you can run these commands directly from the CCM, it is recommended that you run apsdbsetup.sh instead. It provides a text-based interface to APS configuration. For details, see apsdbsetup.sh.
|
-socksserver
-listall
-wcssocks
-wcsfriendlyname
-getsocks
-wcssocks
-deletesocks
-moveup
-movedown
-create
-modify
-port
-version
-useauth
| Run ccm.sh -help for complete details.
| These options are used primarily by sockssetup.sh. Although you can run these commands directly from the CCM, it is recommended that you run sockssetup.sh instead. It provides a text-based interface to SOCKS server configuration. For details, see sockssetup.sh.
|
This table describes the options that make up the argument denoted by other authentication information.
| Authentication
Option
| Valid arguments
| Description
|
|---|
-aps
| apsname:port#
| Specify the APS that you want to log on to. If not specified, the CCM defaults to the local machine and the default port (6400).
|
-username
| username
| Specify an account that provides administrative rights to Crystal Enterprise. If not specified, the default Administrator account is attempted.
|
-password
| password
| Specify the corresponding password. If not specified, a blank password is attempted.
|
-authentication
| secEnterprise, secWindowsNT, secLDAP
| Specify the appropriate authentication type for the administrative account. If not specified, secEnterprise is attempted.
|
The CCM reads the server launch strings and other configuration values from the ccm.config file. For details, see ccm.config.
Examples
These two commands start and enable all the servers. The Automated Process Scheduler (APS) is started on the local machine and the default port (6400):
ccm.sh -start all
ccm.sh -enable all
These two commands start and enable all the servers. The APS is started on port 6701, rather than on the default port:
ccm.sh -start all
ccm.sh -enable all -aps MACHINE01:6701
These two commands start and enable all the servers with a specified administrative account named SysAdmin:
ccm.sh -start all
ccm.sh -enable all -aps MACHINE01:6701 -username SysAdmin -password 35%bC5@5
-authentication LDAP
This single command logs on with a specified administrative account to disable a Job Server that is running on a second machine:
ccm.sh -disable MACHINE02.crystaldecisions.com.reportserver -aps MACHINE01:6701 -username SysAdmin -password 35%bC5@5 -authentication secLDAP
ccm.config
This configuration file defines the server launch strings and other values that are used by the CCM when you run its commands. This file is maintained by the CCM itself, and by the other Crystal Enterprise script utilities. You typically edit this file only when you need to modify a server's command line. For details, see Command lines overview.