Get-VMHostNetworkAdapter

This cmdlet retrieves the host network adapters on a vCenter Server system.

Syntax

[[-Name]  <String[]>]
[-Console]
[-Id  <String[]>]
[-Physical]
[-PortGroup  <VirtualPortGroupBase[]>]
[-Server  <VIServer[]>]
[-VMHost  <VMHost[]>]
[-VMKernel]
[-VirtualSwitch  <VirtualSwitchBase[]>]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
optional
Name
String[] 1
  • wildcards
  • 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.
    optional
    Console
    SwitchParameter named Indicates that you want to retrieve only service console virtual network adapters.
    optional
    Id
    String[] named
  • wildcards
  • Specifies the IDs of the host network adapters you want to retrieve.
    optional
    Physical
    SwitchParameter named Indicates that you want to retrieve only physical network adapters.
    optional
    PortGroup
    VirtualPortGroupBase[] named
  • pipeline
  • Specifies the port groups to which network adapters that you want to retrieve are connected.
    optional
    Server
    VIServer[] named
  • wildcards
  • Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null 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.
    optional
    VMHost
    VMHost[] named
  • wildcards
  • pipeline
  • Specifies the hosts whose network adapters you want to retrieve. The position of this parameter is deprecated and might change in a following release.
    optional
    VMKernel
    SwitchParameter named Indicates that you want to retrieve only VMKernel virtual network adapters.
    optional
    VirtualSwitch
    VirtualSwitchBase[] named
  • pipeline
  • 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.

    Output

    VMware.VimAutomation.ViCore.Types.V1.Host.Networking.Nic.HostVirtualNic

    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.

    Related Commands

    Feedback

    Was this page helpful?