PowerCLI Reference



This cmdlet creates an HCX Network Profile.


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

Related Commands

Detailed Description

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.


NameTypeDescriptionRequired?Pipeline InputDefault Value
AllowEditingIPPoolBooleanSpecifies if you can edit the IP Pool by using the Enterprise Administrator login.falseFalse
DNSSuffixStringSpecifies the DNS suffix for the IP Pool.falseFalse
GatewayAddressStringSpecifies the Gateway IP address for the IP Pool.falseFalse
IPPoolString[]Specifies the IP ranges. The following formats are valid: 1. IP address (ex: 2. IP range (ex:
MTUInt32Specifies the maximum transmission unit (MTU).falseFalse
NameStringSpecifies the name of the HCX Network Profile.trueFalse
NetworkHCXNetworkBackingSpecifies the Network backing.trueTrue (ByValue)
PrefixLengthInt32Specifies the prefix length for the Network Profile.falseFalse
PrimaryDNSStringSpecifies the primary DNS for the Network Profile.falseFalse
SecondaryDNSStringSpecifies the secondary DNS for the Network Profile.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

Return Type




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

PS C:\> $myNetworkBacking = Get-HCXNetworkBacking -Name "myNetworkBacking"
New-HCXNetworkProfile -PrimaryDNS -SecondaryDNS -DNSSuffix "eng.vmware.com" -Name "myNetworkProfile" -GatewayAddress -IPPool, -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.

Copyright © VMware, Inc. All rights reserved.