Set-SPOfficeWebAppsCache
Applies to: SharePoint Server 2010
Topic Last Modified: 2010-02-11
Modifies properties on the Microsoft Office Web Apps cache.
Syntax
Set-SPOfficeWebAppsCache [-WebApplication] <SPWebApplicationPipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm [<SwitchParameter>]] [-ExpirationPeriodInDays <Int32>] [-MaxFrontEndCacheSizeInMB <Int32>] [-MaxFrontEndDocumentInfoCacheItems <UInt32>] [-MaxSizeInBytes <Int64>] [-Owner <SPUser>] [-WarningSizeInBytes <Int64>] [-WhatIf [<SwitchParameter>]]
Set-SPOfficeWebAppsCache -Site <SPSitePipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm [<SwitchParameter>]] [-ExpirationPeriodInDays <Int32>] [-MaxFrontEndCacheSizeInMB <Int32>] [-MaxFrontEndDocumentInfoCacheItems <UInt32>] [-MaxSizeInBytes <Int64>] [-Owner <SPUser>] [-WarningSizeInBytes <Int64>] [-WhatIf [<SwitchParameter>]]
Detailed Description
The Set-SPOfficeWebAppsCache cmdlet changes properties of the site collection associated with the cache for the specified Web application. In addition to enabling the modification of all properties exposed on the SPSitePipeBind object, the Set-SPOfficeWebAppsCache cmdlet can also be used to modify the expiration period for stored renditions.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
WebApplication |
Required |
Microsoft.SharePoint.PowerShell.SPWebApplicationPipeBind |
Specifies the Web application that contains the Office Web Apps cache. |
Site |
Required |
Microsoft.SharePoint.PowerShell.SPSitePipeBind |
Specifies the Office Web Apps cache site collection. |
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. Note 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 |
WarningSizeInBytes |
Optional |
System.Int64 |
Specifies the threshold, in bytes, at which the owner starts to receive alerts that the Office Web Apps cache is nearing its quota limitation. The default value is 0. |
ExpirationPeriodInDays |
Optional |
System.Nullable |
Specifies the amount of time since creation that cached renditions will be stored. The default value is 30. |
MaxFrontEndCacheSizeInMB |
Optional |
System.Int32 |
Specifies, in megabytes, the maximum amount of memory the cache is allowed to consume. The default value is 75. |
MaxFrontEndDocumentInfoCacheItems |
Optional |
System.UInt32 |
Specifies the maximum number of items that can be added to the cache. The default value is 1,000. |
MaxSizeInBytes |
Optional |
System.Int64 |
Specifies the size in bytes of the Office Web Apps cache. After the limit is exceeded, the next expiration timer job removes the oldest items in the cache until the cache is below quota. The default value is 107374182400. |
Owner |
Optional |
Microsoft.SharePoint.SPUser |
Specifies the owner of the Office Web Apps cache. |
WarningSizeInBytes |
Optional |
System.Int64 |
When the Office Web Apps cache size reaches the size specified by this parameter, a notification is sent to the site collection owner that the cache is approaching its quota. |
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 |
Input Types
Return Types
Example
-------------EXAMPLE--------------
Get-SPWebApplication | Set-SPOfficeWebAppsCache -ExpirationPeriod 30
This example enumerates all Web applications in the farm and sets the expiration on each Web application's Office Web Apps cache to 30 days.