Starting a CLI session

The start command begins a Rational® Synergy CLI session.

About this task

ccm start [-nogui][-q] -d database_path [-s server_url] [-m] 
          [-pw password] | [-pwprompt]) [-fpw password_file] 
          [-n username] [-r initial_role] 
          [-single|-single_user reason] [-reset_single|-reset_single_user]

-nogui

This option is present for backward compatibility for the existing scripts to work.

-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 to use multiple sessions. You must set the CCM_ADDR environment variable to the session to be used. 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 setting is used as the default address.
-n user_name
On Windows, specifies a Rational Synergy user name to use.
On UNIX, the user name is the same as the operating system user name and you do not need to specify -n. If you specify -n, the user name must match the current user.
-pw password
This option is available to Windows users only. (On UNIX, the user name is taken from the operating system user name.)
Specifies the password for the Rational 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. See Setting up ccm set_password for details.)
-pwprompt
Prompts for a password to use to authenticate the user.
-q
Starts a session in Quiet mode. When you use this option, Rational Synergy shows the CCM_ADDR for the CLI session. If you do not use this option, the startup shows additional information, such as a copyright notice, before CCM_ADDR.
-reset_single|-reset_single_user
Specifies to start a new session by resetting single user admin mode. See Single user admin mode for details.
-r initial_role
Specifies the initial role to be used. If you do not specify a role, the default role is developer. To change your initial role, see ccm.cli.start.defaultrole in Rational Synergy Default Settings.
-s server_url
Specifies the URL of the Rational Synergy server to use. Specifying the server URL is optional.
If you do not specify a server URL, a default URL registered with the Rational Synergy router for the database is used. View the registered databases and servers by using the ccm show_servers command.
If the default server URL does not resolve from a client machine, use the -s server_url option to specify a server URL with a name that resolves.
-single|-single_user reason
Specifies to start the session in single user admin mode. See Single user admin mode for details.

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 setting 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. These settings distinguish your ccm_root session from sessions where other users are running as ccm_root.


Feedback