Resource Type: dsc_spexcelserviceapp

Defined in:

lib/puppet/type/dsc_spexcelserviceapp.rb

Providers:

powershell

Overview

The DSC SPExcelServiceApp resource type. Automatically generated from ‘SharePointDsc/DSCResources/MSFT_SPExcelServiceApp/MSFT_SPExcelServiceApp.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
  • absent

Parameters

• dsc_applicationpool

  ApplicationPool - The name of the application pool to run the service app in

• dsc_cachingofunusedfilesenable

  CachingOfUnusedFilesEnable - Specifies that files that are no longer used by Excel Services Application can remain in the cache for later use.

  Supported values:

  • true
  • false
• dsc_crossdomainaccessallowed

  CrossDomainAccessAllowed - Specifies that trusted workbooks and data connection files can be requested and rendered by Web Parts or pages that reside in other HTTP domains.

  Supported values:

  • true
  • false
• dsc_encrypteduserconnectionrequired

  EncryptedUserConnectionRequired - Requires that encryption is used between the end-user and the server running Excel Services Application. Valid values are None, Connection.

• dsc_ensure

  Ensure - Present ensures service app exists, absent ensures it is removed Valid values are Present, Absent.

• dsc_externaldataconnectionlifetime

  ExternalDataConnectionLifetime - Specifies the maximum number of seconds that an external data connection can remain open in the connection pool.

• dsc_fileaccessmethod

  FileAccessMethod - Specifies the authentication method that Excel Services Application uses to retrieve files. Valid values are UseImpersonation, UseFileAccessAccount.

• dsc_installaccount

  InstallAccount - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5

• dsc_loadbalancingscheme

  LoadBalancingScheme - Specifies the load-balancing schema that is used by the Excel Services Application Web service application to send requests to different back-end Excel Services Application computers. Valid values are RoundRobin, Local, WorkbookURL.

• dsc_memorycachethreshold

  MemoryCacheThreshold - Specifies the percentage of the maximum private bytes that can be allocated to inactive objects.

• dsc_name

  Name - The name of the service application

• dsc_privatebytesmax

  PrivateBytesMax - Specifies the maximum private bytes, in megabytes, that are used by Excel Services Application.

• dsc_psdscrunascredential

  PsDscRunAsCredential

• dsc_sessionsperusermax

  SessionsPerUserMax - Specifies the maximum number of sessions allowed for a user.

• dsc_sitecollectionanonymoussessionsmax

  SiteCollectionAnonymousSessionsMax - Specifies the maximum number of anonymous sessions allowed per site collection.

• dsc_terminateprocessonaccessviolation

  TerminateProcessOnAccessViolation - Terminates Excel Services Application when an access violation occurs in the process.

  Supported values:

  • true
  • false
• dsc_throttleaccessviolationspersitecollection

  ThrottleAccessViolationsPerSiteCollection - Specifies that if a workbook causes an access violation error on Excel Services Application, all files originating from that workbook’s site collection are blocked from loading for the specified period (in seconds).

• dsc_trustedfilelocations

  TrustedFileLocations - Trusted file locations for the service app

• dsc_unattendedaccountapplicationid

  UnattendedAccountApplicationId - Specifies that the application ID that is used to look up the unattended service account credentials from the secure storage service that is specified by the UnattendedAccountSecureServiceAppName parameter.

• dsc_unusedobjectagemax

  UnusedObjectAgeMax - Specifies the maximum amount of time, in minutes, that objects not currently used in a session are kept in the memory cache.

• dsc_workbookcache

  WorkbookCache - Specifies the local file system location of the cache that is used to store workbooks that are used by Excel Services Application.

• dsc_workbookcachesizemax

  WorkbookCacheSizeMax - Specifies the maximum allowable size, in megabytes, of an individual session.

• name (namevar)
• provider

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