Share via

Remove-DPMRole

Module:
DataProtectionManager Module

Deletes a DPM role.

Syntax

Default (Default) 

Remove-DPMRole
    [-DpmRole] <DpmRole>
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The Remove-DPMRole cmdlet deletes a System Center - Data Protection Manager (DPM) role. DPM roles let Microsoft SQL Server database owners to recover databases without assistance from a DPM administrator.

Examples

Example 1: Remove a role

PS C:\>$DpmRole = Get-DpmRole -Name "OpsMgrSQL" -Editable
PS C:\> Remove-DPMRole -DpmRole $DpmRole

The first command gets the role by using the Get-DPMRole cmdlet, and then stores it in the $DpmRole variable. The command makes the role editable.

The second command removes the role stored in $DpmRole.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DpmRole

Specifies a DPM role that this cmdlet removes. To obtain a DPM role object, use the Get-DPMRole cmdlet.

Parameter properties

Type:DpmRole
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:1
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.