Get-SCGuestOSProfile
Gets a guest operating system profile object from the VMM library.
Syntax
Connection (Default)
Get-SCGuestOSProfile
[[-Name] <String>]
[-VMMServer <ServerConnection>]
[-OnBehalfOfUser <String>]
[-OnBehalfOfUserRole <UserRole>]
[<CommonParameters>]
SysprepScript
Get-SCGuestOSProfile
[[-Name] <String>]
-AnswerFile <Script>
[-OperatingSystem <OperatingSystem>]
[-OnBehalfOfUser <String>]
[-OnBehalfOfUserRole <UserRole>]
[<CommonParameters>]
Description
The Get-SCGuestOSProfile cmdlet gets one or more guest operating system profile objects from the Virtual Machine Manager (VMM) library.
Examples
Example 1: Get all guest operating system profiles from the library
PS C:\> Get-SCGuestOSProfile -VMMServer "VMMServer01.Contoso.com"
This command gets all guest OS profile objects from the library on VMMServer01 and displays information about these profiles to the user.
Example 2: Get a specific guest operating system profile from the library
PS C:\> Get-GuestOSProfile -Name "NewOSProfile01"
This command gets the guest OS profile object named NewOSProfile01 and displays information about this profile to the user.
Parameters
-AnswerFile
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:
- Sysprep.inf. Windows XP, Windows Server 2000, or Windows Server 2003
- Unattend.xml. Windows Vista, Windows 7, or Windows Server 2008
Parameter properties
| Type: | Script |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | SysPrepFile |
Parameter sets
SysprepScript
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Name
Specifies the name of a VMM object.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 0 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-OnBehalfOfUser
Specifies a user name. This cmdlet operates on behalf of the user that this parameter specifies.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-OnBehalfOfUserRole
Specifies a user role. To obtain a user role, use the Get-SCUserRole cmdlet. This cmdlet operates on behalf of the user role that this parameter specifies.
Parameter properties
| Type: | UserRole |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-OperatingSystem
Specifies the type of operating system for a virtual machine.
To list the names of all available operating systems in VMM, type Get-SCOperatingSystem.
Parameter properties
| Type: | OperatingSystem |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
SysprepScript
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-VMMServer
Specifies a VMM server object.
Parameter properties
| Type: | ServerConnection |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
Connection
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Outputs
GuestOSProfile
This cmdlet returns a GuestOSProfile object.