Syntax
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.Parameters
| Name | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| AllowEditingIPPool | Boolean | Specifies if you can edit the IP Pool by using the Enterprise Administrator login. | false | False | |
| DNSSuffix | String | Specifies the DNS suffix for the IP Pool. | false | False | |
| GatewayAddress | String | Specifies the Gateway IP address for the IP Pool. | false | False | |
| IPPool | String[] | 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) | false | False | |
| MTU | Int32 | Specifies the maximum transmission unit (MTU). | false | False | |
| Name | String | Specifies the name of the HCX Network Profile. | true | False | |
| Network | HCXNetworkBacking | Specifies the Network backing. | true | True (ByValue) | |
| PrefixLength | Int32 | Specifies the prefix length for the Network Profile. | false | False | |
| PrimaryDNS | String | Specifies the primary DNS for the Network Profile. | false | False | |
| SecondaryDNS | String | Specifies the secondary DNS for the Network Profile. | false | False | |
| 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 |
Return Type
VMware.VimAutomation.Hcx.Types.V1.HCXNetworkProfileJobNotes
Examples
-------------------------- Example 1 --------------------------
PS C:\> $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.