PowerCLI Reference

Get-HCXInventoryDVS

Synopsis

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

Syntax

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

Get-HCXInventoryDVS [[-Name] <String[]>] [-Server <HcxServer[]>] [<CommonParameters>]

Get-HCXInventoryDVS [-Server <HcxServer[]>] -Uid <String[]> [<CommonParameters>]

Related Commands

Detailed Description

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.

Parameters

Name	Type	Description	Required?	Pipeline Input
Name	String[]	Specifies the name of the vCenter Server DVS.	false	False
Compute	HCXApplianceCompute[]	Specifies the vCenter Server compute.	true	True (ByValue)
Server	HcxServer[]	Specifies the HCX Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-HCXServer cmdlet.	false	False
Uid	String[]	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.	true	False

Return Type

VMware.VimAutomation.Hcx.Types.V1.HCXApplianceDVS

Notes

Examples

-------------------------- Example 1 --------------------------

PS C:\> Get-HCXInventoryDVS

Retrieves a list of the vCenter Server DVS.

-------------------------- Example 2 --------------------------

PS C:\> Get-HCXInventoryDVS -Name "myDvs"

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

-------------------------- Example 3 --------------------------

PS C:\> $myDvs = Get-HCXInventoryDVS
        Get-HCXInventoryDVS -Uid $myDvs.Uid

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

-------------------------- Example 4 --------------------------

PS C:\> $myCompute = Get-HCXInventoryCompute -ClusterComputeResource -Name "myCompute"
        Get-HCXInventoryDVS -Compute $myCompute

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