Update-EtwTraceSession
Modifies an existing ETW session.
Syntax
Update-EtwTraceSession
[-Name] <String[]>
[-LogFileMode <UInt32>]
[-LocalFilePath <String>]
[-MaximumFileSize <UInt32>]
[-BufferSize <UInt32>]
[-MaximumBuffers <UInt32>]
[-FlushTimer <UInt32>]
[-ClockType <ClockType>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Update-EtwTraceSession
-InputObject <CimInstance[]>
[-LogFileMode <UInt32>]
[-LocalFilePath <String>]
[-MaximumFileSize <UInt32>]
[-BufferSize <UInt32>]
[-MaximumBuffers <UInt32>]
[-FlushTimer <UInt32>]
[-ClockType <ClockType>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
The Update-EtwTraceSession cmdlet modifies an existing Event Tracing for Windows (ETW) session.
Parameters
-AsJob
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.
The cmdlet immediately returns an object that represents the job and then displays the command prompt.
You can continue to work in the session while the job completes.
To manage the job, use the *-Job cmdlets.
To get the job results, use the Receive-Job cmdlet.
For more information about Windows PowerShell background jobs, see about_Jobs.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-BufferSize
Specifies the ETW session buffer size, in kilobytes.
| Type: | UInt32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-CimSession
Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.
| Type: | CimSession[] |
| Aliases: | Session |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ClockType
Specifies the type of timestamp that will be used for each event logged to this ETW session.
This is an advanced session configuration option, and it is not recommended that this parameter be set.
For more information, see the description of the ClientContext field in the topic WNODE_HEADER structure for a description of the different clock types available.
| Type: | ClockType |
| Accepted values: | Performance, System, Cycle |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-FlushTimer
When set, all active buffers in the session will be flushed at this interval, in seconds.
This is an advanced session configuration option, and it is not recommended that this parameter be set.
If it is not set, the ETW will select an appropriate default based on the LogFileMode.
| Type: | UInt32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InputObject
Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet.
| Type: | CimInstance[] |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-LocalFilePath
Specifies the full path to the file the ETW session should write to. For non-buffering mode sessions only.
Do not use this parameter if the session is configured as a buffering mode session. Use Save-EtwTraceSession to save a buffering mode session to disk instead.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-LogFileMode
Specifies the ETW session logging mode. The value is a bitmask of the ETW logging mode constants. For valid values, see Logging Mode Constants.
| Type: | UInt32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-MaximumBuffers
Specifies the maximum number of buffers the ETW session should use.
The ETW session will use a maximum of (BufferSize * MaximumBuffers) kilobytes of memory. Depending on the specified LogFileMode this may be pageable or non-paged memory.
If the session is losing events because the buffers cannot be flushed quickly enough to keep up with the incoming event rate, try increasing this value.
Configuring a session to use too many buffers may affect system performance.
| Type: | UInt32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-MaximumFileSize
Specifies the maximum file size for the output .etl file to grow to, in megabytes.
The parameter must be set for a circular, new-file, or sequential file mode ETW session.
For circular sessions, once the file reaches this size the oldest buffers will be overwritten by the new buffers.
For new-file sessions, once the file reaches this size a new file will be created and all new events will be written to that file.
For sequential file sessions, once the file reaches this size the session will stop.
| Type: | UInt32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Name
Specifies the name of the ETW session.
| Type: | String[] |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-PassThru
Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ThrottleLimit
Specifies the maximum number of concurrent operations that can be established to run the cmdlet.
If this parameter is omitted or a value of 0 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.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |