## PowerCLI Reference

# Set-OSCustomizationSpec

## Synopsis

This cmdlet modifies the specified OS customization specification.

Syntax

Set-OSCustomizationSpec [-OSCustomizationSpec] <OSCustomizationSpec[]> [-NewSpec <OSCustomizationSpec>] [-Type <OSCustomizationSpecType>] [-Server <VIServer[]>] [-Name <String>] [-DnsServer <String[]>] [-DnsSuffix <String[]>] [-Domain <String>] [-NamingScheme <String>] [-NamingPrefix <String>] [-Description <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
Set-OSCustomizationSpec [-FullName <String>] [-OrgName <String>] [-ChangeSID <Boolean>] [-DeleteAccounts <Boolean>] [-OSCustomizationSpec] <OSCustomizationSpec[]> [-NewSpec <OSCustomizationSpec>] [-Type <OSCustomizationSpecType>] [-Server <VIServer[]>] [-Name <String>] [-DnsServer <String[]>] [-DnsSuffix <String[]>] [-GuiRunOnce <String[]>] [-AdminPassword <String>] [-TimeZone <String>] [-AutoLogonCount <Int32>] [-Domain <String>] [-Workgroup <String>] [-DomainCredentials <PSCredential>] [-DomainUsername <String>] [-DomainPassword <String>] [-ProductKey <String>] [-NamingScheme <String>] [-NamingPrefix <String>] [-Description <String>] [-LicenseMode <LicenseMode>] [-LicenseMaxConnections <Int32>] [-WhatIf] [-Confirm] [<CommonParameters>]

Related Commands

Online version
New-OSCustomizationSpec

Detailed Description

This cmdlet modifies the specified OS customization specification. The specification to be updated is identified by one or both of the Name and Spec parameters. If a Windows specification is to be updated, one of the Domain and Workgroup parameters must be provided. If a Linux specification is to be updated, the Domain parameter must be provided.

Parameters

Name | Type | Description | Required? | Pipeline Input | Default Value
--- | --- | --- | --- | --- | ---
OSCustomizationSpec | OSCustomizationSpec[] | Specifies the specification you want to modify. | true | true (ByValue)
AdminPassword | String | Specifies the new OS administrator's password. This parameter applies only to Windows operating systems. | false | false
AutoLogonCount | Int32 | Specifies the number of times the virtual machine should automatically login as an administrator. 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. | false | false
ChangeSID | Boolean | Indicates that the customization should modify the system security identifier (SID). This parameter applies only to Windows operating systems. | false | false
Confirm | SwitchParameter | If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation. | false | false
DeleteAccounts | Boolean | Indicates that you want to delete all user accounts. This parameter applies only to Windows operating systems. | false | false
Description | String | Provides a new description for the specification. | false | false
DnsServer | String[] | Specifies the DNS server. This parameter applies only to Linux operating systems. | false | false
DnsSuffix | String[] | Specifies the DNS suffix. This parameter applies only to Linux operating systems. | false | false
Domain | String | Specifies the domain name. | false | false
DomainCredentials | PSCredential | Specifies credentials for authentication with the specified domain. This parameter applies only to Windows operating systems. | false | false
DomainPassword | String | Specifies a password for authentication with the specified domain. This parameter applies only to Windows operating systems. | false | false
DomainUsername | String | Specifies a username for authentication with the specified domain. This parameter applies only to Windows operating systems. | false | false
FullName | String | Specifies the administrator's full name. This parameter applies only to Windows operating systems. | false | false
GuiRunOnce | String[] | Provides a list of commands to run after first user login. This parameter applies only to Windows operating systems. | false | false
LicenseMaxConnections | Int32 | 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. | false | false
LicenseMode | LicenseMode | 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. | false | false
Name | String | Specifies a new name for the OS customization specification. | false | false
NamingPrefix | String | The behavior of this parameter is related to the customization scheme. If a Custom customization scheme is specified, NamingPrefix is an optional argument that is passed to the utility for this IP address. The value of this field is defined by the user in the script. If a Fixed customization scheme is specified, NamingPrefix should indicate the name of the virtual machine. If a Prefix customization scheme is set, NamingPrefix indicates the prefix to which a unique number is appended. | false | false
NamingScheme | String | Specifies the naming scheme for the virtual machine. The valid values are Custom, Fixed, Prefix, and Vm. | false | false
NewSpec | OSCustomizationSpec | If no other parameters are provided, this parameter specifies a specification from which to retrieve information for the updated specification. | false | false
OrgName | String | Specifies the name of the organization to which the administrator belongs. | false | false
ProductKey | String | 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 Windows Vista and later, the OS customization is unattended no matter if the ProductKey parameter is set. | false | false
Server | VIServer[] | Specifies the vCenter 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 Connect-VIServer. | false | false
TimeZone | String | 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: 000 Int'l Dateline 001 Samoa 002 Hawaii 003 Alaskan 004 Pacific 010 Mountain (U.S. and Canada) 015 U.S. Mountain: Arizona 020 Central (U.S. and Canada) 025 Canada Central 030 Mexico 033 Central America 035 Eastern (U.S. and Canada) 040 U.S. Eastern: Indiana (East) 045 S.A. Pacific 050 Atlantic (Canada) 055 S.A. Western 056 Pacific S.A. 060 Newfoundland 065 E. South America 070 S.A. Eastern 073 Greenland 075 Mid-Atlantic 080 Azores 083 Cape Verde Islands 085 GMT (Greenwich Mean Time) 090 GMT Greenwich 095 Central Europe 100 Central European 105 Romance 110 W. Europe 113 W. Central Africa 115 E. Europe 120 Egypt 125 EET (Helsinki, Riga, Tallinn) 130 EET (Athens, Istanbul, Minsk) 135 Israel: Jerusalem 140 S. Africa: Harare, Pretoria 145 Russian 150 Arab 155 E. Africa 160 Iran 165 Arabian 170 Caucasus Pacific (U.S. and Canada) 175 Afghanistan 180 Russia Yekaterinburg 185 W. Asia 190 India 193 Nepal 195 Central Asia 200 Sri Lanka 201 N. Central Asia 203 Myanmar: Rangoon 205 S.E. Asia 207 N. Asia 210 China 215 Singapore 220 Taipei 225 W. Australia 227 N. Asia East 230 Korea: Seoul 235 Tokyo 240 Sakha Yakutsk 245 A.U.S. Central: Darwin 250 Central Australia 255 A.U.S. Eastern 260 E. Australia 265 Tasmania 270 Vladivostok 275 W. Pacific 280 Central Pacific 285 Fiji 290 New Zealand 300 Tonga | false | false
Type | OSCustomizationSpecType | Sets the type of the OS customization specification. The valid values are Persistent and NonPersistent. | false | false
WhatIf | SwitchParameter | Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified. | false | false
Workgroup | String | Specifies the workgroup. This parameter applies only to Windows operating systems. | false | false

Return Type

Zero or more modified OSCustomizationSpec objects

Notes

When the ProductKey parameter is not specified, the OS customization is unattended only if the Windows guest operating system version is Vista or later.

Examples

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

    Set-OSCustomizationSpec Spec -Description 'This is a test OS customization specification.'

Updates the description of the Spec OS customization specification.

Copyright © VMware, Inc. All rights reserved.