Set-SCSQLDeployment
Set-SCSQLDeployment
Modifies a SQL Server deployment.
Syntax
Parameter Set: Default
Set-SCSQLDeployment [-SQLDeployment] <SQLDeployment> [-AgentServiceRunAsAccount <VMMCredential> ] [-DeploymentRunAsAccount <VMMCredential> ] [-DeploymentTimeoutSeconds <Int32> ] [-EnableNamedPipes <Boolean> ] [-EnableTCP <Boolean> ] [-InstanceID <String> ] [-InstanceName <String> ] [-JobVariable <String> ] [-MediaSource <String> ] [-MergeSQLAnswerFile <Boolean> ] [-Name <String> ] [-ProductKey <String> ] [-PROTipID <Guid> ] [-ReportingServiceRunAsAccount <VMMCredential> ] [-RunAsynchronously] [-SARunAsAccount <VMMCredential> ] [-SecurityMode <String> ] [-SQLConfigurationFile <Script> ] [-SQLServiceRunAsAccount <VMMCredential> ] [-SQLSysAdminMemberList <String[]> ] [ <CommonParameters>]
Detailed Description
The Set-SCSQLDeployment cmdlet modifies a SQL Server deployment.
Parameters
-AgentServiceRunAsAccount<VMMCredential>
Specifies the Run As account to use for the SQL Server agent service.
Aliases |
none |
Required? |
false |
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? |
false |
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? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-MergeSQLAnswerFile<Boolean>
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.
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? |
false |
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 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 |
-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 |
-SQLDeployment<SQLDeployment>
Specifies a SQL Server deployment object.
Aliases |
none |
Required? |
true |
Position? |
1 |
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? |
false |
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? |
false |
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
1: Modify an existing SQL Server deployment.
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.
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")