Resource Type: dsc_officeonlineserverfarm

Defined in:

lib/puppet/type/dsc_officeonlineserverfarm.rb

Providers:

powershell

Overview

The DSC OfficeOnlineServerFarm resource type. Automatically generated from ‘OfficeOnlineServerDsc/DSCResources/MSFT_OfficeOnlineServerFarm/MSFT_OfficeOnlineServerFarm.schema.mof’

To learn more about PowerShell Desired State Configuration, please visit technet.microsoft.com/en-us/library/dn249912.aspx.

For more information about built-in DSC Resources, please visit technet.microsoft.com/en-us/library/dn249921.aspx.

For more information about xDsc Resources, please visit github.com/PowerShell/DscResources.

Properties

• ensure

  The basic property that the resource should be in.

  Supported values:

  • exists?
  • present

Parameters

• dsc_allowceip

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

  Supported values:

  • true
  • false
• dsc_allowhttp

  AllowHttp - 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.

  Supported values:

  • true
  • false
• dsc_allowhttpsecurestoreconnections

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

  Supported values:

  • true
  • false
• dsc_allowoutboundhttp

  AllowOutboundHttp

  Supported values:

  • true
  • false
• dsc_cachelocation

  CacheLocation - Specifies the location of the global disk cache that is used to store rendered image files.

• dsc_cachesizeingb

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

• dsc_certificatename

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

• dsc_clipartenabled

  ClipartEnabled - 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.

  Supported values:

  • true
  • false
• dsc_documentinfocachesize

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

• dsc_editingenabled

  EditingEnabled - 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.

  Supported values:

  • true
  • false
• dsc_excelabortonrefreshonopenfail

  ExcelAbortOnRefreshOnOpenFail - Specifies that the loading of a Web Excel file automatically fails if an automatic data refresh operation fails when the file is opened.

  Supported values:

  • true
  • false
• dsc_excelallowexternaldata

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

  Supported values:

  • true
  • false
• dsc_excelautomaticvolatilefunctioncachelifetime

  ExcelAutomaticVolatileFunctionCacheLifetime - Specifies the maximum time, in seconds, that a computed value for a volatile function is cached for automatic recalculations.

• dsc_excelcachingunusedfiles

  ExcelCachingUnusedFiles - Enable caching of files that are no longer in use by Web Excel sessions.

  Supported values:

  • true
  • false
• dsc_excelchartandimagesizemax

  ExcelChartAndImageSizeMax - Specifies the maximum size, in megabytes, of a chart or image that can be opened.

• dsc_excelconcurrentdatarequestspersessionmax

  ExcelConcurrentDataRequestsPerSessionMax - Specifies the maximum number of concurrent external data requests allowed in each session. If a session must issue more than this number of requests, additional requests must be queued. The scope of this setting is the logical server.

• dsc_excelconnectionlifetime

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

• dsc_exceldefaultworkbookcalcmode

  ExcelDefaultWorkbookCalcMode - Specifies the calculation mode of workbooks. Settings other than File override the workbook settings.

• dsc_excelexternaldatacachelifetime

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

• dsc_excelmemorycachethreshold

  ExcelMemoryCacheThreshold - The percentage of the Maximum Private Bytes that can be allocated to inactive objects. When the memory cache threshold is exceeded, cached objects that are not currently in use are released.

• dsc_excelprivatebytesmax

  ExcelPrivateBytesMax - 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.

• dsc_excelrequestdurationmax

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

• dsc_excelrestexternaldataenabled

  ExcelRestExternalDataEnabled - Specifies whether requests from the Representational State Transfer (REST) Application Programming Interface (API) are permitted to refresh external data connections.

  Supported values:

  • true
  • false
• dsc_excelsessiontimeout

  ExcelSessionTimeout - Specifies the time, in seconds, that a session remains active in Excel Web App when there is no user activity.

• dsc_exceludfsallowed

  ExcelUdfsAllowed - Activates user-defined functions for use with Web Excel.

  Supported values:

  • true
  • false
• dsc_excelunusedobjectagemax

  ExcelUnusedObjectAgeMax - The maximum time (in minutes) that inactive objects remain in the memory cache. Inactive objects are objects that are not used in a session.

• dsc_exceluseeffectiveusername

  ExcelUseEffectiveUserName

  Supported values:

  • true
  • false
• dsc_excelwarnondatarefresh

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

  Supported values:

  • true
  • false
• dsc_excelworkbooksizemax

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

• dsc_externalurl

  ExternalURL - 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.

• dsc_farmou

  FarmOU - 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.

• dsc_internalurl

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

• dsc_loglocation

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

• dsc_logretentionindays

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

• dsc_logverbosity

  LogVerbosity - Specifies how much information is stored in the trace log files.

• dsc_maxmemorycachesizeinmb

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

• dsc_maxtranslationcharactercount

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

• dsc_openfromuncenabled

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

  Supported values:

  • true
  • false
• dsc_openfromurlenabled

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

  Supported values:

  • true
  • false
• dsc_openfromurlthrottlingenabled

  OpenFromUrlThrottlingEnabled - 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.

  Supported values:

  • true
  • false
• dsc_picturepastedisabled

  PicturePasteDisabled

  Supported values:

  • true
  • false
• dsc_proxy

  Proxy - 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.

• dsc_psdscrunascredential

  PsDscRunAsCredential

• dsc_recycleactiveprocesscount

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

• dsc_removepersonalinformationfromlogs

  RemovePersonalInformationFromLogs

  Supported values:

  • true
  • false
• dsc_renderinglocalcachelocation

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

• dsc_s2scertificatename

  S2SCertificateName

• dsc_ssloffloaded

  SSLOffloaded - 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.

  Supported values:

  • true
  • false
• dsc_translationenabled

  TranslationEnabled - 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.

  Supported values:

  • true
  • false
• dsc_translationserviceaddress

  TranslationServiceAddress - 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.

• dsc_translationserviceappid

  TranslationServiceAppId - 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.

• name (namevar)
• provider

  The specific backend to use for this ‘dsc_officeonlineserverfarm` resource. You will seldom need to specify this — Puppet will usually discover the appropriate provider for your platform.