New-NetEventSession
New-NetEventSession
Creates a network event session.
Sintaxis
Parameter Set: cim:CreateInstance0
New-NetEventSession [-Name] <String> [-CaptureMode <CaptureModes> {RealtimeRPC | SaveToFile | RealtimeLocal} ] [-CimSession <CimSession[]> ] [-LocalFilePath <String> ] [-MaxFileSize <UInt32> ] [-MaxNumberOfBuffers <Byte> ] [-ThrottleLimit <Int32> ] [-TraceBufferSize <UInt32> ] [-Confirm] [-WhatIf] [ <CommonParameters>] [ <WorkflowParameters>]
Descripción detallada
The New-NetEventSession cmdlet creates a network event session. A session controls how the computer logs events and, optionally, network traffic, or packets. Add network event providers to a session. A network event provider logs events and network traffic as Event Tracing for Windows (ETW) events. The session stores these events in an .etl file or provides them to an application that displays them.
Assign a name for the session. Only one session can exist at a time. Remove an existing session by using the Remove-NetEventSession cmdlet. You can specify the maximum number of buffers in a session and the size of the trace buffer.
You can also specify whether to use an.etl file and, if you do, specify its location and maximum size. Instead of an .etl file, you can select a type of live display.
After you create a session, you can use the Set-NetEventSession cmdlet to modify the session settings. After you create a session, add one or more providers to it by using the Add-NetEventProvider cmdlet. Use the Start-NetEventSession and Stop-NetEventSession cmdlets to start and stop logging.
Parámetros
-CaptureMode<CaptureModes>
Specifies a capture mode. Los valores aceptables para este parámetro son los siguientes:
-- SaveToFile. Saves the capture to an .etl file.
-- RealtimeRPC. Connects remotely for a live event and packet capture.
-- RealtimeLocal. Connects locally for a live event and packet capture.
If you specify a value of SaveToFile, you can specify a location for the file by using the LocalFilePath parameter and specify a maximum file size by using the MaxFileSize parameter.
If you specify a value of RealtimeRPC or RealtimeLocal, the capture requires additional software, such as Microsoft Message Analyzer..
Alias |
cm |
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
none |
¿Aceptar canalización? |
false |
¿Aceptar caracteres comodín? |
false |
-CimSession<CimSession[]>
Ejecuta el cmdlet en una sesión remota o en un equipo remoto. Escriba un nombre de equipo o un objeto de sesión, como la salida de un cmdlet New-CimSession o Get-CimSession. El valor predeterminado es la sesión actual en el equipo local.
Alias |
Session |
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
none |
¿Aceptar canalización? |
false |
¿Aceptar caracteres comodín? |
false |
-LocalFilePath<String>
Specifies a file path. If you specify a value of SaveToFile for the CaptureMode parameter, the cmdlet saves the file to this location. Be sure that you can write to this location. If you do not specify this parameter, the cmdlet uses the default value of %LocalAppData%\Temp\NetTrace.etl.
Alias |
lfp |
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
none |
¿Aceptar canalización? |
false |
¿Aceptar caracteres comodín? |
false |
-MaxFileSize<UInt32>
Specifies a maximum file size, in megabytes. If you specify a value of SaveToFile for the CaptureMode parameter, this value is the maximum size for the .etl file. Once the file reaches the maximum, the session continues to save events, and discards the oldest events to make room. A value of 0 means that there is no maximum. If you do not specify this parameter, the cmdlet uses a default value of 250.
Alias |
none |
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
none |
¿Aceptar canalización? |
false |
¿Aceptar caracteres comodín? |
false |
-MaxNumberOfBuffers<Byte>
Specifies the maximum number of buffers used in a session. If the computer determines that the value restricts performance or the value is 0, the computer overrides the configuration to optimize trace performance. For more information, see EVENT_TRACE_PROPERTIES structure (https://msdn.microsoft.com/en-us/library/windows/desktop/aa363784(v=vs.85).aspx) In the Microsoft Developer Network library.
Alias |
none |
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
none |
¿Aceptar canalización? |
false |
¿Aceptar caracteres comodín? |
false |
-Name<String>
Specifies a name to assign to the session for event and packet capture.
Alias |
none |
¿Requerido? |
true |
¿Posición? |
1 |
Valor predeterminado |
none |
¿Aceptar canalización? |
false |
¿Aceptar caracteres comodín? |
false |
-ThrottleLimit<Int32>
Especifica el número máximo de operaciones simultáneas que se pueden establecer para ejecutar el cmdlet. Si se omite este parámetro o es especifica un valor de 0, Windows PowerShell ® calcula un límite óptimo para el cmdlet en función del número de cmdlets de CIM que se estén ejecutando en el equipo. El límite solo se aplica al cmdlet actual, no a la sesión ni al equipo.
Alias |
none |
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
none |
¿Aceptar canalización? |
false |
¿Aceptar caracteres comodín? |
false |
-TraceBufferSize<UInt32>
Specifies the amount of memory, in kilobytes, for a buffer for event tracing. The maximum value is 1024. If the computer determines that the value restricts performance or the value is 0, the computer overrides the configuration to optimize trace performance. The ETW logger uses the size of physical memory to calculate the default value.
Alias |
none |
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
none |
¿Aceptar canalización? |
false |
¿Aceptar caracteres comodín? |
false |
-Confirm
Solicita confirmación antes de ejecutar el cmdlet.
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
falso |
¿Aceptar canalización? |
false |
¿Aceptar caracteres comodín? |
false |
-WhatIf
Muestra lo que sucedería si se ejecutara el cmdlet. El cmdlet no se ejecuta.
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
falso |
¿Aceptar canalización? |
false |
¿Aceptar caracteres comodín? |
false |
<CommonParameters>
Este cmdlet admite los siguientes parámetros comunes: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer y -OutVariable. Para obtener más información, consulte about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
<WorkflowParameters>
Este cmdlet admite los siguientes parámetros comunes de flujos de trabajo: -PSParameterCollection, -PSComputerName, -PSCredential, -PSConnectionRetryCount, -PSConnectionRetryIntervalSec, -PSRunningTimeoutSec, -PSElapsedTimeoutSec, -PSPersist, -PSAuthentication, -PSAuthenticationLevel, -PSApplicationName, -PSPort, -PSUseSSL, -PSConfigurationName, -PSConnectionURI, -PSAllowRedirection, -PSSessionOption, -PSCertificateThumbprint, -PSPrivateMetadata, -AsJob, -JobName e –InputObject. Para obtener más información, consulte about_WorkflowCommonParameters.
Entradas
El tipo de entrada es el tipo de los objetos que se pueden canalizar al cmdlet.
Salidas
El tipo de resultado es el tipo de objetos que emite el cmdlet.
Ejemplos
Example 1: Create a session
This command creates session named Session38. Use the Add-NetEventProvider cmdlet to add a provider for the session.
PS C:\> New-NetEventSession -Name "Session38"