Upgrade-SPSingleSignOnDatabase

Reference

Module:: sharepoint-server

Applies to:: SharePoint Server Subscription Edition

Migrates the application definitions from Single Sign-On (SSO) database to Secure Store database as target applications.

Syntax

Upgrade-SPSingleSignOnDatabase
       -SecureStoreConnectionString <String>
       -SecureStorePassphrase <SecureString>
       -SSOConnectionString <String>
       [-AssignmentCollection <SPAssignmentCollection>]
       [<CommonParameters>]

Description

The Upgrade-SPSingleSignOnDatabase cmdlet migrates the application definitions from SSO database to Secure Store database as target applications. Use the Upgrade-SPSingleSignOn cmdlet to convert an SSO database to a Secure Store database. SSO is a SharePoint Server feature. SSO functionality is performed by the Secure Store Service in SharePoint Server.

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

Examples

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

Upgrade-SPSingleSignOnDatabase -SSOConnectionString "Data Source=oldServer;Database=SSO;Trusted_Connection=yes;" -SecureStoreConnectionString "Data Source=CONTOSO\SQLDatabase;Database=ContosoSSDatabase;Trusted_Connection=yes;" -SecureStorePassphrase "abcDEF123!@#"

This example migrates the SSO database at the SSO connection to a Secure Store database at the Secure Store connection.

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

-SecureStoreConnectionString

Specifies the SQL Server connection string for the Secure Store database.

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

-SecureStorePassphrase

Specifies the passphrase used for the Secure Store database.

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

-SSOConnectionString

Specifies the SQL Server connection string for the SSO database.

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

Share via