Remove-RDMDeletedEntry

2025-01-30

Remove-RDMDeletedEntry

SYNOPSIS

Delete the history of one or more deleted entries

SYNTAX

Id

Remove-RDMDeletedEntry [-ID] <guid> [-PassThru] [-VaultMode <VaultMode>]
 [-ForcePromptAnswer <DialogResult[]>] [-WhatIf] [-Confirm] [<CommonParameters>]

InputObject

Remove-RDMDeletedEntry [-InputObject] <PSConnectionHistory[]> [-PassThru]
 [-ForcePromptAnswer <DialogResult[]>] [-WhatIf] [-Confirm] [<CommonParameters>]

ALIASES

This cmdlet has the following aliases,

DESCRIPTION

Delete the history of one or more deleted entries. For the data source supporting this functionality, every time an entry is deleted it is logged. This cmdlet will delete the entries from the log, permanently deleting them. The user can permanently delete an entry by its ID, or by the result of the cmdlet Get-DSDeletedEntry. The user must be an administrator or vault owner this use this cmdlet.

EXAMPLES

EXAMPLE 1

PS C:> $today = (Get-Date).Date; $deletedEntries = Get-RDMDeletedEntry | Where ModifiedDate -ge $today Remove-RDMDeletedEntry -InputObject $deletedEntries

Delete all entries deleted today

EXAMPLE 2

PS C:> $deletedEntries = Get-RDMDeletedEntry | Where GroupName -eq 'a\group\name' Remove-RDMDeletedEntry -InputObject $deletedEntries

Delete all deleted entries whose groupName is 'a\group\name'.

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

-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

Histories to delete of a specific entry

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

-InputObject

Histories to delete obtained from Get-RDMDeletedEntry

Type: RemoteDesktopManager.PowerShellModule.PSOutputObject.PSConnectionHistory[]
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: InputObject
  Position: 1
  IsRequired: true
  ValueFromPipeline: true
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-PassThru

Return the InputObject input.

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

-VaultMode

Vault where the command will be applied. Three choices are offered:

• Default: Current vault that has been set.
• User: Vault specific to the current user.
• Global: Global vault of the data source.

Type: Devolutions.RemoteDesktopManager.VaultMode
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: Id
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  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

RemoteDesktopManager.PowerShellModule.PSOutputObject.PSConnectionHistory

Array of PSConnectionHistory obtained from Get-RDMDeletedEntry

OUTPUTS

RemoteDesktopManager.PowerShellModule.PSOutputObject.PSConnectionHistory

NOTES

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

RELATED LINKS