PowerCLI Reference

Set-HCXNetworkProfile

Synopsis

This cmdlet modifies the HCX Network Profile.

Syntax

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

Related Commands

Detailed Description

This cmdlet modifies the HCX Network Profile.

Parameters

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: 10.2.3.4). 2. IP range (ex: 10.2.3.4-10.2.3.5).falseFalse
MTUInt32Specifies the maximum transmission unit.falseFalse
NameStringSpecifies the name of the HCX Network Profile.falseFalse
NetworkHCXNetworkBackingSpecifies the HCX network backing.falseTrue (ByValue)
NetworkProfileHCXNetworkProfileSpecifies the Network Profile that you want to modify.trueFalse
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

VMware.VimAutomation.Hcx.Types.V1.HCXNetworkProfileJob

Notes

Examples

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

PS C:\> $myNetworkProfile = Get-HCXNetworkProfile -Name "myNetworkProfile"
Set-HCXNetworkProfile -Name "newNetworkProfile" -NetworkProfile $myNetworkProfile

Modifies the name of the Network Profile.


Copyright © VMware, Inc. All rights reserved.