Remove-VMNetworkAdapterRoutingDomainMapping
Remove-VMNetworkAdapterRoutingDomainMapping
Removes a routing domain from a virtual network adapter.
Syntax
Parameter Set: VMName
Remove-VMNetworkAdapterRoutingDomainMapping [-VMName] <String[]> [-ComputerName <String[]> ] [-Passthru] [-RoutingDomainID <String> ] [-RoutingDomainName <String> ] [-VMNetworkAdapterName <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: InputObjectParameter
Remove-VMNetworkAdapterRoutingDomainMapping [-InputObject] <VMNetworkAdapterRoutingDomainSetting[]> [-Passthru] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: ManagementOS
Remove-VMNetworkAdapterRoutingDomainMapping -ManagementOS [-ComputerName <String[]> ] [-Passthru] [-RoutingDomainID <String> ] [-RoutingDomainName <String> ] [-VMNetworkAdapterName <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: ResourceObject
Remove-VMNetworkAdapterRoutingDomainMapping [-VMNetworkAdapter] <VMNetworkAdapterBase[]> [-Passthru] [-RoutingDomainID <String> ] [-RoutingDomainName <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: VMObject
Remove-VMNetworkAdapterRoutingDomainMapping [-VM] <VirtualMachine[]> [-Passthru] [-RoutingDomainID <String> ] [-RoutingDomainName <String> ] [-VMNetworkAdapterName <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Remove-VmNetworkAdapterRoutingDomainMapping cmdlet removes a routing domain from a virtual network adapter on a multitenant gateway virtual machine.
Parameters
-ComputerName<String[]>
Specifies an array of Hyper-V hosts. The cmdlet removes the virtual subnets from the Hyper-V hosts that you specify.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-InputObject<VMNetworkAdapterRoutingDomainSetting[]>
Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue, ByPropertyName) |
Accept Wildcard Characters? |
false |
-ManagementOS
Indicates that the cmdlet removes the virtual subnet on the parent partition 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 removes the virtual subnet from the routing domain that you specify.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-RoutingDomainName<String>
Specifies the name of a routing domain. The cmdlet removes the virtual subnet from the routing domain that you specify.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-VM<VirtualMachine[]>
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.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-VMName<String[]>
Specifies an array of names of virtual machines. The cmdlet removes the virtual subnet from the virtual machines that you specify.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-VMNetworkAdapter<VMNetworkAdapterBase[]>
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.
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 removes the virtual subnet for the 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: Remove a tenant from a multitenant virtual machine
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.
PS C:\> Remove-VMNetworkAdapterRoutingDomainMapping -VMName "Gateway01" -VMNetworkAdapterName "Internal NIC" –RoutingDomainID "{5a07361e-6a54-49fc-9210-bfbf14a5c56f}"
Related topics
Get-VMNetworkAdapterRoutingDomainMapping