Configures or modifies databases. Although you can use installutil with
a variety of subcommands, the syntax that is described in this reference
page is specific to subcommands used to configure LDAP user authentication.
The installutil command line utility is available on Windows only.
Synopsis
- installutil subcommand -dbset dbset_name cq_login cq_password [ –site site ]
[ –domain domain ] [ subcommand_arguments ...]
Description
Use the installutil command
with the following subcommands:
- getauthenticationalgorithm. Displays the algorithm specified
by the setauthenticationalgorithm subcommand.
- getcqldapmap. Displays the string specified by the setcqldapmap subcommand.
- getldapinit. Displays the ldapsearch string
specified by the setldapinit subcommand for the specified database
set.
- getldapsearch. Displays the string specified by the setldapsearch subcommand
for the specified database set.
- setauthenticationalgorithm. Controls whether Rational® ClearQuest® supports
both ClearQuest and
LDAP authentication or only ClearQuest authentication
for the specified database set.
- setcqldapmap. Identifies theClearQuest user
profile field and the LDAP user attribute that ClearQuest uses
to map a user account in the ClearQuest database
set to a user account in the LDAP directory. This command is run once
per domain, site, or both, if applicable.
- setldapinit. Sets the parameter string that is required
to connect a ClearQuest database
set to the LDAP directory used for authentication. It is run once
per domain, site, or both, if applicable.
- setldapsearch. Specifies the LDAP search criteria to use
to find an LDAP user account to authenticate against. It is run once
per domain, site, or both, if applicable.
- validateldap. Confirms that an LDAP configuration is working
correctly.
Important: If you enable LDAP authentication,
you must keep one administrator account that is ClearQuest authenticated.
You must run the installutil subcommands from an administrator
account that uses ClearQuest authentication.
The reason is that ClearQuest cannot
authenticate the administrator's credentials if the LDAP configuration
settings are inconsistent, incorrect, or in a non-functioning state.
Running the subcommands from an administrator account that uses ClearQuest authentication
ensures that you can access ClearQuest administrative
functions if the LDAP directory is unavailable.
ClearQuest prevents
users with administrator privileges from setting their own user account
to use LDAP authentication, but it does not prevent users with administrator
privileges from setting another administrator's account to use LDAP
authentication.
At a minimum, when you run an installutil subcommand
to configure ClearQuest for
LDAP authentication, you must specify the ClearQuest database
set name, administrator user name, and associated administrator password.
Options and Arguments
- -dbset dbset_name
- Name of the ClearQuest database
set or connection that contains the database to enable for LDAP authentication.
- cq_login
- Login name of the ClearQuest administrative
user. This user must have Super User privileges and be marked for ClearQuest authentication.
- cq_password
- Password for the ClearQuest administrative
user. To specify a null password, enter an empty set of double quotes
"".
- –site site
- In a Rational ClearQuest MultiSite environment,
the name of a specific MultiSite site. If you use this option, the
command applies only to the specified site. If you omit this option,
the command applies to all sites.
- –domain domain
- Rational ClearQuest supports
environments where multiple LDAP configurations can be used to authenticate.
If you use this option, the installutil subcommand applies
only to the specified LDAP domain. If you omit this option, the subcommand
applies to all domains.
- subcommand_argument
- One or more arguments specific to the installutil subcommand.
For the installutil setldapinit and installutil setldapsearch subcommands,
you must enclose arguments in double quotes. Use single quotes to
enclose nested parameter lists and strings that include spaces.