Add-VmNetworkAdapterRoutingDomainMapping

  • Reference
Module:
Hyper-V

Adds a routing domain and virtual subnets to a virtual network adapter.

Syntax

Add-VmNetworkAdapterRoutingDomainMapping
   [-RoutingDomainID] <Guid>
   [-RoutingDomainName] <String>
   [-IsolationID] <Int32[]>
   [[-IsolationName] <String[]>]
   [-Passthru]
   [-VMNetworkAdapterName <String>]
   [-CimSession <CimSession[]>]
   [-ComputerName <String[]>]
   [-Credential <PSCredential[]>]
   [-VMName] <String[]>
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Add-VmNetworkAdapterRoutingDomainMapping
   [-RoutingDomainID] <Guid>
   [-RoutingDomainName] <String>
   [-IsolationID] <Int32[]>
   [[-IsolationName] <String[]>]
   [-Passthru]
   [-VMNetworkAdapter] <VMNetworkAdapterBase[]>
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Add-VmNetworkAdapterRoutingDomainMapping
   [-RoutingDomainID] <Guid>
   [-RoutingDomainName] <String>
   [-IsolationID] <Int32[]>
   [[-IsolationName] <String[]>]
   [-Passthru]
   [-ManagementOS]
   [-VMNetworkAdapterName <String>]
   [-CimSession <CimSession[]>]
   [-ComputerName <String[]>]
   [-Credential <PSCredential[]>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Add-VmNetworkAdapterRoutingDomainMapping
   [-RoutingDomainID] <Guid>
   [-RoutingDomainName] <String>
   [-IsolationID] <Int32[]>
   [[-IsolationName] <String[]>]
   [-Passthru]
   [-VMNetworkAdapterName <String>]
   [-VM] <VirtualMachine[]>
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

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.

Examples

Example 1: Add a tenant and virtual subnet to a multitenant virtual network

PS C:\> Add-VMNetworkAdapterRoutingDomainMapping -VMName "Gateway01" -VMNetworkAdapterName "Internal NIC" -RoutingDomainID "{5a07361e-6a54-49fc-9210-bfbf14a5c56f}" RoutingDomainName "Contoso" -IsolationID 6000 -IsolationName "ContosoGatewayVsid"

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.

Parameters

-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[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ComputerName

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.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Credential

Specifies one or more user accounts that have permission to perform this action. The default is the current user.

Type:PSCredential[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-IsolationID

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.

Type:Int32[]
Position:3
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-IsolationName

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.

Type:String[]
Position:4
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ManagementOS

Indicates that the cmdlet operates on the parent or host operating system.

Type:SwitchParameter
Position:Named
Default value:None
Required:True
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
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-RoutingDomainID

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.

Type:Guid
Position:1
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-RoutingDomainName

Specifies the name of a routing domain. The cmdlet adds the routing domain that you specify to the virtual network adapter.

Type:String
Position:2
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-VM

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.

Type:VirtualMachine[]
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-VMName

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.

Type:String[]
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-VMNetworkAdapter

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.

Type:VMNetworkAdapterBase[]
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-VMNetworkAdapterName

Specifies the name of a virtual network adapter. The cmdlet adds the routing domain on adapter that you specify.

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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Outputs

Microsoft.HyperV.PowerShell.VMNetworkAdapterRoutingDomainSetting