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).

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

Examples

  • This command refreshes the dataset product immediately on defaultCache on server 20.200.20.11.
Invoke-RefresherDataset -CacheName defaultCache -Server 20.200.20.11 `
                        -Dataset product -RefreshPreference RefreshNow
  • This command refreshes the dataset product at the configured time of the dataset on defaultCache 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 defaultCache -Server 20.200.20.11 `
                        -Dataset product -RefreshPreference RefreshOnNextTimeOfDay
  • This command immediately refreshes the product dataset in defaultCache on the specified server with mutual TLS (mTLS) enabled. It runs from a machine where NCache is not installed and uses C:\certs\client.pem to authenticate the machine running the cmdlet. The -TlsCertPassword parameter decrypts the certificate’s password-protected private key. Omit this parameter if the private key is not encrypted.
Invoke-RefresherDataset -CacheName defaultCache -Server 20.200.20.11 `
                        -Dataset product -RefreshPreference RefreshNow `
                        -TlsCertPath "C:\certs\client.pem" -TlsCertPassword "clientKeyPassword"
  • This command refreshes the dataset product immediately on defaultCache on server 20.200.20.11, using security credentials.
Invoke-RefresherDataset -CacheName defaultCache -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. 9817
-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 the next 24 hours. Possible values are:
  1. RefreshNow
  2. RefreshOnNextTimeOfDay
-
-TlsCertPath <string> Path to the client PEM certificate used to authenticate the machine running the NCache PowerShell cmdlet when connecting to an NCache server with mutual TLS (mTLS) enabled. The PEM file must contain the private key, leaf certificate, and any intermediate certificates. You can generate a certificate using New-NCacheTlsCertificate. This parameter is required when running the PowerShell module from a machine where NCache is not installed and the server requires mTLS. On a machine with an NCache server installation, the node's own certificate is used automatically. Relative paths are resolved against the current PowerShell location, and the file must exist. To configure the certificate presented by the server, use -CustomCertificatePath. -
-TlsCertPassword <string> Password used to load the encrypted private key in the PEM file specified by -TlsCertPath. Required only when the private key is password-protected. Not needed for an unencrypted private key. The password is used only to load the client certificate for the current command's connections. It is not saved in the NCache server configuration. -
-NoLogo <SwitchParameter> Suppresses display of the logo banner. False