Edit

Share via

Set-VMNetworkAdapterRoutingDomainMapping

Module:
Hyper-V Module

Sets virtual subnets on a routing ___domain.

Syntax

VMName (Default) 

Set-VMNetworkAdapterRoutingDomainMapping
    [-VMName] <String[]>
    [-VMNetworkAdapterName <String>]
    [-CimSession <CimSession[]>]
    [-ComputerName <String[]>]
    [-Credential <PSCredential[]>]
    [-RoutingDomainID <Guid>]
    [-RoutingDomainName <String>]
    [-NewRoutingDomainName <String>]
    [-IsolationID <Int32[]>]
    [-IsolationName <String[]>]
    [-Passthru]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ResourceObject 

Set-VMNetworkAdapterRoutingDomainMapping
    [-VMNetworkAdapter] <VMNetworkAdapterBase[]>
    [-RoutingDomainID <Guid>]
    [-RoutingDomainName <String>]
    [-NewRoutingDomainName <String>]
    [-IsolationID <Int32[]>]
    [-IsolationName <String[]>]
    [-Passthru]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ManagementOS 

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>]

VMObject 

Set-VMNetworkAdapterRoutingDomainMapping
    [-VM] <VirtualMachine[]>
    [-VMNetworkAdapterName <String>]
    [-RoutingDomainID <Guid>]
    [-RoutingDomainName <String>]
    [-NewRoutingDomainName <String>]
    [-IsolationID <Int32[]>]
    [-IsolationName <String[]>]
    [-Passthru]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

InputObjectParameter 

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 6001

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.

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.

Parameter properties

Type:

CimSession[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

VMName
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ManagementOS
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

VMName
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ManagementOS
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Credential

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

Parameter properties

Type:

PSCredential[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

VMName
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ManagementOS
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-InputObject

Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet.

Parameter properties

Type:VMNetworkAdapterRoutingDomainSetting
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

InputObjectParameter
Position:0
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:True
Value from remaining arguments: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.

Parameter properties

Type:

Int32[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ManagementOS

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

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ManagementOS
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-NewRoutingDomainName

Specifies a new name for the routing ___domain.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Passthru

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:Guid
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

VMName
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ResourceObject
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ManagementOS
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
VMObject
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-RoutingDomainName

Specifies the name of a routing ___domain. The cmdlet adds the virtual subnets to the routing ___domain that you specify.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

VMName
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ResourceObject
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ManagementOS
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
VMObject
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:

VirtualMachine[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

VMObject
Position:0
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

VMName
Position:0
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:

VMNetworkAdapterBase[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ResourceObject
Position:0
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

VMName
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ManagementOS
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
VMObject
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

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

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Outputs

Microsoft.HyperV.PowerShell.VMNetworkAdapterRoutingDomainSetting