New-SCPhysicalComputerProfile
Creates a profile that is used to deploy an operating system to a computer.
Syntax
New-SCPhysicalComputerProfile
[-Name] <String>
-VirtualHardDisk <VirtualHardDisk>
-Domain <String>
-DomainJoinRunAsAccount <RunAsAccount>
-LocalAdministratorCredential <VMMCredential>
[-UseAsVMHost]
-PhysicalComputerNetworkAdapterProfile <PhysicalComputerNetworkAdapterProfile[]>
[-ComputerAccessRunAsAccount <RunAsAccount>]
[-DiskConfiguration <String>]
[-DriverMatchingTag <System.Collections.Generic.List`1[System.String]>]
[-VMPaths <String>]
[-FullName <String>]
[-IsGuarded <Boolean>]
[-CodeIntegrityPolicy <CodeIntegrityPolicy>]
[-GuiRunOnceCommands <String[]>]
[-OrganizationName <String>]
[-ProductKey <String>]
[-TimeZone <Int32>]
[-Baseline <Baseline[]>]
[-JobGroup <Guid>]
[-Description <String>]
[-Owner <String>]
[-AnswerFile <Script>]
[-BypassVHDConversion <Boolean>]
[-VMMServer <ServerConnection>]
[-RunAsynchronously]
[-PROTipID <Guid>]
[-JobVariable <String>]
[<CommonParameters>] New-SCPhysicalComputerProfile
[-Name] <String>
-VirtualHardDisk <VirtualHardDisk>
[-JoinWorkgroup]
-LocalAdministratorCredential <VMMCredential>
[-UseAsVMHost]
-PhysicalComputerNetworkAdapterProfile <PhysicalComputerNetworkAdapterProfile[]>
[-ComputerAccessRunAsAccount <RunAsAccount>]
[-DiskConfiguration <String>]
[-DriverMatchingTag <System.Collections.Generic.List`1[System.String]>]
[-VMPaths <String>]
[-FullName <String>]
[-IsGuarded <Boolean>]
[-CodeIntegrityPolicy <CodeIntegrityPolicy>]
[-GuiRunOnceCommands <String[]>]
[-OrganizationName <String>]
[-ProductKey <String>]
[-TimeZone <Int32>]
[-Baseline <Baseline[]>]
[-JobGroup <Guid>]
[-Description <String>]
[-Owner <String>]
[-AnswerFile <Script>]
[-BypassVHDConversion <Boolean>]
[-VMMServer <ServerConnection>]
[-RunAsynchronously]
[-PROTipID <Guid>]
[-JobVariable <String>]
[<CommonParameters>] New-SCPhysicalComputerProfile
[-Name] <String>
-VirtualHardDisk <VirtualHardDisk>
-Domain <String>
-DomainJoinRunAsAccount <RunAsAccount>
-LocalAdministratorCredential <VMMCredential>
[-UseAsFileServer]
-PhysicalComputerNetworkAdapterProfile <PhysicalComputerNetworkAdapterProfile[]>
[-ComputerAccessRunAsAccount <RunAsAccount>]
[-DiskConfiguration <String>]
[-DriverMatchingTag <System.Collections.Generic.List`1[System.String]>]
[-VMPaths <String>]
[-FullName <String>]
[-GuiRunOnceCommands <String[]>]
[-OrganizationName <String>]
[-ProductKey <String>]
[-TimeZone <Int32>]
[-JobGroup <Guid>]
[-Description <String>]
[-Owner <String>]
[-AnswerFile <Script>]
[-BypassVHDConversion <Boolean>]
[-VMMServer <ServerConnection>]
[-RunAsynchronously]
[-PROTipID <Guid>]
[-JobVariable <String>]
[<CommonParameters>] New-SCPhysicalComputerProfile
[-Name] <String>
-PhysicalComputerProfile <PhysicalComputerProfile>
[-Description <String>]
[-Owner <String>]
[-AnswerFile <Script>]
[-BypassVHDConversion <Boolean>]
[-VMMServer <ServerConnection>]
[-RunAsynchronously]
[-PROTipID <Guid>]
[-JobVariable <String>]
[<CommonParameters>] Description
The New-SCPhysicalComputerProfile cmdlet creates a profile that is used to deploy an operating system to a computer.
Examples
Example 1: Create a physical computer profile
PS C:\> $Account = Get-SCRunaAsAccount -Name "CloudAdmin"
PS C:\> $Credential = Get-Credential "Contoso\ServiceAdmin"
PS C:\> $AdapterProfile = Get-SCPhysicalComputerNetworkAdapterProfile -ID "eede207d-d263-4212-ad32-fd29b5a1a6ce"
PS C:\> $Vhd = Get-SCVirtualHardDisk -Name "Win2012stdGen1template_disk_1.vhdx"
PS C:\> New-SCPhysicalComputerProfile -Name "ContosoHostProfile" -Domain "contoso.com" -DomainJoinRunAsAccount $Account -LocalAdministratorCredential $Credential -PhysicalComputerNetworkAdapterProfile $AdapterProfile -UseAsVMHost -VirtualHardDisk $VhdThe first command gets the Run As account object and stores it in a variable named $Account.
The second command creates a Windows PowerShell credentials object for the account Contoso\ServiceAdmin and stores it in the $Credential variable. You must supply the password for the ServiceAdmin account to the Get-Credential cmdlet.
The third command creates an object reference to the physical computer network adapter profile that has the specified ID and stores it in the $AdapterProfile variable.
The fourth command creates an object reference by using the Get-SCVirtualHardDisk cmdlet. This object references is associated with the virtual hard disk Win2012stdGen1template_disk_1.vhdx.
The final command creates a physical computer profile named ContosoHostProfile based on the values from previous commands.
Parameters
-AnswerFile
Specifies a script object stored in the Virtual Machine Manager (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
| Type: | Script |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Baseline
Specifies an array of Baseline objects.
| Type: | Baseline[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-BypassVHDConversion
Indicates whether a dynamic VHD attached to a host profile is converted to a fixed type during deployment.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-CodeIntegrityPolicy
Specifies a code integrity policy.
| Type: | CodeIntegrityPolicy |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ComputerAccessRunAsAccount
Specifies the computer access Run As account to use to deploy the computer. This Run As account is added to the machine as a local administrator and used to manage the machine.
| Type: | RunAsAccount |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Description
Specifies a description for the computer profile.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DiskConfiguration
Specifies the disk and partition configuration for the physical computer that is to be deployed with Windows Hyper-V.
Example format: -DiskConfiguration "MBR=1:PRIMARY:QUICK:4:FALSE:OS::0:BOOTPARTITION;"
You must be sure to specify the correct cluster size. In the example above, the cluster size is 0. If you do not specify a cluster size, VMM uses the default of 512 bytes, which may be unsuitable to configure advanced format disks.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Domain
Specifies a fully qualified domain name (FQDN) for an Active Directory domain.
Example format: -Domain "Domain01.Corp.Contoso.com"
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DomainJoinRunAsAccount
Specifies a Run As account that has permission to join the specified domain.
| Type: | RunAsAccount |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DriverMatchingTag
Specifies the custom tags to match with driver properties during deployment. When tags are specified, the deployment process matches the tags specified in the host profile with the tags in the drivers in order to download matching drivers and install them in the target image.
| Type: | System.Collections.Generic.List`1[System.String] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-FullName
Specifies the name of the person in whose name a virtual machine is registered.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-GuiRunOnceCommands
Specifies an array of commands to add to the [GuiRunOnce] section of an unattended answer file. Use single quotation marks around each string enclosed in double quotation marks.
Example format:
-GuiRunOnceCommands '"C:\APF\APFPostSysPrepCopy.cmd PARAMS1"', '"C:\APF\APFPostSysPrepCopy.cmd PARAMS1"'
For information about how Windows PowerShell uses quotation marks, type Get-Help about_Quoting_Rules.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-IsGuarded
Indicates that the host needs to be a Guarded Host.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-JobGroup
Specifies an identifier for a series of commands that will run as a set just before the final command that includes the same job group identifier runs.
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-JobVariable
Specifies that job progress is tracked and stored in the variable named by this parameter.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-JoinWorkgroup
Indicates that this operation joins a workgroup.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-LocalAdministratorCredential
Specifies the user name and password for the Local Administrator account (or Linux root account in the case of a Linux compatible Guest Operating System profile).
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.
| Type: | VMMCredential |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Name
Specifies the name of a VMM object.
| Type: | String |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-OrganizationName
Specifies the name of the organization for the person in whose name a virtual machine is registered.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Owner
Specifies the owner of a VMM object in the form of a valid domain user account.
- Example format:
-Owner "Contoso\PattiFuller" - Example format:
-Owner "PattiFuller@Contoso"
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PhysicalComputerNetworkAdapterProfile
Specifies an array of physical computer network adapter profile objects.
| Type: | PhysicalComputerNetworkAdapterProfile[] |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PhysicalComputerProfile
Specifies a profile that is used to deploy an operating system to a computer.
| Type: | PhysicalComputerProfile |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ProductKey
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.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PROTipID
Specifies the ID of the Performance and Resource Optimization tip (PRO tip) that triggered this action. This parameter lets you audit PRO tips.
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-RunAsynchronously
Indicates that the job runs asynchronously so that control returns to the command shell immediately.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-TimeZone
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
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-UseAsFileServer
Marks the profile as a file server profile.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-UseAsVMHost
Marks the profile as a virtual machine host profile.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-VirtualHardDisk
Specifies a virtual hard disk object.
| Type: | VirtualHardDisk |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-VMMServer
Specifies a VMM server object.
| Type: | ServerConnection |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-VMPaths
Specifies a set of default paths (as strings separated by the pipeline operator) on a host where virtual machine files can be stored.
Example format: -VMPaths "C:\Folder1|C:\Folder2|C:\Folder3"
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Outputs
PhysicalComputerProfile
This cmdlet returns a PhysicalComputerProfile object.