Remove-BEJobHistory Help

Synopsis

Removes job histories from Backup Exec.

Syntax

Remove-BEJobHistory -InputObject [<BEJobHistory[]>] [-PassThru [<SwitchParameter>]] [-Confirm [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]] [<CommonParameters>]

Description

Removes job histories from Backup Exec.

Parameters

-PassThru <SwitchParameter>

Passes the removed object to the pipeline. By default, this cmdlet does not generate any output.

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-InputObject <BEJobHistory[]>

Specifies one or more job history objects. Enter a variable that contains the objects, or type a command or expression that gets the objects.

Required	true
Position	Named
Accepts pipeline input	true (ByValue)
Accepts wildcard characters	false

-WhatIf <SwitchParameter>

Describes what happens if you execute the command without actually executing the command.

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-Confirm <SwitchParameter>

Prompts you for confirmation before executing the command.

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

For more information about common parameters, type "Get-Help about_commonparameters".

Input Type

BackupExec.Management.CLI.BEJobHistory

You can pipe a Backup Exec job history object to Remove-BEJobHistory.

Return Value

None or BackupExec.Management.CLI.BEJobHistory

When you use the PassThru parameter, Remove-BEJobHistory returns an object that represents the job history that was removed. Otherwise, this cmdlet does not generate any output.

Example

C:\PS> Get-BEJob "Job 0001" | Get-BEJobHistory | Remove-BEJobHistory

These commands remove all job histories associated with a job named "Job 0001".