Set-HCXNetworkProfile Command | Vmware PowerCLI Reference

Set-HCXNetworkProfile

This cmdlet modifies the HCX Network Profile.

Syntax

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

Parameters

Required Parameter Name Type Position Features Description
required
NetworkProfile HCXNetworkProfile named
Specifies the Network Profile that you want to modify.
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.
optional Name String named
Specifies the name of the HCX Network Profile.
optional Network HCXNetworkBacking named
  • pipeline
Specifies the HCX network backing.
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

$myNetworkProfile = Get-HCXNetworkProfile -Name "myNetworkProfile"
Set-HCXNetworkProfile -Name "newNetworkProfile" -NetworkProfile $myNetworkProfile

Modifies the name of the Network Profile.

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.