Set-NetVirtualizationProviderAddress

Changes a VLAN ID or prefix length for a Provider Address.

Syntax

Set-NetVirtualizationProviderAddress
   [-ProviderAddress <String[]>]
   [-InterfaceIndex <UInt32[]>]
   [-AddressState <AddressState[]>]
   [-VlanID <UInt16>]
   [-PrefixLength <Byte>]
   [-MACAddress <String>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [-PassThru]
   [<CommonParameters>]
Set-NetVirtualizationProviderAddress
   -InputObject <CimInstance[]>
   [-VlanID <UInt16>]
   [-PrefixLength <Byte>]
   [-MACAddress <String>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [-PassThru]
   [<CommonParameters>]

Description

The Set-NetVirtualizationProviderAddress cmdlet changes a virtual local area network (VLAN) ID or prefix length for Provider Addresses used with Microsoft® Hyper-V® Server 2016 Network Virtualization. For more information, see Network Virtualization technical details on TechNet.

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

Examples

Example 1: Change a virtual LAN ID

PS C:\> Set-NetVirtualizationProviderAddress -ProviderAddress "192.168.2.3" -InterfaceIndex 17 -VlanID 201

This command changes the virtual LAN ID for the Provider Address 192.168.2.3 on the interface that has the Index 17.

Example 2: Change a virtual LAN ID for specified Provider Addresses

PS C:\>Get-NetVirtualizationProviderAddress -InterfaceIndex 23 | Set-NetVirtualizationProviderAddress -VlanID 20

This command uses the Get-NetVirtualizationProviderAddress cmdlet to get all the Provider Addresses for the interface that has the index 23, and then passes them to the Set-NetVirtualizationProviderAddress cmdlet by using the pipeline operator. The command assigns a value of 20 for the virtual LAN ID of all the Provider Address for the interface.

Required Parameters

-InputObject

Specifies the input object that is used in a pipeline command.

Type:CimInstance[]
Position:Named
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False

Optional 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.
Type:AddressState[]
Parameter Sets:Invalid, Tentative, Duplicate, Deprecated, Preferred
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-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
-InterfaceIndex

Specifies an array of indexes for network interfaces that have Hyper-V Server 2016 Network Virtualization enabled.

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

Specifies a media access control (MAC) address that corresponds to the Provider Address.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-PassThru

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

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-PrefixLength

Specifies the length of an IP prefix.

Type:Byte
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ProviderAddress

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

Type:String[]
Position:Named
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
-VlanID

Specifies an ID for a VLAN for the Provider Address.

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