Set-SPOneNoteWebAppConfig
Applies to: SharePoint Server 2010
Topic Last Modified: 2010-02-22
Modifies properties on the SPOneNoteWebAppConfig object that is activated on the specified SPSite object.
Syntax
Set-SPOneNoteWebAppConfig [-Site] <SPSitePipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-ClipartEnabled <SwitchParameter>] [-Confirm [<SwitchParameter>]] [-NotebookVersioningEnabled <SwitchParameter>] [-Proxy <String>] [-SyncIntervalMaxInSeconds <Nullable>] [-SyncIntervalMinInSeconds <Nullable>] [-SyncIntervalMinOnHeavyLoadInSeconds <Nullable>] [-SyncIntervalStepInSeconds <Nullable>] [-WhatIf [<SwitchParameter>]]
Detailed Description
The Set-SPOneNoteWebAppConfig cmdlet changes properties associated with OneNote Web App that are activated on the specified SPSite object.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
Site |
Required |
Microsoft.SharePoint.PowerShell.SPSitePipeBind |
Specifies the site on which Microsoft OneNote Web App is activated. |
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. |
ClipartEnabled |
Optional |
System.Management.Automation.SwitchParameter |
Enables support for inserting clipart in Microsoft Word Web App and OneNote Web App. |
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 |
NotebookVersioningEnabled |
Optional |
System.Management.Automation.SwitchParameter |
Specifies that the notebook use its internal versioning system to track versions. Valid values are True or False. The default value is True. |
Proxy |
Optional |
System.String |
Specifies the URL of the proxy server configured to allow HTTP requests to Office.com to succeed. Used so that the server is able to retrieve and insert clipart in the Word Web App and OneNote Web App. Changes to this setting require an IISReset command to take effect. To reset this value back to its default setting, use "". |
SyncIntervalMaxInSeconds |
Optional |
System.Nullable |
Specifies the minimum interval, in seconds, for replicating when the user is idle. The default value is 30. |
SyncIntervalMinInSeconds |
Optional |
System.Nullable |
Specifies the minimum level, in seconds, for replication to occur when a user is idle. The default value is 5. |
SyncIntervalMinOnHeavyLoadInSeconds |
Optional |
System.Nullable |
Specifies the sync interval level, in seconds, for the OneNote Web App when the server is experiencing heavy load. Valid values are 1 to 1000. The default value is 30. |
SyncIntervalStepInSeconds |
Optional |
System.Nullable |
Specifies the amount, in seconds, to increase the interval of replicating when the user is idle. The default value is 5. |
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 1-----------
Set-SPOneNoteWebAppConfig -Site "http://sitename" -SyncIntervalMinInSeconds 50
This example changes the sync interval for the OneNote Web App that is activated on the site located at http://sitename.
---------------EXAMPLE 2-----------
Get-SPSite | Set-SPOneNoteWebAppConfig -ClipartEnabled
This example enables clipart on all instances of OneNote Web App in the farm.