Edit

Share via

Set-SPDistributedCacheClientSetting

  • Reference
Module:
SharePointServer
Applies to:
SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

Sets distributed cache settings.

Syntax

Set-SPDistributedCacheClientSetting
   [-ContainerType] <SPDistributedCacheContainerType>
   [-DistributedCacheClientSettings] <SPDistributedCacheClientSettings>
   [-AssignmentCollection <SPAssignmentCollection>]
   [<CommonParameters>]

Description

Use the Set-SPDistributedCacheClientSettings cmdlet to set the distributed cache service based on usage. Usage can be any type of cache that the ContainerType parameter specifies.

For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at SharePoint Server Cmdlets.

Examples

--------------------EXAMPLE---------------------

$settings = Get-SPDistributedCacheClientSetting -ContainerType DistributedLogonTokenCache
$settings.MaxConnectionsToServer = 10
Set-SPDistributedCacheClientSetting -ContainerType DistributedLogonTokenCache -DistributedCacheClientSettings $settings

This example updates the MaxConnectionsToServer to 10 for DistributedLogonTokenCache.

Parameters

-AssignmentCollection

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.

Type:SPAssignmentCollection
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-ContainerType

Specifies the container type to clear.

The valid values are the following:

-DistributedDefaultCache

-DistributedAccessCache

-DistributedActivityFeedCache

-DistributedBouncerCache

-DistributedLogonTokenCache

-DistributedServerToAppServerAccessTokenCache

-DistributedSearchCache

-DistributedSecurityTrimmingCache

-DistributedActivityFeedLMTCache

-DistributedViewStateCache

Type:SPDistributedCacheContainerType
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-DistributedCacheClientSettings

Updates the various cache client settings. It is recommended to use the default settings.

Type:SPDistributedCacheClientSettings
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019