Page History
SQL VDB 2.0 and later includes a new command line interface (CLI) that offers new functions and replaces the previous Map Generation utility.
If you are upgrading from SQL VDB 1.x to SQL VDB 2.0 or later , you must update any SQL jobs that use the previous SQLvdbCLI commands. Starting with SQL VDB version 2.0, all SQLvdbCLI commands have been obsoleted.
Use the following table to identify which SQLvdbCLI commands you will need to replace with new CLI actions. For detailed descriptions and available options, see the CLI Help (sqlvdbcmd Help action).
| Command | Corresponding command for 2.0 and later |
|---|---|
| SQLvdbCLI | sqlvdbcmd |
-Create | Create |
-Update | Update |
| -Remove | Remove |
| -Cleanup | Cleanup |
| -EncryptWindowsPassword | EncryptWindowsPassword |
| None available | EncryptSqlPassword |
| None available | EncryptRestorePassword |
| -List | None available |
| SQLvdbMapGen | Map |
CLI commands for 1.x
| Info |
|---|
SQL VDB CLI actions and options are not case-sensitive. |
Update jobs that call the Map Generation utility
The Map Generation utility was used with SQL VDB versions 1.x. This utility has been replaced by the Map Generation CLI action that is included with the SQL VDB CLI.
For each job that calls the Map Generation utility, update your code to use the Map Generation CLI action instead:
- Use Microsoft Management Studio to edit the job.
- Find and delete this code:
sqlvdbmapgen -BackupFile MyFolder\MyBackupFiles\Name.bak -WindowsUsername targetdomain\account -WindowsPassword password - Enter this new code:
sqlvdbcmd Map MyFolder\MyBackupFiles\Name.bak -WindowsUsername targetdomain\account -WindowsPassword password - Save the job, and then run it manually to validate that it completes as expected.
Update grooming jobs
You can use SQL Server Agent jobs to groom (delete) unused data files associated with your virtual databases.
For each job that grooms virtual data files, update your code to use the new CLI action:
- Use Microsoft Management Studio to edit the job.
- Find and delete this code:
sqlvdbcli -Cleanup - Enter this new code:
sqlvdbcmd Cleanup - Save the job, and then run it manually to validate that it completes as expected.
Update jobs that restore backups as virtual databases
You can use SQL Server Agent jobs to prepare backup jobs for future restoration as a virtual database.
For each job that creates virtual databases, update your code to use the new CLI action:
- Use Microsoft Management Studio to edit the job.
- Find and delete this code:
sqlvdbcli -Create -Database MyNewVirtualDB -Full MyFolder\MyBackupFiles\Name.bak -InstanceName TargetServer -WindowsUsername targetdomain\account -WindowsPassword password - Enter this new code:
sqlvdbcmd Create VirtualDatabaseName MyFolder\MyBackupFiles\Name.bak -WindowsUsername targetdomain\account -WindowsPassword password - Save the job, and then run it manually to validate that it completes as expected.