Sync-RDMUserGroup

Synopsis

Update user groups from their identity provider.

Syntax

__AllParameterSets

Sync-RDMUserGroup [-Provider] <ServerUserType[]> [-RemoveAllMissing]
 [-ForcePromptAnswer <DialogResult[]>] [-WhatIf] [-Confirm] [<CommonParameters>]

Description

Update user groups from their identity provider. Names of every group still present in the provider are refreshed silently. The cmdlet returns every group still flagged as requiring intervention after synchronizing, so they can be reviewed and, when actionable, passed to Remove-RDMUserGroup. Requires a Devolutions Server workspace.

Examples

Example 1

PS C:\> Sync-RDMUserGroup -Provider Domain

Update all Active Directory groups and list the ones that no longer match the domain.

Example 2

PS C:\> Sync-RDMUserGroup -Provider Domain, AzureAD

Update groups from both Active Directory and Microsoft Entra ID.

Example 3

PS C:\> Sync-RDMUserGroup -Provider Domain -RemoveAllMissing

Update Active Directory groups and delete every one the domain no longer has, in one call.

Example 4

PS C:\> Sync-RDMUserGroup -Provider Domain | Where-Object Reason -eq NotFound | Remove-RDMUserGroup -Force

Same result as -RemoveAllMissing, reviewing the list yourself before deleting.

Parameters

-Confirm

Prompts 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: ''

-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: ''

-Provider

The identity providers to synchronize.

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

-RemoveAllMissing

Delete every user group reported as missing from the provider (Reason = NotFound) instead of just reporting it. Groups flagged for any other reason are always left for review.

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

-WhatIf

Shows what would happen if the cmdlet were to run. The cmdlet does 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.

Outputs

RemoteDesktopManager.PowerShellModule.PSOutputObject.PSUserGroupSyncResult

One entry per flagged user group still left to review. No output means nothing is left to review.

Notes

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