Set-OfficeWebAppsFarm

Модуль:

OfficeOnlineServerPowerShell

Настройка параметров существующей фермы 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 настраивает параметры существующей фермы Office Online Server.

Примеры

------------------ПРИМЕР 1---------------------

Set-OfficeWebAppsFarm -ClipartEnabled:$true

В этом примере разрешается вставка картинок с сайта Office.com.

------------------ПРИМЕР 2---------------------

Set-OfficeWebAppsFarm -EditingEnabled:$true

В этом примере включается функция редактирования Office в браузере.

------------------ПРИМЕР 3---------------------

Set-OfficeWebAppsFarm -OpenFromUncEnabled:$false

В этом примере отключается возможность просматривать любой файл Office по UNC-пути.

Параметры

-AllowCEIP

Включает отчеты по программе улучшения качества программного обеспечения (CEIP) на всех серверах в ферме Office Online Server.

Чтобы это изменение вступило в силу, необходимо перезапустить каждый сервер в ферме Office Online Server.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-AllowHttp

Указывает, что сайты IIS должны быть подготовлены через порт 80 для доступа по протоколу HTTP. Используйте параметр AllowHTTP только в средах, в которых все компьютеры применяют IPSEC (полное шифрование), или в тестовых средах без конфиденциальных файлов.

Включается автоматически при включении параметра SSLOffloaded.

Необходимо перезапустить все серверы в ферме, чтобы это изменение вступило в силу.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-AllowHttpSecureStoreConnections

Указывает, что подключения Secure Store могут выполняться с помощью подключений, не использующих протокол SSL (например, HTTP). Значение по умолчанию - false.

Используйте AllowHTTPSecureStoreConnections только в средах, где для всех компьютеров требуется IPSEC (полное шифрование), либо в тестовых средах без конфиденциальных файлов.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-AllowOutboundHttp

Разрешает исходящие HTTP-подключения из Office Online Server.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-CacheLocation

Определяет расположение глобального кэша диска, используемого для хранения файлов сформированных изображений. Расположение по умолчанию — %programdata%\Майкрософт\OfficeWebApps\Working\d.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-CacheSizeInGB

Определяет максимальный размер глобального кэша диска в гигабайтах.

Типом должно быть целое значение в диапазоне от 0 до любого положительного целого числа. Значение по умолчанию: 15 ГБ.

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. Чтобы эта функция работала, сервер должен быть подключен к Интернету напрямую или с использованием прокси-сервера, заданного в параметре 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 в браузере, где книги содержат подключения к внешним данным. Значение по умолчанию — True.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ExcelAutomaticVolatileFunctionCacheLifeTime

Задает максимальное время (в секундах) кэширования вычисленного значения переменной функции для автоматического пересчета. -1: вычисление осуществляется один раз при загрузке книги. 0: вычисления осуществляются всегда. От 1 до 2 073 600: значение кэшируется от 1 секунды до 24 дней.

Type:	Int32
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ExcelCachingUnusedFiles

Включает кэширование файлов, которые больше не используются сеансами веб-приложения 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

PARAMVALUE: File | Manual | Auto | 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 до 2 073 600. Значение по умолчанию равно 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 до 2 073 600 Сеанс остается активным от 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

Указывает наибольший размер книги, при котором ее можно загрузить (МБ).

Типом должно быть целое число от 1 до 2000. Значение по умолчанию — 10.

Type:	Int32
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ExternalURL

Указывает корневой URL-адрес, используемый клиентами для доступа к ферме Office Online Server из Интернета. В случае фермы с балансировкой нагрузки с многосерверным Office Online Server внешний URL-адрес привязывается к IP-адресу внешней подсистемы балансировки нагрузки.

Для фермы Office Online Server требуется по крайней мере один URL-адрес, который определяется с помощью ExternalURL или InternalURL. Можно также задать и внутренний и внешний URL-адрес.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-FarmOU

Указывает имя подразделения Active Directory, членом которому должны быть серверы для присоединения к ферме Office Online Server. Используйте этот параметр, чтобы предотвратить присоединение несанкционированных серверов (то есть серверов, которые не находятся в подразделении) к ферме 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

Указывает корневой URL-адрес, который клиенты должны использовать для доступа к ферме Office Online Server из интрасети.

Ферме Office Online Server требуется по крайней мере один URL-адрес. Он задается с помощью параметра ExternalURL или InternalURL. Можно также задать и внутренний и внешний URL-адрес.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-LogLocation

Определяет расположение на локальном компьютере, в котором хранятся журналы активности.

Данное расположение применяется на всех серверах в ферме и его нельзя настроить для каждого из них отдельно. Расположение по умолчанию — %programdata%\Майкрософт\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

Определяет максимальный объем памяти в мегабайтах, который может использовать кэш отображения.

Типом должно быть целое значение в диапазоне от 0 до любого положительного целого числа. Значение по умолчанию: 1024 МБ.

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

Отключает или включает возможность использования средств просмотра Online Viewer для просмотра файлов Office по UNC-пути.

Чтобы разрешить в средствах просмотра Online Viewer отображение файлов в UNC-путях, следует сначала задать для параметра OpenFromUrlEnabled значение True.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-OpenFromUrlEnabled

Включает или отключает возможность просмотра файлов Office по URL-адресу или по пути UNC с помощью веб-средств просмотра.

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

Определяет URL-адрес прокси-сервера, который разрешает HTTP-запросы на внешние сайты. Обычно этот параметр задается вместе с параметрами 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%\Майкрософт\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 включен, веб-приложения привязаны к порту 80 (HTTP) на локальном сервере. Однако HTML-код, ссылающийся на другие ресурсы, например CSS и изображения, использует URL-адреса HTTPS для этих ссылок.

Необходимо перезапустить все серверы в ферме, чтобы это изменение вступило в силу.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-TranslationEnabled

Включает поддержку автоматического перевода документа с помощью Microsoft Translator, интерактивной службы, переводящей текст с разных языков. Переведенный файл отображается в Word. Так как Microsoft Translator — это интерактивная служба, необходимо включить связь сервера с Интернетом напрямую или через прокси-сервер, указанный в параметре Proxy.

Служба 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

Указывает идентификатор приложения для службы перевода. По умолчанию используется общедоступный идентификатор приложения Office в браузере. Обычно этот параметр не используется (за исключением случая, когда с Microsoft Translator согласовано предоставление дополнительных служб и был получен соответствующий идентификатор частного приложения).

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