HCXNetwork Category | Vmware PowerCLI Reference

HCX Network Category

Cmdlets are usually implemented around resource operations. The four basic operations are CREATE, READ, UPDATE and DELETE. This set of operations is known as CRUD. Most of the cmdlets support CRUD which are respectively cmdlets that start with the New/Get/Set/Remove cmdlet verbs but they also may have additional operations

Step 1: Retrieve a object by running a Get command

You can READ objects by using Get-HCXNetwork cmdlet. See example below:

# Retrieves the available HCX network at the source site.


Step 2 : Run commands from the CRUD group

You can CREATE objects by using New-HCXNetworkExtension cmdlet. See example below:

# Creates a network extension.

$myL2CAppliance = Get-HCXAppliance -Type L2Concentrator -Name "myAppliance" New-HCXNetworkExtension -Appliance $myL2CAppliance -DestinationGateway $myGateway -DestinationSite $myDestination -GatewayIp -Netmask -Network $myNetwork -SourceSite $mySource
You can UPDATE objects by using Set-HCXNetworkProfile cmdlet. See example below:

# Modifies the name of the Network Profile.

$myNetworkProfile = Get-HCXNetworkProfile -Name "myNetworkProfile" Set-HCXNetworkProfile -Name "newNetworkProfile" -NetworkProfile $myNetworkProfile
You can REMOVE objects by using Remove-HCXNetworkExtension cmdlet. See example below:

# Removes the network extension.

Remove-HCXNetworkExtension -HCXNetworkExtension $networkExtended

Step 3: Explore More Related Commands:

Get-HCXNetworkBacking This cmdlet retrieves a list of HCX Network Backings.
Get-HCXNetworkExtension This cmdlet retrieves a list of HCX Network Extension (HCX-NET-EXT).
Get-HCXNetworkProfile This cmdlet retrieves a list of HCX Network Profiles.
New-HCXNetworkMapping This cmdlet creates an HCX network mapping request.
New-HCXNetworkProfile This cmdlet creates an HCX Network Profile.
Remove-HCXNetworkProfile This cmdlet removes an existing HCX Network Profile.