Cmdlets for protecting Microsoft SQL Server data

The following table identifies the cmdlets that you can use to protect Microsoft SQL Server data.

Table 1. Cmdlets to protect Microsoft SQL Server data. The following table identifies the cmdlets that you can use to protect Microsoft SQL Server data.
Cmdlet name	Related command-line interface command	Short description
Add-DpSqlPolicy	tdpsqlc create policy	Create a policy for Microsoft SQL Server data.
Backup-DpSqlComponent	tdpsqlc backup	Backup SQL Server components.
Copy-DpSqlPolicy	tdpsqlc copy policy	Copy an existing policy to a new policy.
Dismount-DpSqlBackup	tdpsqlc unmount backup	Dismount a backup.
Dismount-DpSqlClone	not applicable	Dismounts a clone backup.
Get-DpSqlBackup	tdpsqlc query tsm *	Query the backups that are stored on the server.
Get-DpSqlClone	not applicable	Queries the clone backups that are stored on the SQL server.
Get-DpSqlComponent	tdpsqlc query sql *	Query the databases that are available on the SQL Server.
Get-DpSqlConfig	tdpsqlc query tdp	Display configuration information.
Get-DpSqlConnection	tdpsqlc query tsm	Displays the IBM Spectrum Protect API and server information.
Get-DpSqlFileGroups	not applicable	Displays all file and group information about specified SQL Server databases.
Get-DpSqlInformation	tdpsqlc query sql	Display specified SQL Server information.
Get-DpSqlManagedCapacity	tdpsqlc query managedcapacity	Assist with storage planning by determining the amount of managed capacity that is in use.
Get-DpSqlPolicy	tdpsqlc query policy	Query policy.
Mount-DpSqlBackup	tdpsqlc mount backup	Mounts a backup that provides access to the files that are contained by the backup. You can mount a backup as read-only or read/write.
Mount-DpSqlClone	not applicable	Mounts a cloned database that provides access to the files that are contained in a clone backup. You can mount a cloned database as read/write only.
New-DpSqlCloneFromComponent	not applicable	Creates a clone backup from a production database. You can select specific databases from the current SQL server for which you want to create a clone backup. This backup is then used to create a clone of the production database.
Remove-DpSqlBackup	tdpsqlc delete backup and tdpsqlc inactivate	Use to delete a VSS backup of an SQL Server database, or deactivate one or more active legacy backup objects on the IBM Spectrum Protect server.
Remove-DpSqlClone	not applicable	Deletes one or more SQL clone backups.
Remove-DpSqlPolicy	tdpsqlc delete policy	Deletes a local policy.
Reset-DpSqlTsmPassword	tdpsqlc changetsmpassword	Changes the IBM Spectrum Protect password that is used by Data Protection for SQL Server.
Restore-DpSqlBackup	tdpsqlc restore	Restore backups of Microsoft SQL Server data.
Set-DpSqlConfig	tdpsqlc set paramname	Set the Data Protection for SQL Server configuration parameters in the configuration file.
Set-DpSqlPolicy	tdpsqlc update policy	Changes an existing policy.

To view the details about a specific cmdlet, run the Get-Help cmdlet with the cmdlet name. For example:

Get-Help Get-DpSqlBackup

To continue the example, to see examples for the cmdlet, enter:

get-help Get-DpSqlBackup -examples

For more information, enter:

get-help Get-DpSqlBackup -detailed

For technical information, enter:

get-help Get-DpSqlBackup -full

For online product information, enter:

get-help Get-DpSqlBackup -online

For information about a specific parameter, enter:

help Get-DpSqlBackup -Parameter backupdestination

To display the help in a separate window, include the -showwindow parameter with the help command.