New-NCAzClientCache

The New-NCAzClientCache PowerShell cmdlet creates a client cache linked to an existing clustered cache in the environment. It also saves the client cache information in the environment.

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

Example

• This command creates a Full-Data Client Cache named demoClientCache on client node 10.0.0.10 for an existing clustered cache demoCache on server 10.0.0.4 with a size of 1024 MB:

New-NCAzClientCache -EnvName Production -CacheName demoCache -ClientCacheName demoClientCache -Type FullData -Server 10.0.0.4 -Size 1024 -ClientNode 10.0.0.10

• This command creates a Regular Client Cache named demoClientCache on client node 10.0.0.10 for an existing clustered cache demoCache on server 10.0.0.4 with a size of 1024 MB:

New-NCAzClientCache -EnvName Production -CacheName demoCache -ClientCacheName demoClientCache -Type Regular -Server 10.0.0.4 -Size 1024 -ClientNode 10.0.0.10

Properties

Note

Parameters marked with an asterisk (*) are required. All others are optional.

Parameter	Data Type	Description	Default Value
-EnvName*	<String>	Name of the environment where the client cache is created.	-
-CacheName*	<String>	Name of the clustered cache to associate the client cache with. Must already exist on the source server.	-
-ClientCacheName*	<String>	Name or ID of the new client cache to be created.	-
-Server	<String>	Specifies the clustered cache server node.	-
-ClientNode	<String>	Specifies the client node registered with the clustered cache.	-
-Size	<Long>	Size allocated to the new client cache in MB.	1024
-Type	<String>	Type of client cache. Possible values: Regular, FullData.	Regular
-CleanupInterval	<Integer>	Time interval (in seconds) after which cache cleanup is performed.	15 seconds
-EvictionPolicy	<String>	Eviction policy for cache items. Possible values: Priority, LFU, LRU.	LRU
-EvictionRatio	<Decimal>	Eviction ratio (percentage) for cache items.	5%
-DefaultPriority	<String>	Default priority if eviction policy is Priority-based. Possible values: High, Above Normal, Normal, Below Normal, Low.	Normal
-InProc	<SwitchParameter>	Specifies whether the client cache is InProc (true) or OutProc (false).	OutProc
-Port	<Integer>	Server port where NCache Service is listening.	8250
-Optimistic	<SwitchParameter>	Enables optimistic client cache synchronization mode.	False
-DisableL2FallbackOnMiss	<SwitchParameter>	Returns a cache miss for any key not found in the client cache with no fallback to the clustered cache.	False
-FailQueryOnPartialDataset	<SwitchParameter>	Throws an exception when querying a partially loaded dataset in Full-Data Client Cache without fallback to clustered cache.	False
-UpdateServerConfig	<SwitchParameter>	Updates the client node sections of the server node config file. Useful when cluster and client nodes are on different networks.	True
-Credentials	<PSCredential>	User credentials authorizing this operation. Required if security is enabled on cache server.	-
-Path	<String>	Path to an existing exported cache configuration file.	-