Get-HCXInventoryCompute

This cmdlet retrieves a list of vCenter Server compute resources. You can use the output of the cmdlet for creating ? Compute Profile and an HCX Appliance request.

Syntax

-ClusterComputeResource
[-Name  <String[]>]
[-Server  <HcxServer[]>]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
ClusterComputeResource
SwitchParameter named Indicates that you want to fetch clusters.
optional
Name
String[] named Specifies the name of the vCenter Server compute.
optional
Server
HcxServer[] named Specifies the HCX 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 the Connect-HCXServer cmdlet.

-DVS  <HCXApplianceDVS>
[-Name  <String[]>]
[-Server  <HcxServer[]>]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
DVS
HCXApplianceDVS named
  • pipeline
  • Specifies the DVS filter.
    optional
    Name
    String[] named Specifies the name of the vCenter Server compute.
    optional
    Server
    HcxServer[] named Specifies the HCX 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 the Connect-HCXServer cmdlet.

    -Network  <HCXNetwork>
    [-Name  <String[]>]
    [-Server  <HcxServer[]>]
    [CommonParameters]

    Parameters

    Required Parameter Name Type Position Features Description
    required
    Network
    HCXNetwork named
  • pipeline
  • Specifies the HCX networks. These include networks of type Network, DistributedVirtualPortgroup, VirtualWire, and VirtualNetwork.
    optional
    Name
    String[] named Specifies the name of the vCenter Server compute.
    optional
    Server
    HcxServer[] named Specifies the HCX 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 the Connect-HCXServer cmdlet.

    -Cluster  <HCXApplianceCompute[]>
    [-Name  <String[]>]
    [-Server  <HcxServer[]>]
    [CommonParameters]

    Parameters

    Required Parameter Name Type Position Features Description
    required
    Cluster
    HCXApplianceCompute[] named
  • pipeline
  • Specifies the vCenter Server cluster filter.
    optional
    Name
    String[] named Specifies the name of the vCenter Server compute.
    optional
    Server
    HcxServer[] named Specifies the HCX 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 the Connect-HCXServer cmdlet.

    Output

    VMware.VimAutomation.Hcx.Types.V1.HCXApplianceCompute

    Examples


    Example 1

    $myNetwork = Get-HCXNetwork -Name "myName"
    Get-HCXInventoryCompute -Network $myNetwork

    Retrieves a list of vCenter Server compute resources filtered by network.

    Example 2

    $myDvs = Get-HCXInventoryDVS -Name "myDvs"
    Get-HCXInventoryCompute -DVS $myDvs

    Retrieves ? list of vCenter Server compute resources filtered by DVS (Distributed Virtual Switch).

    Example 3

    $myDvs = Get-HCXInventoryDVS -Name "myDvs"
    Get-HCXInventoryCompute -DVS $myDvs -Name "myName"

    Retrieves a list of vCenter Server compute resources filtered by name.

    Example 4

    Get-HCXInventoryCompute -ClusterComputeResource

    Retrieves a list of vCenter Server ClusterComputeResource.

    Example 5

    $myCluster = Get-HCXInventoryCompute -ClusterComputeResource
    Get-HCXInventoryCompute -Cluster $myCluster

    Retrieves a list of vCenter Server compute resources filtered by cluster.

    Related Commands

    Feedback

    Was this page helpful?