Set-NetVirtualizationProviderAddress
Set-NetVirtualizationProviderAddress
Changes a VLAN ID or prefix length for a Provider Address.
Syntax
Parameter Set: ByName
Set-NetVirtualizationProviderAddress [-AddressState <AddressState[]> ] [-AsJob] [-CimSession <CimSession[]> ] [-InterfaceIndex <UInt32[]> ] [-PassThru] [-PrefixLength <Byte> ] [-ProviderAddress <String[]> ] [-ThrottleLimit <Int32> ] [-VlanID <UInt16> ] [ <CommonParameters>]
Parameter Set: InputObject (cdxml)
Set-NetVirtualizationProviderAddress -InputObject <CimInstance[]> [-AsJob] [-CimSession <CimSession[]> ] [-PassThru] [-PrefixLength <Byte> ] [-ThrottleLimit <Int32> ] [-VlanID <UInt16> ] [ <CommonParameters>]
Detailed Description
The Set-NetVirtualizationProviderAddress cmdlet changes a virtual local area network (VLAN) ID or prefix length for Provider Addresses used with Network Virtualization. For more information, see Network Virtualization technical details (https://technet.microsoft.com/library/jj134174.aspx) 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.
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-AsJob
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-CimSession<CimSession[]>
Aliases |
Session |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-InputObject<CimInstance[]>
Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-InterfaceIndex<UInt32[]>
Specifies an array of indexes for network interfaces that have Network Virtualization enabled.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
true |
-PassThru
Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-PrefixLength<Byte>
Specifies the length of an IP prefix.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ProviderAddress<String[]>
Specifies an array of IP addresses. You can use IPv4 or IPv6 addresses.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
true |
-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 |
-VlanID<UInt16>
Specifies an ID for a VLAN for the Provider Address.
Aliases |
none |
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 (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: Change a virtual LAN ID
This command changes the virtual LAN ID for the Provider Address 192.168.2.3 on the the interface that has the Index 17.
PS C:\> Set-NetVirtualizationProviderAddress -ProviderAddress "192.168.2.3" -InterfaceIndex 17 -VlanID 201
Example 2: Change a virtual LAN ID for specified Provider Addresses
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 pipe operator. The command assigns a value of 20 for the virtual LAN ID of all the Provider Address for the interface.
PS C:\> Get-NetVirtualizationProviderAddress -InterfaceIndex 23 | Set-NetVirtualizationProviderAddress -VlanID 20
Related topics
Get-NetVirtualizationProviderAddress