Remove-RDMSystemInformationReport

    2024-12-11

    Remove-RDMSystemInformationReport

    SYNOPSIS

    Delete the inventory report from the history

    SYNTAX

    InputObject

    Remove-RDMSystemInformationReport [-InputObject] <PSSystemInformationReport>
     [-VaultMode <VaultMode>] [-ForcePromptAnswer <DialogResult[]>] [-WhatIf] [-Confirm]
     [<CommonParameters>]
    

    ALIASES

    This cmdlet has the following aliases,

    DESCRIPTION

    Delete the inventory report from the history. Only an administrator or vault owner can use this command.

    EXAMPLES

    EXAMPLE

    PS C:> $lastYearReports = Get-RDMEntry -Name 'MySystemInformationReportEntry' | Get-RDMSystemInformationReport -After 2023-01-01 -Before 2023-12-31 PS C:> foreach ($report in $lastYearReports) { $exportPath = "C:\my\path$($report.Inventory.ComputerName)_$($report.MetaInformation.CreationDate.ToString('yyyy-MM-dd')).inv" Export-RDMSystemInformationReport -Path $exportPath -InputObject $report } PS C:> $lastYearReports | Remove-RDMSystemInformationReport

    Export all the last year inventories and delete them from the hisotry

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

    -InputObject

    System information report to delete

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

    System information report object with metadata

    OUTPUTS

    NOTES

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