Set-Printer

Set-Printer

Updates the configuration of an existing printer.

構文

Parameter Set: Name
Set-Printer [-Name] <String[]> [-AsJob] [-BranchOfficeOfflineLogSizeMB <UInt32> ] [-CimSession <CimSession[]> ] [-Comment <String> ] [-ComputerName <String> ] [-Datatype <String> ] [-DisableBranchOfficeLogging <Boolean> ] [-DriverName <String> ] [-KeepPrintedJobs <Boolean> ] [-Location <String> ] [-PassThru] [-PermissionSDDL <String> ] [-PortName <String> ] [-PrintProcessor <String> ] [-Priority <UInt32> ] [-Published <Boolean> ] [-RenderingMode <RenderingModeEnum> ] [-SeparatorPageFile <String> ] [-Shared <Boolean> ] [-ShareName <String> ] [-StartTime <UInt32> ] [-ThrottleLimit <Int32> ] [-UntilTime <UInt32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: InputObject (cdxml)
Set-Printer -InputObject <CimInstance[]> [-AsJob] [-BranchOfficeOfflineLogSizeMB <UInt32> ] [-CimSession <CimSession[]> ] [-Comment <String> ] [-Datatype <String> ] [-DisableBranchOfficeLogging <Boolean> ] [-DriverName <String> ] [-KeepPrintedJobs <Boolean> ] [-Location <String> ] [-PassThru] [-PermissionSDDL <String> ] [-PortName <String> ] [-PrintProcessor <String> ] [-Priority <UInt32> ] [-Published <Boolean> ] [-RenderingMode <RenderingModeEnum> ] [-SeparatorPageFile <String> ] [-Shared <Boolean> ] [-ShareName <String> ] [-StartTime <UInt32> ] [-ThrottleLimit <Int32> ] [-UntilTime <UInt32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

詳細説明

The Set-Printer cmdlet updates the configuration of the specified printer.

Use the KeepPrintedJobs parameter to make a printer keep printed jobs.

You can specify the printer to update by using either a printer object retrieved by Get-Printer, or by specifying a printer name.

You can use wildcard characters with Set-Printer. You can use Set-Printer in a Windows PowerShell remoting session.

You need administrator privileges to use Set-Printer.

パラメーター

-AsJob

エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-BranchOfficeOfflineLogSizeMB<UInt32>

Specifies the maximum size, in megabytes, of the branch office remote offline log file for this printer. You cannot specify this parameter for unshared queues or queues that do not have branch office enabled.

エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-CimSession<CimSession[]>

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

エイリアス

Session

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-Comment<String>

Specifies the text to add to the Comment field for the specified printer.

エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-ComputerName<String>

Specifies the name of the computer on which the printer is installed.

エイリアス

CN

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-Datatype<String>

Specifies the data type the printer uses to record print jobs.

エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-DisableBranchOfficeLogging<Boolean>

Indicates whether branch office remote logging is disabled. You cannot specify this parameter for unshared queues.

エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-DriverName<String>

Specifies the name of the printer driver for the printer.

エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-InputObject<CimInstance[]>

Specifies the object which contains the printer information to update.

エイリアス

なし

必須?

true

位置は?

named

既定値

なし

パイプライン入力を許可する

True (ByValue)

ワイルドカード文字を許可する

false

-KeepPrintedJobs<Boolean>

Specifies whether the printer jobs in the queue are kept.

エイリアス

なし

必須?

false

位置は?

named

既定値

False

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-Location<String>

Specifies the location of the printer.

エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-Name<String[]>

Specifies the name of the printer to modify.

エイリアス

なし

必須?

true

位置は?

1

既定値

なし

パイプライン入力を許可する

True (ByPropertyName)

ワイルドカード文字を許可する

false

-PassThru

作業中の項目を表すオブジェクトを返します。既定では、このコマンドレットによる出力はありません。

エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-PermissionSDDL<String>

Specifies the permissions for the printer as an SDDL string.

エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-PortName<String>

Specifies the name of the port used or created for the printer.

エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-PrintProcessor<String>

Specifies the name of the print processor used by the printer.

エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-Priority<UInt32>

Specifies the relative queue priority.

エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-Published<Boolean>

Specifies whether or not the printer is published in the network directory service.

エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-RenderingMode<RenderingModeEnum>

Specifies the rendering mode for the printer. You can specify one of the following three rendering modes: SSR, CSR, or BOPD

エイリアス

なし

必須?

false

位置は?

named

既定値

CSR

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-SeparatorPageFile<String>

Specifies the path to and name of the separator page to be used by the printer.

エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-ShareName<String>

Specifies the name by which to share the printer on the network. To change the share state of a printer, specify the Shared parameter.

エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-Shared<Boolean>

Changes the share state of the printer.

エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-StartTime<UInt32>

Specifies the starting time of printer availability.

エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-ThrottleLimit<Int32>

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

エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-UntilTime<UInt32>

Specifies the ending time of printer availability.

エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-Confirm

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

必須?

false

位置は?

named

既定値

false

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-WhatIf

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

必須?

false

位置は?

named

既定値

false

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

<CommonParameters>

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

入力

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

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

    This cmdlet accepts one printer object.

出力

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

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

    This cmdlet returns a printer object.

Example 1: Set printer to keep printed jobs

This command configures the "Microsoft XPS Document Writer" printer to keep printed jobs.

PS C:\> Set-Printer –Name "Microsoft XPS Document Writer" -KeepPrintedJobs $true

Example 2: Set printer to keep printed jobs by using a printer object

This set of commands retrieves a printer object in to a variable ($printer) using Get-Printer, and passes the contents of the variable to Set-Printer.

PS C:\> $printer = Get-Printer –Name "Microsoft XPS Document Writer"
PS C:\> $printer.KeepPrintedJobs = $true
PS C:\> Set-Printer –InputObject $printer

関連トピック

Add-Printer

Get-Printer

Remove-Printer

Rename-Printer