powershellscripts.com

Tutorials  PowerShell Cmdlet Help for Set-OSCustomizationSpec



NAME
Set-OSCustomizationSpec

SYNOPSIS
Changes the specified OS customization specification.

SYNTAX
Set-OSCustomizationSpec [-OSCustomizationSpec] [-NewSpec ] [-Type ustomizationSpecType>] [-Server ] [-Name ] [-DnsServer ] [-DnsSuffix ] [-Do
main ] [-NamingScheme ] [-NamingPrefix ] [-Description ] [-WhatIf] [-Confirm] [ monParameters>]

Set-OSCustomizationSpec [-FullName ] [-OrgName ] [-ChangeSID []] [-DeleteAccounts [ n>]] [-OSCustomizationSpec] [-NewSpec ] [-Type e>] [-Server ] [-Name ] [-DnsServer ] [-DnsSuffix ] [-GuiRunOnce
] [-AdminPassword ] [-TimeZone ] [-AutoLogonCount ] [-Domain ] [-Workgroup ]
[-DomainCredentials ] [-DomainUsername ] [-DomainPassword ] [-ProductKey ] [
-NamingScheme ] [-NamingPrefix ] [-Description ] [-LicenseMode ] [-LicenseMaxC
onnections ] [-WhatIf] [-Confirm] []


DESCRIPTION
Changes 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 para
meters must be provided. If a Linux specification is to be updated, the Domain parameter must be provided. This cmd
let runs only on x32 process.


PARAMETERS
-OSCustomizationSpec
Specify the specification you want to modify.

Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? true

-NewSpec
If no other parameters are given, this parameter specifies a specification from which to retrieve information f
or the updated specification.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? true

-Type
Set the type of the OS customization specification. The valid values are Persistent and NonPersistent.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Server
Specify the vSphere servers on which you want to run the cmdlet. If no value is given to this parameter, the co
mmand runs on the default servers. For more information about default servers, see the description of Connect-V
IServer.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? true

-Name
Specify a new name for the OS customization specification.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-DnsServer
Specify the DNS server. This parameter applies only to Linux operating systems.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-DnsSuffix
Specify the DNS suffix. This parameter applies only to Linux operating systems.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Domain
Specify the domain name.

Required? false
Position? named
Default value empty string
Accept pipeline input? false
Accept wildcard characters? false

-NamingScheme
Specify the naming scheme for the virtual machine. The valid values are Custom, Fixed, Prefix, and Vm.

Required? false
Position? named
Default value Vm
Accept pipeline input? false
Accept wildcard characters? false

-NamingPrefix
Depends on 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.

Required? false
Position? named
Default value empty string
Accept pipeline input? false
Accept wildcard characters? false

-Description
Provide a new description for the specification.

Required? false
Position? named
Default value empty string
Accept pipeline input? false
Accept wildcard characters? false

-WhatIf
Indicate that the cmdlet is run only to display the changes that would be made and actually no objects are modi
fied.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Confirm
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.

Required? false
Position? named
Default value $true
Accept pipeline input? false
Accept wildcard characters? false

-FullName
Specify the administrator's full name. This parameter applies only to Windows operating systems.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-OrgName
Specify the name of the organization to which the administrator belongs.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-ChangeSID []
Indicate that the customization should modify the system security identifier (SID). This parameter applies only
to Windows operating systems.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-DeleteAccounts []
Indicate that you want to delete all user accounts. This parameter applies only to Windows operating systems.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-GuiRunOnce
Provide a list of commands to run after first user login. This parameter applies only to Windows operating syst
ems.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-AdminPassword
Specify the new OS administrator's password. This parameter applies only to Windows operating systems.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-TimeZone
Specify the name or ID of the new time zone for the OS. 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

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-AutoLogonCount
Specify the number of times the virtual machine should automatically login as an administrator. The valid value
s are in the range between 0 and Int32.MaxValue. Specifying 0 disables auto log-on. This parameter applies only
to Windows operating systems.

Required? false
Position? named
Default value 0
Accept pipeline input? false
Accept wildcard characters? false

-Workgroup
Specify the workgroup. This parameter applies only to Windows operating systems.

Required? false
Position? named
Default value empty string
Accept pipeline input? false
Accept wildcard characters? false

-DomainCredentials
Specify credentials for authentication with the specified domain. This parameter applies only to Windows operat
ing systems.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-DomainUsername
Specify a username for authentication with the specified domain. This parameter applies only to Windows operati
ng systems.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-DomainPassword
Specify a password for authentication with the specified domain. This parameter applies only to Windows operati
ng systems.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-ProductKey
Specify 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 P
roductKey parameter is set.

Required? false
Position? named
Default value empty string
Accept pipeline input? false
Accept wildcard characters? false

-LicenseMode
Specify the license mode of the Windows 2000/2003 guest operating system. The valid values are Perseat, Perserv
er, 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.

Required? false
Position? named
Default value NotSpecified
Accept pipeline input? false
Accept wildcard characters? false

-LicenseMaxConnections
Specify the maximum connections for server license mode. Use this parameter only if the LicenseMode parameter i
s set to Perserver. This parameter applies only to Windows operating systems.

Required? false
Position? named
Default value $null
Accept pipeline input? false
Accept wildcard characters? false


This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer and OutVariable. For more information, type,
"get-help about_commonparameters".

INPUTS



OUTPUTS
OSCustomizationSpec


NOTES


When the ProductKey parameter is not specified, the OS customization is unattended only if the Windows guest op
erating system version is Vista or later.
This cmdlet is supported only in 32-bit PowerCLI mode.

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

C:\PS>Set-OSCustomizationSpec Spec -Description 'This is a test OS customization specification.'


Updates the description of the Spec OS customization specification.






RELATED LINKS
Online version: http://www.vmware.com/support/developer/PowerCLI/PowerCLI501/html/Set-OSCustomizationSpec.html
New-OSCustomizationSpec