Share via


Remove-DPMRole

Remove-DPMRole

Deletes a DPM role.

Syntax

Parameter Set: Default
Remove-DPMRole [-DpmRole] <DpmRole> [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed Description

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

Parameters

-DpmRole<DpmRole>

Specifies a DPM role that this cmdlet removes. 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

-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.

Examples

Example 1: Remove a role

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.

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

Get-DPMRole

New-DPMRole

Rename-DPMRole

Set-DPMRole