Update-SPSecureStoreApplicationServerKey

Reference

Module:: sharepoint-server

Applies to:: SharePoint Server Subscription Edition

Synchronizes the key on a Microsoft SharePoint server with the Secure Store master key.

Syntax

Update-SPSecureStoreApplicationServerKey
      -Passphrase <String>
      -ServiceApplicationProxy <SPServiceApplicationProxyPipeBind>
      [-AssignmentCollection <SPAssignmentCollection>]
      [<CommonParameters>]

Description

The Update-SPSecureStoreApplicationServerKey cmdlet synchronizes the key on a SharePoint server with the master key for the Secure Store service database.

Updating a server key is required when:

--A new SharePoint server that will run a Secure Store service instance is joined to the farm. --The key stored in the server is not the key required for the current Secure Store service database (because of server or networking issues). --The master key is updated but during propagation of the new key, this process fails on one or more of the servers.

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

Examples

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

$newPassPhrase = "abcDEF123!"
$proxy = Get-SPServiceApplicationProxy | ?{$_.TypeName -eq 'Secure Store Service Application Proxy'}
Update-SPSecureStoreApplicationServerKey -ServiceApplicationProxy $proxy -Passphrase $newPassPhrase

This example synchronizes the passphrase of the server key on a SharePoint server with the master key for the Secure Store service database.

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

-Passphrase

Specifies the passphrase that is used for the Secure Store service database.

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

-ServiceApplicationProxy

Specifies the proxy of the service application that contains the server key to synchronize.

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

Share via