Starting a CLI session

The start command begins a Rational Synergy CLI session. After the session starts, the Rational Synergy address (CCM_ADDR), a unique identifier for this CLI session, displays in your command window (Windows) or in the shell where you started the session (UNIX).

If you run multiple Rational Synergy sessions, set the CCM_ADDR environment variable to specify which session will run your Rational Synergy commands. If you don't set CCM_ADDR, a default address is used. This default address is read from a .ccm_addr file. This file is generated if you start a CLI session without the -m (multiple sessions) option.

About this task

ccm start [-q] -d database_path -s server_url [-m] 
          [-pw password] [-n username] [-r initial_role] [-fpw]
-d database_pathname
Specifies the absolute database path. For a database hosted on a UNIX server, use an absolute UNIX path. For a database hosted on a WIndows server, use a UNC path.
-fpw
Specifies the path to the password file to be used instead of the default .ccmrc file.
-m
Specifies that multiple sessions will be used. You must set the CCM_ADDR environment variable to the session you will use. If omitted, CCM_ADDR is not defined for the different session, and the session information is written to a .ccm.addr file on the client. This is used as the default address.

-n user_name

-pw password
Specifies the password for the Synergy user. If you do not specify a password, a default password is obtained from the .ccmrc file. If you specify the -fpw option, that file is used as a password file. If you do not specify the -fpw option, then $HOME/.ccmwc is used on UNIX, and %HOMEPATH%\.ccmrc is used on Windows. (The default password is defined by using the ccm set_password command).
-q
Starts a session in Quiet mode. When you use this option, Rational Synergy shows the CCM_ADDR for the CLI session. If you don't use this the option, the startup shows additional information, such as a copyright notice, before CCM_ADDR.
-r initial_role
Specifies the initial role to be used. If you don't specify a role, your default initial role is used. It is based on the first role defined for you in the database user list.
-s server_url
Specifies the server to connect to. Ensure that the server_url is a valid URL for a compatible server, starting with either http:// or https://

Example

Attention:

If you start an additional session and you plan to use the command line, a warning message is displayed. Set the CCM_ADDR variable for the new session to the displayed address, for example:

set CCM_ADDR=prefect.cwi.com:1368

This causes commands to be executed by the new session rather than by the session you were already running.

When running as user ccm_root, always use the -m option and always set CCM_ADDR in the environment. This distinguishes your ccm_root session from sessions where other users are running as ccm_root.


Feedback