crmregister

Product	Command type
ClearCase®	command

Platform
Windows®
UNIX®
Linux®

Synopsis

Show the syntax for a crmregister subcommand.
crmregister –help { add | remove | replace }
Register a new Rational ClearQuest user database in the local cache.
crmregister add –database crm-database-name –con/nection crm-connection –user/name crm-user-name [–pass/word password ]
Remove locally cached information about Rational ClearQuest user databases.
crmregister remove –database crm-database-name | –all
Change connection or user credentials information for a Rational ClearQuest user database already registered in the local cache.
crmregister replace –database crm-database-name [–con/nection crm-connection ] [–user/name crm-user-name ] [–pass/word password ]

Description

The UCM integration with Rational ClearQuest supports multiple database sets (connections). Each connection for each Rational ClearQuest user database on a local host requires a valid Rational ClearQuest user name and password. If a user of the integration performs an action that requires a login to a Rational ClearQuest user database, the integration requires database, connection, and user credentials before it can attempt the login.

The crmregister utility provides a way for a user to create, add, or change the connection and credential information that UCM operations use in a UCM project that has been enabled for Rational ClearQuest. The information is registered (stored on the local host) and used by UCM operations when they need to access a Rational ClearQuest user database.

The crmregister utility affects locally cached information only. It has no effect on the Rational ClearCase registry.

Options and arguments

The crmregister utility has four subcommands. The following sections describe options and arguments supported by each of the subcommands.

Getting syntax help

Use crmregister –help to display a summary of command line syntax for any of the crmregister subcommands.

Default: None.
add: Displays command line syntax for the add subcommand
remove: Displays command line syntax for the remove subcommand
replace: Displays command line syntax for the replace subcommand

Adding a new registration

Use crmregister add to register connection information for a Rational ClearQuest user database.

Default: None.
–database crm-database-name: Creates an entry for crm-database-name in the local CRM information registry. A Rational ClearQuest user database named crm-database-name must be accessible from the local host over the connection specified with the –connection option.
–con/nection crm-connection: Specifies a database connection to be used when accessing the database specified by crm-database-name. A connection named crm-connection must exist on the local host.
–user/name crm-user-name: Specifies a valid Rational ClearQuest user name to use for authentication when accessing the database specified by crm-database-name. This must be a name that maps to the current UCM user. The user name is not validated by crmregister.
–pass/word password: Specifies a password that is valid for crm-user-name. The password is not validated by crmregister.

Removing an existing registration

Use crmregister remove to remove an entry from the local CRM registry.

Default: None
–database crm-database-name: Removes the entry for crm-database-name from the local CRM registry. Returns an error if no entry for crm-database-name exists.
–all: Removes all entries from the local CRM information registry.

Replacing an existing registration

Use crmregister replace to replace connection information for a Rational ClearQuest user database that is already registered in the local CRM registry.

Default: None.
–database crm-database-name: Replaces the connection and, optionally, user name and password information for crm-database-name in the local CRM registry. Returns an error if no entry for crm-database-name exists.
–con/nection crm-connection: Specifies a database connection to be used when accessing the Rational ClearQuest user database specified by crm-database-name. A connection named crm-connection must exist on the local host and be a valid connection for the specified crm-database-name.
–user/name crm-user-name: Specifies a valid Rational ClearQuest user name to use for authentication when accessing the Rational ClearQuest user database specified by crm-database-name. This should be a name that maps to the current UCM user. The user name is not validated by crmregister.
–pass/word password: Specifies a password that is valid for crm-user-name. The password is not validated by crmregister.

Examples

The UNIX system and Linux examples in this section are written for use in csh. If you use another shell, you may need to use different quoting and escaping conventions.

The Windows examples that include wildcards or quoting are written for use in cleartool interactive mode. If you use cleartool single-command mode, you may need to change the wildcards and quoting to make your command interpreter process the command appropriately.

In cleartool single-command mode, cmd-context represents the UNIX system and Linux shells or Windows command interpreter prompt, followed by the cleartool command. In cleartool interactive mode, cmd-context represents the interactive cleartool prompt.

cmd-context crmregister add -database TEST -connection CQMS.UCMCQ_DBS.EXAMPLE -username akp

Change the password for the user name associated with database TEST.

cmd-context crmregister replace -database TEST -password N09b6tyP 
Updating ClearQuest login information for user akp, ClearQuest database TEST.