Add-SCSQLDeployment

Add-SCSQLDeployment

Adds a SQL Server deployment to a SQL Server profile.

Syntax

Parameter Set: Default
Add-SCSQLDeployment -AgentServiceRunAsAccount <VMMCredential> -InstanceID <String> -MediaSource <String> -Name <String> -SQLProfile <SQLProfile> -SQLServiceRunAsAccount <VMMCredential> -SQLSysAdminMemberList <String[]> [-DeploymentRunAsAccount <VMMCredential> ] [-DeploymentTimeoutSeconds <Int32> ] [-EnableNamedPipes <Boolean> ] [-EnableTCP <Boolean> ] [-InstanceName <String> ] [-JobVariable <String> ] [-MergeSQLAnswerFile <Boolean> ] [-ProductKey <String> ] [-PROTipID <Guid]> ] [-ReportingServiceRunAsAccount <VMMCredential> ] [-RunAsynchronously] [-SARunAsAccount <VMMCredential> ] [-SecurityMode <String> ] [-SQLConfigurationFile <Script> ] [ <CommonParameters>]

Detailed Description

The Add-SCSQLDeployment cmdlet adds a Microsoft SQL Server deployment to a SQL Server profile.

Parameters

-AgentServiceRunAsAccount<VMMCredential>

Specifies the Run As account to use for the SQL Server agent service.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-DeploymentRunAsAccount<VMMCredential>

Specifies the Run As account to use for installing SQL Server.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-DeploymentTimeoutSeconds<Int32>

Specifies the amount of time, in seconds, that the SQL Server deployment waits before timing out.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-EnableNamedPipes<Boolean>

Indicates that named pipes are used for remote connections.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-EnableTCP<Boolean>

Indicates that TCP/IP is used for remote connections.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-InstanceID<String>

Specifies a SQL Server deployment instance ID.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-InstanceName<String>

Specifies the SQL Server Analysis Services (SSAS) database instance name.

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

-MediaSource<String>

Specifies a media source for a SQL Server deployment.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-MergeSQLAnswerFile<Boolean>

Indicates whether this cmdlet merges the specified SQL Server configuration file with the specified guest operating system settings. The default value is $True. This parameter is used by the Virtual Machine Manager (VMM) console. You do not need to use this parameter at the command prompt.

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?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ProductKey<String>

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.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-PROTipID<Guid]>

Specifies the ID of the Performance and Resource Optimization tip (PRO tip) that triggered this action. This parameter lets you audit PRO tips.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ReportingServiceRunAsAccount<VMMCredential>

Specifies the Run As account to use for Reporting Services.

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

-SARunAsAccount<VMMCredential>

Specifies the Run As account to use for the SQL Server system administrator (SA) password.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-SecurityMode<String>

Specifies the security mode for SQL Server. Valid values are:

-- WindowsAuthentication
-- SQLServerAuthentication

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-SQLConfigurationFile<Script>

Specifies a SQL Server configuration file.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-SQLProfile<SQLProfile>

Specifies a SQL Server profile object.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-SQLServiceRunAsAccount<VMMCredential>

Specifies the Run As account to use for the SQL Server service.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-SQLSysAdminMemberList<String[]>

Specifies a list of users that are SQL Server administrators.

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 (https://go.microsoft.com/fwlink/p/?LinkID=113216).

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.

  • SQLDeployment

Examples

Example 1: Add a SQL Server deployment to a SQL Server profile

The first command gets the SQL Server profile object named SQLProfile01, and then stores it in the $SQLProfile variable.

The second command gets the RunAsProfile object named NTSystemRAP, which is used to initiate and run the deployment, and then stores object in the $DeploymentRunAsProfile variable.

The third command gets the RunAsProfile object named SQLAdminRAP, which defines the SA credentials for the deployment, and then stores the object in the $SARunAsProfile variable.

The fourth command gets the RunAsProfile named NTSystemRAP, which is used as the service account for the SQL Server and SQL Server Agent Windows services, and then stores the object in the $SQLSvcsRunAsProfile variable.

The last command adds a SQL Server deployment to the SQLProfile01 SQL profile.

PS C:\> $SQLProfile = Get-SCSQLProfile -Name "SQLProfile01"
PS C:\> $DeploymentRunAsProfile = Get-SCRunAsProfile -Name "NTSystemRAP"
PS C:\> $SARunAsProfile = Get-SCRunAsProfile -Name "SQLAdminRAP"
PS C:\> $SQLSvcsRunAsProfile = Get-SCRunAsProfile -Name "NTSystemRAP"
PS C:\> Add-SCSQLDeployment -SQLProfile $SQLProfile -Name "SQL Deployment 01" -MediaSource "C:\SQLMedia" -InstanceID "SysPrepSQL" -InstanceName "MSSQLSERVER" -DeploymentTimeoutSeconds 3600 -SQLAuthenticationType "SQLServerAuthentication" -EnableNamedPipes $True -EnableTCP $True -SQLSysAdminMemberList @("Contoso\SQLAdmins") -ProductKey $Null -AgentServiceRunAsProfile $SQLSvcsRunAsProfile -SQLServiceRunAsProfile $SQLSvcsRunAsProfile -DeploymentRunAsProfile $DeploymentRunAsProfile -SARunAsProfile $SARunAsProfile

Get-SCSQLDeployment

Remove-SCSQLDeployment

Set-SCSQLDeployment

Get-SCSQLProfile