New-AutologgerConfig

S'applique à: Windows 10, Windows Server Technical Preview

New-AutologgerConfig

Creates an Autologger configuration.

Syntaxe

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

Description détaillée

The New-AutologgerConfig cmdlet creates an Autologger configuration. An AutoLogger event tracing session records events that occur early in the operating system boot process, in addition to any other events. Applications and device drivers capture traces both before and after the user logs in. Restart the computer for the new configuration to initiate an Event Trace for Windows (ETW) trace session. Modify the ETW trace session by using the Set-EtwTraceSession and Remove-EtwTraceSession cmdlets.

Paramètres

-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.

Alias	none
Requis ?	false
Position ?	named
Valeur par défaut	none
Accepter l'entrée de pipeline ?	false
Accepter les caractères génériques ?	false

-CimSession<CimSession[]>

Exécute l'applet de commande dans une session distante ou sur un ordinateur distant. Entrez un nom d'ordinateur ou un objet de session, tels que le résultat d'une applet de commande New-CimSession ou Get-CimSession. La valeur par défaut est la session en cours sur l'ordinateur local.

Alias	Session
Requis ?	false
Position ?	named
Valeur par défaut	none
Accepter l'entrée de pipeline ?	false
Accepter les caractères génériques ?	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.

Alias	none
Requis ?	false
Position ?	named
Valeur par défaut	none
Accepter l'entrée de pipeline ?	false
Accepter les caractères génériques ?	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.

Alias	none
Requis ?	false
Position ?	named
Valeur par défaut	none
Accepter l'entrée de pipeline ?	false
Accepter les caractères génériques ?	false

-FileCount<UInt32>

Specifies the file count value.

Alias	none
Requis ?	false
Position ?	named
Valeur par défaut	none
Accepter l'entrée de pipeline ?	false
Accepter les caractères génériques ?	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.

Alias	none
Requis ?	false
Position ?	named
Valeur par défaut	none
Accepter l'entrée de pipeline ?	false
Accepter les caractères génériques ?	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.

Alias	none
Requis ?	false
Position ?	named
Valeur par défaut	none
Accepter l'entrée de pipeline ?	false
Accepter les caractères génériques ?	false

-Guid<String>

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

Alias	none
Requis ?	false
Position ?	named
Valeur par défaut	none
Accepter l'entrée de pipeline ?	false
Accepter les caractères génériques ?	false

-LocalFilePath<String>

Specifies the full path for an ETW log file.

Alias	none
Requis ?	false
Position ?	named
Valeur par défaut	none
Accepter l'entrée de pipeline ?	false
Accepter les caractères génériques ?	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.

Alias	none
Requis ?	false
Position ?	named
Valeur par défaut	none
Accepter l'entrée de pipeline ?	false
Accepter les caractères génériques ?	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.

Alias	none
Requis ?	false
Position ?	named
Valeur par défaut	none
Accepter l'entrée de pipeline ?	false
Accepter les caractères génériques ?	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.

Alias	none
Requis ?	false
Position ?	named
Valeur par défaut	none
Accepter l'entrée de pipeline ?	false
Accepter les caractères génériques ?	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.

Alias	none
Requis ?	false
Position ?	named
Valeur par défaut	none
Accepter l'entrée de pipeline ?	false
Accepter les caractères génériques ?	false

-Name<String>

Specifies the name of the Autologger configuration.

Alias	none
Requis ?	true
Position ?	named
Valeur par défaut	none
Accepter l'entrée de pipeline ?	true(ByValue)
Accepter les caractères génériques ?	false

-Start<Enabled>

Specifies whether to activate the Autologger session at the next computer restart. Valid values are: Disabled and Enabled.

Alias	none
Requis ?	false
Position ?	named
Valeur par défaut	none
Accepter l'entrée de pipeline ?	false
Accepter les caractères génériques ?	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.

Alias	none
Requis ?	false
Position ?	named
Valeur par défaut	none
Accepter l'entrée de pipeline ?	false
Accepter les caractères génériques ?	false

-Confirm

Vous invite à confirmer l'exécution de l'applet de commande.

Requis ?	false
Position ?	named
Valeur par défaut	false
Accepter l'entrée de pipeline ?	false
Accepter les caractères génériques ?	false

-WhatIf

Indique ce qui se produit en cas d'exécution de l'applet de commande. L'applet de commande n'est pas exécutée.

Requis ?	false
Position ?	named
Valeur par défaut	false
Accepter l'entrée de pipeline ?	false
Accepter les caractères génériques ?	false

<CommonParameters>

Cette applet de commande prend en charge les paramètres courants : -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer et -OutVariable. Pour plus d'informations, consultez  . about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

<WorkflowParameters>

Entrées

Le type d'entrée correspond au type des objets que vous pouvez adresser à l'applet de commande.

Sorties

Le type de sortie correspond au type des objets que l'applet de commande émet.

Exemples

Example 1: Create a configuration

This command creates an Autologger configuration named WFP-IPsec Trace.

PS C:\> New-AutoLoggerconfig -Name "WFP-IPsec Trace"

Rubriques connexes

Configuring and Starting an AutoLogger Session

Logging Mode Constants

WNODE_HEADER structure

Get-AutologgerConfig

Remove-AutologgerConfig

Set-AutologgerConfig

Remove-EtwTraceSession

Set-EtwTraceSession