Remove-RDMPrivateSession

Synopsis

Delete an existing session.

Syntax

ID

Remove-RDMPrivateSession [-ID] <guid> [-Force] [-Refresh] [-ForcePromptAnswer <DialogResult[]>]
 [-WhatIf] [-Confirm] [<CommonParameters>]

PSConnection

Remove-RDMPrivateSession [-Session] <PSConnection[]> [-Force] [-Refresh]
 [-ForcePromptAnswer <DialogResult[]>] [-WhatIf] [-Confirm] [<CommonParameters>]

Description

You will be prompted to confirm the delete.

Examples

Example 1

PS C:\> $list = Get-RDMUserVaultSession; Remove-RDMUserVaultSession $list[1].ID

Retrieves the list of available sessions, deletes session at index 1.

Example 2

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

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

Example 3

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

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

Example 4

PS C:\> $sessions = Get-RDMUserVaultSession -Name 'My Session'; Remove-RDMUserVaultSession -Session $session -Force

Force delete of the session MySession

Parameters

-Confirm

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

-Force

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

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

-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

Specifies the ID of the session to be deleted.

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

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

-Refresh

Send refresh notification to Remote Desktop Manager application.

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

-Session

Specifies the sessions to remove

Type: RemoteDesktopManager.PowerShellModule.PSOutputObject.PSConnection[]
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: PSConnection
  Position: 0
  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
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.

Notes

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