New-HCXGuestOSNetworkCustomization Command | Vmware PowerCLI Reference

New-HCXGuestOSNetworkCustomization

The New-HCXGuestOSNetworkCustomization cmdlet in PowerCLI is used to customize network settings for a guest OS in an HCX environment.

Syntax

New-HCXGuestOSNetworkCustomization
-VM < HCXVM >
[-DnsSuffix < String > ]
[-Gateways < 0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] > ]
[-IPAddress < String > ]
[-NetMask < String > ]
[-NetworkName < String > ]
[-PrimaryDns < String > ]
[-ProgressAction < ActionPreference > ]
[-SecondaryDns < String > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
 VM HCXVM named
  • pipeline
 Specifies the VM to which the network customization will be applied.
optional DnsSuffix String named
  • pipeline
 Specifies the DNS suffix for the guest OS.
optional Gateways 0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] named
  • pipeline
 Specifies one or more gateway addresses for the guest OS.
optional IPAddress String named
  • pipeline
 Specifies the IP address of the guest OS.
optional NetMask String named
  • pipeline
 Specifies the subnet mask of the guest OS.
optional NetworkName String named
  • pipeline
 Specifies the name of the network to which the VM NIC is currently connected on the source side. This is required to get the MAC address of the network adapter that gets included as part of the GuestOSCustomization payload.
optional PrimaryDns String named
  • pipeline
 Specifies the primary DNS server for the guest OS.
optional ProgressAction ActionPreference named
optional SecondaryDns String named
  • pipeline
 Specifies the secondary DNS server for the guest OS.

Output

VMware.VimAutomation.Hcx.Types.V1.HCXGuestOSNetworkCustomization

Examples

Example 1 

New-HCXGuestOSNetworkCustomization -NetworkName $networkName -IPAddress $ipAddress -NetMask $netMask -Gateways $gateways -PrimaryDns $nwPrimaryDns -SecondaryDns $nwSecondaryDns -DnsSuffix $dnsSuffix -VM $testVM

Creates a guest OS network customization object.

Related Commands

HCXGuestOSCustomization

This cmdlet creates guest OS customization object to be used in HCX bulk migrations.

HCXGuestOSNetworkCustomization

This cmdlet creates network customization object to be used in HCX guest OS customization.