Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Remove-NetEventSession

Remove-NetEventSession

msft_neteventvmswitch.cdxml, msft_neteventvmnetworkadatper.cdxml, msft_neteventsession.cdxml, msft_neteventprovider.cdxml, msft_neteventpacketcaptureprovider.cdxml, msft_neteventnetworkadapter.cdxml

Synopsis

Removes a network event session.

Syntax

Remove-NetEventSession [-AssociatedEventProvider] [-CimSession] [-PassThru] [-ThrottleLimit] [-Confirm] [-WhatIf] [<CommonParameters>]

Remove-NetEventSession [-CimSession] [-PassThru] [-ThrottleLimit] [-Confirm] [-WhatIf] [<CommonParameters>]

Remove-NetEventSession [-Name] [-CimSession] [-PassThru] [-ThrottleLimit] [-Confirm] [-WhatIf] [<CommonParameters>]

Detailed Description

The Remove-NetEventSession cmdlet removes a network event session. The cmdlet also deletes all properties and objects associated with the session. A session controls how the computer logs events and, optionally, network traffic, or packets.

You can have only one session at a time. Before you can add a network event session by using the New-NetEventSession cmdlet, remove an existing session.

Parameters

-AssociatedEventProvider <CimInstance>

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

Aliases

none

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.

Aliases

Session

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 remove.

Aliases

none

Required?

true

Position

1

Default value

none

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-PassThru <SwitchParameter>

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.

Aliases

none

Required?

false

Position

named

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.

Aliases

none

Required?

false

Position

named

Default value

none

Accept pipeline input?

false

Accept wildcard characters?

false

-Confirm <SwitchParameter>

Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

-WhatIf <SwitchParameter>

Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type


Return Type


Notes

None

Examples

Example 1: Remove a session

This command removes the session named Session38. The command removes all the configuration information associated with the session.

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

Online Version
Get-NetEventSession
New-NetEventSession
Set-NetEventSession
Start-NetEventSession
Stop-NetEventSession
Get-NetEventProvider