Get-HCXInventoryDVS Command | Vmware PowerCLI Reference

Get-HCXInventoryDVS

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

Syntax

Get-HCXInventoryDVS
-Compute < HCXApplianceCompute[] >
[-Name < String[] > ]
[-ProgressAction < ActionPreference > ]
[-Server < HcxServer[] > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
 Compute HCXApplianceCompute[] named
  • pipeline
 Specifies the vCenter Server compute.
optional Name String[] named
Specifies the name of the vCenter Server DVS.
optional ProgressAction ActionPreference named
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.
Get-HCXInventoryDVS
-Uid < String[] >
[-ProgressAction < ActionPreference > ]
[-Server < HcxServer[] > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
 Uid String[] named
Specifies the Uid of the vCenter Server DVS. Note: When a list of values is specified for the Uid parameter, the returned objects have a Uid that matches exactly one of the string values in the list.
optional ProgressAction ActionPreference named
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.
Get-HCXInventoryDVS
[-Name < String[] > ]
[-ProgressAction < ActionPreference > ]
[-Server < HcxServer[] > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
optional Name String[] named
Specifies the name of the vCenter Server DVS.
optional ProgressAction ActionPreference named
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.HCXApplianceDVS

Examples

Example 1 

Get-HCXInventoryDVS

Retrieves a list of the vCenter Server DVS.

Example 2 

Get-HCXInventoryDVS -Name "myDvs"

Retrieves a list of the vCenter Server DVS filtered by name.

Example 3 

$myDvs = Get-HCXInventoryDVS
        Get-HCXInventoryDVS -Uid $myDvs.Uid

Retrieves a list of the vCenter Server DVS filtered by Uid.

Example 4 

$myCompute = Get-HCXInventoryCompute -ClusterComputeResource -Name "myCompute"
        Get-HCXInventoryDVS -Compute $myCompute

Retrieves a list of the vCenter Server DVS filtered by compute.

Related Commands

HCXInventoryCompute

This cmdlet retrieves a list of vCenter Server compute resources from the connected HCX server.

HCXInventoryDVS

This cmdlet retrieves a list of the vCenter Server Distributed Virtual Switch (DVS) from the connected HCX server.

HCXInventoryDatastore

This cmdlet retrieves a list of the vCenter Server datastore from the connected HCX server.

HCXInventoryNetwork

This cmdlet retrieves a list of the vCenter Server network from the connected HCX server.