Name
backup
Synopsis
backup [-h] -c CLIENTNAME [-sc SUBCLIENTNAME] [-bk BACKUPSETNAME] [-l LEVEL {'full', 'incremental', 'differential'}] [-i INSTANCENAME] [-a AGENTNAME] [-k KEY] [-tf TOKENFILEPATH] [-of OUTPUTFILEPATH]
Note
In some cases the subclient name may require the use of double quotes " " rather than single quotes ' ' as shown in the command above and examples below.
Description
Perform a backup operation on a client.
By default, backup operation runs at the incremental level. You can use the ‘-tf’ switch to specify the path of the token file saved in login command.
The table lists the options that the software supports.
|
Option |
Description |
|---|---|
|
-l |
The backup type. Valid values are: full - For information on full backups, see Full Backups. incremental - For information on incremental backups, see Incremental Backups. differential - For information on differential backups, see Differential Backups. |
|
-c |
The CommCell Console client name. The software uses the information that is in the computer registry when you do not specify this option. |
|
-i |
The CommCell Console instance name. |
|
-bk |
The CommCell Console backup set name. The software uses the DefaultBackupSet when you do not specify this option. |
|
-sc |
The CommCell Console subclient name. The software uses the DefaultBackupSet and the default subclient when you do not specify this option. |
|
-a |
The Commvault agent name. |
|
-of |
The path to the output file of the backup operation. |
|
-k |
The 16-character encryption key. |
|
-tf |
The path to the token file. |
|
-h,--help |
Displays help |
Example
Perform a Full Backup Operation on the Default Subclient
The following command performs a full backup on the default subclient that is part of the default backup set. In this example, the parameters are listed on the command line.
python3 cvc.py backup -c example_client -sc "MySubclient" -tf objfile
<?xml version="1.0" ?>
<Task>
<JobID>14565</JobID>
</Task>
Backup Initiated Successfully
Perform an Incremental Backup Operation on a Specific Subclient
The following command performs an incremental backup of a test subclient that is part of a test backup set. In this example, the parameters are listed on the command line.
python3 cvc.py backup -c example_client -bk "test" -sc "test" -tf objfile -l incremental
<?xml version="1.0" ?>
<Task> <JobId>14569</JobId>
</Task>
Backup Initiated Successfully
Perform a Backup Operation With Given Output File Path
The following command performs a backup stores the output in a specific path. In this example, the parameters are listed on the command line.
python3 cvc.py backup -c example_client -bk "test" -sc "test" -tf objfile -of /opfile
<?xml version="1.0" ?>
<Task> <JobId>14572</JobId>
</Task>
Backup Initiated Successfully