Invoke Refresher Dataset

Note

This feature is only available in NCache Enterprise.

This enables the user to refresh a pre-configured dataset at runtime. The dataset is refreshed based on the RefreshPreference. However, if all the nodes are busy refreshing other datasets, then the new datasets are refreshed in the refresh interval when any node is free.

Windows PowerShell
Linux CLI

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

Examples

The following 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 load only dataset, its preference will be treated as same as RefreshNow

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

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.	-
`-Port`	`<Integer>`	Specifies the server port where NCache Service is listening.	8250
`-Server`	`<String>`	Specifies the NCache server name where the NCache Service is running.	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 who has appropriate permissions at the node.	-
`-NoLogo`	`<SwitchParameter>`	Suppresses display of the logo banner.	False
`-RefreshPreference*`	`<String>`	Specifies whether to refresh the dataset immediately or anytime within next 24 hours. Possible values are: RefreshNow RefreshOnNextTimeOfDay	-

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

Examples

The following 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 load only dataset, its preference will be treated as same as RefreshNow

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

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.	-
`-port`	`<Integer>`	Specifies the server port where NCache Service is listening.	8250
`-server`	`<String>`	Specifies the NCache server name where the NCache Service is running.	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.	-
`-nologo`	`<SwitchParameter>`	Suppresses display of the logo banner.	False
`-refreshpreference*`	`<String>`	Specifies whether to refresh the dataset immediately or anytime within next 24 hours. Possible values are: RefreshNow RefreshOnNextTimeOfDay	-