Add-VmNetworkAdapterRoutingDomainMapping
Add-VmNetworkAdapterRoutingDomainMapping
Adds a routing domain and virtual subnets to a virtual network adapter.
Syntax
Parameter Set: VMName
Add-VmNetworkAdapterRoutingDomainMapping [-VMName] <String[]> [-RoutingDomainID] <String> [-RoutingDomainName] <String> [[-IsolationID] <Int32[]> ] [[-IsolationName] <String[]> ] [-ComputerName <String[]> ] [-Passthru] [-VMNetworkAdapterName <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: ManagementOS
Add-VmNetworkAdapterRoutingDomainMapping [-RoutingDomainID] <String> [-RoutingDomainName] <String> [[-IsolationID] <Int32[]> ] [[-IsolationName] <String[]> ] -ManagementOS [-ComputerName <String[]> ] [-Passthru] [-VMNetworkAdapterName <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: ResourceObject
Add-VmNetworkAdapterRoutingDomainMapping [-VMNetworkAdapter] <VMNetworkAdapterBase[]> [-RoutingDomainID] <String> [-RoutingDomainName] <String> [[-IsolationID] <Int32[]> ] [[-IsolationName] <String[]> ] [-Passthru] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: VMObject
Add-VmNetworkAdapterRoutingDomainMapping [-VM] <VirtualMachine[]> [-RoutingDomainID] <String> [-RoutingDomainName] <String> [[-IsolationID] <Int32[]> ] [[-IsolationName] <String[]> ] [-Passthru] [-VMNetworkAdapterName <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Add-VmNetworkAdapterRoutingDomainMapping cmdlet adds a routing domain and virtual subnets to a virtual network adapter. The cmdlet adds the information about the routing domain and virtual subnets to connected multitenant virtual machines.
Parameters
-ComputerName<String[]>
Specifies an array of Hyper-V hosts. The cmdlet adds the routing domain and virtual subnet to a virtual network adapter 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 |
-IsolationID<Int32[]>
Specifies an array of IDs of virtual subnets. The cmdlet adds the virtual subnets that you specify to the virtual network adapter. You can isolate a virtual machine adapter by using virtual local area network (VLAN), Hyper-V Network Virtualization, or a third party virtualization solution. For more information about isolation IDs, see the Set-VmNetworkAdapterIsolation cmdlet.
Aliases |
none |
Required? |
false |
Position? |
4 |
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 virtual network adapter. The subnet uses VLAN or Hyper-V Network Virtualization.
Aliases |
none |
Required? |
false |
Position? |
5 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ManagementOS
Indicates that the cmdlet operates on the parent or host operating system.
Aliases |
none |
Required? |
true |
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 routing domain that you specify to the virtual network adapter.
Aliases |
none |
Required? |
true |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-RoutingDomainName<String>
Specifies the name of a routing domain. The cmdlet adds the routing domain that you specify to the virtual network adapter.
Aliases |
none |
Required? |
true |
Position? |
3 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-VM<VirtualMachine[]>
Specifies an array of virtual machine objects. The cmdlet adds the routing domain to 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 friendly names of virtual machines. The cmdlet adds the routing domain to the network interfaces that belong to the virtual machines that you specify.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
true |
-VMNetworkAdapter<VMNetworkAdapterBase[]>
Specifies an array of virtual network adapter as VMNetworkAdapterBase objects. The cmdlet adds 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 routing domain on 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: Add a tenant and virtual subnet to a multitenant virtual network
This command adds a tenant that has the specified routing domain to the virtual network adapter named Internal NIC that belongs to the multitenant virtual machine named Gateway01. The command also adds the virtual subnet that has the ID 6000 to the virtual network adapter.
PS C:\> Add-VMNetworkAdapterRoutingDomainMapping -VMName "Gateway01" -VMNetworkAdapterName "Internal NIC" –RoutingDomainID "{5a07361e-6a54-49fc-9210-bfbf14a5c56f}" RoutingDomainName "Contoso" -IsolationID 6000 -IsolationName "ContosoGatewayVsid"
Related topics
Get-VMNetworkAdapterRoutingDomainMapping
Set-VmNetworkAdapterRoutingDomainMapping