Export (0) Print
Expand All
4 out of 7 rated this helpful - Rate this topic

New-OfficeWebAppsFarm

Office Web Apps

Updated: July 2, 2013

Applies to:  Office Web Apps Server 

Creates a new Office Web Apps Server farm on the local computer.

New-OfficeWebAppsFarm [-AllowCEIP <SwitchParameter>] [-AllowHttp <SwitchParameter>] [-AllowHttpSecureStoreConnections <SwitchParameter>] [-CacheLocation <String>] [-CacheSizeInGB <Nullable>] [-CertificateName <String>] [-ClipartEnabled <SwitchParameter>] [-Confirm [<SwitchParameter>]] [-DocumentInfoCacheSize <Nullable>] [-EditingEnabled <SwitchParameter>] [-ExcelAllowExternalData <SwitchParameter>] [-ExcelConnectionLifetime <Nullable>] [-ExcelExternalDataCacheLifetime <Nullable>] [-ExcelPrivateBytesMax <Nullable>] [-ExcelRequestDurationMax <Nullable>] [-ExcelSessionTimeout <Nullable>] [-ExcelWarnOnDataRefresh <SwitchParameter>] [-ExcelWorkbookSizeMax <Nullable>] [-ExternalURL <String>] [-FarmOU <String>] [-Force <SwitchParameter>] [-InternalURL <String>] [-LogLocation <String>] [-LogRetentionInDays <Nullable>] [-LogVerbosity <String>] [-MaxMemoryCacheSizeInMB <Nullable>] [-MaxTranslationCharacterCount <Nullable>] [-OpenFromUncEnabled <SwitchParameter>] [-OpenFromUrlEnabled <SwitchParameter>] [-OpenFromUrlThrottlingEnabled <SwitchParameter>] [-PicturePasteDisabled <SwitchParameter>] [-Proxy <String>] [-RecycleActiveProcessCount <Nullable>] [-RemovePersonalInformationFromLogs <SwitchParameter>] [-RenderingLocalCacheLocation <String>] [-SSLOffloaded <SwitchParameter>] [-TranslationEnabled <SwitchParameter>] [-TranslationServiceAddress <String>] [-TranslationServiceAppId <String>] [-WhatIf [<SwitchParameter>]]

Parameters

Parameter Required Type Description

AllowCEIP

Optional

System.Management.Automation.SwitchParameter

Enables Customer Experience Improvement Program (CEIP) reporting on all servers in the Office Web Apps Server farm.

AllowHttp

Optional

System.Management.Automation.SwitchParameter

Indicates that IIS sites should be provisioned on port 80 for HTTP access. Use AllowHTTP only in environments where all computers require IPSEC (full encryption) or in test environments that do not contain sensitive files.

Enabled automatically when you enable SSLOffloaded.

AllowHttpSecureStoreConnections

Optional

System.Management.Automation.SwitchParameter

Indicates that secure store connections can be made by using non-SSL connections (such as HTTP). The default is False.

Use AllowHTTPSecureStoreConnections only in environments where all computers require IPSEC (full encryption) or in test environments that do not contain sensitive files.

CacheLocation

Optional

System.String

Specifies the location of the global disk cache that is used to store rendered image files. The default location is %programdata%\Microsoft\OfficeWebApps\Working\d\.

CacheSizeInGB

Optional

System.Nullable

Specifies the maximum size of the global disk cache in gigabytes.

The type must be an integer value in the range of 0 to any positive integer. The default size is 15 GB.

CertificateName

Optional

System.String

Specifies the friendly name of the certificate that Office Web Apps Server uses to create HTTPS bindings.

If the specified certificate is not found or has expired, or if the specified value is associated with more than one certificate, an error is logged and the farm is not created.

Important Important:

This value is used on every server that joins the Office Web Apps Server farm. Therefore, every server in the farm must have a certificate that has this friendly name.

You don’t have to specify the CertificateName parameter if you are using either the AllowHttp or SSLOffloaded parameter.

ClipartEnabled

Optional

System.Management.Automation.SwitchParameter

Enables support for inserting clip art from Office.com into Office documents. This feature requires server-to-web communication, configured either directly or by using a proxy that you specify by using the Proxy parameter.

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

DocumentInfoCacheSize

Optional

System.Nullable

Specifies the maximum number of document conversion records that are stored in a memory cache.

The default value is 5000 records.

EditingEnabled

Optional

System.Management.Automation.SwitchParameter

Enables support for editing in the browser. The default is False. Only set to True if you have the appropriate licensing to use the editing functionality.

ExcelAllowExternalData

Optional

System.Management.Automation.SwitchParameter

Enables the refresh of supported external data in Excel Web App workbooks where workbooks contain connections to external data. The default is True.

ExcelConnectionLifetime

Optional

System.Nullable

Specifies the duration, in seconds, of external data connections for Excel Web App. The default is 1800 seconds.

ExcelExternalDataCacheLifetime

Optional

System.Nullable

Specifes the duration, in seconds, of the external data cache lifetime in Excel Web App. The default is 300 seconds.

ExcelPrivateBytesMax

Optional

System.Nullable

Specifies the maximum private bytes, in megabytes, used by Excel Web App. When set to -1, the maximum private bytes use 50 percent of physical memory on the computer.

The type must be -1 or any positive integer. The default value is -1.

ExcelRequestDurationMax

Optional

System.Nullable

Specifies the maximum duration, in seconds, for a single request in a session. After this time elapses, the request times out.

The type must be -1 (no limit) or an integer in the range of 1 to 2073600. The default value is 300.

ExcelSessionTimeout

Optional

System.Nullable

Specifies the time, in seconds, that a session remains active in Excel Web App when there is no user activity. Valid values include the following:

-1 Session never expires.

0  Session expires at the end of a single request.

1 to 2073600Session remains active for 1 second to 24 days. The default value is 450.

ExcelWarnOnDataRefresh

Optional

System.Management.Automation.SwitchParameter

Turns off or on the warning dialog displayed when data refreshes in Excel Web App.

ExcelWorkbookSizeMax

Optional

System.Nullable

Specifies the maximum size, in megabytes, of a workbook that can be loaded.

The type must be an integer value in the range of 1 to 2000. The default value is 10.

ExternalURL

Optional

System.String

Specifies the URL root that clients use to access the Office Web Apps Server farm from the Internet. In the case of a load-balanced, multiserver Office Web Apps Server farm, the external URL is bound to the IP address of the external-facing load balancer.

An Office Web Apps Server farm requires at least one URL, set using either ExternalURL or InternalURL. You can also set both internal and external URLs.

FarmOU

Optional

System.String

Specifies the name of the Active Directory organizational unit (OU) that servers must be a member of to join the Office Web Apps Server farm. Use this parameter to prevent unauthorized servers (that is, servers that are not in the OU) from joining an Office Web Apps Server farm.

Force

Optional

System.Management.Automation.SwitchParameter

Suppresses any user prompts by answering Yes.

InternalURL

Optional

System.String

Specifies the URL root that clients use to access the Office Web Apps Server farm from the intranet.

An Office Web Apps Server farm requires at least one URL, set using either ExternalURL or InternalURL. You can also set both internal and external URLs.

LogLocation

Optional

System.String

Specifies the location on the local computer where activity logs are stored.

The location applies for every server in the farm and cannot be customized on a per-server basis. The default location is %programdata%\Microsoft\OfficeWebApps\Data\Logs\ULS\.

Be sure to allow sufficient disk space on the drive on which logs are stored.

LogRetentionInDays

Optional

System.Nullable

Specifies the number of days that log entries are stored. Log entries older than the configured date are trimmed.

The type must be an integer value in the range of 0 to 365. The default value is 7 days.

LogVerbosity

Optional

System.String

Specifies how much information is stored in the trace log files. The values are as follows:

VerboseEX writes low-level detail to the trace log file. Useful for traces that are likely to be high volume.

Verbose writes low-level detail to the trace log file.

Medium writes medium-level detail to the trace log file.

High writes high-level detail to the trace log file.

Monitorable writes traces that represent an unusual code path and actions that should be monitored.

Unexpected writes traces that represent an unexpected code path and actions that should be monitored.

None writes no trace information to the trace log file.

Important Important:

Leaving the LogVerbosity at a low level for an extended period of time will negatively impact performance.

MaxMemoryCacheSizeInMB

Optional

System.Nullable

Specifies, in megabytes, the maximum amount of memory that the rendering cache can use.

The type must be an integer value in the range of 0 to any positive integer. The default size is 1024 MB.

MaxTranslationCharacterCount

Optional

System.Nullable

Specifies the maximum amount of characters a document can have in order to be translated.

The type must be an integer value. The value can be set to 0 to indicate no limit or a value from 2000 to 2,000,000. The default value is 125,000.

OpenFromUncEnabled

Optional

System.Management.Automation.SwitchParameter

Turns on or off the ability to use Online Viewers to view Office files from a UNC path.

note Note:

You must first set OpenFromUrlEnabled to True to allow Online Viewers to display files in UNC paths.

OpenFromUrlEnabled

Optional

System.Management.Automation.SwitchParameter

Turns on or off the ability to use Online Viewers to view Office files from a URL or UNC path. The default is False.

OpenFromUrlThrottlingEnabled

Optional

System.Management.Automation.SwitchParameter

Throttles the number of Open From URL requests from any given server in a time period. The default throttling values, which are not configurable, make sure that an Office Web Apps Server farm will not overwhelm a single server with requests for content to be viewed in the Online Viewers.

PicturePasteDisabled

Optional

System.Management.Automation.SwitchParameter

Turns off the ability for users to paste images from a web page into Office Web Apps. The default is False. If OpenFromURLEnabled is set to True and PicturePasteDisabled is not set or set to False, users can paste images into Office Web Apps.

Proxy

Optional

System.String

Specifies the URL of the proxy server that is configured to allow HTTP requests to external sites. Typically configured in conjunction with the ClipartEnabled and TranslationEnabled parameters.

RecycleActiveProcessCount

Optional

System.Nullable

Specifies the number of files that a single Word or PowerPoint process can render before the process is recycled.

The type must be an integer value in the range of 1 to 1000. The default value is 5.

RemovePersonalInformationFromLogs

Optional

System.Management.Automation.SwitchParameter

Provides a best effort scrub of personal information from Office Web Apps Server logs and replaces values with a SHA256 hash. Potentially scrubbed information can be:

  • Document names and URLs

  • IP addresses

  • Email addresses

  • User names

The default is False. Note that enabling this parameter doesn't guarantee that personal information won't be logged to the Office Web Apps Server logs.

RenderingLocalCacheLocation

Optional

System.String

Specifies the location of the temporary cache for use by the Word and PowerPoint Viewing Services.

The default location is %programdata%\Microsoft\OfficeWebApps\Working\waccache\.

SSLOffloaded

Optional

System.Management.Automation.SwitchParameter

Indicates to the servers in the Office Web Apps Server farm that SSL is offloaded to the load balancer. When SSLOffloaded is enabled, web applications are bound to port 80 (HTTP) on the local server. However, HTML that references other resources, such as CSS or images, uses HTTPS URLs for those references.

TranslationEnabled

Optional

System.Management.Automation.SwitchParameter

Enables support for automatic document translation using Microsoft Translator, an online service that translates text between languages. The translated file is shown in the Word Web App. Because Microsoft Translator is an online service, you must enable server-to-web communication directly or by using a proxy that you specify by using the Proxy parameter.

Important Important:

Microsoft Translator may collect data to improve the quality of translations.

TranslationServiceAddress

Optional

System.String

Specifies the URL of the translation server that translation requests are sent to. The default is the Microsoft Translator online service. Typically you will not use this parameter unless you must change translation services.

TranslationServiceAppId

Optional

System.String

Specifies the application ID for the translation service. The default is the public application ID for Office Web Apps. Typically you will not use this parameter unless you have negotiated with Microsoft Translator for additional services and they have provided you with a private application ID.

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 New-OfficeWebAppsFarm cmdlet creates a new Office Web Apps Server farm on the local computer. You run this cmdlet on the first server in the Office Web Apps Server farm and then add more servers to the farm by using the New-OfficeWebAppsMachine cmdlet.

Input Types

Return Types

------------------EXAMPLE 1---------------------

New-OfficeWebAppsFarm -InternalUrl "https://server.corp.contoso.com" -ExternalUrl "https://server.external.contoso.com" –EditingEnabled:$true –SSLOffloaded

This example creates an Office Web Apps Server farm on the local server that has editing enabled for Office Web Apps. The farm is configured for load balancing by enabling SSLOffloaded, which automatically enables AllowHttp. If you are not using a load balancer, make sure that you set CertificateName.

Change History

Date Description

July 02, 2013

Added PicturePasteDisabled and RemovePersonalInformationFromLogs parameters.

July 16, 2012

Initial publication

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.