Get-DPMRole
Gets a DPM role to view or edit.
Syntax
Default (Default)
Get-DPMRole
[[-DPMServerName] <String>]
[[-Name] <String>]
[-Editable]
[<CommonParameters>]
Description
The Get-DPMRole cmdlet gets a System Center - 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 let 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.
Examples
Example 1: Get a role
PS C:\>Get-DpmRole -Name "OpsMgrSQL"
This command gets a DPM role named OpsMgrSQL. If you intend to make changes to the role, specify the Editable parameter.
Parameters
-DPMServerName
Specifies the name of a DPM server on which this cmdlet acts.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 1 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Editable
Indicates that you can edit the DPM role.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Name
Specify the name of a protection group.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 2 |
| 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.