Sync-RDMUser

Synopsis

Update users from their identity provider.

Syntax

__AllParameterSets

Sync-RDMUser [-Provider] <ServerUserType[]> [-OnDisabledInProvider <UserCleanupOption>]
 [-OnMissingFromProvider <UserCleanupOption>] [-UnassignLicenses] [-TransferUserVaultToSharedVault]
 [-ForcePromptAnswer <DialogResult[]>] [-WhatIf] [-Confirm] [<CommonParameters>]

Description

Update users from their identity provider. Profile information for every user still present in the provider is refreshed silently. The cmdlet returns every user still flagged as requiring intervention after synchronizing, so they can be reviewed and, when actionable, passed to Invoke-RDMUserCleanup. Each result carries a Reason: NotFound and Disabled reflect the provider directly and are actionable via OnMissingFromProvider and OnDisabledInProvider. DomainConfigurationNotFound and Unknown mean the server could not reach a verdict, an unmatched domain configuration, or a failed save, and since no On parameter covers them, they are never auto-actioned. Without the On parameters nothing is disabled or deleted. Requires a Devolutions Server workspace.

Examples

Example 1

PS C:\> Sync-RDMUser -Provider Domain

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

Example 2

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

Update users from both Active Directory and Microsoft Entra ID.

Example 3

PS C:\> Sync-RDMUser -Provider Domain -OnDisabledInProvider Disable -OnMissingFromProvider Delete -UnassignLicenses -TransferUserVaultToSharedVault

Mirror the provider state in one call: disable the users disabled in the domain, delete the ones no longer there, and keep their private vault contents.

Example 4

PS C:\> Sync-RDMUser -Provider Domain -OnDisabledInProvider Disable | Invoke-RDMUserCleanup -CleanupOption Delete

Disable the users disabled in the domain, then delete whatever is left to decide.

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

-OnDisabledInProvider

The action to apply to the users that are disabled in the provider. Omit to report them instead.

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

-OnMissingFromProvider

The action to apply to the users that no longer exist in the provider. Omit to report them instead.

Type: System.Nullable`1[Devolutions.RemoteDesktopManager.UserCleanupOption]
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: ''

-TransferUserVaultToSharedVault

Move the private vault contents of the users that are deleted by this cmdlet into a new shared vault.

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

-UnassignLicenses

Release the licenses held by the users that are disabled by this cmdlet.

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.PSUserSyncResult

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

Notes

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