Get-DPMRole

Get-DPMRole

Gets a DPM role to view or edit.

Syntax

Parameter Set: Default
Get-DPMRole [[-DPMServerName] <String> ] [[-Name] <String> ] [-Editable] [ <CommonParameters>]

Detailed Description

The Get-DPMRole cmdlet gets a System Center 2012 – Data Protection Manager (DPM) role for you to view or edit. You can use this cmdlet to display the properties of a DPM role, or all the DPM roles for a DPM server. DPM roles allow Microsoft SQL Server database owners to recover databases without assistance from a DPM administrator.

To open a role for editing, use the Editable parameter. After you make changes to a DPM role, use the Set-DPMRole cmdlet to save those changes.

Parameters

-DPMServerName<String>

Specifies the name of a DPM server.

Aliases

none

Required?

false

Position?

1

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Editable

Indicates that you can edit the DPM role.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Name<String>

Specify the name of a protection group.

Aliases

none

Required?

false

Position?

2

Default Value

none

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 Get-DPMRole -detailed".

Examples

Example 1: Get a role

This command gets a DPM role named OpsMgrSQL. If you intend to make changes to the role, specify the Editable parameter.

PS C:\> Get-DpmRole -Name "OpsMgrSQL"

New-DPMRole

Remove-DPMRole

Rename-DPMRole

Set-DPMRole