Remove-DPMRecoveryItem
Remove-DPMRecoveryItem
Removes a recovery item.
Syntax
Parameter Set: All
Remove-DPMRecoveryItem [-DpmRole] <DpmRole> [-Type] <AmDatasourceType> {SqlDatabase | SqlInstance | Client} [-All] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: Datasources
Remove-DPMRecoveryItem [-DpmRole] <DpmRole> [-Type] <AmDatasourceType> {SqlDatabase | SqlInstance | Client} [-Datasources] <SQLDataSource[]> [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SqlInstances
Remove-DPMRecoveryItem [-DpmRole] <DpmRole> [-Type] <AmDatasourceType> {SqlDatabase | SqlInstance | Client} [-SqlInstances] <String[]> [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Remove-DPMRecoveryItem cmdlet removes a recovery item from the list of recoverable items that members of a System Center 2012 – Data Protection Manager (DPM) role can recover. You must specify at least one instance of SQL Server for this cmdlet, regardless of whether you specify the All parameter.
Parameters
-All
Indicates that the remove action affects all objects that the cmdlet references.
Aliases |
none |
Required? |
true |
Position? |
3 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Datasources<SQLDataSource[]>
Specifies an array of data source objects. Data source objects include the following:
-- Windows file system share or volume.
-- Microsoft SQL Server database.
-- Microsoft Exchange storage group.
-- Microsoft SharePoint Server farm.
-- Microsoft Virtual Machine.
-- DPM database.
-- A system state that is a member of a protection group.
Aliases |
none |
Required? |
true |
Position? |
3 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-DpmRole<DpmRole>
Specifies a DPM role object. To obtain a DPM role object, use the Get-DPMRole cmdlet.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-SqlInstances<String[]>
Specifies an array of SQL Server instances.
Aliases |
none |
Required? |
true |
Position? |
3 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Type<AmDatasourceType>
Specifies the type of data source that the cmdlet uses. The acceptable values for this parameter are:
-- SqlDatabase
-- SqlInstance
-- Client
Aliases |
none |
Required? |
true |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Confirm
Prompts you for confirmation before running the cmdlet.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
Notes
- For more information, type "
Get-Help Remove-DPMRecoveryItem -detailed".