Share via

Get-DPMRole

  • Article

Get-DPMRole

Allows you to open a DPM role for editing or to display a DPM role and its properties.

Syntax

Get-DPMRole [[-Name] <String>] [-DPMServerName] <String> [-Editable <SwitchParameter>] [<CommonParameters>]

Detailed Description

The Get-DPMRole cmdlet allows you to open a DPM role for editing or to display a DPM role and its properties.

Use the –Editable parameter to open the role for editing.

To list all the available role names, use the cmdlet without specifying a DPM role name.

Parameters

-Name

The name of a protection group.

Attributes

Name Value

Required?

false

Accept wildcard characters?

false

Accept Pipeline Input?

false

Position?

1

-DPMServerName

The name of a DPM server.

Attributes

Name Value

Required?

true

Accept wildcard characters?

false

Accept Pipeline Input?

false

Position?

0

-Editable

Retrieves the DPM role in editable mode.

Attributes

Name Value

Required?

false

Accept wildcard characters?

false

Accept Pipeline Input?

false

Position?

named

-CommonParameter

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

Input and Return Types

The input type is the type of the objects that you can pipe to the cmdlet. The return type is the type of the objects that the cmdlet emits.

Notes

  • For more information, type "Get-Help Get-DPMRole -detailed".
    For technical information, type "Get-Help Get-DPMRole -full".

    Additionally, any updated information about the cmdlet will be available at https://go.microsoft.com/fwlink/?LinkId=95130.

Examples