Available Parameters for CvSQLBackupUtility Tool

Updated

Parameters

Description of Parameter Values

operation

Use this parameter to run an operation. For more information, see Available Operations for CvSQLBackupUtility Tool.

backupfile

This parameter specifies the name of the File System file.

backupsetid

The ID number of a backup or restore backupset. This parameter can be queried with the GetBackupInfo operation and GetRestoreInfo operation.

blocksize

Size of the data blocks.

Default value is 65536.

buffercount

Number of data blocks to use during backup or restore to improve performance.

Default value is one.

compression

Use this parameter to compress the contents of the backup file.

database

Name of the database.

devicecount

Use this parameter to control the number of backup files that are created for backup operation or read for restore operation.

Number of backup files created will be equal to the value of this parameter.

instance

The name of the SQL instance. Use sqlservername for the default instance of a SQL Server. Use sqlservername\instancename for a non-default instance. sqlservername might be a short or a fully-qualified DNS name of a SQL Server. Some examples are MySQLServer, MySQLServer.MyDomain.com\Instance1

logfile

Fully qualified path or file name for a log file. CvSQLBackupUtility tool does not maintain a log file unless log file name is specified.

maxtransfersize

Maximum number of bytes to transfer at a time to tune performance.

Default value is 65536.

nocopyonly

Use this parameter to perform a non-COPY_ONLY backup operation. By default, a COPY_ONLY backup operation is performed.

Caution

It might affect the normal production backup cycle.

nofileio

Use this parameter to discard backup data and not write it to the backup file. You can use this parameter to test backups of large databases.

Caution

Do not use /nofileio and /nocopyonly parameters together as this might lead to data loss for the production backup cycle.

novdi

Use this parameter if the SQL server of the instance is not in the same computer from where the CvSQLBackupUtility.exe command is run. Using this parameter will cause all the files to be local to the SQL server of the instance.

password

Password of the login ID used to connect to the SQL server.

quiet

Use this parameter to suppress the display of output information. All output information will be written to the log file if "/logfile" parameter is specified. This parameter is useful when executing CvSQLBackupUtility.exe tool via a CMD script.

renameparams

Use this parameter during a restore operation to restore the raw files of a database to a different location than where they were located when the database was backed up.

user

Login ID specified in the SQL server.

If not specified, the Windows credentials of the Windows user account executing the command are considered.

vditimeout

The time the system must wait for the SQL Server to become ready. Time value is in seconds.

Default value is 300.

verbose

Use this parameter to display and write all output information to the log file that would normally be hidden. An example of this hidden information is the connection attempt for all operations other than Connect.

verifyonly

Use this parameter during a restore operation to open and verify the backup file but the data is not restored to the database. You can use this parameter to verify if the previous backup was successful or not.

Was this page helpful?