Commvault End-User Command Line (cvc) Interface Operations for File Systems

Updated

On this page

You can perform file system backup and restore operations by using the Commvault End-User Command Line Interface (cvc).

You can perform the following operations:

  • Log on to a local CommServe computer or a remote CommServe computer where you want to perform the operations.

  • Add a new subclient.

  • Modify the content of an existing subclient.

  • Delete a subclient.

  • Perform any of the following backup operations:

    • Full

    • Incremental

    • Differential

    • Synthetic full

  • Search for a backup set or subclient backup

  • Browse the backup set or subclient data

  • Perform any of the following restore operations:

    • In-place

    • Out-of-place

    • Point-in-time

  • Kill, pause or resume a job

The user running the Commvault End-User Command Line Interface (cvc) operations must have permission to the /tmp/cvc directory to write to the cvc.log log file.

Note: You can use the Commvault End-User Command Line Interface (cvc) on UNIX and Windows configurations. The examples are UNIX examples. If you have a Windows configuration, then specify the path in the Windows format, such as "C:\temp".

Procedure

  1. Set the PYTHONPATH environment variable. On the command line, type the following command:

    export PYTHONPATH=<software_install_path>/Base/PythonSDK

    where software_install_path is the Commvault software installation directory.

  2. Make sure that you are in the correct directory to run the command. On the command line, type the following command:

    cd <software_install_path>/Base

    where software_install_path is the Commvault software installation directory.

  3. Add the EnforceUnixUserPermissionsOnRestore additional setting to the CommServe computer, to perform command line (cvc) operations as a non-root user, as shown in the following table:

    For instructions about adding an additional setting from the CommCell Console, see Adding an Additional Setting from the CommCell Console.

    Property

    Value

    Name

    EnforceUnixUserPermissionsOnRestore

    Category

    CommServDB.GxGlobalParam

    Type

    Integer

    Value

    1

  4. You can run the Commvault End-User Command Line Interface (cvc) on UNIX and Windows configurations.

    • On UNIX, run the cvc command to run backup and restore operations or the cvrecover command when you only want to run restore operations. On the command line, type the following command:

      Backup operations and restore operations

      ./cvc

      Restore operations

      ./cvrecover
    • On Windows, run the cvc command to run backup and restore operations.

      py cvc.py
  5. Optional: To view documentation for the Python SDK Wrapper, type the following command:

    >./cvc

    Starting prompt...

    >>> help

To learn more, we recommend that you explore the examples or code snippets.