Set-SCSQLDeployment

Modifies a SQL Server deployment.

Description

The Set-SCSQLDeployment cmdlet modifies a SQL Server deployment.

For more information about Set-SCSQLDeployment, type: "Get-Help Set-SCSQLDeployment -online".

Parameters

SQLDeployment

Required? true
Accept Pipeline Input? true (ByValue)
Position? 0
Specifies a SQL Server deployment object.

AgentServiceRunAsAccount

Required? false
Accept Pipeline Input? false
Position? named
Specifies the Run As account to use for the SQL Server agent service.

DeploymentRunAsAccount

Required? false
Accept Pipeline Input? false
Position? named
Specifies the Run As account to use for installing SQL Server.

DeploymentTimeoutSeconds

Required? false
Accept Pipeline Input? false
Position? named
Specifies the amount of time, in seconds, that the SQL Server deployment waits before timing out.

EnableNamedPipes

Required? false
Accept Pipeline Input? false
Position? named
Indicates that named pipes are used for remote connections.

EnableTCP

Required? false
Accept Pipeline Input? false
Position? named
Indicates that TCP/IP is used for remote connections.

InstanceID

Required? false
Accept Pipeline Input? false
Position? named
Specifies a SQL Server deployment instance ID.

InstanceName

Required? false
Accept Pipeline Input? false
Position? named
Specifies the SQL Server Analysis Services (SSAS) database instance name.

JobVariable

Required? false
Accept Pipeline Input? false
Position? named
Specifies that job progress is tracked and stored in the variable named by this parameter. 

MediaSource

Required? false
Accept Pipeline Input? false
Position? named
Specifies a media source for a SQL Server deployment.

MergeSQLAnswerFile

Required? false
Accept Pipeline Input? false
Position? named
Specifies that the cmdlet merge the specified SQL Server configuration 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.

Name

Required? false
Accept Pipeline Input? false
Position? named
Specifies the name of a VMM object.

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.

ReportingServiceRunAsAccount

Required? false
Accept Pipeline Input? false
Position? named
Specifies the Run As account to use for Reporting Services.

RunAsynchronously

Required? false
Accept Pipeline Input? false
Position? named
Indicates that the job runs asynchronously so that control returns to the command shell immediately. 

SARunAsAccount

Required? false
Accept Pipeline Input? false
Position? named
Specifies the Run As account to use for the SQL Server system administrator (SA) password.

SecurityMode

Required? false
Accept Pipeline Input? false
Position? named
Specifies the security mode for SQL Server. Valid values are: WindowsAuthentication, SQLServerAuthentication.

SQLConfigurationFile

Required? false
Accept Pipeline Input? false
Position? named
Specifies a SQL Server configuration file.

SQLServiceRunAsAccount

Required? false
Accept Pipeline Input? false
Position? named
Specifies the Run As account to use for the SQL Server service.

SQLSysAdminMemberList

Required? false
Accept Pipeline Input? false
Position? named
Specifies a list of users that are SQL Server administrators.

Examples

1: Modify an existing SQL Server deployment.
PS C:\> $SQLProfile = Get-SCSQLProfile -Name "SQLProfile01"
PS C:\> $SQLDeployment = Get-SCSQLDeployment -SQLProfile $SQLProfile -Name "SQL Deployment 01"
PS C:\> Set-SCSQLDeployment -SQLDeployment $SQLDeployment -SQLSysAdminMemberList @("Contoso\SQLAdmins","Contoso\User")
The first command gets the SQL Server profile object named SQLProfile01 and stores the object in the $SQLProfile variable.

The second command gets the SQL Server deployment object named SQL Deployment from the SQL profile stored in $SQLProfile, and then stores the object in the $SQLDeployment variable.

The last command modifies the SQL Server administrators list of the SQL deployment stored in $SQLDeployment.

See Also