To perform a LogShipRestore use the following command:
- SQLsafeCmd LogShipRestore [options]
Where the required [options] are:
Options | Descriptions |
|---|---|
| -BackupLocation <path> | <path> - the network path where backups will be stored. |
| -DatabaseName <name> | <name> - name of the primary database. |
Common Options
The following options help you perform LogShipRestore operations:
Options | Descriptions |
|---|---|
| -DisconnectUsers | Disconnects all users from the target database before the restore operation begins. |
| -EncryptedRestorePassword <pwd> | <pwd> - the encrypted password used to decrypt the backup. |
| -InstanceName <name> | <name> - SQL server instance name. Note: it is not required if instance is the default instance on the target server. |
| -LoadDelay <minutes> | <minutes> - the number of minutes to delay the restore. |
Security Options
Secure your LogShipBackup operations with the following options:
Options | Description |
|---|---|
| -NoPrompt | Never prompt for credentials even if necessary. |
| -SecurityModel <model> | The security model used to log into SQL Server. <model> - Integrated or SQL. Note: Integrated (Windows authentication) is the default. |
| -SqlUsername <username> | <username> - the SQL Server username (SQL SecurityModel). |
| -SqlPassword <pwd> | <pwd> - the SQL Server password (SQL SecurityModel). |
| -EncryptedSqlPassword <pwd> | <pwd> - the encrypted SQL Server password generated by EncryptSqlPassword action (SQL SecurityModel). |
| -WindowsUsername <domain\user> | <domain\user> - the Windows user that will be used to read/write the backup archive. |
| -WindowsPassword <pwd> | <pwd> - the password for the Windows user. |
| -EncryptedWindowsPassword <pwd> | <pwd> - the encrypted password for the Windows user generated by EncryptWindowsPassword action. |
Advanced Options
The following advanced options help you perform LogShipBackup operations:
Options | Description |
|---|---|
| -MailTo <email_address> | <email_address> - an e-mail address(es) to send a notification via SMTP. Note: multiple addresses may be separated by spaces, semicolons, or commas. |
| -Threads<number> | <number> - specifies the number of threads that should be used to distribute the backup process across multiple processors. |
| -RetryWrites<interval> <retry_time> <total_time> | On a network file error, retry every certain amount of time. <interval> - retry from every certain amount of time in seconds. <retry_time> - retry up to certain amount of time in seconds. <total_time> - total retry time allowed in minutes. |
For detailed descriptions and available options, see the CLI Help (SQLsafecmd help logshipbackup).