Syntax
Get-VMHostNetworkAdapter [-VMHost <VMHost[]>] [[-VirtualSwitch] <VirtualSwitchBase[]>] [-PortGroup <VirtualPortGroupBase[]>] [-Physical] [-VMKernel] [-Console] [[-Name] <String[]>] [-Id <String[]>] [-Server <VIServer[]>] [<CommonParameters>]Related Commands
Online versionDetailed Description
This cmdlet retrieves the host network adapters on a vCenter Server system.Parameters
| Name | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| VirtualSwitch | VirtualSwitchBase[] | Specifies the virtual switches to which network adapters that you want to retrieve are connected. The position of this parameter is deprecated and will be changed in a future release. To avoid errors when you run existing scripts on future PowerCLI versions, specify the parameter by name. | false | true (ByValue) | |
| Name | String[] | Specifies the names of the host network adapters you want to retrieve. The position of this parameter is deprecated and will be changed in a future release. To avoid errors when you run existing scripts on future PowerCLI versions, specify the parameter by name. | false | false | |
| Console | SwitchParameter | Indicates that you want to retrieve only service console virtual network adapters. | false | false | |
| Id | String[] | Specifies the IDs of the host network adapters you want to retrieve.
Note: When a list of values is specified for the Id parameter, the returned objects would have an ID that matches exactly one of the string values in that list. | false | false | |
| Physical | SwitchParameter | Indicates that you want to retrieve only physical network adapters. | false | false | |
| PortGroup | VirtualPortGroupBase[] | Specifies the port groups to which network adapters that you want to retrieve are connected. | false | true (ByValue) | |
| Server | VIServer[] | Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer. | false | false | |
| VMHost | VMHost[] | Specifies the hosts whose network adapters you want to retrieve. The position of this parameter is deprecated and might change in a following release. | false | true (ByValue) | |
| VMKernel | SwitchParameter | Indicates that you want to retrieve only VMKernel virtual network adapters. | false | false |
Return Type
Zero or more HostVirtualNic objectsNotes
Examples
-------------- Example 1 --------------
Get-VMHostNetworkAdapter -VMKernel
Retrieves information about about all VMKernel network adapters on servers that you are connected to.
-------------- Example 2 --------------
$myVMHost = Get-VMHost -Name MyVMHost Get-VMHostNetworkAdapter -VMHost $myVMHost -Physical
Retrieves all physical network adapters on the specified host.
-------------- Example 3 --------------
$myVDSwitch = Get-VDSwitch -Name MyVDSwitch Get-VMHostNetworkAdapter -VirtualSwitch $myVDSwitch -VMKernel
Retrieves all VMKernel network adapters connected to the specified virtual switch.
-------------- Example 4 --------------
Get-VDPortGroup -Name MyVDPortGroup | Get-VMHostNetworkAdapter
Retrieves VMHost network adapters by a specified distributed port group.
-------------- Example 5 --------------
$myVirtualSwitch = Get-VirtualSwitch -Name MyVirtualSwitch Get-VMHostNetworkAdapter -VirtualSwitch $myVirtualSwitch
Retrieves physical VMHost network adapters by a specified standard virtual switch.