Set-VmNetworkAdapterRoutingDomainMapping
Sets virtual subnets on a routing domain.
Syntax
Set-VmNetworkAdapterRoutingDomainMapping
[-VMNetworkAdapterName <String>]
[-CimSession <CimSession[]>]
[-ComputerName <String[]>]
[-Credential <PSCredential[]>]
[-VMName] <String[]>
[-RoutingDomainID <Guid>]
[-RoutingDomainName <String>]
[-NewRoutingDomainName <String>]
[-IsolationID <Int32[]>]
[-IsolationName <String[]>]
[-Passthru]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Set-VmNetworkAdapterRoutingDomainMapping
[-VMNetworkAdapter] <VMNetworkAdapterBase[]>
[-RoutingDomainID <Guid>]
[-RoutingDomainName <String>]
[-NewRoutingDomainName <String>]
[-IsolationID <Int32[]>]
[-IsolationName <String[]>]
[-Passthru]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Set-VmNetworkAdapterRoutingDomainMapping
[-ManagementOS]
[-VMNetworkAdapterName <String>]
[-CimSession <CimSession[]>]
[-ComputerName <String[]>]
[-Credential <PSCredential[]>]
[-RoutingDomainID <Guid>]
[-RoutingDomainName <String>]
[-NewRoutingDomainName <String>]
[-IsolationID <Int32[]>]
[-IsolationName <String[]>]
[-Passthru]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Set-VmNetworkAdapterRoutingDomainMapping
[-VMNetworkAdapterName <String>]
[-VM] <VirtualMachine[]>
[-RoutingDomainID <Guid>]
[-RoutingDomainName <String>]
[-NewRoutingDomainName <String>]
[-IsolationID <Int32[]>]
[-IsolationName <String[]>]
[-Passthru]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Set-VmNetworkAdapterRoutingDomainMapping
[-InputObject] <VMNetworkAdapterRoutingDomainSetting>
[-NewRoutingDomainName <String>]
[-IsolationID <Int32[]>]
[-IsolationName <String[]>]
[-Passthru]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
The Set-VmNetworkAdapterRoutingDomainMapping cmdlet sets virtual subnets on a routing domain.
Examples
Example 1: Set a virtual subnet on a routing domain
PS C:\> Set-VMNetworkAdapterRoutingDomainMapping -VMName "Gateway01" -VMNetworkAdapterName "Internal NIC" -RoutingDomainID "{5a07361e-6a54-49fc-9210-bfbf14a5c56f}" -IsolationID 6001This 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.
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 virtual subnets to the routing domain 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 |
-InputObject
Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet.
| Type: | VMNetworkAdapterRoutingDomainSetting |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-IsolationID
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.
| Type: | Int32[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| 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 routing domain. The subnets use VLAN or Hyper-V Network Virtualization.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ManagementOS
Indicates that the cmdlet operates on the parent partition or host operating system.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-NewRoutingDomainName
Specifies a new name for the routing domain.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| 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 virtual subnets to the routing domain that you specify.
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-RoutingDomainName
Specifies the name of a routing domain. The cmdlet adds the virtual subnets to the routing domain that you specify.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-VM
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.
| Type: | VirtualMachine[] |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-VMName
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.
| Type: | String[] |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-VMNetworkAdapter
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.
| 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 virtual subnets to the routing domain on the 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
Related Links
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for