This topic has not yet been rated - Rate this topic

Remove-NetPrefixPolicy

Deletes an entry in the prefix policy table.

Syntax

Parameter Set: ByName
Remove-NetPrefixPolicy [-AsJob] [-CimSession <CimSession[]> ] [-Label <UInt32[]> ] [-PassThru] [-Precedence <UInt32[]> ] [-Prefix <String[]> ] [-Store <Store[]> ] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: __cmdletization_InputObject
Remove-NetPrefixPolicy -InputObject <CimInstance[]> [-AsJob] [-CimSession <CimSession[]> ] [-PassThru] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed Description

The Remove-NetPrefixPolicy cmdlet deletes 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

-InputObject<CimInstance[]>

Accepts an object from the pipeline as input.

Aliases	none
Required?	true
Position?	named
Default Value	none
Accept Pipeline Input?	true (ByValue)
Accept Wildcard Characters?	false

-Label<UInt32[]>

Deletes all entries in the prefix policy table by a specific Label. The label value sets a preference for a particular source address prefix for use with a destination address prefix as well as a preference for source and destination address pairs where the labels match over source and destination address pairs where the labels do not match.

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

-PassThru

Sends items from the interactive window down the pipeline as input to other cmdlets. By default, this cmdlet does not generate any output. This parameter is equivalent to using the Multiple value of the OutputMode parameter.
To send items from the interactive window down the pipeline, click to select the items and then click OK. Shift-click and Ctrl-click are supported.

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

-Precedence<UInt32[]>

Deletes all entries in the prefix policy table 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[]>

Deletes all entries in the prefix policy table 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?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Store<Store[]>

Deletes all entries in the prefix policy table the store value set to active or persistent. The acceptable values for this parameter are:
●Active: The prefix policy configuration is currently valid.
●Persistent: The prefix policy configuration is persistent across reboot. When the system starts, the Persistent store settings are copied to the active store.

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

-Confirm

Prompts you for confirmation before running the cmdlet.

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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

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 (http://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

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

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.

Outputs

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

None

Examples

EXAMPLE 1

This example deletes the prefix policy table entry for Unique Local Addresses (ULAs). Note: There is no table entry for ULAs by default.

PS C:\> Delete-NetPrefixPolicy –Prefix fc00::/7

Remove-NetPrefixPolicy