What is the difference between RefreshNow and RefreshOnNextTimeOfDay?

RefreshNow initiates the refresh operation immediately. RefreshOnNextTimeOfDay defers the update to the dataset's next pre-configured scheduled time within the following 24 hours.

Is it necessary to stop the cache before invoking a dataset refresh?

No. The Invoke-RefresherDataset cmdlet is designed for runtime operations on active caches. The refresh process runs as a non-disruptive background task, allowing client applications to continue accessing data without interruption.

Why are administrative credentials required for this cmdlet?

If security is enabled on your NCache cluster, credentials ensure that only authorized administrators (using LDAP/AD accounts with dataset management rights) can trigger data synchronization tasks.

Invoke-RefresherDataset

This PowerShell cmdlet enables the user to refresh a pre-configured dataset in the cache at runtime, ensuring real-time data freshness and keeping cache data up to date with the backend. The dataset is refreshed according to the specified RefreshPreference, allowing either an immediate refresh (RefreshNow) or a scheduled refresh within the next configured time window (RefreshOnNextTimeOfDay).

Windows PowerShell
Linux CLI

Invoke-RefresherDataset -CacheName [-Port] [-Server] -Dataset [-RefreshPreference] [-Credentials] [-NoLogo]

Examples

This command refreshes the dataset product immediately on demoCache on server 20.200.20.11.

Invoke-RefresherDataset -CacheName demoCache -Server 20.200.20.11 -Dataset product -RefreshPreference RefreshNow

This command refreshes the dataset product at the configured time of the dataset on demoCache within the next 24 hours. If the specified dataset is a loader-only dataset, its refresh preference is treated the same as RefreshNow.

Invoke-RefresherDataset -CacheName demoCache -Server 20.200.20.11 -Dataset product -RefreshPreference RefreshOnNextTimeOfDay

This command refreshes the dataset product immediately on demoCache on server 20.200.20.11, using security credentials.

Invoke-RefresherDataset -CacheName demoCache -Server 20.200.20.11 -Dataset product -RefreshPreference RefreshNow -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 name of the cache registered on the server. Note: The cache must already exist on the source server.	-
`-Port`	`<Integer>`	Specifies the server port where NCache Service is listening.	8250
`-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
`-Dataset*`	`<String>`	Specifies the name of the pre-configured dataset registered on the cache.	-
`-Credentials`	`<pscredential>`	Specifies the user credentials required to authorize access for the specified operation. These credentials should belong to a user with the appropriate permissions at the node.	-
`-RefreshPreference`	`<String>`	Specifies whether to refresh the dataset immediately or anytime within next 24 hours. Possible values are: RefreshNow RefreshOnNextTimeOfDay	-
`-NoLogo`	`<SwitchParameter>`	Suppresses display of the logo banner.	False

invoke-refresherdataset -cachename [-port] [-server] -dataset [-refreshpreference] [-userid] [-password] [-nologo]

Examples

This command refreshes the dataset product immediately on demoCache on server 20.200.20.11.

invoke-refresherdataset -cachename demoCache -server 20.200.20.11 -dataset product -refreshpreference RefreshNow

This command refreshes the dataset product at the configured time of the dataset on demoCache within the next 24 hours. If the dataset specified will be a loader only dataset, its preference will be treated as same as RefreshNow.

invoke-refresherdataset -cachename demoCache -server 20.200.20.11 -dataset product -refreshpreference RefreshOnNextTimeOfDay

This command refreshes the dataset product immediately on demoCache on server 20.200.20.11, using security credentials.

invoke-refresherdataset -cachename demoCache -server 20.200.20.11 -dataset product -refreshpreference RefreshNow -userid john_smith -password pass123

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 cache registered on the server. Note: The cache must already exist on the source server.	-
`-port`	`<Integer>`	Specifies the server port where NCache Service is listening.	8250
`-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
`-dataset*`	`<String>`	Specifies the name of the pre-configured dataset registered on the cache.	-
`-userid`	`<String>`	Specifies the user id used to authorize the user for this operation. It is required in case security is enabled on Cache Server. This user id must be the active directory.	-
`-password`	`<String>`	Specifies the password of the user that is used to authorize the user for this operation. It is required in case security is enabled on Cache Server. This password must be the same as the active directory user password.	-
`-refreshpreference`	`<String>`	Specifies whether to refresh the dataset immediately or anytime within next 24 hours. Possible values are: RefreshNow RefreshOnNextTimeOfDay	-
`-nologo`	`<SwitchParameter>`	Suppresses display of the logo banner.	False

Invoke-RefresherDataset

Examples

Properties

Note

Contact Us