Creates a guest operating system profile for use in VMM.
Description
The New-SCGuestOSProfile cmdlet creates a guest operating system profile for use in System Center Virtual Machine Manager (VMM). A guest operating system is the operating system on a virtual machine, in contrast to a host operating system which is on the physical host computer on which one or more virtual machines are deployed.
A guest operating system profile stores operating system configuration information. A profile consists of a set of properties containing the most common settings specified in an unattended answer file (such as a Sysprep.inf or an Unattend.xml file).
You can create a standalone guest operating system profile or customize a template or virtual machine to include guest operating system profile settings. The New-SCGuestOSProfile cmdlet stores the new guest operating system profile object in the VMM library.
You can create a guest operating system profile based on default settings, based on an existing guest operating system profile, or you can customize settings as you create the profile. If you specify no parameters except the Name parameter, the New-SCGuestOSProfile cmdlet creates a default guest operating system profile object.
For more information about New-SCGuestOSProfile, type: "Get-Help New-SCGuestOSProfile -online".
Parameters
Name
Required?
true
Accept Pipeline Input?
false
Position?
0
Specifies the name of a VMM object.
DomainJoinCredential
Required?
true
Accept Pipeline Input?
false
Position?
named
Specifies the user name and password of an account with permission to join a computer to the domain. A limited rights account should be used for joining computers (either physical or virtual) to the domain.
Example format for a PS credential:
$DomainJoinCredential = Get-Credenital
-Domain "ThisDomain.Corp.Contoso.com" -DomainJoinCredential $DomainJoinCredential
Example format for a Run As account:
$DomainJoinCredential = Get-SCRunAsAccount -Name "RunAsAcct01"
-Domain "ThisDomain.Corp.Contoso.com" -DomainJoinCredential $DomainJoinCredential
NOTE: You can use the DomainJoinCredential parameter to specify credentials (on a VMHostProfile) for joining a physical host computer to the domain, or to specify credentials (on a new or existing template, on a new or existing guest operating system profile, or on a new virtual machine) for joining a virtual machine to the domain.
AnswerFile
Required?
false
Accept Pipeline Input?
true (ByValue)
Position?
named
Specifies a script object stored in the VMM library to use as an answer file. The name of the answer file script depends on the operating system that you want to install on a virtual machine:
ANSWER FILE GUEST OS TO INSTALL ON VM
----------- -------------------------
Sysprep.inf Windows XP, Windows Server 2000, or Windows Server 2003
Unattend.xml Windows Vista, Windows 7, or Windows Server 2008
AutoLogonCount
Required?
false
Accept Pipeline Input?
false
Position?
named
Specifies the number of times that Windows should automatically log the administrator denoted in the Answerr File on to the console session.
AutoLogonCredential
Required?
false
Accept Pipeline Input?
false
Position?
named
Specifies the Run As account contained in the Answer File that Windows uses to log on to the console session when automatic administrator logon is enabled.
ComputerName
Required?
false
Accept Pipeline Input?
false
Position?
named
Specifies the name of a computer that VMM can uniquely identify on your network. Valid formats are: FQDN, IPv4 or IPv6 address, or NetBIOS name.
NOTE: See the examples for a specific cmdlet to determine how that cmdlet specifies the computer name.
Description
Required?
false
Accept Pipeline Input?
false
Position?
named
States a description for the specified object.
DisableAutoLogon
Required?
false
Accept Pipeline Input?
false
Position?
named
Disables automatic administrator logon.
Domain
Required?
false
Accept Pipeline Input?
false
Position?
named
Specifies a fully qualified domain name (FQDN) for an Active Directory domain.
Example format: -Domain "Domain01.Corp.Contoso.com"
DomainJoinOrganizationalUnit
Required?
false
Accept Pipeline Input?
false
Position?
named
Specifies the organizational unit to which the computer is joined during an unattended mini-setup.
FullName
Required?
false
Accept Pipeline Input?
false
Position?
named
Specifies the name of the person in whose name a virtual machine is registered.
GuestOSProfile
Required?
false
Accept Pipeline Input?
true (ByValue)
Position?
named
Specifies a guest operating system profile object.
GuiRunOnceCommands
Required?
false
Accept Pipeline Input?
false
Position?
named
Specifies one or more commands to add to the [GuiRunOnce] section of an unattended answer file (such as Unattend.xml). Use single quotes around each string enclosed in double quotes.
Example format:
-GuiRunOnceCommands '"C:\APF\APFPostSysPrepCopy.cmd PARAMS1"', '"C:\APF\APFPostSysPrepCopy.cmd PARAMS1"'
For information about how Windows PowerShell uses quotes, type: "Get-Help about_Quoting_Rules"
JobVariable
Required?
false
Accept Pipeline Input?
false
Position?
named
Specifies that job progress is tracked and stored in the variable named by this parameter.
LocalAdministratorCredential
Required?
false
Accept Pipeline Input?
false
Position?
named
Specifies the user name and password for the local Administrator account. Specifying credentials on a new or existing template, on a new or existing guest operating system profile, or on a new virtual machine overrides any existing Administrator password.
MergeAnswerFile
Required?
false
Accept Pipeline Input?
false
Position?
named
Specifies that the cmdlet merge the specified answer file with the specified guest operating system settings. The default value is TRUE. This parameter is used by the VMM console. You do not need to use this parameter at the command prompt.
OperatingSystem
Required?
false
Accept Pipeline Input?
false
Position?
named
Specifies the type of operating system for a virtual machine. To list the names of all available operating systems in VMM, type: "Get-SCOperatingSystem".
OrganizationName
Required?
false
Accept Pipeline Input?
false
Position?
named
Specifies the name of the organization for the person in whose name a virtual machine is registered.
Owner
Required?
false
Accept Pipeline Input?
false
Position?
named
Specifies the owner of a VMM object in the form of a valid domain user account.
Example format: -Owner "Contoso\ReneeLo"
Example format: -Owner "ReneeLo@Contoso"
ProductKey
Required?
false
Accept Pipeline Input?
false
Position?
named
Specifies a product key. The product key is a 25-digit number that identifies the product license. A product key can be used to register VMM or an operating system to be installed on a virtual machine or host.
PROTipID
Required?
false
Accept Pipeline Input?
false
Position?
named
Specifies the ID of the PRO tip that triggered this action. This allows for auditing of PRO tips.
RemoveDomainJoinOrganizationalUnit
Required?
false
Accept Pipeline Input?
false
Position?
named
Removes the organizational unit that the computer joined during setup.
RemoveServerFeatures
Required?
false
Accept Pipeline Input?
false
Position?
named
Removes all server roles and features from a template.
RunAsynchronously
Required?
false
Accept Pipeline Input?
false
Position?
named
Indicates that the job runs asynchronously so that control returns to the command shell immediately.
TimeZone
Required?
false
Accept Pipeline Input?
false
Position?
named
Specifies a number (an index) that identifies a geographical region that shares the same standard time. For a list of time zone indexes, see "Microsoft Time Zone Index Values" at: http://go.microsoft.com/fwlink/?LinkId=120935. If no time zone is specified, the default time zone used for a virtual machine is the same time zone setting that is on the virtual machine host.
Example format to specify the GMT Standard Time zone: -TimeZone 085
UnattendSettings
Required?
false
Accept Pipeline Input?
false
Position?
named
Key Value pairs of String, String
UserRole
Required?
false
Accept Pipeline Input?
false
Position?
named
Specifies a user role object.
VMMServer
Required?
false
Accept Pipeline Input?
true (ByValue)
Position?
named
Specifies a VMM server object.
Name
Required?
true
Accept Pipeline Input?
false
Position?
0
Specifies the name of a VMM object.
AnswerFile
Required?
false
Accept Pipeline Input?
true (ByValue)
Position?
named
Specifies a script object stored in the VMM library to use as an answer file. The name of the answer file script depends on the operating system that you want to install on a virtual machine:
ANSWER FILE GUEST OS TO INSTALL ON VM
----------- -------------------------
Sysprep.inf Windows XP, Windows Server 2000, or Windows Server 2003
Unattend.xml Windows Vista, Windows 7, or Windows Server 2008
AutoLogonCount
Required?
false
Accept Pipeline Input?
false
Position?
named
Specifies the number of times that Windows should automatically log the administrator denoted in the Answerr File on to the console session.
AutoLogonCredential
Required?
false
Accept Pipeline Input?
false
Position?
named
Specifies the Run As account contained in the Answer File that Windows uses to log on to the console session when automatic administrator logon is enabled.
ComputerName
Required?
false
Accept Pipeline Input?
false
Position?
named
Specifies the name of a computer that VMM can uniquely identify on your network. Valid formats are: FQDN, IPv4 or IPv6 address, or NetBIOS name.
NOTE: See the examples for a specific cmdlet to determine how that cmdlet specifies the computer name.
Description
Required?
false
Accept Pipeline Input?
false
Position?
named
States a description for the specified object.
DisableAutoLogon
Required?
false
Accept Pipeline Input?
false
Position?
named
Disables automatic administrator logon.
DomainJoinOrganizationalUnit
Required?
false
Accept Pipeline Input?
false
Position?
named
Specifies the organizational unit to which the computer is joined during an unattended mini-setup.
FullName
Required?
false
Accept Pipeline Input?
false
Position?
named
Specifies the name of the person in whose name a virtual machine is registered.
GuestOSProfile
Required?
false
Accept Pipeline Input?
true (ByValue)
Position?
named
Specifies a guest operating system profile object.
GuiRunOnceCommands
Required?
false
Accept Pipeline Input?
false
Position?
named
Specifies one or more commands to add to the [GuiRunOnce] section of an unattended answer file (such as Unattend.xml). Use single quotes around each string enclosed in double quotes.
Example format:
-GuiRunOnceCommands '"C:\APF\APFPostSysPrepCopy.cmd PARAMS1"', '"C:\APF\APFPostSysPrepCopy.cmd PARAMS1"'
For information about how Windows PowerShell uses quotes, type: "Get-Help about_Quoting_Rules"
JobVariable
Required?
false
Accept Pipeline Input?
false
Position?
named
Specifies that job progress is tracked and stored in the variable named by this parameter.
LocalAdministratorCredential
Required?
false
Accept Pipeline Input?
false
Position?
named
Specifies the user name and password for the local Administrator account. Specifying credentials on a new or existing template, on a new or existing guest operating system profile, or on a new virtual machine overrides any existing Administrator password.
MergeAnswerFile
Required?
false
Accept Pipeline Input?
false
Position?
named
Specifies that the cmdlet merge the specified answer file with the specified guest operating system settings. The default value is TRUE. This parameter is used by the VMM console. You do not need to use this parameter at the command prompt.
OperatingSystem
Required?
false
Accept Pipeline Input?
false
Position?
named
Specifies the type of operating system for a virtual machine. To list the names of all available operating systems in VMM, type: "Get-SCOperatingSystem".
OrganizationName
Required?
false
Accept Pipeline Input?
false
Position?
named
Specifies the name of the organization for the person in whose name a virtual machine is registered.
Owner
Required?
false
Accept Pipeline Input?
false
Position?
named
Specifies the owner of a VMM object in the form of a valid domain user account.
Example format: -Owner "Contoso\ReneeLo"
Example format: -Owner "ReneeLo@Contoso"
ProductKey
Required?
false
Accept Pipeline Input?
false
Position?
named
Specifies a product key. The product key is a 25-digit number that identifies the product license. A product key can be used to register VMM or an operating system to be installed on a virtual machine or host.
PROTipID
Required?
false
Accept Pipeline Input?
false
Position?
named
Specifies the ID of the PRO tip that triggered this action. This allows for auditing of PRO tips.
RemoveDomainJoinOrganizationalUnit
Required?
false
Accept Pipeline Input?
false
Position?
named
Removes the organizational unit that the computer joined during setup.
RemoveServerFeatures
Required?
false
Accept Pipeline Input?
false
Position?
named
Removes all server roles and features from a template.
RunAsynchronously
Required?
false
Accept Pipeline Input?
false
Position?
named
Indicates that the job runs asynchronously so that control returns to the command shell immediately.
TimeZone
Required?
false
Accept Pipeline Input?
false
Position?
named
Specifies a number (an index) that identifies a geographical region that shares the same standard time. For a list of time zone indexes, see "Microsoft Time Zone Index Values" at: http://go.microsoft.com/fwlink/?LinkId=120935. If no time zone is specified, the default time zone used for a virtual machine is the same time zone setting that is on the virtual machine host.
Example format to specify the GMT Standard Time zone: -TimeZone 085
UnattendSettings
Required?
false
Accept Pipeline Input?
false
Position?
named
Key Value pairs of String, String
UserRole
Required?
false
Accept Pipeline Input?
false
Position?
named
Specifies a user role object.
VMMServer
Required?
false
Accept Pipeline Input?
true (ByValue)
Position?
named
Specifies a VMM server object.
Workgroup
Required?
false
Accept Pipeline Input?
false
Position?
named
Specifies on a new or existing template, on a new or existing guest operating system profile, or on a new virtual machine the name of the workgroup to which you want to join a virtual machine. You can use this parameter to override the existing value on a template or on a guest operating system profile.
Examples
1: Create a default guest operating
system profile.
PS C:\> $OS = Get-SCOperatingSystem -VMMServer "VMMServer01.Contoso.com" | where {$_.Name -eq "64-bit edition of Windows Server 2008 R2 Enterprise"}
PS C:\> New-SCGuestOSProfile -Name "NewOSProfile01" -OperatingSystem $OS
The first command gets the operating system object named "64-bit edition of Windows Server 2008 R2 Enterprise" from VMMServer01 and stores the object in the $OS variable.
The second command creates a default guest operating system profile named NewProfile01 and specifies the name of the operating system.
2: Create a guest operating system
profile to use to join a virtual machine to a domain.
PS C:\> $DomainCredential = Get-SCRunAsAccount -Name "RunAsAccount01"
PS C:\> $OS = Get-SCOperatingSystem -VMMServer "VMMServer01.Contoso.com" | where {$_.Name -eq "64-bit edition of Windows Server 2008 R2 Enterprise"}
PS C:\> New-SCGuestOSProfile -Name "NewOSProfile02" -JoinDomain "Contoso.com" -DomainJoinCredential $DomainCredential -OperatingSystem $OS
The first command gets the Run As account object named RunAsAccount01 and stores the object in the $DomainCredential variable.
The second command gets the operating system object named "64-bit edition of Windows Server 2008 R2 Enterprise" from VMMServer01 and stores the object in the $OS variable.
The last command creates a guest operating system profile called NewOSProfile02 and specifies the name of the operating system. When you use NewOSProfile02 to create a virtual machine, the profile will use the specified Run As account to join the virtual machine to the Contoso.com domain.
NOTE: If you provide a PSCredential object instead of a RunAs account for the DomainJoinCredential parameter, it is recommended practice to use only an account with limited rights for automatically joining a virtual machine to a domain because the domain account name and password appear briefly in plain text on the host server.
3: Clone an existing guest operating
system profile.
PS C:\> $OSProfile = Get-SCGuestOSProfile -Name "NewOSProfile02"
PS C:\> $OS = Get-SCOperatingSystem -VMMServer "VMMServer01.contoso.com" | where {$_.Name -eq "64-bit edition of Windows Server 2008 R2 Datacenter"}
PS C:\> New-SCGuestOSProfile -Name "NewOSProfile03" -GuestOSProfile $OSProfile -ComputerName "Contoso03" -OperatingSystem $OS
The first command gets the guest OS profile object named NewOSProfile02 and stores the object in the $OSProfile variable.
The second command gets the operating system object named "64-bit edition of Windows Server 2008 R2 Datacenter" and stores the object in the $OS variable.
The last command creates guest operating system profile named NewOSProfile03, which is based on NewOSProfile02, but modifies the computer name and specifies a different name for the operating system. All other settings in NewOSProfile03 are identical to those in NewOSProfile02.