Export (0) Print
Expand All

Set-SPAccessServicesApplication

SharePoint 2013

Published: July 16, 2012

Applies to:  SharePoint Server 2013 Enterprise 

Sets global properties of an existing Access Services application in SharePoint Server 2013.

Set-SPAccessServicesApplication [-Identity] <SPServiceApplicationPipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-CacheTimeout <Int32>] [-Confirm [<SwitchParameter>]] [-PrivateBytesMax <Int32>] [-RequestDurationMax <Int32>] [-SessionsPerAnonymousUserMax <Int32>] [-SessionsPerUserMax <Int32>] [-WhatIf [<SwitchParameter>]]

Parameters

Parameter Required Type Description

Identity

Required

Microsoft.SharePoint.PowerShell.SPServiceApplicationPipeBind

Specifies the Access Services application to update.

The value must be in one of the following forms:

  • A valid name of an Access Services application; for example, AccessSrvApp1

  • A valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh

  • An instance of a valid SPAccessServiceApplication object

AssignmentCollection

Optional

Microsoft.SharePoint.PowerShell.SPAssignmentCollection

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.

noteNote:

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.

CacheTimeout

Optional

System.Int32

Specifies the number of seconds that a data cache will remain active on Access Services with no user activity. Valid values include: -1, cache never times out; 1 to 2073600, cache remains active from 1 second to 24 days.

The type must be the integers -1, or an integer in the range of 1 to 2073600 (24 days). The default value is 300.

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

PrivateBytesMax

Optional

System.Int32

Specifies the maximum private bytes in megabytes that can be used by Access Services. When set to -1, it defaults to 75 percent of physical memory on the server. Valid values: -1, no limit, from 1 to any positive integer.The default value is -1.

RequestDurationMax

Optional

System.Int32

Specifies the maximum number of seconds that a request to perform an operation can use before the request times out. Valid values include: -1, no limit, 1 to 2073600, cache remains active 1 second to 24 days. The default value is 30.

The type must be the integer -1, or an integer in the range of 1 to 2073600 (24 days)

SessionsPerAnonymousUserMax

Optional

System.Int32

The maximum number of sessions allowed per user. If this maximum is exceeded, the oldest session will be deleted when a new session is started. Valid values include: -1, no limit, and 1 to any positive integer. The default value is 10.

The integer -1, or an integer in the range of 1 to MaxInt

SessionsPerUserMax

Optional

System.Int32

Specifies the maximum number of sessions allowed per user. If this maximum is exceeded, the oldest session is deleted when a new session is started. Valid values include: -1, no limit, and 1 to any positive integer. The default value is 10.

The integer -1, or an integer in the range of 1 to MaxInt.

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 Set-SPAccessServiceApplication cmdlet sets the global runtime properties of an existing Access Services application in SharePoint Server 2013. If you use this cmdlet to update properties, updates affect all servers in the farm on which this Access Services application runs.

Input Types

Return Types

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

Set-SPAccessServiceApplication –Identity "MyAccessService" –RequestDurationMax 100

This example sets the Access Services application named MyAccessService to let requests take up to 100 seconds before they time out.

------------EXAMPLE 2------------------

Get-SPAccessServiceApplication | Set-SPAccessServiceApplication –SessionsPerUserMax 5

This example sets every Access Services application in the farm to allow up to five sessions per user on each back-end application server computer on which Access Services runs.

First, every Access Services application is returned, and then a new value is set by using the Set-SPAccessServiceApplication cmdlet.

Change History

Date Description

July 16, 2012

Initial publication

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft