Add-PefProviderConfig

Add-PefProviderConfig

Adds a provider to a remote Trace Session on a target host.

Syntax

Parameter Set: Default
Add-PefProviderConfig [-InformationAction <System.Management.Automation.ActionPreference> {SilentlyContinue | Stop | Continue | Inquire | Ignore | Suspend} ] [-InformationVariable <System.String> ] [-Provider <String> ] [-TargetHost <PefTargetHost> ] [ <CommonParameters>]

Detailed Description

The Add-PefProviderConfig cmdlet adds a provider to the remote session configured by using a friendly name. Do not specify a GUID.

You access provider configuration by using the object that this cmdlet creates. You can configure provider error levels, event keywords, and other provider-specific options for providers such as the Microsoft-Windows-NDIS-PacketCapture, Microsoft-Pef-WebProxy, and Microsoft-Pef-WPF. Use this object as input for the Add-PefMessageSource cmdlet.

Parameters

-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

Aliases

infa

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.

Aliases

iv

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Provider<String>

Specifies the friendly name for a message provider.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-TargetHost<PefTargetHost>

Specifies a target host object that represents a remote computer that you configure for a remote Live Trace Session. To obtain a target host object, use the New-PefTargetHost cmdlet.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

Examples

Example 1: Create and configure a remote trace to a named server

The first command creates a target host for the computer named Server07, by using the New-PefTargetHost cmdlet, and then stores that host in the $targetHost variable.

The second command passes the host stored in $targetHost to the current cmdlet, by using the pipeline operator. This cmdlet adds a provider, and then stores the result in the $th1p1Config variable.

The third, fourth, and fifth commands use standard dot notation to refer to elements of the configuration stored in $th1p1Config, and assign values to those elements. These commands set the truncation level to 128, disables all interfaces, and then re-enables node 3. The re-enabled node might contain multiple child nodes. These nodes are enabled subsequently.

The final command creates a session, adds the target host as the session source, and starts the trace session, by using the New-PefTraceSession, Add-PefMessageSource, and Start-PefTraceSession cmdlets. The final command stores the new session in the $TraceSession01 variable. This session encapsulates the configuration settings of up in the previous commands in this example.

PS C:\> $targetHost = New-PefTargetHost -ComputerName "Server07"
PS C:\> $th1p1Config = $targetHost | Add-PefProviderConfig -Provider "Microsoft-Windows-NDIS-PacketCapture"
PS C:\> $th1p1Config.Configurations[0].TruncationLength = 128
PS C:\> $th1p1Config.Configurations[0].Interfaces[0].Enabled=0
PS C:\> $th1p1Config.Configurations[0].Interfaces[3].Enabled=1
PS C:\> $TraceSession01 = New-PefTraceSession -Force -Path "C:\Trace01" -SaveOnStop | Add-PefMessageSource -Source $targetHost | Start-PefTraceSession

New-PefTargetHost

New-PefTraceSession

Add-PefMessageSource

Start-PefTraceSession