Set-SPExcelServiceApplication
Sets global properties for Excel Services Application.
Syntax
ExistingTargetApplicationParameterSet
Set-SPExcelServiceApplication
[[-Identity] <SPExcelServiceApplicationPipeBind>]
[-AssignmentCollection <SPAssignmentCollection>]
[-CachingOfUnusedFilesEnable]
[-Confirm]
[-CrossDomainAccessAllowed]
[-EncryptedUserConnectionRequired <EncryptedConnectionMode>]
[-ExternalDataConnectionLifetime <Int32>]
[-FileAccessMethod <FileAccessMethod>]
[-LoadBalancingScheme <LoadBalancingScheme>]
[-MemoryCacheThreshold <Int32>]
[-PrivateBytesMax <Int32>]
[-SessionsPerUserMax <Int32>]
[-SiteCollectionAnonymousSessionsMax <Int32>]
[-TerminateProcessOnAccessViolation]
[-ThrottleAccessViolationsPerSiteCollection <Int32>]
[-UnattendedAccountApplicationId <String>]
[-UnusedObjectAgeMax <Int32>]
[-WhatIf]
[-WorkbookCache <String>]
[-WorkbookCacheSizeMax <Int32>]
[-UseEffectiveUserName]
[-WorkbookModelUsageTracker <String>]
[<CommonParameters>]
NewTargetApplicationParameterSet
Set-SPExcelServiceApplication
[[-Identity] <SPExcelServiceApplicationPipeBind>]
[-AssignmentCollection <SPAssignmentCollection>]
[-CachingOfUnusedFilesEnable]
[-Confirm]
[-CrossDomainAccessAllowed]
[-EncryptedUserConnectionRequired <EncryptedConnectionMode>]
[-ExternalDataConnectionLifetime <Int32>]
[-FileAccessMethod <FileAccessMethod>]
[-LoadBalancingScheme <LoadBalancingScheme>]
[-MemoryCacheThreshold <Int32>]
[-PrivateBytesMax <Int32>]
[-SessionsPerUserMax <Int32>]
[-SiteCollectionAnonymousSessionsMax <Int32>]
[-TerminateProcessOnAccessViolation]
[-ThrottleAccessViolationsPerSiteCollection <Int32>]
[-UnusedObjectAgeMax <Int32>]
[-WhatIf]
[-WorkbookCache <String>]
[-WorkbookCacheSizeMax <Int32>]
[-UnattendedServiceAccount <PSCredential>]
[-UseEffectiveUserName]
[-WorkbookModelUsageTracker <String>]
[<CommonParameters>]
Description
The Set-ExcelServiceApplication cmdlet changes global runtime properties for Excel Services Application.
Changes to properties that are made by using this cmdlet affect all machines in the farm that are running an instance of the specified Excel Services Application Web service application.
For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at SharePoint Server Cmdlets.
Examples
EXAMPLE 1
$sa = Get-SPServiceApplication | ?{$_.TypeName -eq 'Excel Services Application Web Service Application'}
Set-SPExcelServiceApplication -Identity $sa -SessionsPerUserMax 10
This example sets the Excel Services Application to enable each user to open no more than 10 sessions at one time on a back-end application server that runs Excel Services Application.
EXAMPLE 2
$sa = Get-SPServiceApplication | ?{$_.TypeName -eq 'Excel Services Application Web Service Application'}
Set-SPExcelServiceApplication -Identity $sa -PrivateBytesMax -1
This example sets the maximum number of private bytes of memory on the computer to a value of -1, which indicates that Excel Services Application will consume 50 percent of the available memory resources.
Parameters
-AssignmentCollection
Applicable: SharePoint Server 2010, SharePoint Server 2013
Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.
When the Global parameter is used, all objects are contained in the global store.
If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.
Parameter properties
| Type: | SPAssignmentCollection |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-CachingOfUnusedFilesEnable
Applicable: SharePoint Server 2010, SharePoint Server 2013
Specifies that files that are no longer used by Excel Services Application can remain in the cache for later use. The default is true when the parameter is not specified on the command.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Confirm
Applicable: SharePoint Server 2010, SharePoint Server 2013
Prompts you for confirmation before executing the command.
For more information, type the following command: get-help about_commonparameters
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-CrossDomainAccessAllowed
Applicable: SharePoint Server 2010, SharePoint Server 2013
Specifies that trusted workbooks and data connection files can be requested and rendered by Web Parts or pages that reside in other HTTP domains.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-EncryptedUserConnectionRequired
Applicable: SharePoint Server 2010, SharePoint Server 2013
Requires that encryption is used between the end-user and the server running Excel Services Application. The scope of this setting is the logical server. The default value is None.
The type must be one of the following: None or Connection.
Parameter properties
| Type: | EncryptedConnectionMode |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ExternalDataConnectionLifetime
Applicable: SharePoint Server 2010, SharePoint Server 2013
Specifies the maximum number of seconds that an external data connection can remain open in the connection pool.
Valid values are:
-1 Never recycle
1 to 2073600 Remain active 1 second to 24 days.
The default value is 1800.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-FileAccessMethod
Applicable: SharePoint Server 2010, SharePoint Server 2013
Specifies the authentication method that Excel Services Application uses to retrieve files. UseFileAccessAccount specifies that all workbooks always use the credentials of the service account running Excel Services Application. UseImpersonation specifies that Excel Services Application retrieves the workbook files as the user who makes the request. The default value is UseImpersonation.
The type must be one of the following: UseImpersonation or UseFileAccessAccount.
Parameter properties
| Type: | FileAccessMethod |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Identity
Applicable: SharePoint Server 2010, SharePoint Server 2013
Specifies the SPExcelServiceApplication object to update.
The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of an Excel Services Application Web service application in the farm (for example, MyExcelService1); or an instance of a valid SPExcelServiceApplication object.
Parameter properties
| Type: | SPExcelServiceApplicationPipeBind |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 1 |
| Mandatory: | False |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-LoadBalancingScheme
Applicable: SharePoint Server 2010, SharePoint Server 2013
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. The default value is WorkbookURL.
The type must be one of the following: RoundRobin, Local, or WorkbookURL.
Parameter properties
| Type: | LoadBalancingScheme |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-MemoryCacheThreshold
Applicable: SharePoint Server 2010, SharePoint Server 2013
Specifies 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. Setting this value to 0 disables caching of inactive objects. The default value is 90.
The type must be an integer in the range of 0 to 95.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-PrivateBytesMax
Applicable: SharePoint Server 2010, SharePoint Server 2013
Specifies the maximum private bytes, in megabytes, that are used by Excel Services Application. When set to -1, the maximum private bytes defaults to 50 percent of physical memory on the computer. Valid values include -1 for no limit, and any positive integer. The default value is -1.
The type must be -1 or any positive integer.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-SessionsPerUserMax
Applicable: SharePoint Server 2010, SharePoint Server 2013
Specifies the maximum number of sessions allowed for a user. If a user reaches this maximum the oldest session is deleted when a new session is started. Valid values include -1 for no limit, and any positive integer. The default value is 25.
The type must be -1 or any positive integer.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-SiteCollectionAnonymousSessionsMax
Applicable: SharePoint Server 2010, SharePoint Server 2013
Specifies the maximum number of anonymous sessions allowed per site collection. A value of 0 specifies that no anonymous sessions are allowed. Valid values include -1 for no limit, 0 to disable the setting, or any positive integer. The default value is 25.
The type must be -1, 0, or any positive integer.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-TerminateProcessOnAccessViolation
Applicable: SharePoint Server 2010, SharePoint Server 2013
Terminates Excel Services Application when an access violation occurs in the process.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ThrottleAccessViolationsPerSiteCollection
Applicable: SharePoint Server 2010, SharePoint Server 2013
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). Existing sessions for files on that site collection are unaffected. Valid values include 0 to disable the setting, and the range of 1 to 2073600 seconds (24 days). The default value is 0.
The type must be an integer value in the range of 0 to 2073600.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-UnattendedAccountApplicationId
Applicable: SharePoint Server 2010, SharePoint Server 2013
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. The secure storage service is contacted when this parameter is set and specific error cases occur. Valid values are alphanumeric strings with a maximum of 256 characters. The default value is an empty string.
The type must be a valid string of alphanumeric characters; for example, UnattendedServiceAccountID.
The unattended account is a single account that all workbooks can use to refresh data. An unattended account is required when workbook connections specify None for authentication, or when any non-Windows credentials are used to refresh data.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ExistingTargetApplicationParameterSet
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-UnattendedServiceAccount
Applicable: SharePoint Server 2013
The Unattended Service Account is a single account that all workbooks can use to refresh data. This account is required to refresh data when workbook connections specify "Use the Unattended Service Account" without using Windows Credentials.
Parameter properties
| Type: | PSCredential |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
NewTargetApplicationParameterSet
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-UnusedObjectAgeMax
Applicable: SharePoint Server 2010, SharePoint Server 2013
Specifies the maximum amount of time, in minutes, that objects not currently used in a session are kept in the memory cache. Valid values include -1 for no maximum setting, and a positive integer in the range of 1 to 34560 minutes (24 days). The default value is -1.
The type must be -1, or an integer in the range of 1 to 34560.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-UseEffectiveUserName
Applicable: SharePoint Server 2013
The UseEffectiveUserName property is an alternative to Windows delegation for allowing users to securely access Analysis Services data.
The setting will only impact external data connections based on Analysis Services workbook connections with an authentication setting of "Use the authenticated user's account".
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-WhatIf
Applicable: SharePoint Server 2010, SharePoint Server 2013
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
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-WorkbookCache
Applicable: SharePoint Server 2010, SharePoint Server 2013
Specifies the local file system location of the cache that is used to store workbooks that are used by Excel Services Application.
If no value is specified, the default value is a subdirectory in the system temporary directory.
The type must be a valid path in either of the following forms:
-- C:\folder_name -- \\server_name\folder_name
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-WorkbookCacheSizeMax
Applicable: SharePoint Server 2010, SharePoint Server 2013
Specifies the maximum allowable size, in megabytes, of an individual session. The default value is 0.
The type must be any positive integer.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-WorkbookModelUsageTracker
Applicable: SharePoint Server 2013
{{Fill WorkbookModelUsageTracker Description}}
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.