Import-RDMUser

Synopsis

Create Devolutions Server user records from an identity provider.

Syntax

__AllParameterSets

Import-RDMUser -InputObject <PSImportableUser[]> [-ForcePromptAnswer <DialogResult[]>] [-WhatIf]
 [-Confirm] [<CommonParameters>]

Description

Create Devolutions Server user records from the candidates discovered by Get-RDMImportableUser. Piping from Get-RDMImportableUser is the only supported way to select a candidate, so every import target is guaranteed to be a real, currently resolvable identity provider account rather than an arbitrary caller-supplied Sid. Candidates already flagged AlreadyExists are skipped with a warning instead of sent to the server. Requires a Devolutions Server workspace.

Examples

Example 1

PS C:\> Get-RDMImportableUser -Provider Domain -DomainName 'contoso.com' | Where-Object SamAccountName -eq 'jdoe' | Import-RDMUser

Import a specific Active Directory user discovered by Get-RDMImportableUser.

Example 2

PS C:\> Get-RDMImportableUser -Provider Domain -DomainName 'contoso.com' | Import-RDMUser -WhatIf

Preview which users would be imported, without making any changes.

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

-InputObject

Candidates fetched from Get-RDMImportableUser.

Type: RemoteDesktopManager.PowerShellModule.PSOutputObject.PSImportableUser[]
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: true
  ValueFromPipeline: true
  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.

Inputs

RemoteDesktopManager.PowerShellModule.PSOutputObject.PSImportableUser

Candidates fetched from Get-RDMImportableUser

Outputs

RemoteDesktopManager.PowerShellModule.PSOutputObject.PSImportUserResult

One entry per import attempt.

Notes

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