New-OSCustomizationSpec
This cmdlet creates a new OS customization specification or clones an existing one. If a name is provided, creates and adds the specified customization specification to the server. Otherwise, creates and returns the requested specification object. If the Name parameter is not specified, the OSCustomizationSpec object is not persisted on the server. Either the Domain or the Workgroup parameters should be provided if a Windows specification is created. If a Linux specification is created, the Domain parameter is mandatory. New-OSCustomizationSpec automatically creates a default NIC mapping.
Syntax
[-DnsServer <String[]>]
[-DnsSuffix <String[]>]
[-Domain <String>]
[-Name <String>]
[-NamingPrefix <String>]
[-NamingScheme <String>]
[-OSType <String>]
[-Server <VIServer[]>]
[-Type <OSCustomizationSpecType>]
[CommonParameters]
Parameters
Required | Parameter Name | Type | Position | Features | Description |
---|---|---|---|---|---|
optional |
|
String | named |
|
Provides a description for the new specification. | optional |
|
String[] | named |
|
Specifies the DNS server settings. This parameter applies only to Linux operating systems. | optional |
|
String[] | named |
|
Specifies the DNS suffix settings. This parameter applies only to Linux operating systems. | optional |
|
String | named |
|
Specifies a domain name. | optional |
|
String | named |
|
Specifies a name for the new specification. | optional |
|
String | named |
|
Depends on the customization naming scheme - Custom, NamingPrefix, or Prefix. If the "Custom" naming scheme is used, NamingPrefix is an optional argument that is passed to the utility for this IP address. The meaning of this field is user-defined in the script. If the "Fixed" naming scheme is used, NamingPrefix should indicate the name of the virtual machine. If the "Prefix" naming scheme is selected, NamingPrefix indicates the prefix to which a unique number is appended. | optional |
|
String | named |
|
Specifies the naming scheme for the virtual machine. The following values are valid: | optional |
|
String | named |
|
Specifies the type of the operating system. The valid values are Linux and Windows. | optional |
|
VIServer[] | named |
|
Specifies the vCenter 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 Connect-VIServer. | optional |
|
OSCustomizationSpecType | named |
|
Specifies the type of the OS customization specification. The valid values are Persistent and NonPersistent. |
[-Name <String>]
[-Server <VIServer[]>]
[-Type <OSCustomizationSpecType>]
[CommonParameters]
Parameters
Required | Parameter Name | Type | Position | Features | Description |
---|---|---|---|---|---|
required |
|
OSCustomizationSpec | named |
|
Specifies an OS customization specification that you want to clone. | optional |
|
String | named |
|
Specifies a name for the new specification. | optional |
|
VIServer[] | named |
|
Specifies the vCenter 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 Connect-VIServer. | optional |
|
OSCustomizationSpecType | named |
|
Specifies the type of the OS customization specification. The valid values are Persistent and NonPersistent. |
-OrgName <String>
[-AdminPassword <String>]
[-AutoLogonCount <Int32>]
[-ChangeSid]
[-DeleteAccounts]
[-Description <String>]
[-DnsServer <String[]>]
[-DnsSuffix <String[]>]
[-Domain <String>]
[-DomainCredentials <PSCredential>]
[-DomainPassword <String>]
[-DomainUsername <String>]
[-GuiRunOnce <String[]>]
[-LicenseMaxConnections <Int32>]
[-LicenseMode <LicenseMode>]
[-Name <String>]
[-NamingPrefix <String>]
[-NamingScheme <String>]
[-OSType <String>]
[-ProductKey <String>]
[-Server <VIServer[]>]
[-TimeZone <String>]
[-Type <OSCustomizationSpecType>]
[-Workgroup <String>]
[CommonParameters]
Parameters
Required | Parameter Name | Type | Position | Features | Description |
---|---|---|---|---|---|
required |
|
String | named |
|
Specifies the administrator's full name. This parameter applies only to Windows operating systems. | required |
|
String | named |
|
Specifies the name of the organization to which the administrator belongs. | optional |
|
String | named |
|
Specifies a new OS administrator's password. This parameter applies only to Windows operating systems. If not specified, the administrator's password is set to blank. | optional |
|
Int32 | named |
|
Specifies the number of times the virtual machine automatically logs in as administrator without prompting for user credentials. The valid values are in the range between 0 and Int32.MaxValue. Specifying 0 disables auto log-on. This parameter applies only to Windows operating systems. | optional |
|
SwitchParameter | named |
|
Indicates that the customization should modify the system security identifier (SID). This parameter applies only to Windows operating systems. | optional |
|
SwitchParameter | named |
|
Indicates that you want to delete all user accounts. This parameter applies only to Windows operating systems. | optional |
|
String | named |
|
Provides a description for the new specification. | optional |
|
String[] | named |
|
Specifies the DNS server settings. This parameter applies only to Linux operating systems. | optional |
|
String[] | named |
|
Specifies the DNS suffix settings. This parameter applies only to Linux operating systems. | optional |
|
String | named |
|
Specifies a domain name. | optional |
|
PSCredential | named |
|
Specifies the credentials you want to use for domain authentication. This parameter applies only to Windows operating systems. | optional |
|
String | named |
|
Specifies the password you want to use for domain authentication. This parameter applies only to Windows operating systems. | optional |
|
String | named |
|
Specifies the user name you want to use for domain authentication. This parameter applies only to Windows operating systems. | optional |
|
String[] | named |
|
Specifies a list of commands. These commands run when a user logs in for the first time after the customization completes. This parameter applies only to Windows operating systems. | optional |
|
Int32 | named |
|
Specifies the maximum connections for server license mode. Use this parameter only if the LicenseMode parameter is set to Perserver. This parameter applies only to Windows operating systems. | optional |
|
LicenseMode | named |
|
Specifies the license mode of the Windows 2000/2003 guest operating system. The valid values are Perseat, Perserver, and Notspecified. If Perserver is set, use the LicenseMaxConnection parameter to define the maximum number of connections. This parameter applies only to Windows operating systems. | optional |
|
String | named |
|
Specifies a name for the new specification. | optional |
|
String | named |
|
Depends on the customization naming scheme - Custom, NamingPrefix, or Prefix. If the "Custom" naming scheme is used, NamingPrefix is an optional argument that is passed to the utility for this IP address. The meaning of this field is user-defined in the script. If the "Fixed" naming scheme is used, NamingPrefix should indicate the name of the virtual machine. If the "Prefix" naming scheme is selected, NamingPrefix indicates the prefix to which a unique number is appended. | optional |
|
String | named |
|
Specifies the naming scheme for the virtual machine. The following values are valid: | optional |
|
String | named |
|
Specifies the type of the operating system. The valid values are Linux and Windows. | optional |
|
String | named |
|
Specifies the MS product key. If the guest OS version is earlier than Vista, this parameter is required in order to make the customization unattended. For Vista or later, the OS customization is unattended no matter if the ProductKey parameter is set. | optional |
|
VIServer[] | named |
|
Specifies the vCenter 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 Connect-VIServer. | optional |
|
String | named |
|
Specifies the name or ID of the time zone for a Windows guest OS only. Using wildcards is supported. The following time zones are available: | optional |
|
OSCustomizationSpecType | named |
|
Specifies the type of the OS customization specification. The valid values are Persistent and NonPersistent. | optional |
|
String | named |
|
Specifies a workgroup. This parameter applies only to Windows operating systems. |
Output
VMware.VimAutomation.ViCore.Types.V1.OSCustomization.OSCustomizationSpec
Examples
Example 1
Generates a new SID for the machine and sets the name of the machine to "Computer".
Example 2
Creates a customization specification that adds a computer in the domain named "Domain".
Related Commands
OSCustomizationNicMapping