Update-AutologgerConfig
Modifies an existing AutoLogger session configuration.
Syntax
Update-AutologgerConfig
[-Name] <String[]>
[-BufferSize <UInt32>]
[-ClockType <ClockType>]
[-DisableRealtimePersistence <UInt32>]
[-LocalFilePath <String>]
[-FileMax <UInt32>]
[-FlushTimer <UInt32>]
[-Guid <String>]
[-LogFileMode <UInt32>]
[-MaximumFileSize <UInt32>]
[-MaximumBuffers <UInt32>]
[-MinimumBuffers <UInt32>]
[-Start <UInt32>]
[-InitStatus <UInt32>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Update-AutologgerConfig
-InputObject <CimInstance[]>
[-BufferSize <UInt32>]
[-ClockType <ClockType>]
[-DisableRealtimePersistence <UInt32>]
[-LocalFilePath <String>]
[-FileMax <UInt32>]
[-FlushTimer <UInt32>]
[-Guid <String>]
[-LogFileMode <UInt32>]
[-MaximumFileSize <UInt32>]
[-MaximumBuffers <UInt32>]
[-MinimumBuffers <UInt32>]
[-Start <UInt32>]
[-InitStatus <UInt32>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
The Update-AutologgerConfig cmdlet modifies an existing AutoLogger session configuration.
Examples
Example 1: Modify a configuration
PS C:\> Update-AutologgerConfig -Name "WFP-IPsec Trace" -MaximumBuffers 8 -ClockType CycleThis command modifies the AutoLogger configuration named WFP-IPsec Trace.
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: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-BufferSize
Specifies the Event Tracing for Windows (ETW) trace session buffer size in KB.
| Type: | UInt32 |
| Position: | Named |
| Default value: | 0 |
| 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 WNODE_HEADER structure for a description of clock types.
| 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: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DisableRealtimePersistence
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.
| Type: | UInt32 |
| Position: | Named |
| Default value: | 0 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-FileMax
Specifies the maximum number of log files an AutoLogger session can create.
| Type: | UInt32 |
| Position: | Named |
| Default value: | 0 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-FlushTimer
Specifies the timeout value for ETW trace session to flush capture buffer.
| Type: | UInt32 |
| Position: | Named |
| Default value: | 0 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Guid
Specifies an AutoLogger session configuration ID.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InitStatus
Specifies the initial status of the AutoLogger configuration.
| Type: | UInt32 |
| Position: | Named |
| Default value: | 0 |
| 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 for an ETW log file.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-LogFileMode
Specify one or more log modes, such as EVENT_TRACE_REAL_TIME_MODE 0x100. Each mode is a bit field.
| Type: | UInt32 |
| Position: | Named |
| Default value: | 0 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-MaximumBuffers
Specifies the maximum number of buffers for an ETW trace session.
| Type: | UInt32 |
| Position: | Named |
| Default value: | 0 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-MaximumFileSize
Specifies the maximum size, in MB, of a log file before a new one is created.
| Type: | UInt32 |
| Position: | Named |
| Default value: | 0 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-MinimumBuffers
Specifies the minimum number of buffers for an ETW trace session.
| Type: | UInt32 |
| Position: | Named |
| Default value: | 0 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Name
Specifies the name of the AutoLogger session.
| Type: | String[] |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | 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.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Start
By default, the AutoLogger session is configured to start at boot time.
| Type: | UInt32 |
| Position: | Named |
| Default value: | 0 |
| 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: | 0 |
| 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: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |