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 command before registering the client: commvault shell

Procedure

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

  • Windows computers

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

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

  • UNIX, Linux, and Macintosh computers

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

    ./SIMCallWrapper -OpType 1000 -CSHost CommServe_hostname -clientname client_name -ClientHostName client_hostname -authcode authcodevalue -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] [-authcode authcodevalue] [-ClientGroup client_group] [-subclientPolicy subclient_policy] [-StoragePolicy storage_policy] [-overwriteClientInfo] [-resetNetworkPassword] [-regPath alternate_registry_path] [-instanceFor1Touch instance_name] -output [-restartServices] [-ConnectionInfo GatewayHostname:Port]

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

-authcode

The company authorization code, which is required only if you have enabled authcode for your company. To obtain the authorization code, go to Command Center Companies > Company name > General or CommCell > General.

-clientGroup

Name of the client group that you want to associate with the computer.

-clientHostName

Host name of the computer that you want to register.

-clientName

Required. Name of the computer that you want to register.

-ConnectionInfo

Host name of the network gateway, and the port number it is reachable on. Use the argument as follows:

-ConnectionInfo Gateway_Hostname:Port

-CSHost

Required. Host name of the CommServe computer.

-CSName

Name of the CommServe computer.

-instance

Name of the CommCell instance on which the command runs (for example, Instance001)

-instanceFor1Touch

Name of the instance for 1-Touch.

-opType 1000

Required. Name of the operation type to register the client to the CommServe computer.

-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.

-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.

-password

Password for the user account provided. This parameter is Required if you used the -user parameter (see below).

-passwordEncrypted

Encrypted password for the user account provided.

-regPath

Name of the alternative registry path.

-storagePolicy

Name of the storage policy that you want to associate with the computer.

-subclientPolicy

Name of the subclient policy that you want to associate with the computer.

-user

User name of your CommCell user account. If the user is part of a domain, specify the user name as domain\user.

Note

  • 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.

Loading...