New-HCXNetworkProfile Command | Vmware PowerCLI Reference

New-HCXNetworkProfile

This cmdlet creates an HCX Network Profile. You can use the HCXInterconnectTask output to retrieve task details by running the Get-HCXJob cmdlet. You can use the Network Profile to create the Compute Profile.

Syntax

New-HCXNetworkProfile
-Name < String >
-Network < HCXNetworkBacking >
[-AllowEditingIPPool < Boolean > ]
[-DNSSuffix < String > ]
[-GatewayAddress < String > ]
[-IPPool < String[] > ]
[-MTU < Int32 > ]
[-PrefixLength < Int32 > ]
[-PrimaryDNS < String > ]
[-SecondaryDNS < String > ]
[-Server < HcxServer[] > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
Name String named
Specifies the name of the HCX Network Profile.
required
Network HCXNetworkBacking named
  • pipeline
Specifies the Network backing.
optional AllowEditingIPPool Boolean named
Specifies if you can edit the IP Pool by using the Enterprise Administrator login.
optional DNSSuffix String named
Specifies the DNS suffix for the IP Pool.
optional GatewayAddress String named
Specifies the Gateway IP address for the IP Pool.
optional IPPool String[] named
Specifies the IP ranges. The following formats are valid: 1. IP address (ex: 10.2.3.4) 2. IP range (ex: 10.2.3.4-10.2.3.5)
optional MTU Int32 named
Specifies the maximum transmission unit (MTU).
optional PrefixLength Int32 named
Specifies the prefix length for the Network Profile.
optional PrimaryDNS String named
Specifies the primary DNS for the Network Profile.
optional SecondaryDNS String named
Specifies the secondary DNS for the Network Profile.
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.

Output

VMware.VimAutomation.Hcx.Types.V1.HCXNetworkProfileJob

Examples

Example 1

$myNetworkBacking = Get-HCXNetworkBacking -Name "myNetworkBacking"
New-HCXNetworkProfile -PrimaryDNS 10.2.3.4 -SecondaryDNS 10.2.3.5 -DNSSuffix "eng.vmware.com" -Name "myNetworkProfile" -GatewayAddress 10.2.3.253 -IPPool 10.2.3.7-10.2.3.10,10.2.3.15 -Network $myNetworkBacking -PrefixLength 24

Creates a new HCX Network Profile.

Example 2

$myNetworkBacking = Get-HCXNetworkBacking -Name "myNetworkBacking"
New-HCXNetworkProfile -Name "myNetworkProfile" -Network $myNetworkBacking

Creates a new VMware HCX Network Profile without specifying IP Pool.

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.