Suspend-PrintJob

Suspend-PrintJob

Suspends a print job on the specified printer.

構文

Parameter Set: jobObject
Suspend-PrintJob [-InputObject] <CimInstance> [-AsJob] [-CimSession <CimSession[]> ] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: printerName
Suspend-PrintJob [-PrinterName] <String> [-ID] <UInt32> [-AsJob] [-CimSession <CimSession[]> ] [-ComputerName <String> ] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: printerObject
Suspend-PrintJob [-PrinterObject] <CimInstance> [-ID] <UInt32> [-AsJob] [-CimSession <CimSession[]> ] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

詳細説明

The Suspend-PrintJob cmdlet suspends a print job on the specified printer. Use Resume-PrintJob to resume the suspended print job.

You can specify the print job to suspend by specifying the PrinterName and job ID parameters, specifying a printer object and the job ID parameter, or by specifying a print job object as an input.

You cannot use wildcard characters with Suspend-PrintJob. You can use Suspend-PrintJob in a Windows PowerShell remoting session.

You do not need administrator privileges to use Suspend-PrintJob.

パラメーター

-AsJob

-CimSession<CimSession[]>

リモート セッションまたはリモート コンピューターでコマンドレットを実行します。New-CimSession コマンドレットや Get-CimSession コマンドレットの出力など、コンピューター名またはセッション オブジェクトを入力します。既定値は、ローカル コンピューターで実行中の現在のセッションです。

-ComputerName<String>

Specifies the name of the computer on which to suspend a print job.

-ID<UInt32>

Specifies the ID of the print job to suspend on the specified printer. You can use wildcard characters.

-InputObject<CimInstance>

Specifies the object which contains the print job to suspend on the specified printer.

-PrinterName<String>

Specifies a printer name on which to suspend the print job.

-PrinterObject<CimInstance>

Specifies the object which contains the printer on which to suspend the print job.

-ThrottleLimit<Int32>

このコマンドレットを実行するために確立できる最大同時操作数を指定します。このパラメーターを省略するか、値として 0 を入力した場合、Windows PowerShell® では、コンピューターで実行している CIM コマンドレットの数に基づいて、コマンドレットに対する最適なスロットル制限を計算します。スロットル制限は現在のコマンドレットのみに適用され、セッションまたはコンピューターには適用されません。

-Confirm

コマンドレットを実行する前に、ユーザーに確認を求めます。

-WhatIf

コマンドレットを実行するとどのような結果になるかを表示します。コマンドレットは実行されません。

<CommonParameters>

このコマンドレットは次の共通パラメーターをサポートします。-Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer、-OutVariable.詳細については、以下を参照してください。 about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216)。

入力

入力型は、コマンドレットにパイプできるオブジェクトの型です。

• Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_PrintJob

  This cmdlet accepts one print job object.

出力

出力型は、コマンドレットによって生成されるオブジェクトの型です。

• This cmdlet produces no output.

例

Example 1: Suspend a specific print job

This command suspends the print job with an ID of 1 on the printer named PrinterName.

PS C:\> Suspend-PrintJob -PrinterName "PrinterName" -ID 1

Example 2: Suspend a print job using a printer object and print job ID

This set of commands retrieves a printer object into a variable ($printer) using Get-Printer, and then passes the contents of the variable to Suspend-PrintJob to suspend the print job with an ID of 1 on the printer contained in the printer object.

PS C:\> $printer = Get-Printer -Name "PrinterName:"

PS C:\> Suspend-PrintJob -PrinterObject $printer -ID 1

Example 3: Suspend a print job using a print job object

This set of commands retrieves a print job object with an ID of 1 into a variable ($printJob) using Get-PrintJob, and then passes the contents of the variable to Suspend-PrintJob to suspend the print job on the printer contained in the print job object.

PS C:\> $printJob = Get-PrintJob -PrinterName "Printer1" -ID 1

PS C:\> Suspend-PrintJob -InputObject $printJob

関連トピック

Get-PrintJob

Remove-PrintJob

Restart-PrintJob

Resume-PrintJob