Edit

Share via

Remove-VMNetworkAdapterRoutingDomainMapping

  • Reference
Module:
Hyper-V

Removes a routing domain from a virtual network adapter.

Syntax

Remove-VMNetworkAdapterRoutingDomainMapping
      [-VMNetworkAdapterName <String>]
      [-CimSession <CimSession[]>]
      [-ComputerName <String[]>]
      [-Credential <PSCredential[]>]
      [-VMName] <String[]>
      [-RoutingDomainID <Guid>]
      [-RoutingDomainName <String>]
      [-Passthru]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-VMNetworkAdapterRoutingDomainMapping
      [-VMNetworkAdapter] <VMNetworkAdapterBase[]>
      [-RoutingDomainID <Guid>]
      [-RoutingDomainName <String>]
      [-Passthru]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-VMNetworkAdapterRoutingDomainMapping
      [-ManagementOS]
      [-VMNetworkAdapterName <String>]
      [-CimSession <CimSession[]>]
      [-ComputerName <String[]>]
      [-Credential <PSCredential[]>]
      [-RoutingDomainID <Guid>]
      [-RoutingDomainName <String>]
      [-Passthru]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-VMNetworkAdapterRoutingDomainMapping
      [-VMNetworkAdapterName <String>]
      [-VM] <VirtualMachine[]>
      [-RoutingDomainID <Guid>]
      [-RoutingDomainName <String>]
      [-Passthru]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-VMNetworkAdapterRoutingDomainMapping
      [-InputObject] <VMNetworkAdapterRoutingDomainSetting[]>
      [-Passthru]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

The Remove-VmNetworkAdapterRoutingDomainMapping cmdlet removes a routing domain from a virtual network adapter on a multitenant gateway virtual machine.

Examples

Example 1: Remove a tenant from a multitenant virtual machine

PS C:\> Remove-VMNetworkAdapterRoutingDomainMapping -VMName "Gateway01" -VMNetworkAdapterName "Internal NIC" -RoutingDomainID "{5a07361e-6a54-49fc-9210-bfbf14a5c56f}"

This command removes the specified routing domain from the virtual network adapter named Internal NIC. The command specifies that the adapter 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 removes the virtual subnets from 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

-ManagementOS

Indicates that the cmdlet removes the virtual subnet 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

-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 removes the virtual subnet from 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 removes the virtual subnet from 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 machines. The cmdlet removes the virtual subnet from 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 removes the virtual subnet from 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 machine network adapters as VMNetworkAdapterBase objects. The cmdlet removes the virtual subnet for 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 removes the virtual subnet for 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