Skip to content

SPDistributedCacheClientSettings

Jump to bottom
dscbot edited this page Apr 14, 2025 · 14 revisions

Parameters

Parameter Attribute DataType Description Allowed Values
IsSingleInstance Key String Unique key for the resource. Set to 'Yes' to apply configuration. Yes
DACChannelOpenTimeOut Write UInt32 Channel timeout for the Distributed Access Cache
DACMaxConnectionsToServer Write UInt32 Maximum number of connections to the Distributed Access Cache
DACRequestTimeout Write UInt32 Request timeout for the Distributed Access Cache
DAFCChannelOpenTimeOut Write UInt32 Channel timeout for the Distributed Activity Feed LMT Cache
DAFChannelOpenTimeOut Write UInt32 Channel timeout for the Distributed Activity Feed Cache
DAFCMaxConnectionsToServer Write UInt32 Maximum number of connections to the Distributed Activity Feed LMT Cache
DAFCRequestTimeout Write UInt32 Request timeout for the Distributed Activity Feed LMT Cache
DAFMaxConnectionsToServer Write UInt32 Maximum number of connections to the Distributed Activity Feed Cache
DAFRequestTimeout Write UInt32 Request timeout for the Distributed Activity Feed Cache
DBCChannelOpenTimeOut Write UInt32 Channel timeout for the Distributed Bouncer Cache
DBCMaxConnectionsToServer Write UInt32 Maximum number of connections to the Distributed Bouncer Cache
DBCRequestTimeout Write UInt32 Request timeout for the Distributed Bouncer Cache
DDBFCChannelOpenTimeOut Write UInt32 Channel timeout for the Distributed Db Level Failover Cache (SP2019 and above)
DDBFCMaxConnectionsToServer Write UInt32 Maximum number of connections to the Distributed Db Level Failover Cache (SP2019 and above)
DDBFCRequestTimeout Write UInt32 Request timeout for the Distributed Db Level Failover Cache (SP2019 and above)
DDCChannelOpenTimeOut Write UInt32 Channel timeout for the Distributed Default Cache
DDCMaxConnectionsToServer Write UInt32 Maximum number of connections to the Distributed Default Cache
DDCRequestTimeout Write UInt32 Request timeout for the Distributed Default Cache
DEHCChannelOpenTimeOut Write UInt32 Channel timeout for the Distributed Edge Header Cache (SP2019 and above)
DEHCMaxConnectionsToServer Write UInt32 Maximum number of connections to the Distributed Edge Header Cache (SP2019 and above)
DEHCRequestTimeout Write UInt32 Request timeout for the Distributed Edge Header Cache (SP2019 and above)
DFLTCChannelOpenTimeOut Write UInt32 Channel timeout for the Distributed File Lock Throttler Cache (SP2016 and above)
DFLTCMaxConnectionsToServer Write UInt32 Maximum number of connections to the Distributed File Lock Throttler Cache (SP2016 and above)
DFLTCRequestTimeout Write UInt32 Request timeout for the Distributed File Lock Throttler Cache (SP2016 and above)
DFSPTCChannelOpenTimeOut Write UInt32 Channel timeout for the Distributed File Store Performance Trace Cache (SP2019 and above)
DFSPTCMaxConnectionsToServer Write UInt32 Maximum number of connections to the Distributed File Store Performance Trace Cache (SP2019 and above)
DFSPTCRequestTimeout Write UInt32 Request timeout for the Distributed File Store Performance Trace Cache (SP2019 and above)
DHSCChannelOpenTimeOut Write UInt32 Channel timeout for the Distributed Health Score Cache (SP2016 and above)
DHSCMaxConnectionsToServer Write UInt32 Maximum number of connections to the Distributed Health Score Cache (SP2016 and above)
DHSCRequestTimeout Write UInt32 Request timeout for the Distributed Health Score Cache (SP2016 and above)
DLTCChannelOpenTimeOut Write UInt32 Channel timeout for the Distributed Logon Token Cache
DLTCMaxConnectionsToServer Write UInt32 Maximum number of connections to the Distributed Logon Token Cache
DLTCRequestTimeout Write UInt32 Request timeout for the Distributed Logon Token Cache
DRTCChannelOpenTimeOut Write UInt32 Channel timeout for the Distributed Resource Tally Cache (SP2016 and above)
DRTCMaxConnectionsToServer Write UInt32 Maximum number of connections to the Distributed Resource Tally Cache (SP2016 and above)
DRTCRequestTimeout Write UInt32 Request timeout for the Distributed Resource Tally Cache (SP2016 and above)
DSCChannelOpenTimeOut Write UInt32 Channel timeout for the Distributed Search Cache
DSCMaxConnectionsToServer Write UInt32 Maximum number of connections to the Distributed Search Cache
DSCRequestTimeout Write UInt32 Request timeout for the Distributed Search Cache
DSGCChannelOpenTimeOut Write UInt32 Channel timeout for the Distributed Stop Gap Cache (SP2019 and above)
DSGCMaxConnectionsToServer Write UInt32 Maximum number of connections to the Distributed Stop Gap Cache (SP2019 and above)
DSGCRequestTimeout Write UInt32 Request timeout for the Distributed Stop Gap Cache (SP2019 and above)
DSPABSCChannelOpenTimeOut Write UInt32 Channel timeout for the Distributed SP Abs Blob Cache (SP2019 and above)
DSPABSCMaxConnectionsToServer Write UInt32 Maximum number of connections to the Distributed SP Abs Blob Cache (SP2019 and above)
DSPABSCRequestTimeout Write UInt32 Request timeout for the Distributed SP Abs Blob Cache (SP2019 and above)
DSPCVCChannelOpenTimeOut Write UInt32 Channel timeout for the Distributed SP Certificate Validator Cache (SP2019 and above)
DSPCVCMaxConnectionsToServer Write UInt32 Maximum number of connections to the Distributed SP Certificate Validator Cache (SP2019 and above)
DSPCVCRequestTimeout Write UInt32 Request timeout for the Distributed SP Certificate Validator Cache (SP2019 and above)
DSPOATCChannelOpenTimeOut Write UInt32 Channel timeout for the Distributed SP OAuth Token Cache (SP2019 and above)
DSPOATCMaxConnectionsToServer Write UInt32 Maximum number of connections to the Distributed SP OAuth Token Cache (SP2019 and above)
DSPOATCRequestTimeout Write UInt32 Request timeout for the Distributed SP OAuth Token Cache (SP2019 and above)
DSTACChannelOpenTimeOut Write UInt32 Channel timeout for the Distributed Server to Application Server Cache
DSTACMaxConnectionsToServer Write UInt32 Maximum number of connections to the Distributed Server to Application Server Cache
DSTACRequestTimeout Write UInt32 Request timeout for the Distributed Server to Application Server Cache
DSWUCChannelOpenTimeOut Write UInt32 Channel timeout for the Distributed Shared With User Cache (SP2016 and above)
DSWUCMaxConnectionsToServer Write UInt32 Maximum number of connections to the Distributed Shared With User Cache (SP2016 and above)
DSWUCRequestTimeout Write UInt32 Request timeout for the Distributed Shared With User Cache (SP2016 and above)
DTCChannelOpenTimeOut Write UInt32 Channel timeout for the Distributed Security Trimming Cache
DTCMaxConnectionsToServer Write UInt32 Maximum number of connections to the Distributed Security Trimming Cache
DTCRequestTimeout Write UInt32 Request timeout for the Distributed Security Trimming Cache
DUACChannelOpenTimeOut Write UInt32 Channel timeout for the Distributed Unified Apps Cache (SP2019 and above)
DUACMaxConnectionsToServer Write UInt32 Maximum number of connections to the Distributed Unified Apps Cache (SP2019 and above)
DUACRequestTimeout Write UInt32 Request timeout for the Distributed Unified Apps Cache (SP2019 and above)
DUAuCChannelOpenTimeOut Write UInt32 Channel timeout for the Distributed Unified Audit Cache (SP2019 and above)
DUAuCMaxConnectionsToServer Write UInt32 Maximum number of connections to the Distributed Unified Audit Cache (SP2019 and above)
DUAuCRequestTimeout Write UInt32 Request timeout for the Distributed Unified Audit Cache (SP2019 and above)
DUGCChannelOpenTimeOut Write UInt32 Channel timeout for the Distributed Unified Groups Cache (SP2016 and above)
DUGCMaxConnectionsToServer Write UInt32 Maximum number of connections to the Distributed Unified Groups Cache (SP2016 and above)
DUGCRequestTimeout Write UInt32 Request timeout for the Distributed Unified Groups Cache (SP2016 and above)
DVSCChannelOpenTimeOut Write UInt32 Channel timeout for the Distributed View State Cache
DVSCMaxConnectionsToServer Write UInt32 Maximum number of connections to the Distributed View State Cache
DVSCRequestTimeout Write UInt32 Request timeout for the Distributed View State Cache

Description

Type: Distributed Requires CredSSP: No

This resource is responsible for configuring the distributed cache client settings. It only accepts Ensure='Present' as a key. The resource can configure the following cache components:

  • All SharePoint versions:
    • DistributedLogonTokenCache
    • DistributedViewStateCache
    • DistributedAccessCache
    • DistributedActivityFeedCache
    • DistributedActivityFeedLMTCache
    • DistributedBouncerCache
    • DistributedDefaultCache
    • DistributedSearchCache
    • DistributedSecurityTrimmingCache
    • DistributedServerToAppServerAccessTokenCache.
  • SharePoint 2016 and above
    • DistributedFileLockThrottlerCache
    • DistributedSharedWithUserCache
    • DistributedUnifiedGroupsCache
    • DistributedResourceTallyCache
    • DistributedHealthScoreCache
  • SharePoint 2019 and above
    • DistributedDbLevelFailoverCache
    • DistributedEdgeHeaderCache
    • DistributedFileStorePerformanceTraceCache
    • DistributedSPAbsBlobCache
    • DistributedSPCertificateValidatorCache
    • DistributedSPOAuthTokenCache
    • DistributedStopgapCache
    • DistributedUnifiedAppsCache
    • DistributedUnifiedAuditCache

More information: https://learn.microsoft.com/en-us/sharepoint/administration/manage-the-distributed-cache-service

Examples

Example 1

This example configures the distributed cache client settings.

Configuration Example
{
    param
    (
        [Parameter(Mandatory = $true)]
        [PSCredential]
        $SetupAccount
    )

    Import-DscResource -ModuleName SharePointDsc

    node localhost
    {
        SPDistributedCacheClientSettings Settings
        {
            IsSingleInstance            = "Yes"
            DLTCMaxConnectionsToServer  = 3
            DLTCRequestTimeout          = 1000
            DLTCChannelOpenTimeOut      = 1000
            DVSCMaxConnectionsToServer  = 3
            DVSCRequestTimeout          = 1000
            DVSCChannelOpenTimeOut      = 1000
            DACMaxConnectionsToServer   = 3
            DACRequestTimeout           = 1000
            DACChannelOpenTimeOut       = 1000
            DAFMaxConnectionsToServer   = 3
            DAFRequestTimeout           = 1000
            DAFChannelOpenTimeOut       = 1000
            DAFCMaxConnectionsToServer  = 3
            DAFCRequestTimeout          = 1000
            DAFCChannelOpenTimeOut      = 1000
            DBCMaxConnectionsToServer   = 3
            DBCRequestTimeout           = 1000
            DBCChannelOpenTimeOut       = 1000
            DDCMaxConnectionsToServer   = 3
            DDCRequestTimeout           = 1000
            DDCChannelOpenTimeOut       = 1000
            DSCMaxConnectionsToServer   = 3
            DSCRequestTimeout           = 1000
            DSCChannelOpenTimeOut       = 1000
            DTCMaxConnectionsToServer   = 3
            DTCRequestTimeout           = 1000
            DTCChannelOpenTimeOut       = 1000
            DSTACMaxConnectionsToServer = 3
            DSTACRequestTimeout         = 1000
            DSTACChannelOpenTimeOut     = 1000
            PsDscRunAscredential        = $SetupAccount
        }
    }
}

Example 2

This example configures the distributed cache client settings in SharePoint 2016.

Configuration Example
{
    param
    (
        [Parameter(Mandatory = $true)]
        [PSCredential]
        $SetupAccount
    )

    Import-DscResource -ModuleName SharePointDsc

    node localhost
    {
        SPDistributedCacheClientSettings Settings
        {
            IsSingleInstance            = "Yes"
            DLTCMaxConnectionsToServer  = 3
            DLTCRequestTimeout          = 1000
            DLTCChannelOpenTimeOut      = 1000
            DVSCMaxConnectionsToServer  = 3
            DVSCRequestTimeout          = 1000
            DVSCChannelOpenTimeOut      = 1000
            DACMaxConnectionsToServer   = 3
            DACRequestTimeout           = 1000
            DACChannelOpenTimeOut       = 1000
            DAFMaxConnectionsToServer   = 3
            DAFRequestTimeout           = 1000
            DAFChannelOpenTimeOut       = 1000
            DAFCMaxConnectionsToServer  = 3
            DAFCRequestTimeout          = 1000
            DAFCChannelOpenTimeOut      = 1000
            DBCMaxConnectionsToServer   = 3
            DBCRequestTimeout           = 1000
            DBCChannelOpenTimeOut       = 1000
            DDCMaxConnectionsToServer   = 3
            DDCRequestTimeout           = 1000
            DDCChannelOpenTimeOut       = 1000
            DSCMaxConnectionsToServer   = 3
            DSCRequestTimeout           = 1000
            DSCChannelOpenTimeOut       = 1000
            DTCMaxConnectionsToServer   = 3
            DTCRequestTimeout           = 1000
            DTCChannelOpenTimeOut       = 1000
            DSTACMaxConnectionsToServer = 3
            DSTACRequestTimeout         = 1000
            DSTACChannelOpenTimeOut     = 1000
            DFLTCMaxConnectionsToServer = 3
            DFLTCRequestTimeout         = 1000
            DFLTCChannelOpenTimeOut     = 1000
            DSWUCMaxConnectionsToServer = 3
            DSWUCRequestTimeout         = 1000
            DSWUCChannelOpenTimeOut     = 1000
            DUGCMaxConnectionsToServer  = 3
            DUGCRequestTimeout          = 1000
            DUGCChannelOpenTimeOut      = 1000
            DRTCMaxConnectionsToServer  = 3
            DRTCRequestTimeout          = 1000
            DRTCChannelOpenTimeOut      = 1000
            DHSCMaxConnectionsToServer  = 3
            DHSCRequestTimeout          = 1000
            DHSCChannelOpenTimeOut      = 1000
            PsDscRunAscredential        = $SetupAccount
        }
    }
}

Example 3

This example configures the distributed cache client settings in SharePoint 2019.

Configuration Example
{
    param
    (
        [Parameter(Mandatory = $true)]
        [PSCredential]
        $SetupAccount
    )

    Import-DscResource -ModuleName SharePointDsc

    node localhost
    {
        SPDistributedCacheClientSettings Settings
        {
            IsSingleInstance              = "Yes"
            DLTCMaxConnectionsToServer    = 3
            DLTCRequestTimeout            = 1000
            DLTCChannelOpenTimeOut        = 1000
            DVSCMaxConnectionsToServer    = 3
            DVSCRequestTimeout            = 1000
            DVSCChannelOpenTimeOut        = 1000
            DACMaxConnectionsToServer     = 3
            DACRequestTimeout             = 1000
            DACChannelOpenTimeOut         = 1000
            DAFMaxConnectionsToServer     = 3
            DAFRequestTimeout             = 1000
            DAFChannelOpenTimeOut         = 1000
            DAFCMaxConnectionsToServer    = 3
            DAFCRequestTimeout            = 1000
            DAFCChannelOpenTimeOut        = 1000
            DBCMaxConnectionsToServer     = 3
            DBCRequestTimeout             = 1000
            DBCChannelOpenTimeOut         = 1000
            DDCMaxConnectionsToServer     = 3
            DDCRequestTimeout             = 1000
            DDCChannelOpenTimeOut         = 1000
            DSCMaxConnectionsToServer     = 3
            DSCRequestTimeout             = 1000
            DSCChannelOpenTimeOut         = 1000
            DTCMaxConnectionsToServer     = 3
            DTCRequestTimeout             = 1000
            DTCChannelOpenTimeOut         = 1000
            DSTACMaxConnectionsToServer   = 3
            DSTACRequestTimeout           = 1000
            DSTACChannelOpenTimeOut       = 1000
            DFLTCMaxConnectionsToServer   = 3
            DFLTCRequestTimeout           = 1000
            DFLTCChannelOpenTimeOut       = 1000
            DSWUCMaxConnectionsToServer   = 3
            DSWUCRequestTimeout           = 1000
            DSWUCChannelOpenTimeOut       = 1000
            DUGCMaxConnectionsToServer    = 3
            DUGCRequestTimeout            = 1000
            DUGCChannelOpenTimeOut        = 1000
            DRTCMaxConnectionsToServer    = 3
            DRTCRequestTimeout            = 1000
            DRTCChannelOpenTimeOut        = 1000
            DHSCMaxConnectionsToServer    = 3
            DHSCRequestTimeout            = 1000
            DHSCChannelOpenTimeOut        = 1000
            DDBFCMaxConnectionsToServer   = 1
            DDBFCRequestTimeout           = 3000
            DDBFCChannelOpenTimeOut       = 3000
            DEHCMaxConnectionsToServer    = 1
            DEHCRequestTimeout            = 3000
            DEHCChannelOpenTimeOut        = 3000
            DFSPTCMaxConnectionsToServer  = 1
            DFSPTCRequestTimeout          = 3000
            DFSPTCChannelOpenTimeOut      = 3000
            DSPABSCMaxConnectionsToServer = 1
            DSPABSCRequestTimeout         = 3000
            DSPABSCChannelOpenTimeOut     = 3000
            DSPCVCMaxConnectionsToServer  = 1
            DSPCVCRequestTimeout          = 3000
            DSPCVCChannelOpenTimeOut      = 3000
            DSPOATCMaxConnectionsToServer = 1
            DSPOATCRequestTimeout         = 3000
            DSPOATCChannelOpenTimeOut     = 3000
            DSGCMaxConnectionsToServer    = 1
            DSGCRequestTimeout            = 3000
            DSGCChannelOpenTimeOut        = 3000
            DUACMaxConnectionsToServer    = 1
            DUACRequestTimeout            = 3000
            DUACChannelOpenTimeOut        = 3000
            DUAuCMaxConnectionsToServer   = 1
            DUAuCRequestTimeout           = 3000
            DUAuCChannelOpenTimeOut       = 3000
            PsDscRunAscredential          = $SetupAccount
        }
    }
}

SharePointDSC

SharePointDsc Module

Clone this wiki locally