Edit

Set-SPSessionStateService

  • Reference
Module:
sharepoint-server
Applies to:
SharePoint Server Subscription Edition

Updates the credentials that are used to communicate with the state service database.

Syntax

Set-SPSessionStateService
   [-AssignmentCollection <SPAssignmentCollection>]
   [-Confirm]
   [-DatabaseCredentials <PSCredential>]
   [-SessionTimeout <Int32>]
   [-WhatIf]
   [<CommonParameters>]

Description

The Set-SPSessionStateService cmdlet updates the credentials that are used to communicate with the state service database.

For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at SharePoint Server Cmdlets.

Examples

--------------------EXAMPLE---------------------

Set-SPSessionStateService -SessionTimeout 120

This example changes the ASP.NET session state time-out to 2 hours.

Parameters

-AssignmentCollection

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.

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.

Type:SPAssignmentCollection
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False
Applies to:SharePoint Server Subscription Edition

-Confirm

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

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server Subscription Edition

-DatabaseCredentials

Specifies the database credentials for SQL Authentication that are 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.

Type:PSCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server Subscription Edition

-SessionTimeout

Specifies the time, in minutes that an ASP.NET session will remain active with no user activity.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server Subscription Edition

-WhatIf

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

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server Subscription Edition