New-HCXGuestOSCustomization Command | Vmware PowerCLI Reference

New-HCXGuestOSCustomization

The New-HCXGuestOSCustomization cmdlet in PowerCLI is used to perform guest OS customization in an HCX environment. It allows you to specify various settings and configurations to customize the guest OS according to your requirements.

Syntax

New-HCXGuestOSCustomization
[-ChangeSID < Boolean > ]
[-DnsSuffixes < String > ]
[-DomainName < String > ]
[-HostName < String > ]
[-NetworkCustomizations < HCXGuestOSNetworkCustomization[] > ]
[-PersonalizationScriptPath < String > ]
[-PrimaryDns < String > ]
[-ProgressAction < ActionPreference > ]
[-SecondaryDns < String > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
optional ChangeSID Boolean named
  • pipeline
 Specifies whether to change the Security Identifier (SID) of the guest OS.
optional DnsSuffixes String named
  • pipeline
 Specifies DNS suffixes for the guest OS.
optional DomainName String named
  • pipeline
 Specifies the domain name for the guest OS.
optional HostName String named
  • pipeline
 Specifies the hostname for the guest OS.
optional NetworkCustomizations HCXGuestOSNetworkCustomization[] named
  • pipeline
 Specifies an array of network customizations to apply to the guest OS.
optional PersonalizationScriptPath String named
  • pipeline
 Specifies the path to a personalization script to run during customization.
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.
New-HCXGuestOSCustomization
-GroupConfiguration
[-ChangeSID < Boolean > ]
[-DnsSuffixes < String > ]
[-PersonalizationScriptPath < String > ]
[-PrimaryDns < String > ]
[-ProgressAction < ActionPreference > ]
[-SecondaryDns < String > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
 GroupConfiguration SwitchParameter named
Specifies if the GOS object is getting created for group configuration. At group level only limited options are supported.
optional ChangeSID Boolean named
  • pipeline
 Specifies whether to change the Security Identifier (SID) of the guest OS.
optional DnsSuffixes String named
  • pipeline
 Specifies DNS suffixes for the guest OS.
optional PersonalizationScriptPath String named
  • pipeline
 Specifies the path to a personalization script to run during customization.
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.HCXGuestOSCustomization

Examples

Example 1 

New-HCXGuestOSCustomization -ChangeSID $changeSID -HostName $hostName -DomainName $domainName -DnsSuffixes $dnsSuffixes -PrimaryDns $primaryDNS -SecondaryDns $secondaryDNS -NetworkCustomizations $networkCustomizations

Creates a guest OS customization object for a bulk migration object.

Example 2 

New-HCXGuestOSCustomization -GroupConfiguration -ChangeSID $changeSID -PersonalizationScriptPath $personalizationScriptPath -DnsSuffixes $dnsSuffixes -PrimaryDns $primaryDNS -SecondaryDns $secondaryDNS

Creates a guest OS customization object for a bulk migration group configuration 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.