Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

Set-SPStateServiceDatabase

Published: July 16, 2012

Applies to:  SharePoint Server 2013 Enterprise 

Updates properties of a state service database.

Set-SPStateServiceDatabase [-Identity] <SPStateDatabasePipeBind> [[-ServiceApplication] <SPStateServiceApplicationPipeBind>] [-AssignmentCollection <SPAssignmentCollection>] [-Confirm [<SwitchParameter>]] [-DatabaseCredentials <PSCredential>] [-Weight <Nullable>] [-WhatIf [<SwitchParameter>]]

Parameters

Parameter Required Type Description

Identity

Required

Microsoft.Office.Server.Administration.SPStateDatabasePipeBind

Specifies the state service database to update.

The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a state database (for example, StateSvcDB1); or an instance of a valid SPStateServiceDatabase object.

ServiceApplication

Optional

Microsoft.Office.Server.Administration.SPStateServiceApplicationPipeBind

Specifies the state service application to which to add the state database.

The type must be a valid name of a state service application (for example, StateServiceApp1); a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or an instance of a valid SPStateServiceApplication object.

AssignmentCollection

Optional

Microsoft.SharePoint.PowerShell.SPAssignmentCollection

Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.

noteNote:

When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.

Confirm

Optional

System.Management.Automation.SwitchParameter

Prompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparameters

DatabaseCredentials

Optional

System.Management.Automation.PSCredential

Specifies the database credentials for SQL Authentication used to access the state service database. If this parameter is not specified, Windows authentication is used.

The type must be a valid PSCredential object.

Weight

Optional

System.Nullable

Specifies the weight for the state database. The default value is 1.

The type must be a valid integer in the range of 1 to 10.

WhatIf

Optional

System.Management.Automation.SwitchParameter

Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparameters

Detailed Description

The Set-SPStateServiceDatabase cmdlet manages the credentials that are used to communicate with the database, sets the weight of the database, or changes the state service application with which it is associated.

Input Types

Return Types

--------------EXAMPLE 1--------------

Set-SPStateServiceDatabase –Identity 9703f7e2-9521-47c3-bd92-80e3eeba391b –Weight 10

This example updates the database weight to the maximum (10).

--------------EXAMPLE 2--------------

Set-SPStateServiceDatabase -Identity 9703f7e2-9521-47c3-bd92-80e3eeba391b -ServiceApplication "StateSvcApp1"

This example updates the associated service application for a state service database.

--------------EXAMPLE 3--------------

$cred = Get-Credential
Set-SPStateServiceDatabase –Identity “StateSvcDB1” –DatabaseCredentials $cred

This example updates the SQL Authentication credentials that are used for a given database.

Change History

Date Description

July 16, 2012

Initial publication

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.