Suspend-BEJob Help

Synopsis

Places a job on hold in Backup Exec.

Syntax

Suspend-BEJob -InputObject [<BEJob[]>] [-Confirm [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]] [<CommonParameters>]

Description

Places a job on hold in Backup Exec.

Use Resume-BEJob to resume jobs that you place on hold.

Parameters

-InputObject <BEJob[]>

Specifies one or more job 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.BEJob

You can pipe a Backup Exec job object to Suspend-BEJob.

Return Value

BackupExec.Management.CLI.BEJob

Suspend-BEJob returns a Backup Exec job object.

Example

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

These commands place a job named "Job 0001" on hold.