Set-AutologgerConfig

[アーティクル]
11/16/2015

適用対象: Windows 10, Windows Server Technical Preview

Set-AutologgerConfig

Modifies an Autologger configuration.

構文

Parameter Set: ByName
Set-AutologgerConfig [-Name] <String[]> [-BufferSize <UInt32> ] [-CimSession <CimSession[]> ] [-ClockType <ClockType> {Performance | System | Cycle} ] [-DisableRealtimePersistence <UInt32> ] [-FileMax <UInt32> ] [-FlushTimer <UInt32> ] [-Guid <String> ] [-InitStatus <UInt32> ] [-LocalFilePath <String> ] [-LogFileMode <UInt32> ] [-MaximumBuffers <UInt32> ] [-MaximumFileSize <UInt32> ] [-MinimumBuffers <UInt32> ] [-PassThru] [-Start <UInt32> ] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>] [ <WorkflowParameters>]

Parameter Set: InputObject (cdxml)
Set-AutologgerConfig [-BufferSize <UInt32> ] [-CimSession <CimSession[]> ] [-ClockType <ClockType> {Performance | System | Cycle} ] [-DisableRealtimePersistence <UInt32> ] [-FileMax <UInt32> ] [-FlushTimer <UInt32> ] [-Guid <String> ] [-InitStatus <UInt32> ] [-LocalFilePath <String> ] [-LogFileMode <UInt32> ] [-MaximumBuffers <UInt32> ] [-MaximumFileSize <UInt32> ] [-MinimumBuffers <UInt32> ] [-PassThru] [-Start <UInt32> ] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>] [ <WorkflowParameters>]

詳細説明

The Set-AutologgerConfig cmdlet modifies an existing Autologger configuration. An Autologger event tracing session records events that occur early in the operating system boot process. Applications and device drivers capture traces both before and after the user logs in. Restart the computer for configuration changes to take effect in the underlying Event Trace for Windows (ETW) session. Modify the ETW trace session by using the Set-EtwTraceSession and Remove-EtwTraceSession cmdlets.

パラメーター

-BufferSize<UInt32>

Specifies the size, in kilobytes, of buffers. We recommend less than 1000 kilobytes. If you do not specify a value for this parameter, ETW uses the size of physical memory to calculate a default value.

Aliases	none
必須/オプション	false
位置	named
既定値	none
パイプライン入力の受け入れ	false
ワイルドカード文字の受け入れ	false

-CimSession<CimSession[]>

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

Aliases	Session
必須/オプション	false
位置	named
既定値	none
パイプライン入力の受け入れ	false
ワイルドカード文字の受け入れ	false

-ClockType<ClockType>

Specifies the timer to use for the time stamp for events. Valid values are:

-- Performance. Performance counter value (high resolution)
-- System. System timer
-- Cycle. CPU cycle counter

The default value is Performance on computers that run Windows Vista and subsequent versions of the Windows operating system. The default value is System for previous versions of the Windows operating system.

Aliases	none
必須/オプション	false
位置	named
既定値	none
パイプライン入力の受け入れ	false
ワイルドカード文字の受け入れ	false

-DisableRealtimePersistence<UInt32>

Specifies whether to not persist real-time events that were not delivered before the time the computer was shutdown. Persisted events are delivered to the consumer the next time the consumer connects to the session. To disable real time persistence, specify a value of one. To persist events, specify a value of zero. The default is zero.

Aliases	none
必須/オプション	false
位置	named
既定値	none
パイプライン入力の受け入れ	false
ワイルドカード文字の受け入れ	false

-FileMax<UInt32>

Specifies the maximum number of instances of the log file that ETW creates. Valid values are integers up to 16.

If the log file you specified with the LocalFilePath parameter exists, ETW appends the FileCounter value to the file name. For example, if the default log file name is used, the form is %SystemRoot%\System32\LogFiles\WMI\<sessionname>.etl.NNNN.

The first time you start the computer, the file name is <sessionname>.etl.0001. The second time, the file name is <sessionname>.etl.0002. If you specify a value of 3 for FileMax, then at the fourth start of the computer, ETW resets the counter to one (1), and then overwrites <sessionname>.etl.0001.

Aliases	none
必須/オプション	false
位置	named
既定値	none
パイプライン入力の受け入れ	false
ワイルドカード文字の受け入れ	false

-FlushTimer<UInt32>

Specifies the interval, in seconds, at which to flush trace buffers. The minimum value is one second. This forced flush is in addition to the automatic flush that occurs when a buffer is full and when the trace session stops.

For a real-time logger, the default value of zero means that the flush time is one second. You can configure a real-time logger by specifying a value of EVENT_TRACE_REAL_TIME_MODE for the LogFileMode parameter.

The default value is zero. By default, buffers are flushed only when they are full.

Aliases	none
必須/オプション	false
位置	named
既定値	none
パイプライン入力の受け入れ	false
ワイルドカード文字の受け入れ	false

-Guid<String>

Specifies a GUID, as a string, that uniquely identifies the session.

Aliases	none
必須/オプション	false
位置	named
既定値	none
パイプライン入力の受け入れ	false
ワイルドカード文字の受け入れ	false

-InitStatus<UInt32>

Specifies the initial status of the Autologger configuration.

Aliases	none
必須/オプション	false
位置	named
既定値	none
パイプライン入力の受け入れ	false
ワイルドカード文字の受け入れ	false

-LocalFilePath<String>

Specifies the full path for an ETW log file.

Aliases	none
必須/オプション	false
位置	named
既定値	none
パイプライン入力の受け入れ	false
ワイルドカード文字の受け入れ	false

-LogFileMode<UInt32>

Specifies one or more log modes. For valid values, see Logging Mode Constants.

Instead of writing to a log file, you can specify either EVENT_TRACE_BUFFERING_MODE or EVENT_TRACE_REAL_TIME_MODE. EVENT_TRACE_BUFFERING_MODE avoids the cost of flushing the contents of the session to disk when the file system becomes available.

Autologger sessions do not support the EVENT_TRACE_FILE_MODE_NEWFILE logging mode.

If you specify EVENT_TRACE_FILE_MODE_APPEND, specify a value for the BufferSize parameter that is the same in both the logger and the file being appended.

Specify more than one log mode, add the values of the modes. For instance, to include both EVENT_TRACE_FILE_MODE_CIRCULAR, which has a value of 0x00000002, and EVENT_TRACE_NO_PER_PROCESSOR_BUFFERING, which has a value of 0x10000000, add 0x10000000 and 0x00000002 to obtain 0x1000002.

Aliases	none
必須/オプション	false
位置	named
既定値	none
パイプライン入力の受け入れ	false
ワイルドカード文字の受け入れ	false

-MaximumBuffers<UInt32>

Specifies the maximum number of buffers to allocate to the Autologger session. We recommend a value of the MinimumBuffers parameter plus twenty. The value must be greater than or equal to MinimumBuffers. If you do not specify a value for the current parameter, ETW uses the buffer size and the size of physical memory to calculate a default value.

Aliases	none
必須/オプション	false
位置	named
既定値	none
パイプライン入力の受け入れ	false
ワイルドカード文字の受け入れ	false

-MaximumFileSize<UInt32>

Specifies the maximum size, in megabytes, of a log file. The session is closed when the maximum size is reached, unless the session uses the circular log file mode. To specify no limit, specify a value of zero. The default value is 100 MB. When the log file size reaches its maximum size, the behavior depends on the value specified by the LogFileMode parameter.

Aliases	none
必須/オプション	false
位置	named
既定値	none
パイプライン入力の受け入れ	false
ワイルドカード文字の受け入れ	false

-MinimumBuffers<UInt32>

Specifies the minimum number of buffers to allocate at startup of the Autologger session. The minimum number of buffers that you can specify is two buffers per processor.

Aliases	none
必須/オプション	false
位置	named
既定値	none
パイプライン入力の受け入れ	false
ワイルドカード文字の受け入れ	false

-Name<String[]>

Specifies an array of names of the Autologger configurations to modify.

Aliases	none
必須/オプション	true
位置	1
既定値	none
パイプライン入力の受け入れ	true(ByPropertyName)
ワイルドカード文字の受け入れ	false

-PassThru

Indicates that this cmdlet returns an object that represents the item on which it operates. By default, this cmdlet does not generate any output.

Aliases	none
必須/オプション	false
位置	named
既定値	none
パイプライン入力の受け入れ	false
ワイルドカード文字の受け入れ	false

-Start<UInt32>

Specifies whether to activate the Autologger session at the next computer restart. Specify a value of one to activate. Otherwise, specify a value of zero.

Aliases	none
必須/オプション	false
位置	named
既定値	none
パイプライン入力の受け入れ	false
ワイルドカード文字の受け入れ	false

-ThrottleLimit<Int32>

Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of zero is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.

Aliases	none
必須/オプション	false
位置	named
既定値	none
パイプライン入力の受け入れ	false
ワイルドカード文字の受け入れ	false

-Confirm

コマンドレットを実行する前に確認メッセージを表示します。

必須/オプション	false
位置	named
既定値	false
パイプライン入力の受け入れ	false
ワイルドカード文字の受け入れ	false

-WhatIf

コマンドレットが実行された場合に何が起きるのかを示します。コマンドレットは実行されません。

必須/オプション	false
位置	named
既定値	false
パイプライン入力の受け入れ	false
ワイルドカード文字の受け入れ	false

<CommonParameters>

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

<WorkflowParameters>

入力

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

出力

出力型は、コマンドレットが出力するオブジェクトの型です。

使用例

Example 1: Modify a configuration

This command modifies the Autologger configuration named WFP-IPsec Trace.

PS C:\> Set-AutologgerConfig -Name "WFP-IPsec Trace" -MaximumBuffers 8 -ClockType Cycle

Set-AutologgerConfig