Get-RDMDeletedUser

Synopsis

Retrieve deleted users from the current workspace.

Syntax

Name (Default)

Get-RDMDeletedUser [[-Name] <string[]>] [-PageNumber <int>] [-PageSize <int>] [-CaseSensitive]
 [-ForcePromptAnswer <DialogResult[]>] [<CommonParameters>]

ID

Get-RDMDeletedUser [-ID] <guid> [-PageNumber <int>] [-PageSize <int>]
 [-ForcePromptAnswer <DialogResult[]>] [<CommonParameters>]

Literal

Get-RDMDeletedUser [-LiteralName] <string[]> [-PageNumber <int>] [-PageSize <int>] [-CaseSensitive]
 [-ForcePromptAnswer <DialogResult[]>] [<CommonParameters>]

Description

Retrieve soft-deleted users from the current workspace. This cmdlet returns users that have been deleted but not permanently removed. The cmdlet works with workspaces that support deleted user management (currently only Devolutions Server).

By default, retrieves the first 10 000 results; this might not include all deleted users.

Examples

Example 1

PS C:\> Get-RDMDeletedUser

Retrieve all deleted users from the current workspace (up to 10 000 results).

Example 2

PS C:\> Get-RDMDeletedUser -PageNumber 2 -PageSize 50

Retrieve the second page of deleted users with 50 users per page.

Example 3

PS C:\> Get-RDMDeletedUser -Name "john*"

Retrieve deleted users whose name starts with 'john' (case-insensitive by default).

Example 4

PS C:\> Get-RDMDeletedUser -LiteralName "johndoe"

Retrieve the deleted user with the exact name 'johndoe' (no wildcards).

Example 5

PS C:\> Get-RDMDeletedUser -ID "3c5d7e8f-9a1b-4c2d-8e3f-4a5b6c7d8e9f"

Retrieve the deleted user with the specified ID.

Example 6

PS C:\> Get-RDMDeletedUser -Name "test*" -CaseSensitive

Retrieve deleted users whose name starts with 'test' using case-sensitive matching.

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
- Name: Literal
  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

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

-LiteralName

Filter by exact user name (no wildcards).

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

-Name

Filter by user 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: ''

-PageNumber

Page number for paginated results. Default: 1

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

-PageSize

Number of results per page. Default: 10000

Type: System.Int32
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.PSUserInfo

Notes

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