This topic has not yet been rated - Rate this topic

Get-NetPrefixPolicy

Applies To: Windows Server 2012

Get-NetPrefixPolicy

Gets information about the prefix policy.

Syntax

Parameter Set: ByName
Get-NetPrefixPolicy [[-Prefix] <String[]> ] [-AsJob] [-CimSession <CimSession[]> ] [-Label <UInt32[]> ] [-Precedence <UInt32[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Detailed Description

The Get-NetPrefixPolicy cmdlet gets the prefix policy. The prefix policy is used in source and destination address selection. The prefix policy is described in RFC 3484.

Parameters

-AsJob

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the Receive-Job cmdlet. For more information about Windows PowerShell® background jobs, see about_Jobs.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
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	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Label<UInt32[]>

Gets prefix policy by a specific Label. The label value allows for policies that prefer a particular source address prefix for use with a destination address prefix.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Precedence<UInt32[]>

Gets prefix policy by a specific Precedence. The Precedence value is used for sorting destination addresses.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Prefix<String[]>

Gets prefix policy by a specific Prefix. The Prefix determines the IP address prefix used to by source and destination address selection algorithms.

Aliases	none
Required?	false
Position?	1
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

<CommonParameters>

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

Inputs

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

None

Outputs

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

Microsoft.Management.Infrastructure.CimInstance#root\StandardCimv2\MSFT_NetPrefixPolicy
The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.

Examples

EXAMPLE 1

This example gets information about the prefix policy.

PS C:\> Get-NetPrefixPolicy

EXAMPLE 2

This example gets information about the prefix policy that has a precedence of 1.

PS C:\> Get-NetPrefixPolicy –Precedence 1

Get-NetPrefixPolicy