Page History
SQL Safe
...
Backup provides you with a Command Line Interface (CLI) to automate its functions. The CLI commands allow you to make changes to your SQL Safe Backup configurations across multiple SQL Server instances in a few lines of text, saving you time.
About Command Line Interface (CLI)
A Command Line Interface (CLI) is a user interface that allows you to interact with the operating system. The interaction is performed through commands where you type a specific command and the operating system performs an action.
| Tip |
|---|
Make sure you are aware of the proper command format for each action you want to perform. |
SQL Safe Backup CLI Usage
The following commands help you automate your SQL Safe Backup functions:
| Usage | Description |
|---|---|
| SQLsafeCmd <action> [options] | Perform an action. |
| SQLsafeCmd help <action> | Display detailed help for an action. |
| SQLsafeCmd -ArgsFile <filename> | Perform the action defined within an argument file. |
where:
| Action | Description |
|---|---|
| <action> | A keyword that tells |
| SQL Safe what to do. | |
| <filename> | Specifies the file that contains command line arguments. |
When you use the SQLsafeCmd command, the following actions can be performed:
| Actions | Description | Example |
|---|---|---|
| Help | Display |
| detailed |
| descriptions and available options. | SQLsafeCmd help <action> | |
| Backup a database. | SQLsafeCmd help backup | |
| Restore | Restore a database. | SQLsafeCmd help restore |
| RestoreLast | Restore the most recent full backup of a database from the specified directory. | SQLsafeCmd help restorelast |
| InstantRestore | Instant Restore a database. | SQLsafeCmd help instantrestore |
| Verify | Verify a database backup. | SQLsafeCmd help verify |
| RestoreFileListOnly | List files for the database in the backup set. | SQLsafeCmd help restorefilelistonly |
| RestoreHeaderOnly | List backup sets in an archive. | SQLsafeCmd help restoreheaderonly |
| Browse Tivoli Storage Management. | SQLsafeCmd help browse TSM | |
| Expire TSM | Expire Tivoli Storage Management backup archives. | SQLsafeCmd help expire TSM |
| Extract TSM | Extract a file from Tivoli Storage Management. | SQLsafeCmd help extract TSM |
| License | Register a Backup Agent license. | SQLsafeCmd help license |
| EncryptBackupPassword | Encrypt plain-text password for encrypted backups. | SQLsafeCmd help encryptbackuppassword |
| EncryptRestorePassword | Encrypt plain-text password for encrypted restores. | SQLsafeCmd help encryptrestorepassword |
| EncryptSqlPassword | Encrypt plain-text password for SQL Server logins. | SQLsafeCmd help encryptsqlpassword |
| EncryptWindowsPassword | Encrypt plain-text password for Windows logins. | SQLsafeCmd help encryptwindowspassword |
| InstallXSP | Install SQL Server extended stored procedures for SQLsafe. | SQLsafeCmd help installxsp |
| Delete | Delete backup archives older than the specified date. | SQLsafeCmd help delete |
| LogShipBackup | Log Shipping primary backup. |
| SQLsafeCmd help logshipbackup | ||
| LogShipRestore | Log Shipping secondary restore. | SQLsafeCmd help logshiprestore |
| ObjectLevelRecovery | Restore database objects. | SQLsafeCmd help objectlevelrecovery |
| Create-Policy | Create a new policy. | SQLsafeCmd help create-policy |
| Edit-Policy | Edit existing policy. | SQLsafeCmd help edit-policy |
| Copy-Policy | Copy existing policy. | SQLsafeCmd help copy-policy |
| AddDatabase | Deploy a new database for the existing policy (LogShipping or Backup policy). |
Backup File Type.
- Help
For detailed descriptions and available options, you can use: SQLsafecmd help <action>.
- Backup
To backup databases, you can use:
SQLsafeCmd Backup <db_name> [<db_name>] <backup_archive> [options]
SQLsafeCmd Backup <db_name> [<db_name>] TSM [options]
SQLsafeCmd Backup <db_name> [<db_name>] TRUNCATEONLY [options]
where:
For detailed descriptions and available options, see the CLI Help (SQLsafecmd help <action>).
SQL Safe is a high-performance backup and recovery solution for your SQL Servers. Learn more > >
| SQLsafeCmd help adddatabase | ||
| MountVDB | Create a new virtual database. | SQLsafeCmd help MountVDB |
| UnmountVDB | Delete a virtual database. | SQLsafeCmd help UnmountVDB |
| CleanupVDB | Cleanup unused virtual database temporary files. | SQLsafeCmd help CleanupVDB |
| Info |
|---|
The examples in the above table provide you with commands to use in Command Prompt. Those commands will display detailed descriptions and available options for each action. |
...