Registering the Commvault Windows/Linux client using the command line

Registering the Client Using the Command Line

When you install Commvault in decoupled mode, the client does not establish connections with the CommServe computer. You must register the client to complete the installation.

You can register the client by running a command from the command-line interface.

Before You Begin

  • The Commvault software must be already installed on the client.
  • If you installed a laptop package on Linux or Macintosh computers as a non-root user, you must run the following commands before registering the client.
    • The cvprofile command:

      . /opt/commvault/Base/cvprofile

    • The galaxy_vm command:

      . /opt/commvault/galaxy_vm

    Note: When you run the commands, make sure to notice the dot space before the /opt directory.

Procedure

On the computer where you installed Commvault, open the command line prompt and do the following:

  • On Windows Computers

    Go to the Installation_Directory_Path/Base directory and run the following command after substituting the parameter values:

    SIMCallWrapper.exe -OpType 1000 -CSHost CommServe_hostname -clientname client_name -output XML_file_location

  • On UNIX, Linux, and Macintosh Computers

    Go to the Installation_Directory_Path/Base directory and run the following command after substituting the parameter values:

    ./SIMCallWrapper -OpType 1000 -CSHost CommServe_hostname -clientname client_name -output XML_file_location

The SIMCallWrapper command supports a variety of parameters:

SIMCallWrapper -OpType 1000 [-instance instance_name] [-user user_name] [-password password] [-passwordEncrypted] [-CSName CommServe_name] [-CSHost CommServe_hostname] [-ClientName client_name] [-ClientHostName client_hostname] [-ClientGroup client_group] [-subclientPolicy subclient_policy] [-StoragePolicy storage_policy] [-overwriteClientInfo] [-resetNetworkPassword] [-regPath alternate_registry_path] [-instanceFor1Touch instance_name] -output XML_file_location [-skipCertificateRevoke] [-restartServices]

The following table describes all of the parameters supported by the command. The required parameters have a Required tag in the description. Other parameters are optional.

Parameter Description of Parameter Values
-opType 1000 Required. Name of the operation type to register the client to the CommServe computer.
-clientName Required. Name of the computer that you want to register.
-output Required. Directory path where you want to save the output XML file. For example:

  • On Windows, C:\temp\output.xml
  • On UNIX, /tmp/output.xml

The SIMCallWrapper command saves the success or error messages in XML format.

-instance CommCell instance on which the command runs. For example, Instance001.
-user User name of your CommCell user account. If the user is part of a domain, specify the user name as 'domain\user'.

Notes:

  • If you installed a laptop package, this parameter is required. You must specify the user name of your Web Console account.
  • If user authentication for installing agents is enabled on the CommCell environment, this parameter is required.
-password Password for the user account provided. This parameter is required if you used the -user parameter.
-CSName Name of the CommServe computer.
-CSHost Required. Host name of the CommServe computer.
-clientHostName Host name of the computer that you want to register.
-clientGroup Name of the client group that you want to associate with the computer.
-subclientPolicy Name of the subclient policy that you want to associate with the computer.
-storagePolicy Name of the storage policy that you want to associate with the computer.
-overwriteClientInfo Overwrites the computer's client name and host name that were provided during the installation with the ones you provide in the SIMCallWrapper command.

Valid values are ON and OFF.

-regPath Name of the alternative registry path.
-instanceFor1Touch Name of the instance for 1-Touch.
-restartServices Restarts Commvault services on the client.

Use this parameter if you installed the Commvault software from a custom package that did not include CommServe details in its configuration.