Get-Net Prefix Policy

Gets the prefix policy.

Syntax

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

Description

The Get-NetPrefixPolicy cmdlet gets the prefix policy. A computer uses a prefix policy to select source and destination addresses. A prefix policy establishes selection criteria based on the precedence of destination addresses and on labels that are attached to source addresses. For more information, see RFC 3484 .

Examples

Example 1: Get a prefix policy

PS C:\>Get-NetPrefixPolicy

This command gets the prefix policy on the computer on which you run the command.

Example 2: Get a prefix policy by precedence

PS C:\>Get-NetPrefixPolicy -Precedence 1

This command gets the prefix policy that has a precedence of 1.

Optional Parameters

-AsJob

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.

Type: SwitchParameter
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-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.

Type: CimSession[]
Aliases: Session
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Label

Specifies an array of labels for a prefix policy. A label value identifies a preference for a particular source address prefix in conjunction with a destination address prefix.

Type: UInt32[]
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Precedence

Specifies an array of precedence values. A precedence value identifies a value that is used to sort destination addresses.

Type: UInt32[]
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Prefix

Specifies an array of prefixes. A prefix identifies the IP address prefix that is used to select source and destination addresses.

Type: String[]
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ThrottleLimit

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.

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

Inputs

None

Outputs

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.