Set-OfficeWebAppsFarm
配置现有 Office Online Server 场的设置。
语法
Set-OfficeWebAppsFarm
[-Force]
[-FarmOU <String>]
[-InternalURL <String>]
[-ExternalURL <String>]
[-AllowHttp]
[-AllowOutboundHttp]
[-SSLOffloaded]
[-CertificateName <String>]
[-S2SCertificateName <String>]
[-EditingEnabled]
[-Proxy <String>]
[-LogLocation <String>]
[-LogRetentionInDays <UInt32>]
[-LogVerbosity <String>]
[-CacheLocation <String>]
[-MaxMemoryCacheSizeInMB <Int32>]
[-DocumentInfoCacheSize <UInt32>]
[-CacheSizeInGB <Int32>]
[-ClipartEnabled]
[-TranslationEnabled]
[-MaxTranslationCharacterCount <Int32>]
[-TranslationServiceAppId <String>]
[-TranslationServiceAddress <String>]
[-RenderingLocalCacheLocation <String>]
[-RecycleActiveProcessCount <UInt32>]
[-AllowCEIP]
[-ExcelRequestDurationMax <Int32>]
[-ExcelSessionTimeout <Int32>]
[-ExcelWorkbookSizeMax <Int32>]
[-ExcelPrivateBytesMax <Int32>]
[-ExcelConnectionLifetime <Int32>]
[-ExcelExternalDataCacheLifetime <Int32>]
[-ExcelAllowExternalData]
[-ExcelUseEffectiveUserName]
[-ExcelWarnOnDataRefresh]
[-ExcelUdfsAllowed]
[-ExcelMemoryCacheThreshold <Int32>]
[-ExcelUnusedObjectAgeMax <Int32>]
[-ExcelCachingUnusedFiles]
[-ExcelAbortOnRefreshOnOpenFail]
[-ExcelAutomaticVolatileFunctionCacheLifeTime <Int32>]
[-ExcelConcurrentDataRequestsPerSessionMax <Int32>]
[-ExcelDefaultWorkbookCalcMode <DefaultWorkbookCalcMode>]
[-ExcelRestExternalDataEnabled]
[-ExcelChartAndImageSizeMax <Int32>]
[-OpenFromUrlEnabled]
[-OpenFromUncEnabled]
[-OpenFromUrlThrottlingEnabled]
[-PicturePasteDisabled]
[-RemovePersonalInformationFromLogs]
[-AllowHttpSecureStoreConnections]
[-WhatIf]
[-Confirm]
说明
Set-OfficeWebAppsFarm cmdlet 配置现有Office Online Server场的设置。
示例
------------------示例 1---------------------
Set-OfficeWebAppsFarm -ClipartEnabled:$true
此示例允许插入来自 Office.com 的剪贴画。
------------------示例 2---------------------
Set-OfficeWebAppsFarm -EditingEnabled:$true
本示例在浏览器中启用 Office 的编辑功能。
------------------示例 3---------------------
Set-OfficeWebAppsFarm -OpenFromUncEnabled:$false
此示例禁用从 UNC 路径查看任何 Office 文件的功能。
参数
-AllowCEIP
启用客户体验改善计划 (Office Online Server场中所有服务器上的 CEIP) 报告。
必须重启Office Online Server场中的每个服务器才能使此更改生效。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-AllowHttp
指示应在端口 80 上预配 IIS 站点,以便进行 HTTP 访问。 应只在所有计算机都需要 IPSEC(完全加密)的环境或不包含敏感文件的测试环境中使用 AllowHTTP。
在启用 SSLOffloaded 时自动启用。
必须重新启动场中的每台服务器,此更改才会生效。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-AllowHttpSecureStoreConnections
指示可使用非 SSL 连接(如 HTTP)进行安全存储连接。 默认值为 False。
仅在所有计算机均需要 IPSEC(完全加密)的环境中或在不包含敏感文件的测试环境中使用 AllowHTTPSecureStoreConnections。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-AllowOutboundHttp
允许来自Office Online Server的出站 HTTP 连接。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-CacheLocation
指定用于存储呈现的图像文件的全局磁盘缓存的位置。 默认位置为 %programdata%\Microsoft\OfficeWebApps\Working\d。
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-CacheSizeInGB
指定全局磁盘缓存的最大大小(以 GB 为单位)。
键入的值必须是 0 或任何正整数。 默认大小为 15 GB。
Type: | Int32 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-CertificateName
指定Office Online Server用于创建 HTTPS 绑定的证书的友好名称。
如果指定的证书找不到或已过期,或者指定的值与多个证书关联,则会记录一条错误,并且不会创建服务器场。
此值用于加入Office Online Server场的每个服务器。 因此,场中的每台服务器都必须拥有具有此友好名称的证书。
如果使用 AllowHttp 或 SSLOffloaded 参数,则无需指定 CertificateName 参数。
必须重新启动场中的每台服务器,此更改才会生效。
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ClipartEnabled
支持将剪贴画从 Office.com 插入 Office 文档。 此功能需要服务器与 Web 进行通信,这种通信可直接配置,也可使用通过 Proxy 参数指定的代理配置。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Confirm
执行命令前,看到确认提示。 有关详细信息,请键入以下命令:get-help about_commonparameters。
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DocumentInfoCacheSize
指定内存缓存中存储的文档转换记录的最大数量。
默认值为 5000 条记录。
Type: | UInt32 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-EditingEnabled
允许在浏览器中进行编辑。 默认值为 False。 只有在您具有使用编辑功能的适当许可的情况下,才应将其设置为 True。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ExcelAbortOnRefreshOnOpenFail
防止数据刷新失败后加载工作簿。 这有助于防止用户查看过期信息或他们不应查看的可能信息。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ExcelAllowExternalData
启用在 Excel 工作簿中刷新 Excel 工作簿中支持的外部数据,其中工作簿包含到外部数据的连接。 默认值为 True。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ExcelAutomaticVolatileFunctionCacheLifeTime
指定缓存可变函数的计算值以进行自动重新计算的最长时间(以秒为单位)。 -1:在工作簿加载时计算一次。 0:始终计算。 1 到 2073600:缓存时间为 1 秒到 24 天。
Type: | Int32 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ExcelCachingUnusedFiles
启用 Web Excel 会话不再使用的文件的缓存。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ExcelChartAndImageSizeMax
指定 Excel 可在浏览器中打开的图表或图像的最大大小(以兆字节为单位)。 值必须是大于 0 的整数。
Type: | Int32 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ExcelConcurrentDataRequestsPerSessionMax
指定每个会话中允许的并发外部数据请求的最大数目。 如果会话必须发出多于此数目的请求,则附加请求必须进入队列。
Type: | Int32 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ExcelConnectionLifetime
指定浏览器中 Excel 的外部数据连接的持续时间(以秒为单位)。 默认值为 1800 秒。
Type: | Int32 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ExcelDefaultWorkbookCalcMode
参数值:文件 | 手动 | 自动 | AutoDataTables
Type: | DefaultWorkbookCalcMode |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ExcelExternalDataCacheLifetime
指定浏览器中 Excel 中外部数据缓存生存期的持续时间(以秒为单位)。 默认值为 300 秒。
Type: | Int32 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ExcelMemoryCacheThreshold
可以分配给非活动对象的最大专用字节所占的百分比。 如果超过内存缓存阈值,则将释放当前未使用的缓存对象。 有效值:0(禁用非活动对象的缓存);从 1 到 95。
Type: | Int32 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ExcelPrivateBytesMax
指定 Excel 在浏览器中使用的最大专用字节(以兆字节为单位)。 如果设置为 -1,则最大专用字节数使用 50% 的计算机物理内存。
键入的值必须为 -1 或任何正整数。 默认值为 -1。
必须重新启动场中的每台服务器,此更改才会生效。
Type: | Int32 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ExcelRequestDurationMax
指定会话中单个请求的最长持续时间(以秒为单位)。 此时间过后,该请求超时。
键入的值必须为 -1(无限制)或介于 1 到 2073600 之间的某个整数。 默认值为 300。
Type: | Int32 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ExcelRestExternalDataEnabled
允许来自 REST API 的刷新外部数据连接的请求。 如果将“允许外部数据”设置为 None,则该设置不起作用。 复选框布尔值。 默认值为 False。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ExcelSessionTimeout
指定当没有用户活动时,会话在浏览器中在 Excel 中保持活动的时间(以秒为单位)。 有效值包括:
-1 会话永不过期。
0 会话在单个请求结束时过期。
1 到 2073600 会话保持活动状态的时间为 1 秒到 24 天。 默认值为 450。
Type: | Int32 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ExcelUdfsAllowed
在浏览器中为 Excel 启用用户定义的函数。 默认值为 False。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ExcelUnusedObjectAgeMax
非活动对象保留在内存缓存中的最大时间(以分钟为单位)。 非活动状态的对象是指不在会话中使用的对象。 有效值:-1(无最大值);从 1 到 34560(24 天)。 默认值为 -1。
Type: | Int32 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ExcelUseEffectiveUserName
允许在浏览器中将 Analysis Services EffectiveUserName 参数与 Excel 配合使用。 默认值为 False。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ExcelWarnOnDataRefresh
关闭或关闭在浏览器中的 Excel 中刷新数据时显示的警告对话框。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ExcelWorkbookSizeMax
指定可以加载的工作簿的最大大小(以 MB 为单位)。
键入的值必须为 1 到 2000 之间的整数。 默认值为 10。
Type: | Int32 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ExternalURL
指定客户端用于从 Internet 访问Office Online Server场的 URL 根。 对于负载均衡的多服务器Office Online Server场,外部 URL 绑定到面向外部的负载均衡器的 IP 地址。
Office Online Server场至少需要一个 URL,该 URL 使用 ExternalURL 或 InternalURL 进行设置。 也可以同时设置内部和外部 URL。
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-FarmOU
指定 Active Directory 组织单位的名称, (OU) 服务器必须是 其成员才能加入Office Online Server场。 使用此参数可防止未经授权的服务器 (即不在 OU 中的服务器) 加入Office Online Server场。
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Force
通过回答“是”禁止显示任何用户提示。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-InternalURL
指定客户端必须用来从 Intranet 访问Office Online Server场的 URL 根。
Office Online Server场至少需要一个 URL。 此 URL 是使用 ExternalURL 或 InternalURL 设置的。 也可以同时设置内部和外部 URL。
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-LogLocation
指定本地计算机上存储活动日志的位置。
该位置应用于场中的每台服务器,不能基于服务器进行自定义。 默认位置为 %programdata%\Microsoft\OfficeWebApps\Data\Logs\ULS。
务必在存储日志的驱动器上留有足够的磁盘空间。
必须重新启动场中的每台服务器,此更改才会生效。
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-LogRetentionInDays
指定日志条目的存储天数。 超过配置天数的日志条目将被修剪。
键入的值必须是介于 0 到 365 之间的整数。 默认值为 7 天。
必须重新启动场中的每台服务器,此更改才会生效。
Type: | UInt32 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-LogVerbosity
指定跟踪日志文件中存储的信息量。 有以下值:
VerboseEX 将非常详细的信息写入跟踪日志文件。 适用于数量可能非常大的跟踪。
Verbose 将详细的信息写入跟踪日志文件。
Medium 将中等详细程度的信息写入跟踪日志文件。
High 将高度概括性的信息写入跟踪日志文件。
Monitorable 写入表示应受到监视的不寻常代码路径和操作的跟踪。
Unexpected 写入表示应受到监视的意外代码路径和操作的跟踪。
None 不向跟踪日志文件写入任何跟踪信息。
长时间将 LogVerbosity 保持为较低级别将会对性能产生不利影响。
必须重新启动场中的每台服务器,此更改才会生效。
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-MaxMemoryCacheSizeInMB
指定呈现缓存可以使用的最大内存容量(以 MB 为单位)。
键入的值必须是 0 或任何正整数。 默认大小为 1024 MB。
Type: | Int32 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-MaxTranslationCharacterCount
指定要翻译的文档可包含的最大字符数。
键入的值必须是整数值。 该值可设置为 0 以指示没有限制或设置为 2000 到 2,000,000 之间的一个值。 默认值为 125,000。
Type: | Int32 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-OpenFromUncEnabled
启用或禁用使用联机查看器从 UNC 路径查看 Office 文件的功能。
必须先将 OpenFromUrlEnabled 设置为 True,然后才能允许联机查看器显示 UNC 路径中的文件。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-OpenFromUrlEnabled
打开或关闭使用联机查看者从 URL 或 UNC 路径查看 Office 文件的功能。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-OpenFromUrlThrottlingEnabled
限制在一定时段内来自任何给定服务器的 URL 打开请求的次数。 默认限制值(不可配置)可确保Office Online Server场不会因请求在联机查看器中查看内容而使单个服务器不堪重负。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-PicturePasteDisabled
关闭用户在浏览器中将图像从网页粘贴到 Office 的功能。 默认值为 False。 如果 OpenFromURLEnabled 设置为 True,并且未将 PicturePasteDisabled 设置为 False,则用户可以在浏览器中将图像粘贴到 Office 中。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Proxy
指定配置为允许向外部网站发出 HTTP 请求的代理服务器的 URL。 通常与 ClipartEnabled 和 TranslationEnabled 参数一起配置。
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-RecycleActiveProcessCount
指定在回收进程之前,单个 Word 或 PowerPoint 进程可以呈现的文件数。
键入的值必须是介于 1 到 1000 之间的整数。 默认值为 5。
必须重新启动场中的每台服务器,此更改才会生效。
Type: | UInt32 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-RemovePersonalInformationFromLogs
尽最大努力清理Office Online Server日志中的个人信息,并将值替换为 SHA256 哈希。 可能会擦除信息包括:
文档名称和 URL
IP 地址
电子邮件地址
用户名
默认值为 False。 请注意,启用此参数并不保证个人信息不会记录到Office Online Server日志中。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-RenderingLocalCacheLocation
指定 Word 和 PowerPoint 查看服务使用的临时缓存的位置。
默认位置为 %programdata%\Microsoft\OfficeWebApps\Working\waccache。
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-S2SCertificateName
用于 SharePoint Server 的服务器到服务器身份验证的证书的友好名称。
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-SSLOffloaded
向Office Online Server场中的服务器指示 SSL 已卸载到负载均衡器。 如果启用 SSLOffloaded,Web 应用程序将绑定到本地服务器上的端口 80 (HTTP)。 但是,引用其他资源(如 CSS 或图像)的 HTML 将对这些引用使用 HTTPS URL。
必须重新启动场中的每台服务器,此更改才会生效。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-TranslationEnabled
启用对使用 Microsoft Translator 的自动文档翻译的支持,Microsoft Translator 是一种在不同的语言之间翻译文本的联机服务。 已翻译的文件显示在 Word 中。 因为 Microsoft Translator 是一项联机服务,您必须直接启用或使用通过 Proxy 参数指定的代理启用服务器与 Web 的通信。
Microsoft Translator 可能会收集数据以改善翻译质量。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-TranslationServiceAddress
指定将翻译请求发送到的翻译服务器的 URL。 默认为 Microsoft Translator 联机服务。 一般不使用此参数,除非必须更改翻译服务。
必须重启Office Online Server场中的每个服务器才能使此更改生效。
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-TranslationServiceAppId
指定翻译服务的应用程序 ID。 默认值为浏览器中 Office 的公共应用程序 ID。 一般不使用此参数,除非您已与 Microsoft Translator 协商要求其他服务,并且他们向您提供了专用应用程序 ID。
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-WhatIf
显示一条描述命令作用的消息,而不执行命令。 有关详细信息,请键入以下命令:get-help about_commonparameters
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |