Get-HCXNetwork Command | Vmware PowerCLI Reference

Get-HCXNetwork

This cmdlet retrieves a list of HCX networks. If the HCXSite is not passed as input, the source site networks are listed. You can create new HCX migration, replication, network extension, and appliance requests by using the output of the cmdlet.

Syntax

Get-HCXNetwork
-Uid < String[] >
[-ProgressAction < ActionPreference > ]
[-Server < HcxServer[] > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
 Uid String[] named
Specifies the Uid of the HCX 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.
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-HCXNetwork
[-DVSName < String[] > ]
[-Name < String[] > ]
[-ProgressAction < ActionPreference > ]
[-Server < HcxServer[] > ]
[-Site < HCXSite[] > ]
[-Type < NetworkType > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
optional DVSName String[] named
{{ Fill DVSName Description }}
optional Name String[] named
Specifies the name of the HCX network.
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.
optional Site HCXSite[] named
  • pipeline
 Specifies the HCX site for which you want to list the networks. If this parameter is not specified, the default one is selected from the source site.
optional Type NetworkType named
Specifies the type of the HCX network. The valid values are Network, DistributedVirtualPortgroup, VirtualWire, NsxtSegment, OpaqueNetwork, OrgVdcNetwork and VirtualNetwork.
Get-HCXNetwork
-ForExtension
[-Appliance < HCXAppliance > ]
[-DVSName < String[] > ]
[-Name < String[] > ]
[-ProgressAction < ActionPreference > ]
[-Server < HcxServer[] > ]
[-Site < HCXSite[] > ]
[-Type < NetworkType > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
 ForExtension SwitchParameter named
{{ Fill ForExtension Description }}
optional Appliance HCXAppliance named
  • pipeline
 Specifies the L2Concentrator appliance to filter networks.
optional DVSName String[] named
{{ Fill DVSName Description }}
optional Name String[] named
Specifies the name of the HCX network.
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.
optional Site HCXSite[] named
  • pipeline
 Specifies the HCX site for which you want to list the networks. If this parameter is not specified, the default one is selected from the source site.
optional Type NetworkType named
Specifies the type of the HCX network. The valid values are Network, DistributedVirtualPortgroup, VirtualWire, NsxtSegment, OpaqueNetwork, OrgVdcNetwork and VirtualNetwork.

Output

VMware.VimAutomation.Hcx.Types.V1.HCXNetwork

Examples

Example 1 

Get-HCXNetwork

Retrieves the available HCX network at the source site.

Example 2 

Get-HCXNetwork -Name "myNetworkName"

Retrieves the HCX network by name at the source site.

Example 3 

Get-HCXNetwork -Type DistributedVirtualPortgroup

Retrieves the HCX network by type at the source site.

Example 4 

$myDestination = Get-HCXSite -Destination -Name "myDestinationName"
        Get-HCXNetwork -Site $myDestination

Retrieves the HCX network by destination site.

Example 5 

$myL2concentrator = Get-HCXAppliance -Type L2Concentrator -Name "myL2ConcentratorName"
        Get-HCXNetwork -ForExtension -Appliance $myL2concentrator

Retrieves the HCX network by L2Concentrator.

Example 6 

$myNetwork = Get-HCXNetwork -Name "myNetworkName"
        Get-HCXNetwork -Uid $myNetwork.Uid

Retrieves the HCX network by Uid.

Example 7 

$myNetwork = Get-HCXNetwork -Type NsxtSegment

Retrieves the HCX network by type NsxtSegment present in Nsxt sites.

Example 8 

$myL2concentrator = Get-HCXAppliance -Type L2Concentrator -Name "myL2ConcentratorName"
        Get-HCXNetwork -ForExtension -Appliance $myL2concentrator -DVSName "myDvs"

Retrieves the HCX network by L2Concentrator and filtered by DvsName.

Related Commands

HCXNetwork

This cmdlet retrieves a list of HCX networks.

HCXNetworkBacking

This cmdlet retrieves a list of HCX Network Backings.

HCXNetworkExtension

This cmdlet retrieves a list of HCX Network Extension (HCX-NET-EXT).

This cmdlet creates an HCX Network Extension (L2 extension).

This cmdlet removes an HCX Network Extension.

HCXNetworkMapping

This cmdlet creates an HCX network mapping request.

HCXNetworkProfile

This cmdlet retrieves a list of HCX Network Profiles.

This cmdlet creates an HCX Network Profile.

This cmdlet removes an existing HCX Network Profile.

This cmdlet modifies the HCX Network Profile.