Commvault End-User Command Line (cvc) Interface Example: login

Name

login

Synopsis

login [-wch WEBCONSOLE_HOSTNAME] [-u USERNAME] [ -p PASSWORD] [-https {True,False}] [ -a AGENTTYPE] [i- INSTANCENAME] [-lf LOG_FILE] [-cert CERTIFICATE_PATH]

Description

Log on to a CommServe computer so that you can perform configuration, backup, and restore operations by using the cvc interface.

The table lists the options that the software supports.

Note

If you do not specify the Web Console host name, then the software uses the computer registry information to discover the name of the local CommServe computer, and then logs on to that computer.

Option

Description

-wch

The Web Console host name.

-lf

The directory where the wrapper log file resides. You can use the log file to debug issues.

If you do not specify a log folder, the logs are created in the user home directory. For example, /home/{user}/cvc.

-p

The password for the CommCell user. This parameter is optional.

-u

A CommCell user name. This parameter is optional.

-https

Log on using the HTTPS protocol. This is set to true by default. You can set it to false to allow the HTTP protocol.

-a

Specifies the agent to use for cvc operations (File System Agent or Virtual Server Agent).

-i

A CommCell instance name, for example Instance001.

-cert

Path to the Root CA certificate file used for verifying TLS/SSL connections.

Examples

Log On to the CommServe Computer

The following command logs on to the CommServe computer. In this example, the parameters are listed on the command line.

cvc> login -u "example_domain\jdoe"
Proceeding with Local CV Detection 
CS Name : 168.42.42.42 
Enter the password for corresponding username and CS name 
Password: 
Login Successful

The following command logs on to the CommServe computer using the host name. In this example, the parameters are listed on the command line.

cvc> login -wch webconsole.example.com -u admin -p admin
Login Successful

Log On to the CommServe Computer Using Local Client User Authentication

The following command logs on to the CommServe computer using local operating system user authentication. You can use this log on method to recover files.

cvc> login
Login Successful

Log On to the CommServe Computer Using the HTTP Protocol

The following command logs on to the CommServe computer using the HTTP protocol.

cvc> login -https false
Login Successful

Specify the Agent Type for cvc Operations

The following command specifies the agent type for cvc operations.

cvc > login -a vsa
Log path: /tmp/cvc
Logging in as local user.
Login Successful
Using Virtual Server agent operations based on flag vsa
Current working directory : /opt/commvault5/Base64

Use a Custom Root CA Certificate for Secure TLS/SSL Connections

The following command logs on to the CommServe computer using a custom Root CA certificate:

cvc> login -cert "/opt/certificates/root.crt"
Login Successful
×

Loading...