Skip to main content

Commvault SDK for Python

Project description

CVPySDK is a Python Package for Commvault Software.

CVPySDK uses REST APIs to perform CommCell operations.


  • Python 3 and above

  • requests Python package

  • future Python package

  • xmltodict Python package

  • Commvault Software v11 SP7 or later release with WebConsole installed

Installing CVPySDK

CVPySDK can be installed directly from PyPI using pip:

>>> pip install cvpysdk

CVPySDK is available on GitHub here

It can also be installed from source.

After downloading, from within the cvpysdk directory, execute:

>>> python install


Login to Commcell:
>>> from cvpysdk.commcell import Commcell
>>> commcell = Commcell(webconsole_hostname, commcell_username, commcell_password)
Print all clients:
>>> print(commcell.clients)
Get a client:
>>> client = commcell.clients.get(client_name)
Get an agent:
>>> agent = client.agents.get(agent_name)
Get an instance:
>>> instance = agent.instances.get(instance_name)
Browsing content at instance level:
>>> paths, dictionary = instance.browse(path='c:\\', show_deleted=True)
Browsing content of a instance in a specific time range:
>>> paths, dictionary = instance.browse(path='f:\\', from_time='2010-04-19 02:30:00', to_time='2014-12-20 12:00:00')
Searching a file in instance backup content:
>>> paths, dictionary = instance.find(file_name="*.csv")
Get a backupset:
>>> backupset = instance.backupsets.get(backupset_name)
Run backup for a backupset:
>>> job = backupset.backup()
Browsing content at backupset level:
>>> paths, dictionary = backupset.browse(path='c:\\', show_deleted=True)
Browsing content of a backupset in a specific time range:
>>> paths, dictionary = backupset.browse(path='f:\\', from_time='2010-04-19 02:30:00', to_time='2014-12-20 12:00:00')
Searching a file in backupset backup content:
>>> paths, dictionary = backupset.find(file_name="*.csv")
Get a subclient:
>>> subclient = backupset.subclients.get(subclient_name)
Run backup for a subclient:
>>> job = subclient.backup(backup_level, incremental_backup, incremental_level)
Browsing content at subclient level:
>>> paths, dictionary = subclient.browse(path='c:\\', show_deleted=True)
Browsing content of a subclient in a specific time range:
>>> paths, dictionary = subclient.browse(path='f:\\', from_time='2010-04-19 02:30:00', to_time='2014-12-20 12:00:00')
Searching a file in subclient backup content:
>>> paths, dictionary = subclient.find(file_name="*.txt")
Run restore in place job for a subclient:
>>> job = subclient.restore_in_place(paths, overwrite, restore_data_and_acl)
Run restore out of place job for a subclient:
>>> job = subclient.restore_out_of_place(client, destination_path, paths, overwrite, restore_data_and_acl)
Job Operations:
>>> job.pause()             # Suspends the Job
>>> job.resume()            # Resumes the Job
>>> job.kill()              # Kills the Job
>>> job.status              # Current Status the Job  --  Completed / Pending / Failed / .... / etc.
>>> job.is_finished         # Job finished or not     --  True / False
>>> job.delay_reason        # Job delay reason (if any)
>>> job.pending_reason      # Job pending reason (if any)


On Windows, if CVPySDK was installed using an .exe or .msi installer, simply use the uninstall feature of “Add/Remove Programs” in the Control Panel.

Alternatively, you can uninstall using the pip command:

>>> pip uninstall cvpysdk

Subclient Support

Subclient operations are currently supported for the following Agents:

  1. File System

  2. Virtual Server

  3. Cloud Apps

  4. SQL Server

  5. NAS / NDMP



  8. Sybase


  10. Exchange Database

  11. Exchange Mailbox

  12. Informix

  13. Notes Database

  14. MySQL

  15. PostgreS

  16. Big Data Apps


To get started, please see the full documentation for this library

Contribution Guidelines

  1. We welcome all the enhancements from everyone although we request the developer to follow some guidelines while interacting with the CVPySDK codebase.

  2. Before adding any enhancements/bug-fixes, we request you to open an Issue first.

  3. The SDK team will go over the Issue and notify if it is required or already been worked on.

  4. If the Issue is approved, the contributor can then make the changes to their fork and open a pull request.

Pull Requests

  • CVPySDK has 2 active branches, namely:
    • master

    • dev

  • The contributor should Fork the dev branch, and make their changes on top of it, and open a Pull Request

  • The master branch will then be updated with the dev branch, once everything is verified

Note: The SDK team will not accept any Pull Requests on the master branch

Coding Considerations

  • All python code should be PEP8 compliant.

  • All changes should be consistent with the design of the SDK.

  • The code should be formatted using autopep8 with line-length set to 99 instead of default 79.

  • All changes and any new methods/classes should be properly documented.

  • The doc strings should be of the same format as existing docs.


If you have any questions or comments, please contact us here. Also Check out our community for Automation incase of queries.

Code of Conduct

Everyone interacting in the CVPySDK project’s codebases, issue trackers, chat rooms, and mailing lists is expected to follow the PyPA Code of Conduct.


CVPySDK and its contents are licensed under Commvault License

About Commvault

Commvault (NASDAQ: CVLT) is a publicly traded data protection and information management software company headquartered in Tinton Falls, New Jersey.

It was formed in 1988 as a development group in Bell Labs, and later became a business unit of AT&T Network Systems. It was incorporated in 1996.

Commvault software assists organizations with data backup and recovery, cloud and infrastructure management, and retention and compliance.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cvpysdk-11.32.5.tar.gz (870.5 kB view hashes)

Uploaded source

Built Distribution

cvpysdk-11.32.5-py2.py3-none-any.whl (1.1 MB view hashes)

Uploaded py2 py3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page