Suspend-BEJobQueue Help

Synopsis

Places the job queue for a server on hold in Backup Exec.

Syntax

Suspend-BEJobQueue [-BackupExecServer [<BEBackupExecServer>]] [<CommonParameters>]

Description

Places the job queue for a server on hold in Backup Exec.

Use Resume-BEJobQueue to resume the job queue for a server that you place on hold.

If you do not specify -BackupExecServer parameter, Suspend-BEJobQueue places the local Backup Exec server's job queue on hold.

Parameters

-BackupExecServer <BEBackupExecServer>

Specifies the Backup Exec server for which to place the job queue on hold in a CASO environment.

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

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

Input Type

BackupExec.Management.CLI.BEBackupExecServer

You can pipe a Backup Exec server object to Suspend-BEJobQueue.

Return Value

BackupExec.Management.CLI.BEBackupExecServer

Suspend-BEJobQueue returns a Backup Exec server object.

Examples

Example 1

C:\PS> Suspend-BEJobQueue

This command places the local Backup Exec server's job queue on hold.

Example 2

C:\PS> Get-BEBackupExecServer "ManagedServer0001" | Suspend-BEJobQueue

These commands place the job queue of the Backup Exec server named "ManagedServer0001" on hold.