Get-RDMAdministrativeRole

Synopsis

Retrieve the administrative roles available in the current workspace.

Syntax

ID

Get-RDMAdministrativeRole [-ID] <guid> [-ScopeType <AdministrativeRoleAssignmentScopeType>]
 [-ForcePromptAnswer <DialogResult[]>] [<CommonParameters>]

Name

Get-RDMAdministrativeRole [[-Name] <string>] [-ScopeType <AdministrativeRoleAssignmentScopeType>]
 [-CaseSensitive] [-ForcePromptAnswer <DialogResult[]>] [<CommonParameters>]

Description

Retrieve the administrative roles that can be assigned in the current workspace, optionally filtered by name, ID, or supported scope type. The cmdlet works with workspaces that manage access through administrative role assignments (currently only Devolutions Server).

Examples

Example 1

PS C:\> Get-RDMAdministrativeRole

Retrieves every administrative role available in the workspace.

Example 2

PS C:\> Get-RDMAdministrativeRole -ScopeType Repository

Retrieves only the roles that can be assigned on a vault.

Example 3

PS C:\> $role = Get-RDMAdministrativeRole -Name "Vault Owner"
PS C:\> $user = Get-RDMUser -Name "jsmith"
PS C:\> $user | Add-RDMRoleAssignment -RoleID $role.Id -ScopeType Repository -ScopeID $vault.ID

Resolves a role by name and assigns it to a user on a vault.

Parameters

-CaseSensitive

Use case-sensitive name matching

Type: System.Management.Automation.SwitchParameter
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: Name
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-ForcePromptAnswer

Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values:

• Yes: Accept the prompt. Cover the OK and Automatic value.
• No: Refuse the yes/no/cancel prompt. "Cancel" is the fallback option if there is no "No" option.
• Cancel: Cancel the yes/no/cancel prompt. "No" is the fallback option if there is no "Cancel" option.

Type: System.Windows.Forms.DialogResult[]
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-ID

Administrative role ID to retrieve

Type: System.Guid
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: ID
  Position: 0
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Name

Filter by role name (supports wildcards)

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: Name
  Position: 0
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-ScopeType

Return only the roles that can be assigned at this scope type

Type: System.Nullable`1[Devolutions.RemoteDesktopManager.AdministrativeRoleAssignmentScopeType]
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

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.

Outputs

RemoteDesktopManager.PowerShellModule.PSOutputObject.PSAdministrativeRole

Notes

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