Remove-NetVirtualizationProviderAddress

Remove-NetVirtualizationProviderAddress

Deletes Provider Addresses.

Syntax

Parameter Set: ByName
Remove-NetVirtualizationProviderAddress [-AddressState <AddressState[]> ] [-AsJob] [-CimSession <CimSession[]> ] [-InterfaceIndex <UInt32[]> ] [-PassThru] [-PrefixLength <Byte[]> ] [-ProviderAddress <String[]> ] [-ThrottleLimit <Int32> ] [-VlanID <UInt16[]> ] [ <CommonParameters>]

Parameter Set: InputObject (cdxml)
Remove-NetVirtualizationProviderAddress -InputObject <CimInstance[]> [-AsJob] [-CimSession <CimSession[]> ] [-PassThru] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Detailed Description

The Remove-NetVirtualizationProviderAddress cmdlet deletes Provider Addresses configured in Network Virtualization. A Provider Address is an IPv4 or IPv6 address that Network Virtualization uses for multiple virtual Customer Addresses. For more information, see Network Virtualization technical details (https://technet.microsoft.com/library/jj134174.aspx) on TechNet.

You can specify which Provider Addresses to delete by using address state, interface index, prefix length, IP address, or VLAN ID, or you can use the Get-NetVirtualizationProviderAddress cmdlet to get Provider Addresses to delete.

You can use this cmdlet to remove a Provider Address when no virtual machines (VMs) use that address. If you deleted or migrated all the VMs from a host, you could then remove the Provider Address.

Parameters

-AddressState<AddressState[]>

Specifies an array of states of Provider Addresses. The acceptable values for this parameter are:

-- Preferred. The address is unique.
-- Tentative. The address is not yet verified.
-- Duplicate. There is a duplicate address on the network.
-- Invalid. The address lifetime has expired.
-- Deprecated. The address cannot start new connections.

-AsJob

-CimSession<CimSession[]>

-InputObject<CimInstance[]>

Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet.

-InterfaceIndex<UInt32[]>

Specifies an array of indexes for network interfaces that have Network Virtualization enabled.

-PassThru

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.

-PrefixLength<Byte[]>

Specifies an array of lengths of IP prefixes.

-ProviderAddress<String[]>

Specifies an array of IP addresses. You can use IPv4 or IPv6 addresses.

-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.

-VlanID<UInt16[]>

Specifies an array of IDs for VLANs for Provider Addresses.

<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: Remove a Provider Address

This command deletes the Provider Address 2001:DB8:11:22:33:44:55:6 on the current host.

PS C:\> Remove-NetVirtualizationProviderAddress -ProviderAddress "2001:DB8:11:22:33:44:55:6"

Example 2: Remove Provider Addresses for an interface

This command removes all the Provider Addresses on the interface that has an index of 13.

PS C:\> Remove-NetVirtualizationProviderAddress -InterfaceIndex 13

Related topics

Get-NetVirtualizationProviderAddress

New-NetVirtualizationProviderAddress

Set-NetVirtualizationProviderAddress