PowerCLI Reference

Get-HCXInventoryNetwork

Synopsis

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

Syntax

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

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

Related Commands

Detailed Description

This cmdlet retrieves a list of the vCenter Server network. You can use the output of the cmdlet for creating a new HCX Appliance request.

Parameters

NameTypeDescriptionRequired?Pipeline InputDefault Value
NameString[]Specifies the name of the vCenter Server network.falseFalse
ServerHcxServer[]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.falseFalse
UidString[]Specifies the Uid of the vCenter Server network.


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.
trueFalse

Return Type

VMware.VimAutomation.Hcx.Types.V1.HCXApplianceNetwork

Notes

Examples

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

PS C:\> Get-HCXInventoryNetwork

Retrieves a list of the vCenter Server network.

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

PS C:\> Get-HCXInventoryNetwork -Name "myName"

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

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

PS C:\> $myNetwork = Get-HCXInventoryNetwork
        Get-HCXInventoryNetwork -Uid $myNetwork.Uid

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


Copyright © VMware, Inc. All rights reserved.