Start SdnNetshTrace

Start-SdnNetshTrace

SYNOPSIS

Enables netsh tracing based on pre-configured trace providers.

SYNTAX

Local (Default)

Start-SdnNetshTrace -Role <String> [-OutputDirectory <String>] [-MaxTraceSize <Int32>] [-Capture <String>]
 [-Overwrite <String>] [-Correlation <String>] [-Report <String>] [-Providers <String>] [<CommonParameters>]

Remote

Start-SdnNetshTrace -Role <String> [-OutputDirectory <String>] [-MaxTraceSize <Int32>] [-Capture <String>]
 [-Overwrite <String>] [-Correlation <String>] [-Report <String>] [-Providers <String>]
 [-ComputerName <String[]>] [-Credential <PSCredential>] [<CommonParameters>]

DESCRIPTION

{{ Fill in the Description }}

EXAMPLES

EXAMPLE 1

Start-SdnNetshTrace -OutputDirectory "C:\Temp\CSS_SDN" -Capture Yes -Role Server

EXAMPLE 2

Start-SdnNetshTrace -ComputerName (Get-SdnInfrastructureInfo -NetworkController 'PREFIX-NC03').Server -Role Server -Credential (Get-Credential)

PARAMETERS

-Role

The specific SDN role of the local or remote computer(s) that tracing is being enabled for.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-OutputDirectory

Specifies a specific path and folder in which to save the files.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: "$(Get-WorkingDirectory)\NetworkTraces"
Accept pipeline input: False
Accept wildcard characters: False

-MaxTraceSize

Optional. Specifies the maximum size in MB for saved trace files. If unspecified, the default is 1024.

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: 1536
Accept pipeline input: False
Accept wildcard characters: False

-Capture

Optional. Specifies whether packet capture is enabled in addition to trace events. If unspecified, the default is No.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: Yes
Accept pipeline input: False
Accept wildcard characters: False

-Overwrite

Optional. Specifies whether this instance of the trace conversion command overwrites files that were rendered from previous trace conversions. If unspecified, the default is Yes.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: Yes
Accept pipeline input: False
Accept wildcard characters: False

-Correlation

Optional. Specifies whether related events will be correlated and grouped together. If unspecified, the default is Disabled.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: Disabled
Accept pipeline input: False
Accept wildcard characters: False

-Report

Optional. Specifies whether a complementing report will be generated in addition to the trace file report. If unspecified, the default is disabled.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: Disabled
Accept pipeline input: False
Accept wildcard characters: False

-Providers

{{ Fill Providers Description }}

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: All
Accept pipeline input: False
Accept wildcard characters: False

-ComputerName

Type the NetBIOS name, an IP address, or a fully qualified domain name of one or more remote computers.

Type: String[]
Parameter Sets: Remote
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Credential

Specifies a user account that has permission to perform this action. The default is the current user. Type a user name, such as User01 or Domain01\User01, or enter a PSCredential object generated by the Get-Credential cmdlet. If you type a user name, you're prompted to enter the password.

Type: PSCredential
Parameter Sets: Remote
Aliases:

Required: False
Position: Named
Default value: [System.Management.Automation.PSCredential]::Empty
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

NOTES

RELATED LINKS