Remove-RDMEntryHistory

Synopsis

Delete one or more versions of an entry's history

Syntax

History

Remove-RDMEntryHistory -History <PSConnectionHistory> [-PassThru]
 [-ForcePromptAnswer <DialogResult[]>] [-WhatIf] [-Confirm] [<CommonParameters>]

Entry

Remove-RDMEntryHistory -Entry <PSConnection> [-PassThru] [-ForcePromptAnswer <DialogResult[]>]
 [-WhatIf] [-Confirm] [<CommonParameters>]

Description

Delete specific version(s) of an entry's history (obtained from Get-RDMEntryHistory), or all versions of one or more entries. Distinct from Clear-RDMEntriesHistory (bulk/date-based cleanup) and Remove-RDMDeletedEntry (deleted-entry mode). The user must be an administrator or vault owner and the workspace must support deleting version history (not supported by Hub Business).

Examples

Example 1

PS C:\> Get-RDMEntryHistory -InputObject $id | Where-Object ModifiedDate -lt $cutoff | Remove-RDMEntryHistory

Delete every version of the entry saved before the cutoff date.

Example 2

PS C:\> Get-RDMEntry $id | Remove-RDMEntryHistory

Delete all versions of the entry's history.

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

-Entry

Delete all versions of the piped entry

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

-History

Specific version to delete, obtained from Get-RDMEntryHistory

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

-PassThru

Return the deleted version(s).

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

-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.PSConnectionHistory

Specific version(s) to delete, obtained from Get-RDMEntryHistory

RemoteDesktopManager.PowerShellModule.PSOutputObject.PSConnection

Entries whose full history will be deleted

Outputs

RemoteDesktopManager.PowerShellModule.PSOutputObject.PSConnectionHistory

The deleted version(s), when -PassThru is specified

Notes

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