Set-VmNetworkAdapterRoutingDomainMapping
Set-VmNetworkAdapterRoutingDomainMapping
Sets virtual subnets on a routing domain.
Syntax
Parameter Set: VMName
Set-VmNetworkAdapterRoutingDomainMapping [-VMName] <String[]> [-ComputerName <String[]> ] [-IsolationID <Int32[]> ] [-IsolationName <String[]> ] [-NewRoutingDomainName <String> ] [-Passthru] [-RoutingDomainID <String> ] [-RoutingDomainName <String> ] [-VMNetworkAdapterName <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: InputObjectParameter
Set-VmNetworkAdapterRoutingDomainMapping [-InputObject] <VMNetworkAdapterRoutingDomainSetting> [-IsolationID <Int32[]> ] [-IsolationName <String[]> ] [-NewRoutingDomainName <String> ] [-Passthru] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: ManagementOS
Set-VmNetworkAdapterRoutingDomainMapping -ManagementOS [-ComputerName <String[]> ] [-IsolationID <Int32[]> ] [-IsolationName <String[]> ] [-NewRoutingDomainName <String> ] [-Passthru] [-RoutingDomainID <String> ] [-RoutingDomainName <String> ] [-VMNetworkAdapterName <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: ResourceObject
Set-VmNetworkAdapterRoutingDomainMapping [-VMNetworkAdapter] <VMNetworkAdapterBase[]> [-IsolationID <Int32[]> ] [-IsolationName <String[]> ] [-NewRoutingDomainName <String> ] [-Passthru] [-RoutingDomainID <String> ] [-RoutingDomainName <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: VMObject
Set-VmNetworkAdapterRoutingDomainMapping [-VM] <VirtualMachine[]> [-IsolationID <Int32[]> ] [-IsolationName <String[]> ] [-NewRoutingDomainName <String> ] [-Passthru] [-RoutingDomainID <String> ] [-RoutingDomainName <String> ] [-VMNetworkAdapterName <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Set-VmNetworkAdapterRoutingDomainMapping cmdlet sets virtual subnets on a routing domain.
Parameters
-ComputerName<String[]>
Specifies an array of Hyper-V hosts. The cmdlet adds the virtual subnets to the routing domain on the Hyper-V hosts that you specify.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-InputObject<VMNetworkAdapterRoutingDomainSetting>
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? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue, ByPropertyName) |
Accept Wildcard Characters? |
false |
-IsolationID<Int32[]>
Specifies an array of IDs of virtual subnets. The cmdlet adds the virtual subnets that you specify to the routing domain. The subnets use VLAN or Hyper-V Network Virtualization. For more information about isolation IDs, see the Set-VmNetworkAdapterIsolation cmdlet.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-IsolationName<String[]>
Specifies an array of names of virtual subnets. The cmdlet adds the virtual subnets that you specify to the routing domain. The subnets use VLAN or Hyper-V Network Virtualization.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ManagementOS
Indicates that the cmdlet operates on the parent partition or host operating system.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-NewRoutingDomainName<String>
Specifies a new name for the routing domain.
Aliases |
none |
Required? |
false |
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-RoutingDomainID<String>
Specifies the ID of a routing domain. The ID of a routing domain is a system-assigned GUID. The cmdlet adds the virtual subnets to the routing domain that you specify.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-RoutingDomainName<String>
Specifies the name of a routing domain. The cmdlet adds the virtual subnets to the routing domain that you specify.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-VM<VirtualMachine[]>
Specifies an array of virtual machine objects. The cmdlet adds the virtual subnets to the routing domain from the network interfaces that belong to the virtual machines that you specify. To obtain a virtual machine object, use the Get-VM cmdlet.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-VMName<String[]>
Specifies an array of names of virtual machines. The cmdlet adds the virtual subnets to the routing domain from the network interfaces that belong to the virtual machines that you specify. To obtain a virtual machine object, use the Get-VM cmdlet.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-VMNetworkAdapter<VMNetworkAdapterBase[]>
Specifies an array of virtual network adapters as a VMNetworkAdapterBase object. The cmdlet adds the virtual subnets to the routing domain on the adapters that you specify. To obtain a network adapter, use the Get-VMNetworkAdapter cmdlet.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-VMNetworkAdapterName<String>
Specifies the name of a virtual network adapter. The cmdlet adds the virtual subnets to the routing domain on the adapter that you specify.
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 |
false |
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 |
false |
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: Set a virtual subnet on a routing domain
This command sets the virtual subnet that has the ID 6001 for the specified routing domain. The command specifies that the routing domain is on the network adapter named Internal NIC that belongs to the multitenant virtual machine named Gateway01.
PS C:\> Set-VMNetworkAdapterRoutingDomainMapping -VMName "Gateway01" -VMNetworkAdapterName "Internal NIC" -RoutingDomainID "{5a07361e-6a54-49fc-9210-bfbf14a5c56f}" -IsolationID 6001
Related topics
Get-VMNetworkAdapterRoutingDomainMapping