Get-NetEventSession

NAME Get-NetEventSession



SYNOPSIS

Gets network event sessions.





SYNTAX

Get-NetEventSession [[-Name] <String[]>] [-CimSession <CimSession[]>] [-InformationAction {SilentlyContinue | Stop | Continue | Inquire | Ignore |

Suspend}] [-InformationVariable <System.String>] [-ThrottleLimit <Int32>] [<CommonParameters>]



Get-NetEventSession [-AssociatedEventProvider <CimInstance>] [-CimSession <CimSession[]>] [-InformationAction {SilentlyContinue | Stop | Continue

| Inquire | Ignore | Suspend}] [-InformationVariable <System.String>] [-ThrottleLimit <Int32>] [<CommonParameters>]





DESCRIPTION

The Get-NetEventSession cmdlet gets network event sessions. A session controls how the computer logs events and, optionally, network traffic, or

packets.



Use this cmdlet to display configuration settings for the session. The configuration settings include the following:



-- Whether the session writes logs to a local file or sends events to live display.

-- For local file logging, the maximum size and location of the .etl file.

-- The maximum number of buffers and size of a buffer.



You can also use this cmdlet to see whether the session is running, such as after you run the Start-NetEventSession cmdlet.





PARAMETERS

-AssociatedEventProvider [<CimInstance>]

Specifies the associated network event provider as a CIM object. To obtain the network event provider, use the Get-NetEventProvider cmdlet.



Required? false

Position? named

Default value none

Accept pipeline input? True (ByValue)

Accept wildcard characters? false



-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



-Name [<String[]>]

Specifies an array of names of sessions to get.



Required? false

Position? 1

Default value none

Accept pipeline input? True (ByPropertyName)

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: Display settings for a session



PS C:\\>Get-NetEventSession -Name "Session38"



This command displays the settings of the session named Session38.







RELATED LINKS

Online Version: http://go.microsoft.com/fwlink/?LinkID=294390

New-NetEventSession

Remove-NetEventSession

Set-NetEventSession

Start-NetEventSession

Stop-NetEventSession

Get-NetEventProvider





CommonParameters : True

WorkflowCommonParameters : False

details : @{name=Get-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 :

Get-NetEventVFPProvider [[-SessionName] <string[]>] [-CimSession <CimSession[]>] [-ThrottleLimit <int>] [-AsJob]

[<CommonParameters>]



Get-NetEventVFPProvider [-AssociatedEventSession <CimInstance#MSFT_NetEventSession>] [-CimSession <CimSession[]>]

[-ThrottleLimit <int>] [-AsJob] [<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 : Get-NetEventVFPProvider

Category : Function

Component :

Role :

Functionality :