Remove-NetVirtualizationProviderAddress
Deletes Provider Addresses.
Syntax
ByName (Default)
Remove-NetVirtualizationProviderAddress
[-ProviderAddress <String[]>]
[-InterfaceIndex <UInt32[]>]
[-PrefixLength <Byte[]>]
[-VlanID <UInt16[]>]
[-AddressState <AddressState[]>]
[-MACAddress <String[]>]
[-ManagedByCluster <Boolean[]>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[-PassThru]
[<CommonParameters>]
InputObject (cdxml)
Remove-NetVirtualizationProviderAddress
-InputObject <CimInstance[]>
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[-PassThru]
[<CommonParameters>]
Description
The Remove-NetVirtualizationProviderAddress cmdlet deletes Provider Addresses configured in Microsoft® Hyper-V® Server 2016 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 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 use that address. If you deleted or migrated all the virtual machines from a Hyper-V Server 2016 host, you could then remove the Provider Address.
Examples
Example 1: Remove a Provider Address
PS C:\> Remove-NetVirtualizationProviderAddress -ProviderAddress "2001:DB8:11:22:33:44:55:6"
This command deletes the Provider Address 2001:DB8:11:22:33:44:55:6 on the current host.
Example 2: Remove Provider Addresses for an interface
PS C:\>Remove-NetVirtualizationProviderAddress -InterfaceIndex 13
This command removes all the Provider Addresses on the interface that have an index of 13.
Parameters
-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.
Parameter properties
| Type: | AddressState[] |
| Default value: | None |
| Accepted values: | Invalid, Tentative, Duplicate, Deprecated, Preferred |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ByName
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-AsJob
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | CimSession[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | Session |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-InputObject
Specifies the input object that is used in a pipeline command.
Parameter properties
| Type: | CimInstance[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
InputObject (cdxml)
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-InterfaceIndex
Specifies an array of indexes for network interfaces that have Hyper-V Server 2016 Network Virtualization enabled.
Parameter properties
| Type: | UInt32[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ByName
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-MACAddress
Specifies an array of media access control (MAC) addresses that corresponds to the Provider Address.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ByName
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ManagedByCluster
Specifies an array of Boolean values that determines whether a highly available Provider Address configuration entry exists on a Hyper-V Network Virtualization gateway. If you use a Provider Address cluster resource, this value is $True. Otherwise, the value is $False. This parameter is a read-only parameter that is used by an administrator to diagnose problems.
Parameter properties
| Type: | Boolean[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ByName
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-PassThru
Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-PrefixLength
Specifies an array of lengths of IP prefixes.
Parameter properties
| Type: | Byte[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ByName
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ProviderAddress
Specifies an array of IP addresses. You can use IPv4 or IPv6 addresses.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ByName
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-VlanID
Specifies an array of IDs for VLANs for Provider Addresses.
Parameter properties
| Type: | UInt16[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ByName
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.