Update-ClientCache

The Update-ClientCache cmdlet updates the Client Cache configuration associated with an existing cache. It can be used to enable or disable the Client Cache, configure eviction, change its maximum size and client polling interval, and update supported Full-Data Client Cache settings. Parameters that are not specified retain their existing values.

Note

Enabling or disabling the Client Cache and changing its maximum size are applied at runtime.

Update-ClientCache -CacheName [-EnableClientCache] `
                   [-Eviction] [-Size] `
                   [-ClientPollingInterval] [-FailQueryOnPartialDataset] `
                   [-DisableL2FallbackOnMiss] [-DataReloadThreshold] `
                   [-Server] [-Port] `
                   [-TlsCertPath] [-TlsCertPassword] `
                   [-Credentials] [-NoLogo]

Examples

This command changes the maximum size of the Client Cache configured for defaultCache to 512 MB.

Update-ClientCache -CacheName defaultCache -Size 512

This command disables eviction and sets the client polling interval to 30 seconds.

Update-ClientCache -CacheName defaultCache `
                   -Eviction false -ClientPollingInterval 30

This command disables the Client Cache configured for defaultCache on server 20.200.20.11.

Update-ClientCache -CacheName defaultCache `
                   -EnableClientCache false -Server 20.200.20.11

This command enables the Client Cache configured for defaultCache on server 20.200.20.11 using security credentials.

Update-ClientCache -CacheName defaultCache `
                   -EnableClientCache true -Server 20.200.20.11 `
                   -Credentials(Get-Credential john_smith)

This command disables the Client Cache configured for defaultCache on server 20.200.20.11 using a client PEM certificate and password for mutual TLS (mTLS) authentication.

Update-ClientCache -CacheName defaultCache -Enable false `
                   -Server 20.200.20.11 -TlsCertPath "C:\certs\client.pem" `
                   -TlsCertPassword "clientKeyPassword"

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 name of the clustered cache for which the Client Cache is configured.	-
`-EnableClientCache`	`<String>`	Specifies whether the configured Client Cache is enabled (true) or disabled (false). This change is applied at runtime.	-
`-Eviction`	`<String>`	Specifies whether eviction is enabled (`true`) or disabled (`false`) for a Regular Client Cache. Eviction is always enabled for a Full-Data Client Cache.	-
`-Size`	`<Long>`	Specifies the maximum size of the Client Cache in MB.	-
`-ClientPollingInterval`	`<Integer>`	Specifies the interval, in seconds, at which the Client Cache polls the clustered cache for changes.	-
`-FailQueryOnPartialDataset`	`<SwitchParameter>`	Throws an exception when querying a partially loaded dataset in the Full-Data Client Cache, with no fallback to the clustered cache.	False
`-DisableL2FallbackOnMiss`	`<SwitchParameter>`	Full-Data only. Prevents fallback to the clustered cache when an item from a reference dataset is not found in the Client Cache.	False
`-DataReloadThreshold`	`<Integer>`	Specifies the minimum percentage of free Client Cache capacity required before NCache attempts to reload evicted reference data. This parameter applies only to Full-Data Client Cache.	20
`-Server`	`<String>`	Specifies a server name where the NCache Service is running and a cache with the specified cache-name is registered.	IP of local machine
`-Port`	`<Integer>`	Specifies the server port where NCache Service is listening.	9803
`-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 user id.	-
`-TlsCertPath`	`<String>`	Specifies the path to a client PEM certificate for mTLS authentication. The PEM file must contain the private key, leaf certificate, and any intermediate certificates. This is required when running the PowerShell module from a machine without NCache installed and connecting to a server that requires mTLS. On an NCache server installation, the node's own certificate is used automatically. Relative paths are resolved from the current PowerShell location. A certificate can be generated using `New-NCacheTlsCertificate`.	-
`-TlsCertPassword`	`<String>`	Specifies the password for the encrypted private key in the PEM file provided through `-TlsCertPath`. Omit this parameter if the private key is not encrypted. The password is used only for the current command and is not saved in the NCache server configuration.	-
`-NoLogo`	`<SwitchParameter>`	Suppresses display of the logo banner.	False

Update-ClientCache

Note

Examples

Properties

Note

Contact Us