New-ClientCache - PowerShell Cmdlet

This PowerShell cmdlet enables the user to create a new Client Cache on the specified server. The user can specify the eviction policy, type of Client Cache i.e., Full-Data or Regular, and create InProc or OutProc cache as part of this PowerShell cmdlet.

Note

This feature is only available in NCache Enterprise.

New-ClientCache -CacheName -ClientNode [-Size] [-Type] [-CleanupInterval] [-ClientCacheName] [-DefaultPriority] [-EvictionPolicy] [-InProc] [-NoLogo] [-Optimistic] [-Path] [-Port] [-EvictionRatio] -Server [-UpdateServerConfig] [-FailQueryOnPartialDataset] [-DisableL2FallbackOnMiss] [-Credentials]

Examples of New-ClientCache - PowerShell Cmdlet

  • This command creates a Regular Client Cache named demoClientCache on client node 20.200.20.12 for an already registered clustered cache on server 20.200.20.11 having size 1024 MB. If the Type parameter is not specified, a Regular Client Cache will be created by default.
New-ClientCache -CacheName demoCache -ClientCacheName demoClientCache -Server 20.200.20.11 -Size 1024 -ClientNode 20.200.20.12
  • This command creates a Full-Data Client Cache named demoClientCache on client node 20.200.20.12 for an already registered clustered cache on server 20.200.20.11 having size 1024 MB.
New-ClientCache -CacheName demoCache -ClientCacheName demoClientCache -Type FullData -Server 20.200.20.11 -Size 1024 -ClientNode 20.200.20.12
  • This command creates a Regular Client Cache named demoClientCache on client node 20.200.20.12 for an already registered clustered cache on server 20.200.20.11.
New-ClientCache -CacheName demoCache -ClientCacheName demoClientCache -Type Regular -Server 20.200.20.11 -ClientNode 20.200.20.12 -Path C:\config.xml
  • This command creates a Full-Data Client Cache named demoClientCache on the client node 20.200.20.12, linked to a clustered cache hosted on the server 20.200.20.11. The client cache is configured with 1024 MB of memory, and uses optimistic synchronization mode. The FailQueryOnPartialDataset switch parameter enforces Strict Query Enforcement and throws an exception if a query is executed on a partially loaded dataset, with no fallback to the clustered cache. The DisableL2FallbackOnMiss switch parameter enforces Strict Local Reads and returns a cache miss for any key not found in the client cache, without attempting to retrieve it from the clustered cache.
New-ClientCache -CacheName demoCache -ClientCacheName demoClientCache -Type FullData -Server 20.200.20.11 -Size 1024 -ClientNode 20.200.20.12 -Optimistic -FailQueryOnPartialDataset -DisableL2FallbackOnMiss
  • This command creates a Regular Client Cache named demoClientCache on client node 20.200.20.12 for an already registered clustered cache on server 20.200.20.11 having size 1024 MB for simple case using security credentials.
New-ClientCache -CacheName demoCache -ClientCacheName demoClientCache -Server 20.200.20.11 -Size 1024 -ClientNode 20.200.20.12 -Credentials (Get-Credential john_smith)

Properties

Note

The parameters with asterisk (*) on their names are the required parameters and the rest are optional.

Parameters Data Types Description Default Value
-cacheName* <String> Specifies the clustered cache name. A clustered cache must be specified for creating a Client Cache. -
-ClientNode* <String> Specifies a client node which is registered with the cluster cache. -
-Size <Long> Specifies the size of the cache that is allocated to the newly created Client Cache. 1024 MB
-Type <String> Specifies the type of the Client Cache. The possible values are:
  • Regular
  • FullData
    		•  Regular
    -CleanupInterval <Integer> Specifies the time interval (in seconds) after which the cache cleanup is called. 15 seconds
    -ClientCacheName* <String> Specifies the name or id of the new Client Cache to be created. -
    -DefaultPriority <String> If the eviction policy opted by the user is Priority based, this parameter specifies the default priority. Possible values are:
  • High
  • Above Normal
  • Normal
  • Below Normal
  • Low
    		•  Normal
    -EvictionPolicy <String> Specifies the eviction policy for cache items. Cached items will be cleared from the cache according to the specified policy, if the cache reaches its limit. Possible values are:
  • Priority
  • LFU
  • LRU
    		•  LRU
    -InProc <SwitchParameter> Specifies if the Client Cache needs to be InProc or OutProc. If not specified the Client Cache will be OutProc by default. OutProc
    -NoLogo <SwitchParameter> Suppresses display of the logo banner. False
    -Optimistic <SwitchParameter> Specifies optimistic Client Cache synchronization mode to be enabled. -
    -Path <String> Specifies the path of the cache configuration file which will be configured. -
    -Port <Integer> Specifies the server port where NCache Service is listening. 8250
    -EvictionRatio <Decimal> Specifies the eviction ratio (in percentage) for cache items. Cached items will be cleared from the cache according to the specified ratio if the cache reaches its limit. 5%
    -Server* <String> Specifies the clustered cache that the client cache is associated with. -
    -UpdateServerConfig <SwitchParameter> Specifies whether to update the client-node sections of server node of the specified cluster in the configuration (config) file. It is useful when cluster nodes and client nodes are in different networks. True
    -FailQueryOnPartialDataset <SwitchParameter> Throws an exception when querying a partially loaded dataset in the Full-Data Client Cache, with no fallback to the clustered cache. -
    -DisableL2FallbackOnMiss <SwitchParameter> Returns a cache miss for any key not found in the Client Cache, with no fallback to the clustered cache. -
    -Credentials <pscredential> Specifies the user credentials used to authorize the user for this operation. It is required in case security is enabled on cache server. The password must be the same as the active directory user password. The user id must be the same as the active directory userid. -