New-NetEventSession
New-NetEventSession
Creates a network event session.
Sintaxe
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>]
Descrição detalhada
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. Os valores aceitáveis para este parâmetro são:
-- 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..
Aliases |
cm |
Necessário? |
false |
Posição? |
named |
Valor padrão |
none |
Aceitar entrada do pipeline? |
false |
Aceitar caracteres curinga? |
false |
-CimSession<CimSession[]>
Executa o cmdlet em uma sessão remota ou em um computador remoto. Insira um nome do computador ou um objeto de sessão, como a saída de um cmdlet New-CimSession ou Get-CimSession. O padrão é a sessão atual do computador local.
Aliases |
Session |
Necessário? |
false |
Posição? |
named |
Valor padrão |
none |
Aceitar entrada do pipeline? |
false |
Aceitar caracteres curinga? |
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.
Aliases |
lfp |
Necessário? |
false |
Posição? |
named |
Valor padrão |
none |
Aceitar entrada do pipeline? |
false |
Aceitar caracteres curinga? |
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.
Aliases |
none |
Necessário? |
false |
Posição? |
named |
Valor padrão |
none |
Aceitar entrada do pipeline? |
false |
Aceitar caracteres curinga? |
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.
Aliases |
none |
Necessário? |
false |
Posição? |
named |
Valor padrão |
none |
Aceitar entrada do pipeline? |
false |
Aceitar caracteres curinga? |
false |
-Name<String>
Specifies a name to assign to the session for event and packet capture.
Aliases |
none |
Necessário? |
true |
Posição? |
1 |
Valor padrão |
none |
Aceitar entrada do pipeline? |
false |
Aceitar caracteres curinga? |
false |
-ThrottleLimit<Int32>
Especifica o número máximo de operações simultâneas que podem ser estabelecidas para executar o cmdlet. Se esse parâmetro for omitido ou um valor de 0
for inserido, o Windows PowerShell® calculará o limite ideal de restrição para o cmdlet com base no número de cmdlets do CIM que estão em execução no computador. O limite de restrição se aplica somente ao cmdlet atual, e não à sessão ou ao computador.
Aliases |
none |
Necessário? |
false |
Posição? |
named |
Valor padrão |
none |
Aceitar entrada do pipeline? |
false |
Aceitar caracteres curinga? |
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.
Aliases |
none |
Necessário? |
false |
Posição? |
named |
Valor padrão |
none |
Aceitar entrada do pipeline? |
false |
Aceitar caracteres curinga? |
false |
-Confirm
Solicita que você confirme antes de executar o cmdlet.
Necessário? |
false |
Posição? |
named |
Valor padrão |
false |
Aceitar entrada do pipeline? |
false |
Aceitar caracteres curinga? |
false |
-WhatIf
Mostra o que aconteceria se o cmdlet fosse executado. O cmdlet não é executado.
Necessário? |
false |
Posição? |
named |
Valor padrão |
false |
Aceitar entrada do pipeline? |
false |
Aceitar caracteres curinga? |
false |
<CommonParameters>
Esse cmdlet dá suporte a parâmetros comuns: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer e -OutVariable. Para obter mais informações, consulte about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
<WorkflowParameters>
Este cmdlet dá suporte aos seguintes parâmetros comuns de fluxo de trabalho: -PSParameterCollection, -PSComputerName, -PSCredential, -PSConnectionRetryCount, -PSConnectionRetryIntervalSec, -PSRunningTimeoutSec, -PSElapsedTimeoutSec, -PSPersist, -PSAuthentication, -PSAuthenticationLevel, -PSApplicationName, -PSPort, -PSUseSSL, -PSConfigurationName, -PSConnectionURI, -PSAllowRedirection, -PSSessionOption, -PSCertificateThumbprint, -PSPrivateMetadata, -AsJob, -JobName e –InputObject. Para obter mais informações, consulte about_WorkflowCommonParameters.
Entradas
O tipo de entrada é o tipo dos objetos que você pode canalizar para o cmdlet.
Saídas
O tipo de saída é o tipo de objeto emitido pelo cmdlet.
Exemplos
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"