Remove-DPMRecoveryTarget
Remove-DPMRecoveryTarget
Revokes permissions to a recovery location.
Syntax
Parameter Set: Default
Remove-DPMRecoveryTarget [-DpmRole] <DpmRole> [-Type] <AmDatasourceType> {SqlDatabase | SqlInstance | Client} [[-RecoveryTargets] <String[]> ] [-All] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Remove-DPMRecoveryTarget cmdlet revokes permissions to a recovery location for a System Center 2012 – Data Protection Manager (DPM) role.
Parameters
-All
Indicates that the remove action affects all objects that the cmdlet references.
Aliases |
none |
Required? |
false |
Position? |
named |
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 |
-RecoveryTargets<String[]>
Specifies an array of target recovery items which consist of the instance of SQL Server and the folder to use for alternate instance recovery.
Aliases |
none |
Required? |
false |
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-DPMRecoveryTarget -detailed".
Examples
Example 1: Revoke permission to a recovery location
This example revokes permission to a recovery location for a DPM role.
The first command gets a DPM role named OpsMgrSQL and stores the result in the $Role variable.
The second command revokes permission to the target recovery location C:\Div02Recovery for the DPM role stored in the $Role variable.
PS C:\> $Role = Get-DPMRole -Name "OpsMgrSQL"
PS C:\> Remove-DPMRecoveryTarget -DPMRole $Role -Type SQLInstance -RecoveryTargets "C:\Div02Recovery"