< Back
Add-NetEventProvider
Post
NAME Add-NetEventProvider
SYNOPSIS
Adds an ETW provider to a session.
SYNTAX
Add-NetEventProvider [-Name] <String> [-SessionName] <String> [[-Level] <Byte>] [[-MatchAnyKeyword] <UInt64>] [[-MatchAllKeyword] <UInt64>]
[-CimSession <CimSession[]>] [-InformationAction {SilentlyContinue | Stop | Continue | Inquire | Ignore | Suspend}] [-InformationVariable
<System.String>] [-ThrottleLimit <Int32>] [<CommonParameters>]
DESCRIPTION
The Add-NetEventProvider cmdlet adds an Event Tracing for Windows (ETW) provider to a session.
PARAMETERS
-CimSession [<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.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-InformationAction [<System.Management.Automation.ActionPreference>]
Specifies how this cmdlet responds to an information event. The acceptable values for this parameter are:
-- SilentlyContinue
-- Stop
-- Continue
-- Inquire
-- Ignore
-- Suspend
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-InformationVariable [<System.String>]
Specifies a variable in which to store an information event message.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Level [<Byte>]
Specifies the level of Event Tracing for Windows (ETW) events for the provider. Use the level of detail for the event to filter the events
that are logged. The default value for this parameter is 0x4. The acceptable values for this parameter are:
-- 0x5. Verbose
-- 0x4. Informational
-- 0x3. Warning
-- 0x2. Error
-- 0x1. Critical
-- 0x0. LogAlways
The provider must log the event if the value of the event is less than or equal to the value of this parameter.
Required? false
Position? 3
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-MatchAllKeyword [<UInt64>]
Specifies a bitmask that restricts the events that the provider logs.
Required? false
Position? 5
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-MatchAnyKeyword [<UInt64>]
Specifies keywords as a set of hexadecimal values. Keywords are flags that you can combine to generate values. Use a set of hexadecimal values
of the keywords instead of the keyword names, and apply a filter to write ETW events for keyword matches.
Required? false
Position? 4
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Name <String>
Specifies a name that identifies an ETW provider.
Required? true
Position? 1
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-SessionName <String>
Specifies the name of the session associated with the packet capture provider.
Required? true
Position? 2
Default value none
Accept pipeline input? false
Accept wildcard characters? 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 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.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
Example 1: Add an ETW provider to a session
PS C:\\>New-NetEventSession -SessionName "Session01"
PS C:\\> Add-NetEventProvider -Name "Microsoft-Windows-TCPIP" -SessionName "Session01"
This example adds an ETW provider to a session.
The first command uses the New-NetEventSession cmdlet to create a new session named Session01.
The second command adds an ETW provider named Microsoft-Windows-TCPIP to the session named Session01.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?LinkID=294383
Get-NetEventProvider
New-NetEventSession
Remove-NetEventProvider
Set-NetEventProvider
CommonParameters : True
WorkflowCommonParameters : False
details : @{name=Add-NetEventVFPProvider; noun=; verb=}
Syntax : @{syntaxItem=System.Object[]}
parameters : @{parameter=System.Object[]}
inputTypes : @{inputType=}
returnValues : @{returnValue=}
aliases : None
remarks : Get-Help cannot find the Help files for this cmdlet on this computer. It is displaying only partial help.
-- To download and install Help files for the module that includes this cmdlet, use Update-Help.
alertSet :
description :
examples :
Synopsis :
Add-NetEventVFPProvider [-SessionName] <string> [[-Level] <byte>] [[-MatchAnyKeyword] <uint64>] [[-MatchAllKeywords]
<uint64>] [[-DestinationMACAddresses] <string[]>] [[-SourceMACAddresses] <string[]>] [[-VLANIds] <uint16[]>] [[-TenantIds]
<uint32[]>] [[-GREKeys] <uint32[]>] [[-SourceIPAddresses] <string[]>] [[-DestinationIPAddresses] <string[]>]
[[-IPProtocols] <byte[]>] [[-TCPPorts] <uint16[]>] [[-UDPPorts] <uint16[]>] [[-VFPFlowDirection] <uint32>] [[-SwitchName]
<string>] [[-PortIds] <uint32[]>] [-CimSession <CimSession[]>] [-ThrottleLimit <int>] [-AsJob] [-WhatIf] [-Confirm]
[<CommonParameters>]
ModuleName : NetEventPacketCapture
nonTerminatingErrors :
xmlns:command : http://schemas.microsoft.com/maml/dev/command/2004/10
xmlns:dev : http://schemas.microsoft.com/maml/dev/2004/10
xmlns:maml : http://schemas.microsoft.com/maml/2004/10
Name : Add-NetEventVFPProvider
Category : Function
Component :
Role :
Functionality :
SYNOPSIS
Adds an ETW provider to a session.
SYNTAX
Add-NetEventProvider [-Name] <String> [-SessionName] <String> [[-Level] <Byte>] [[-MatchAnyKeyword] <UInt64>] [[-MatchAllKeyword] <UInt64>]
[-CimSession <CimSession[]>] [-InformationAction {SilentlyContinue | Stop | Continue | Inquire | Ignore | Suspend}] [-InformationVariable
<System.String>] [-ThrottleLimit <Int32>] [<CommonParameters>]
DESCRIPTION
The Add-NetEventProvider cmdlet adds an Event Tracing for Windows (ETW) provider to a session.
PARAMETERS
-CimSession [<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.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-InformationAction [<System.Management.Automation.ActionPreference>]
Specifies how this cmdlet responds to an information event. The acceptable values for this parameter are:
-- SilentlyContinue
-- Stop
-- Continue
-- Inquire
-- Ignore
-- Suspend
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-InformationVariable [<System.String>]
Specifies a variable in which to store an information event message.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Level [<Byte>]
Specifies the level of Event Tracing for Windows (ETW) events for the provider. Use the level of detail for the event to filter the events
that are logged. The default value for this parameter is 0x4. The acceptable values for this parameter are:
-- 0x5. Verbose
-- 0x4. Informational
-- 0x3. Warning
-- 0x2. Error
-- 0x1. Critical
-- 0x0. LogAlways
The provider must log the event if the value of the event is less than or equal to the value of this parameter.
Required? false
Position? 3
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-MatchAllKeyword [<UInt64>]
Specifies a bitmask that restricts the events that the provider logs.
Required? false
Position? 5
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-MatchAnyKeyword [<UInt64>]
Specifies keywords as a set of hexadecimal values. Keywords are flags that you can combine to generate values. Use a set of hexadecimal values
of the keywords instead of the keyword names, and apply a filter to write ETW events for keyword matches.
Required? false
Position? 4
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Name <String>
Specifies a name that identifies an ETW provider.
Required? true
Position? 1
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-SessionName <String>
Specifies the name of the session associated with the packet capture provider.
Required? true
Position? 2
Default value none
Accept pipeline input? false
Accept wildcard characters? 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 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.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
Example 1: Add an ETW provider to a session
PS C:\\>New-NetEventSession -SessionName "Session01"
PS C:\\> Add-NetEventProvider -Name "Microsoft-Windows-TCPIP" -SessionName "Session01"
This example adds an ETW provider to a session.
The first command uses the New-NetEventSession cmdlet to create a new session named Session01.
The second command adds an ETW provider named Microsoft-Windows-TCPIP to the session named Session01.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?LinkID=294383
Get-NetEventProvider
New-NetEventSession
Remove-NetEventProvider
Set-NetEventProvider
CommonParameters : True
WorkflowCommonParameters : False
details : @{name=Add-NetEventVFPProvider; noun=; verb=}
Syntax : @{syntaxItem=System.Object[]}
parameters : @{parameter=System.Object[]}
inputTypes : @{inputType=}
returnValues : @{returnValue=}
aliases : None
remarks : Get-Help cannot find the Help files for this cmdlet on this computer. It is displaying only partial help.
-- To download and install Help files for the module that includes this cmdlet, use Update-Help.
alertSet :
description :
examples :
Synopsis :
Add-NetEventVFPProvider [-SessionName] <string> [[-Level] <byte>] [[-MatchAnyKeyword] <uint64>] [[-MatchAllKeywords]
<uint64>] [[-DestinationMACAddresses] <string[]>] [[-SourceMACAddresses] <string[]>] [[-VLANIds] <uint16[]>] [[-TenantIds]
<uint32[]>] [[-GREKeys] <uint32[]>] [[-SourceIPAddresses] <string[]>] [[-DestinationIPAddresses] <string[]>]
[[-IPProtocols] <byte[]>] [[-TCPPorts] <uint16[]>] [[-UDPPorts] <uint16[]>] [[-VFPFlowDirection] <uint32>] [[-SwitchName]
<string>] [[-PortIds] <uint32[]>] [-CimSession <CimSession[]>] [-ThrottleLimit <int>] [-AsJob] [-WhatIf] [-Confirm]
[<CommonParameters>]
ModuleName : NetEventPacketCapture
nonTerminatingErrors :
xmlns:command : http://schemas.microsoft.com/maml/dev/command/2004/10
xmlns:dev : http://schemas.microsoft.com/maml/dev/2004/10
xmlns:maml : http://schemas.microsoft.com/maml/2004/10
Name : Add-NetEventVFPProvider
Category : Function
Component :
Role :
Functionality :