Skip to content

Latest commit

 

History

History
259 lines (204 loc) · 6.24 KB

Remove-VMNetworkAdapter.md

File metadata and controls

259 lines (204 loc) · 6.24 KB
Raw
description external help file Module Name ms.date online version schema title
Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell.
Microsoft.HyperV.PowerShell.Cmdlets.dll-Help.xml
Hyper-V
12/20/2016
2.0.0
Remove-VMNetworkAdapter

Remove-VMNetworkAdapter

SYNOPSIS

Removes one or more virtual network adapters from a virtual machine.

SYNTAX

VMName (Default)

Remove-VMNetworkAdapter [-CimSession <CimSession[]>] [-ComputerName <String[]>] [-Credential <PSCredential[]>]
 [-VMName] <String[]> [-Name <String>] [-Passthru] [-WhatIf] [-Confirm] [<CommonParameters>]

ResourceObject

Remove-VMNetworkAdapter [-VMNetworkAdapter] <VMNetworkAdapterBase[]> [-Passthru] [-WhatIf] [-Confirm]
 [<CommonParameters>]

ManagementOS

Remove-VMNetworkAdapter [-ManagementOS] [-CimSession <CimSession[]>] [-ComputerName <String[]>]
 [-Credential <PSCredential[]>] [-Name <String>] [-SwitchName <String>] [-Passthru] [-WhatIf] [-Confirm]
 [<CommonParameters>]

VMObject

Remove-VMNetworkAdapter [-VM] <VirtualMachine[]> [-Name <String>] [-Passthru] [-WhatIf] [-Confirm]
 [<CommonParameters>]

DESCRIPTION

The Remove-VMNetworkAdapter cmdlet removes one or more virtual network adapters from a virtual machine.

EXAMPLES

Example 1

PS C:\> Remove-VMNetworkAdapter -VMName Redmond -VMNetworkAdapterName Redmond_NIC1

This example removes network adapter Redmond_NIC1 from a virtual machine named Redmond.

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[]
Parameter Sets: VMName, ManagementOS
Aliases: 

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

-ComputerName

Specifies one or more Hyper-V hosts on which the virtual network adapter is to be removed. NetBIOS names, IP addresses, and fully qualified domain names are allowable. The default is the local computer. Use localhost or a dot (.) to specify the local computer explicitly.

Type: String[]
Parameter Sets: VMName, ManagementOS
Aliases: 

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: 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[]
Parameter Sets: VMName, ManagementOS
Aliases: 

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

-ManagementOS

Specifies the management operating system of the virtual network adapter to be removed.

Type: SwitchParameter
Parameter Sets: ManagementOS
Aliases: 

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

-Name

Specifies the name of the virtual network adapter to be removed.

Type: String
Parameter Sets: VMName, ManagementOS, VMObject
Aliases: VMNetworkAdapterName

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

-Passthru

Specifies that an object to be passed through to the pipeline representing the virtual machine network adapter to be removed. This is a Microsoft.HyperV.PowerShell.VMInternalNetworkAdapter object, if -ManagementOS is specified; otherwise it is a Microsoft.HyperV.PowerShell.VMNetworkAdapter object.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: 

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

-SwitchName

Specifies the name of the virtual switch connected to the virtual network adapter to be removed.

Type: String
Parameter Sets: ManagementOS
Aliases: 

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

-VM

Specifies the virtual machine that has the virtual network adapter you want to remove.

Type: VirtualMachine[]
Parameter Sets: VMObject
Aliases: 

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-VMName

Specifies the name of the virtual machine that has the virtual network adapter you want to remove.

Type: String[]
Parameter Sets: VMName
Aliases: 

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-VMNetworkAdapter

Specifies the virtual machine network adapter to be removed.

Type: VMNetworkAdapterBase[]
Parameter Sets: ResourceObject
Aliases: 

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-WhatIf

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

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

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

CommonParameters

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

INPUTS

OUTPUTS

None by default. if PassThru is specified, Microsoft.HyperV.PowerShell.VMInternalNetworkAdapter, if -ManagementOS is also specified;otherwise Microsoft.HyperV.PowerShell.VMNetworkAdapter.

NOTES

RELATED LINKS