Set-DSAddInRootPermission

Synopsis

Modify the permission 'Add in root'

Syntax

__AllParameterSets

Set-DSAddInRootPermission [-ID] <guid> [-Override] <SecurityRoleOverride> [[-UserIDs] <guid[]>]
 [-WhatIf] [-Confirm] [<CommonParameters>]

Description

Modify the permission 'Add in root'. This can be only used on a root. If the root permission override is 'Never', it will be changed to 'Default'.

Examples

PS C:\> $userIds = Get-DSUsers -All | Where Name -like *@domain.loc | Select -ExpandProperty ID
PS C:\> $userGroupIds = Get-DSRole -All | Where Name -eq UserGroupA | Select -ExpandProperty ID
PS C:\> $ids = $userIds + $userGroupIds
PS C:\> Set-DSAddInRootPermission -ID $rootID -Override CustomInherited -UserIDs $ids

Grant the right to add in the root to users whose usernames end with '@domain.loc' and to the user group UserGroupA. Users and user groups from the default permissions should retain this right.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

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

-ID

Root's ID

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

-Override

Determines how the permission 'Add In Root' is resolved. Five options are available: Default => Use the default value from the settings. Custom => Specify those who can add in root. Everyone => Same as Allowed in the UI. Everyone can add in root. Never => Same as Disallowed in the UI. Only administrators can add in root. CustomInherited => A mix of Default and Custom. Add users to the default ones who can add in root.

Type: Devolutions.RemoteDesktopManager.SecurityRoleOverride
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: 1
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-UserIDs

Ids of users, user groups, and applications who will be granted the right to add in the root.

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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: System.Management.Automation.SwitchParameter
DefaultValue: False
SupportsWildcards: false
Aliases:
- wi
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.

Notes

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