powershellscripts.com

Tutorials  PowerShell Cmdlet Help for New-OSCustomizationSpec



NAME
New-OSCustomizationSpec

SYNOPSIS
Creates a new OS customization specification.

SYNTAX
New-OSCustomizationSpec [-OSType ] [-Server ] [-Name ] [-Type
] [-DnsServer ] [-DnsSuffix ] [-Domain ] [-NamingScheme ] [-NamingPrefix g>] [-Description ] [-WhatIf] [-Confirm] []

New-OSCustomizationSpec -OSCustomizationSpec [-Server ] [-Name ] [-Type <
OSCustomizationSpecType>] [-WhatIf] [-Confirm] []

New-OSCustomizationSpec -FullName -OrgName [-OSType ] [-ChangeSid] [-DeleteAccounts] [-Se
rver ] [-Name ] [-Type ] [-DnsServer ] [-DnsSuffix >] [-GuiRunOnce ] [-AdminPassword ] [-TimeZone ] [-AutoLogonCount ] [-Domain ng>] [-Workgroup ] [-DomainCredentials ] [-DomainUsername ] [-DomainPassword
] [-ProductKey ] [-NamingScheme ] [-NamingPrefix ] [-Description ] [-LicenseMode icenseMode>] [-LicenseMaxConnections ] [-WhatIf] [-Confirm] []


DESCRIPTION
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 ob
ject. If the -Name parameter is not specified, the OSCustomizationSpec object is not persisted on the server. Eithe
r the Domain or the Workgroup parameters should be provided if a Windows specification is created. If a Linux speci
fication is created, the Domain parameter is mandatory. New-OSCustomizationSpec automatically creates a default NI
C mapping.


PARAMETERS
-OSType
Specify the type of the operating system. The valid values are Linux and Windows.

Required? false
Position? named
Default value Windows
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? true (ByValue)
Accept wildcard characters? true

-Name
Specify a name for the new specification.

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

-Type
Specify 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

-DnsServer
Specify the DNS server settings. 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 settings. This parameter applies only to Linux operating systems.

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

-Domain
Specify a 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 following values are valid:

Custom - Specifies that vCenter Server will launch an external application to generate the (hostname/IP). The c
ommand line for this application must be specified in the server configuration file (vpxd.cfg) in the vpxd/name
-ip-generator key.


Fixed - Specifies that the name is fixed.

Prefix - Specifies that a unique name should be generated by concatenating the base string with a number. Virt
ual machine names are unique across the set of hosts and virtual machines known to the vCenter Server instance.
vCenter Server tracks the network names of virtual machines as well as hosts. VMware Tools runs in a guest ope
rating system and reports information to vCenter Server, including the network name of the guest.

Vm - Specifies that vCenter Server should generate a virtual machine name from a base prefix comprising the vir
tual machine entity name. A number is appended, if necessary, to make it unique. Virtual machine names are uniq
ue across the set of hosts and virtual machines known to the vCenter Server instance. VMware Tools reports the
names of existing virtual machines.

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

-NamingPrefix
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 th
is 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 wh
ich a unique number is appended.

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

-Description
Provide a description for the new 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

-OSCustomizationSpec
Specify an OS customization specification that you want to clone.

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

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

Required? true
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? true
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
Specify a list of commands. These commands run when a user logs in for the first time after the customization c
ompletes. This parameter applies only to Windows operating systems.

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

-AdminPassword
Specify a 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 time zone for the OS. 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? true

-AutoLogonCount
Specify the number of times the virtual machine automatically logs in as administrator without prompting for us
er 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.

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

-Workgroup
Specify a 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 the credentials you want to use for domain authentication. This parameter applies only to Windows opera
ting systems.

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

-DomainUsername
Specify the user name you want to use for domain authentication. 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 the password you want to use for domain authentication. This parameter applies only to Windows operatin
g 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
is 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>New-OSCustomizationSpec -Name Spec -OSType Windows -FullName Administrator -OrgName Organization -NamingSchem
e Fixed -NamingPrefix Computer -ProductKey "xxxx-xxxx" -LicenseMode PerSeat -Workgroup Workgroup -ChangeSid


Generates a new SID for the machine and sets the name of the machine to "Computer".





-------------- Example 2 --------------

C:\PS>New-OSCustomizationSpec -Name Spec -OSType Windows -Description "This spec adds a computer in a domain." -Ful
lName Administrator -OrgName Organization -NamingScheme Fixed -NamingPrefix "Computer" -ProductKey "xxxx-xxxx" -Lic
enseMode Perserver -LicenseMaxConnections 30 -AdminPassword pass -Domain Domain -DomainUsername Root -DomainPasswor
d pass


Creates a customization specification that adds a computer in the domain named "Domain".






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