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 an 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 | SQLsafeCmd help <action> |
Backup | Backup a database. |
SQLsafecmd | SQLsafeCmd help backup |
| Restore | Restore a database. |
SQLsafecmd | SQLsafeCmd help restore |
| RestoreLast | Restore the most recent full backup of a database from the specified directory. |
SQLsafecmd SQLsafecmd | SQLsafeCmd help instantrestore |
| Verify | Verify a database backup. |
SQLsafecmd SQLsafecmd SQLsafecmd | SQLsafeCmd help restoreheaderonly |
Browse TSM | Browse Tivoli Storage Management. |
SQLsafecmd | SQLsafeCmd help browse TSM |
| Expire TSM | Expire Tivoli Storage Management backup archives. |
SQLsafecmd | SQLsafeCmd help expire TSM |
| Extract TSM | Extract a file from Tivoli Storage Management. |
SQLsafecmd | SQLsafeCmd help extract TSM |
| License | Register a Backup Agent license. |
SQLsafecmd SQLsafecmd | SQLsafeCmd help encryptbackuppassword |
| EncryptRestorePassword | Encrypt plain-text password for encrypted restores. |
SQLsafecmd | SQLsafeCmd help encryptrestorepassword |
| EncryptSqlPassword | Encrypt plain-text password for SQL Server logins. |
SQLsafecmd SQLsafecmd | SQLsafeCmd help encryptwindowspassword |
InstallXsp| InstallXSP | Install SQL Server extended stored procedures for SQLsafe. |
SQLsafecmd | SQLsafeCmd help installxsp |
| Delete | Delete backup archives older than the specified date. |
SQLsafecmd SQLsafecmd | SQLsafeCmd help logshipbackup |
| LogShipRestore | Log Shipping secondary restore. |
SQLsafecmd SQLsafecmd | SQLsafeCmd help objectlevelrecovery |
| Create-Policy | Create a new policy. |
SQLsafecmd | SQLsafeCmd help create-policy |
| Edit-Policy | Edit existing policy. |
SQLsafecmd | 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). |
SQLsafecmd | SQLsafeCmd help adddatabase |
| BckDstType | Backup Destination. | SQLsafecmd help bckdsttype |
BackupFileType | Backup File Type. | |
| 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 |
SQLsafecmd help backupfiletype| Info |
|---|
The examples in the above table provides table provide you with commands to use in Command Prompt. Those commands will display detailed descriptions and available options for each action. |
SQL Safe is a high-performance backup and recovery solution for your SQL Servers. Learn more > >
...
| Scroll pdf ignore |
|---|
| Newtabfooter |
|---|
| alias | IDERA |
|---|
| url | http://www.idera.com |
|---|
|
| | Newtabfooter |
|---|
| alias | Products |
|---|
| url | https://www.idera.com/productssolutions/sqlserver |
|---|
|
| | Newtabfooter |
|---|
| alias | Purchase |
|---|
| url | https://www.idera.com/buynow/onlinestore |
|---|
|
| | Newtabfooter |
|---|
| alias | Support |
|---|
| url | https://idera.secure.force.com/ |
|---|
|
| | Newtabfooter |
|---|
| alias | Community |
|---|
| url | http://community.idera.com |
|---|
|
| | Newtabfooter |
|---|
| alias | Resources |
|---|
| url | http://www.idera.com/resourcecentral |
|---|
|
| | Newtabfooter |
|---|
| alias | About Us |
|---|
| url | http://www.idera.com/about/aboutus |
|---|
|
| | Newtabfooter |
|---|
| alias | Legal |
|---|
| url | https://www.idera.com/legal/termsofuse |
|---|
|
|
...