Remove-NetEventSession

Remove-NetEventSession

Removes a network event session.

構文

Parameter Set: ByName
Remove-NetEventSession [-Name] <String[]> [-CimSession <CimSession[]> ] [-PassThru] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>] [ <WorkflowParameters>]

Parameter Set: ByProviderOfSession
Remove-NetEventSession [-AssociatedEventProvider <CimInstance> ] [-CimSession <CimSession[]> ] [-PassThru] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>] [ <WorkflowParameters>]

Parameter Set: InputObject (cdxml)
Remove-NetEventSession [-CimSession <CimSession[]> ] [-PassThru] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>] [ <WorkflowParameters>]

詳細説明

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.

パラメーター

-AssociatedEventProvider<CimInstance>

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

エイリアス

none

必須?

false

位置は?

named

既定値

none

パイプライン入力を許可する

True (ByValue)

ワイルドカード文字を許可する

false

-CimSession<CimSession[]>

リモート セッションまたはリモート コンピューターでコマンドレットを実行します。New-CimSession コマンドレットや Get-CimSession コマンドレットの出力など、コンピューター名またはセッション オブジェクトを入力します。既定値は、ローカル コンピューターで実行中の現在のセッションです。

エイリアス

Session

必須?

false

位置は?

named

既定値

none

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-Name<String[]>

Specifies an array of names of sessions to remove.

エイリアス

none

必須?

true

位置は?

1

既定値

none

パイプライン入力を許可する

True (ByPropertyName)

ワイルドカード文字を許可する

false

-PassThru

作業中の項目を表すオブジェクトを返します。既定では、このコマンドレットによる出力はありません。

エイリアス

none

必須?

false

位置は?

named

既定値

none

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-ThrottleLimit<Int32>

このコマンドレットを実行するために確立できる最大同時操作数を指定します。このパラメーターを省略するか、値として 0 を入力した場合、Windows PowerShell® では、コンピューターで実行している CIM コマンドレットの数に基づいて、コマンドレットに対する最適なスロットル制限を計算します。スロットル制限は現在のコマンドレットのみに適用され、セッションまたはコンピューターには適用されません。

エイリアス

none

必須?

false

位置は?

named

既定値

none

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-Confirm

コマンドレットを実行する前に、ユーザーに確認を求めます。

必須?

false

位置は?

named

既定値

false

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-WhatIf

コマンドレットを実行するとどのような結果になるかを表示します。コマンドレットは実行されません。

必須?

false

位置は?

named

既定値

false

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

<CommonParameters>

このコマンドレットは次の共通パラメーターをサポートします。-Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer、-OutVariable.詳細については、以下を参照してください。 about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216)。

<WorkflowParameters>

このコマンドレットは次のワークフロー共通パラメーターをサポートします。-PSParameterCollection、-PSComputerName、-PSCredential、-PSConnectionRetryCount、-PSConnectionRetryIntervalSec、-PSRunningTimeoutSec、-PSElapsedTimeoutSec、-PSPersist、-PSAuthentication、-PSAuthenticationLevel、-PSApplicationName、-PSPort、-PSUseSSL、-PSConfigurationName、-PSConnectionURI、-PSAllowRedirection、-PSSessionOption、-PSCertificateThumbprint、-PSPrivateMetadata、-AsJob、-JobName、–InputObject。詳細については、以下を参照してください。  about_WorkflowCommonParameters

入力

入力型は、コマンドレットにパイプできるオブジェクトの型です。

出力

出力型は、コマンドレットによって生成されるオブジェクトの型です。

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"

関連トピック

Get-NetEventSession

New-NetEventSession

Set-NetEventSession

Start-NetEventSession

Stop-NetEventSession

Get-NetEventProvider