cmiregister

Manages task-provider user credentials

Applicability

Product

Command type

VersionVault

utility

Platform

UNIX®

Linux®

Windows®

Synopsis

  • Interactive mode:

    cmiregister
    cmiregister>
    subcommand [ options/args ]
    .
    .
    .
    cmiregister> { quit  | exit }

  • Single-command mode:
    cmiregister subcommand [ options/args ]
  • Subcommands:
    • Display help:
      help [ subcommand ]
    • Add credentials:
      add
      { -cq -name provider-name -userdb userdatabase-name
      -dbset dbset-name | -rtc -name provider-name }
      | -jira -name provider-name }
      -username user-name [ -password password ]
    • Remove HCL Compass credentials:
      remove -cq
      { -name provider-name -dbset dbset-name -userdb userdatabase-name -username user-name
      | -all }
    • Remove Rational® Team Concert credentials:
      remove -rtc
      { -name provider-name | -all }
    • Remove JIRA credentials:
      remove -jira
      { -name provider-name | -all }
    • Remove credentials for all change-management providers:
      remove -all
    • Replace credentials:
      replace
      { -cq -name provider-name -userdb userdatabase-name
      -dbset dbset-name | -rtc -name provider-name }
      | -jira -name provider-name }
      [ -username user-name ] [ -password password ]
    • List HCL Compass credentials:
      list -cq -name provider-name -userdb userdatabase-name
      -dbset dbset-name
    • List Rational® Team Concert credentials:
      list -rtc -name provider-name
    • List JIRA credentials:
      list -jira -name provider-name
    • List all HCL Compass credentials:
      list -cq -rtc

Description

The cmiregister utility enables you to manage the credentials of users of task providers, such as Compass, that are integrated with VersionVault through the VersionVault change management interface (CMI).

Restrictions

None.

General options and arguments

-name provider-name
Name of the task provider that has been configured for the integration.
-username user-name
The user-identity portion of the credentials.
-password password
The password portion of the credentials. This option is not required if the user identity is not associated with a password.
-all
Specifies either all credentials for the specified provider or all credentials for all providers.

Compass options and arguments

-cq
Specifies that Compass is the provider.
-dbset dbset-name
Name of the database set.
-userdb userdatabase-name
Name of the user database that is associated with the database set.
-username user-name
The login name of the Compass user.

Rational® Team Concert options and arguments

-rtc
Specifies that Rational® Team Concert is the provider.

JIRA options and arguments

-jira
Specifies that JIRA is the provider.

Examples

  • Add user credentials for Compass:

    cmiregister add -cq -name CQPROV2 -dbset RATL2 -userdb CQDB2 -username cquser -password national

  • Remove all credentials for all task providers:

    cmiregister remove -all

  • Replace RTC credentials:

    cmiregister replace -rtc -name RTCPROV2 -username newuser2 -password newpassword