Syntax
Get-HCXNetwork [[-Name] <String[]>] -Appliance <HCXAppliance> [-Server <HcxServer[]>] [-Site <HCXSite[]>] [-Type <NetworkType>] [<CommonParameters>]Related Commands
Detailed Description
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.Parameters
| Name | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Name | String[] | Specifies the name of the HCX network. | false | False | |
| Appliance | HCXAppliance | Specifies the L2Concentrator appliance to filter networks. | 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 | |
| Site | HCXSite[] | 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. | false | True (ByValue) | |
| Type | NetworkType | Specifies the type of the HCX network. The valid values are Network, DistributedVirtualPortgroup, VirtualWire, and VirtualNetwork. | false | False | |
| Uid | String[] | 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. | true | False |
Return Type
VMware.VimAutomation.Hcx.Types.V1.HCXNetworkNotes
Examples
-------------------------- Example 1 --------------------------
PS C:\> Get-HCXNetwork
Retrieves the available HCX network at the source site.
-------------------------- Example 2 --------------------------
PS C:\> Get-HCXNetwork -Name "myNetworkName"
Retrieves the HCX network by name at the source site.
-------------------------- Example 3 --------------------------
PS C:\> Get-HCXNetwork -Type DistributedVirtualPortgroup
Retrieves the HCX network by type at the source site.
-------------------------- Example 4 --------------------------
PS C:\> $myDestination = Get-HCXSite -Destination -Name "myDestinationName"
Get-HCXNetwork -Site $myDestinationRetrieves the HCX network by destination site.
-------------------------- Example 5 --------------------------
PS C:\> $myL2concentrator = Get-HCXAppliance -Type L2Concentrator -Name "myL2ConcentratorName"
Get-HCXNetwork -Appliance $myL2concentratorRetrieves the HCX network by L2Concentrator.
-------------------------- Example 6 --------------------------
PS C:\> $myNetwork = Get-HCXNetwork -Name "myNetworkName"
Get-HCXNetwork -Uid $myNetwork.UidRetrieves the HCX network by Uid.