Add-SCComputerTierTemplate

Applies To: System Center 2012 - Virtual Machine Manager

Add-SCComputerTierTemplate

Adds a computer tier template to a service template.

Syntax

Parameter Set: Default
Add-SCComputerTierTemplate [-Name] <String> -ServiceTemplate <ServiceTemplate> -VMTemplate <Template> [-BlockAutomaticMigration <Boolean> ] [-DefaultInstanceCount <Int32> ] [-DeploymentOrder <Int32> ] [-Description <String> ] [-InstanceMaximumCount <Int32> ] [-InstanceMinimumCount <Int32> ] [-JobVariable <String> ] [-NumberOfUpgradeDomains <Int32> ] [-PROTipID <Guid> ] [-RunAsynchronously] [-ServicingOrder <Int32> ] [-Tag <String> ] [ <CommonParameters>]

Detailed Description

The Add-SCComputerTierTemplate cmdlet adds a computer tier template to a service template. A computer tier template contains a virtual machine template that is used to create a virtual machine.

For information about service templates, type: "Get-Help New-SCServiceTemplate -detailed". For more information about virtual machine templates, type: "Get-Help New-SCVMTemplate -detailed".

For more information about Add-SCComputerTierTemplate, type: "Get-Help Add-SCComputerTierTemplate -online".

Parameters

-BlockAutomaticMigration<Boolean>

Indicates whether the computer can be automatically migrated. When set to $True, automatic migration is blocked. When set to $False, automatic migration is allowed. Default value: $False.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-DefaultInstanceCount<Int32>

Specifies the default instance count for a computer tier that can be scaled out. Default value: 1.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-DeploymentOrder<Int32>

Specifies the order in which a computer tier or application host is deployed.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Description<String>

States a description for the specified object.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-InstanceMaximumCount<Int32>

Specifies the maximum number of virtual machines to which a service instance can scale out.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-InstanceMinimumCount<Int32>

Specifies the minimum number of virtual machines to which a service instance can scale in.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-JobVariable<String>

Specifies that job progress is tracked and stored in the variable named by this parameter.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Name<String>

Specifies the name of a VMM object.

Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-NumberOfUpgradeDomains<Int32>

Specifies the number of upgrade domains for a computer tier that can be scaled out. Default value: 1.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-PROTipID<Guid>

Specifies the ID of the PRO tip that triggered this action. This allows for auditing of PRO tips.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-RunAsynchronously

Indicates that the job runs asynchronously so that control returns to the command shell immediately.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ServiceTemplate<ServiceTemplate>

Specifies a service template object.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

-ServicingOrder<Int32>

Specifies the order in which a computer tier or application host is serviced.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Tag<String>

Specifies a word or phrase to associate with an object so that you can search for all objects with the specified set of tags. You can search for a subset of tags, or you can search for the full set of tags.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-VMTemplate<Template>

Specifies a VMM template object used to create virtual machines.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters.

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

  • ComputerTierTemplate

Examples

1: Add a computer tier template to a service template.

The first command gets the virtual machine template object named WebTemplate01 and stores the object in the $WebTemplate variable.

The second command gets the service template object named ServiceTemplate01 and stores the object in the $ServiceTemplate variable.

The last command adds a computer tier template to the service template stored in $ServiceTemplate.

PS C:\> $WebTemplate = Get-SCVMTemplate | where { $_.Name -eq "WebTemplate01" }
PS C:\> $ServiceTemplate = Get-SCServiceTemplate -Name "ServiceTemplate01"
PS C:\> Add-SCComputerTierTemplate -ServiceTemplate $ServiceTemplate -VMTemplate $WebTemplate -Name "Web Tier" -DefaultInstanceCount 3 -InstanceMinimumCount 1 -InstanceMaximumCount 5 -DeploymentOrder 1 -ServicingOrder 1 -NumberOfUpgradeDomains 1

Get-SCComputerTierTemplate

Get-SCServiceTemplate

Get-SCVMTemplate

Remove-SCComputerTierTemplate

Set-SCComputerTierTemplate