Remove-RDMUser

    2025-02-17

    Remove-RDMUser

    SYNOPSIS

    Delete an existing user.

    SYNTAX

    ID

    Remove-RDMUser [-ID] <guid> [-DeleteSQLLogin] [-Force] [-ForcePromptAnswer <DialogResult[]>]
 [-WhatIf] [-Confirm] [<CommonParameters>]

    User

    Remove-RDMUser [-User] <PSUserInfo[]> [-DeleteSQLLogin] [-Force]
 [-ForcePromptAnswer <DialogResult[]>] [-WhatIf] [-Confirm] [<CommonParameters>]

    ALIASES

    This cmdlet has the following aliases,

    DESCRIPTION

    You will be prompted to confirm the delete.

    EXAMPLES

    EXAMPLE 1

    PS C:> $list = Get-User; Remove-RDMUser $list[1]

    Retrieves the list of available users, deletes user at index 0 and from 1 from a list.

    EXAMPLE 2

    PS C:> $list = Get-User; $users = @($list[0], $list[1]); $Remove-RDMUser $users

    Retrieves the list of available users, deletes user at index 1.

    EXAMPLE 3

    PS C:> Remove-RDMUser "{00000000-0000-0000-0000-000000000000}"

    Delete security group with ID = "{00000000-0000-0000-0000-000000000000}".

    EXAMPLE 4

    PS C:> Remove-RDMUser -ID "{00000000-0000-0000-0000-000000000000}" -Force

    Force delete of the user with ID = "{00000000-0000-0000-0000-000000000000}".

    PARAMETERS

    -Confirm

    Prompts you for confirmation before running the cmdlet.

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

    -DeleteSQLLogin

    Forces removal of the SQL Login without confirmation by the user. Optional.

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

    -Force

    Forces removal of the user without confirmation by the user. Optional.

    Type: System.Management.Automation.SwitchParameter
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
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 not an option No.
    • Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.
    Type: System.Windows.Forms.DialogResult[]
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

    -ID

    Specifies the GUID of the user to be deleted from.

    Must be a valid GUID, in the form {00000000-0000-0000-0000-000000000000}.

    Type: System.Nullable`1[System.Guid]
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: ID
  Position: 1
  IsRequired: true
  ValueFromPipeline: true
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

    -User

    Specifies the array of users to be deleted.

    Users must be retrieved by Get-RDMUser

    Type: RemoteDesktopManager.PowerShellModule.PSOutputObject.PSUserInfo[]
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: User
  Position: 1
  IsRequired: true
  ValueFromPipeline: true
  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
ParameterValue: []
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

    System.Nullable`1[[System.Guid, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]

    RemoteDesktopManager.PowerShellModule.PSOutputObject.PSUserInfo

    OUTPUTS

    NOTES

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