Backup CLI Commands

One or more names of database(s) to backup.

If a database name contains a space, the database name should be surrounded with "double quotes".

Special keywords may be used to backup multiple databases. These keywords are: {all}, {allsystem}, {alluser}.

<backup_archive>

Use Tivoli Storage Manager (see below for special options).

Use this keyword to truncate the transaction log of the SQL Server database only.

-BackupDescription <desc>

The backup type required.

<type> - {full, differential, log, file}.

-BckDstType <type>

The backup destination type is used for the backup.

<type> - {0, 1, 2, 3, 4, 5, 6, 7}.

where:

Note: the default value is "0".

The compression level used for the backup.

<level> - {ispeed, isize, 0, 1, 2, 3, 4}.

Note: if the compression level is not specified, ispeed is the default.

<db_name> [<db_name> ...] - one or more names of database(s) to not backup.

<name> - the SQL server instance name. 

Note: it is not required if the instance is set as a default on the target server.

Do not truncate the transaction log. (Log backup only).

Overwrite existing archive if one exists.

Note: if this option is omitted, the default behavior is to append.

<hostname> - the hostname of the server hosting the SQL Server where the operation should be performed.

 Note: this option is required for accessing remote or clustered SQL Servers (where applicable).

Verify the backup set after backup is complete.

-EncryptionType <type>

The type of encryption used to encrypt the backup.

<type> - {AES128, AES256}.

The security model used to log into SQL Server.

<model> - {Integrated, SQL}.

Note: Integrated (Windows authentication) is the default.

The path to a file containing command-line arguments.

<filename> - specifies the file that contains the command line arguments.

-BackupFile <filename>

Specifies additional backup archive files to be used for striping backups.

<filename> - specifies the backup archive files.

 Note: use once for each additional stripe.

-Checksum

Instructs SQL Server to generate backup checksums during a backup, or verify backup checksums during a verify or restore.

Note: for SQL 2005 and later only.

Instructs SQL Server to continue the operation despite encountering errors such as invalid checksums.

Note: for SQL 2005 and later only.

Specifies that the backup does not affect the normal sequence of backups.

Note: for SQL 2005 and later only.

<filegroup> - the database logical filegroup.

Note: for file BackupType only.

<filename> - the database logical filename.

Note: for file BackupType only.

After a backup successfully completes, delete archives that are older than the specified amount of time.

<n> - amount of time.

 <time_period> - {minutes, hours, days, weeks, months}.

There must be NO SPACE between <n> and <time_period>.

E.g., -delete 2hours.

Note: if you use the space between <n> and <time_period>, the backup archive filename will be automatically generated with the following pattern:

<instancename>_<databasename>_<backuptype>_ <timestamp>.safe

where the <timestamp> is in UTC time and in the form of YYYYMMDDHHMM.

After a backup successfully completes, delete mirrors that are older than the specified amount of time.

<n> - amount of time.

<time_period> - {minutes, hours, days, weeks, months}.

There must be NO SPACE between <n> and <time_period>.

E.g., -deletemirror 2hours.

Note: if you use the space between <n> and <time_period>, the mirror filename will be automatically generated with the following pattern:

<instancename>_<databasename>_<backuptype>_<timestamp>.safe

where the <timestamp> is in UTC time and in the form of YYYYMMDDHHMM.

-FailOnMirrorError

To abort a backup if an error is encountered while writing to a mirror backup archive.

Note: the default behavior is to abort only if an error is encountered while writing to a primary backup archive.

For backup, includes the database logins in the backup file.

For restore, creates the logins from the backup file on the destination server.

<email_address> - an email address(es) to send the notification via SMTP.

Note: multiple addresses may be separated by spaces, semicolons, or commas.

Specifies additional backup archive files to be used for mirroring backups.

<filename> - specifies the backup archive files.

Note: use once for each additional mirror. Up to two mirrors may be specified.

Disables automatic skipping of databases that cannot be backed up, such as offline databases.

Prevents status messages from being cached or sent to the Repository.

-ReadWriteFileGroups

Instructs SQL Server to perform a partial backup, which includes the primary filegroup and any read/write secondary filegroups.

Note: SQL 2005 and later only.

Specifies the mode in which to leave the database after the operation is completed.

<mode> - NoRecovery, Standby.

Note: for Standby mode an undo file may be specified with the -UndoFile option.

<filename> - specifies the ABSOLUTE path to the undo filename.

Note: for Standby recovery mode only.

<number> - specifies the number of threads that should be used to distribute the backup process across multiple processors.

Do not optimize for quick access by SQL virtual database.

Displays SQL Server result text for both successful and failed backups.

Note: by default, it displays for failed backups only.

Specifies that a pre-command is expected. No value is expected here, just the presence of the parameter -PreCommandRun.

Note: Optional.

The UNC location and filename of the pre-backup command.

-PreBackupDestination = '\\myserver\safecommands\prebackupcommand.bat'

Note: Optional.

Quits the backup operation if the pre-backup command fails. No value is expected here, just the presence of the parameter -QuitJobPreJobFail.

Note: Optional.

Specifies that a post-command is expected. No value is expected here, just the presence of the parameter -PostCommandRun.

Note: Optional.

The UNC location and filename of the post-backup command.

-PostBackupDestination = '\\myserver\safecommands\postbackupcommand.bat'

Note: Optional.