Remove-LoaderDataset
Use the Remove-LoaderDataset cmdlet to manage the lifecycle of your automated data-loading logic. This command allows for the dynamic modification of the Startup Loader's dataset list, enabling administrators to retire obsolete or seasonal data-refresh routines without manual configuration file edits. This ensures your cache remains lean and its startup sequence remains deterministic as your application's data requirements evolve.
Remove-LoaderDataset -CacheName [-Port] `
[-Server] -Dataset `
[-TlsCertPath] [-TlsCertPassword] `
[-Credentials]
Examples
- This command removes a dataset order on local server where the Startup Cache Loader and Refresher are enabled.
Remove-LoaderDataset -CacheName defaultCache -Dataset "order"
- This command removes a dataset order from the cache named defaultCache existing on the server 20.200.20.11, where the Startup Cache Loader and Refresher are enabled.
Remove-LoaderDataset -CacheName defaultCache -Server 20.200.20.11 -Dataset "order"
- This command removes the order loader dataset from cache on the specified server with mutual TLS (mTLS) enabled. It runs from a machine where NCache is not installed and uses
C:\certs\client.pemto authenticate the machine running the cmdlet. The-TlsCertPasswordparameter decrypts the certificate’s password-protected private key. Omit this parameter if the private key is not encrypted.
Remove-LoaderDataset -CacheName cache -Server 20.200.20.11 `
-DataSet order -TlsCertPath "C:\certs\client.pem" `
-TlsCertPassword "clientKeyPassword"
- This command removes a dataset order on local server where the Startup Cache Loader and Refresher are enabled, using security credentials.
Remove-LoaderDataset -CacheName defaultCache -Dataset "order" `
-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. The dataset will be removed from this specific cache. NOTE: The cache must already exist on the source server. |
- |
-Port |
<Integer> |
Specifies the port on which NCache Service is listening. | 9800 |
-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 dataset that needs to be removed. | - |
-TlsCertPath |
<string> |
Specifies the path to the client PEM certificate used to authenticate this cmdlet when the target NCache server requires Mutual TLS. This parameter is required for Mutual TLS connections even when the cmdlet runs on an NCache server. The PEM file must contain the private key, leaf certificate, and any intermediate certificates. Relative paths are resolved against the current PowerShell location, and the file must exist. You can generate a client certificate using New-NCacheTlsCertificate. | - |
-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. |
- |
-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. | - |