Set-SCSQLDeployment
Modifies a SQL Server deployment.
Syntax
Set-SCSQLDeployment
[-AgentServiceRunAsAccount <VMMCredential>]
[-SQLServiceRunAsAccount <VMMCredential>]
[-SQLConfigurationFile <Script>]
[-ReportingServiceRunAsAccount <VMMCredential>]
[-DeploymentRunAsAccount <VMMCredential>]
[-DeploymentTimeoutSeconds <Int32>]
[-EnableNamedPipes <Boolean>]
[-SARunAsAccount <VMMCredential>]
[-SecurityMode <String>]
[-EnableTCP <Boolean>]
[-ProductKey <String>]
[-SQLDeployment] <SQLDeployment>
[-Name <String>]
[-InstanceID <String>]
[-MediaSource <String>]
[-SQLSysAdminMemberList <String[]>]
[-InstanceName <String>]
[-MergeSQLAnswerFile <Boolean>]
[-RunAsynchronously]
[-PROTipID <Guid>]
[-JobVariable <String>]
[<CommonParameters>]Description
The Set-SCSQLDeployment cmdlet modifies a Microsoft SQL Server deployment.
Examples
Example 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 named SQLProfile01, and then stores that object in the $SQLProfile variable. This command uses the Get-SCSQLProfile cmdlet.
The second command gets the SQL Server deployment named SQL Deployment from the SQL profile stored in $SQLProfile, and then stores that object in the $SQLDeployment variable.
The final command modifies the SQL Server administrators for the SQL deployment stored in $SQLDeployment.
Parameters
-AgentServiceRunAsAccount
Specifies the Run As account that the SQL Server agent service uses.
| Type: | VMMCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DeploymentRunAsAccount
Specifies the Run As account that this cmdlet uses to modify SQL Server.
| Type: | VMMCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DeploymentTimeoutSeconds
Specifies the amount of time, in seconds, that the SQL Server deployment waits before it time out.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-EnableNamedPipes
Indicates whether remote connections use named pipes.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-EnableTCP
Indicates whether remote connections use TCP/IP.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InstanceID
Specifies the ID of a SQL Server deployment instance.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InstanceName
Specifies the name of a SQL Server Analysis Services (SSAS) database instance.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-JobVariable
Specifies a variable in which job progress is tracked and stored.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-MediaSource
Specifies a media source for the SQL Server deployment to modify.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-MergeSQLAnswerFile
Indicates whether this cmdlet merges the SQL Server configuration file and the guest operating system settings. The default value is $True. Virtual Machine Manager Administrator Console uses this parameter. Do not specify this parameter at the command prompt.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Name
Specifies the name of the SQL Server deployment that this cmdlet modifies.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ProductKey
Specifies the product key for the VMM Server. The product key is a 25-digit number that identifies the product license.
| 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 |
-ReportingServiceRunAsAccount
Specifies the Run As account that Reporting Services uses.
| Type: | VMMCredential |
| 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 |
-SARunAsAccount
Specifies the Run As account for the SQL Server system administrator password.
| Type: | VMMCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SecurityMode
Specifies the security mode for SQL Server. Valid values are: WindowsAuthentication and SQLServerAuthentication.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SQLConfigurationFile
Specifies the configuration file for the SQL Server deployment that this cmdlet modifies.
| Type: | Script |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SQLDeployment
Specifies the SQL Server deployment that this cmdlet modifies.
| Type: | SQLDeployment |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-SQLServiceRunAsAccount
Specifies the Run As account that the SQL Server service uses.
| Type: | VMMCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SQLSysAdminMemberList
Specifies an array of users who are SQL Server administrators.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Outputs
SQLDeployment
This cmdlet returns a SQLDeployment object.