Update-SPFarmEncryptionKey
Published: July 16, 2012
Applies to: SharePoint Foundation 2013 | SharePoint Server 2013 Enterprise
Changes the value of the farm encryption key and, using the new key, re-encrypts all the data.
Update-SPFarmEncryptionKey [-AssignmentCollection <SPAssignmentCollection>] [-Confirm [<SwitchParameter>]] [-Resume <SwitchParameter>] [-WhatIf [<SwitchParameter>]]
Parameters
| Parameter | Required | Type | Description | ||
|---|---|---|---|---|---|
| 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.
| ||
| 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 | ||
| Resume | Optional | System.Management.Automation.SwitchParameter | Resumes re-encryption of data with the new farm encryption key if a previous attempt failed. | ||
| 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 Update-SPFarmEncryptionKey cmdlet changes the farm encryption key to a new randomly generated value. When the new key is used, all the data is re-encrypted.
Input Types
Return Types
Errors
| Error | Description |
|---|---|
| Exceptions | Description |
|---|---|
------------------EXAMPLE-----------------------
Update-SPFarmEncryptionKey -confirm
This example changes the farm encryption key to a new value and re-encrypts all the data.
Change History
| Date | Description |
|---|---|
| July 16, 2012 | Initial publication |

Note: