Command-Line Reference

NCache provides integration with various Command-Line Tools to easily automate its administrative processes. This guide briefly explains how to use them.

In this Section

PowerShell on Windows
Explains what is necessary to set up a PowerShell environment for using NCache.

Add Backing Source
Discusses how to add backing source using Command Line.

Add Bridge Cache
Discusses how to add a clustered cache to a registered bridge.

Add Bridge Node
Discusses how to add a bridge server node to a registered bridge.

Add Client Node
Discusses how to add a client node to a cache.

Add Client Node Security
Discusses how to add client node security.

Add Compact Type
Discusses how to add compact serialization to the cache.

Add Custom Dependency
Discusses how to add custom dependency.

Add Loader Dataset
Discusses how to add a loader dataset.

Add MapReduce
Discusses how to configure MapReduce on a cache.

Add NCache User Or Group
Discusses how to add a user or group to the NCache security configuration.

Add Node
Discusses how to add a server node to an existing cache.

Add Portable Type
Discusses how to enable data sharing for different classes.

Add Query Index
Discusses how to add query indexes for the objects to be added in the cache.

Add Startup Loader
Discusses how to configure startup loader provider for the cache.

Add Test Data
Discusses how to add some test data to the cache.

Clear Cache
Discusses how to clear the cache.

Disable NCache Security
Discusses how to disable NCache security on the specified server.

Disable NCache TLS
Discusses how to disable TLS encryption on specified nodes.

Enable NCache Security
Discusses how to enable NCache security on the specified server.

Enable NCache TLS
Discusses how to enable TLS encryption on specified nodes.

Export Cache Configuration
Discusses how to export the cache configuration to the specified path.

Export Cache Data
Discuesses how to export cache data to the specified path.

Export Cache Keys
Discusses how to export the cache keys to the specified path.

Get Cache Client Statistics
Discusses how to fetch the client statistics for a specified cache.

Get Cache Count
Discusses how to get the total cache count of a particular cache.

Get Cache Logs
Discusses how to fetch particular log file(s) from NCache repository to the local machine.

Get Cache Logs List
Discusses how to get a list of cache logs for a particular cache.

Get Caches
Discusses how to get the total number of caches registered on a server.

Get Cache Server Statistics
Discusses how to fetch the server statistics for a specified cache.

Get Cluster Health
Discusses how to display the cluster health of a specific cache.

Get Connected Clients
Discusses how to list connected clients for server based licensing.

Get Memory Dump List
Discusses how to get a list of all memory dumps generated on a server.

Get NCache Version
Discusses how to get the details about the NCache version installed.

Get Topics
Discusses how to get the list of all the topics registered on a cache.

Import Cache Data
Discusses how to get the cache data from the backup.

Import Distributed Lucene Index
Discusses how to get the distributed lucene index.

Import Lucene Index
Discusses how to get the lucene index.

Install Module
Discusses how to deploy provider assemblies.

Invoke Refresher Dataset
Discusses how to enable refresher dataset.

Invoke Server Logger
Discusses how to enable detailed logging.

New Bridge
Discusses how to create a new bridge.

New Cache
Discusses how to create a new cache.

New Client Cache
Discusses how to create a new client cache.

New Memory Dump
Discusses how to generate a memory dump on a server for a cache or process.

Remove Backing Source
Discusses how to remove preconfigured backing source providers.

Remove Bridge
Discusses how to remove an already registered bridge.

Remove Bridge Cache
Discusses how to remove an existing clustered cache from a registered bridge.

Remove Bridge Node
Discusses how to remove an existing bridge server node from a registered bridge.

Remove Cache
Discusses how to remove an already existing cache.

Remove Client Cache
Discusses how to remove an already existing client cache.

Remove Client Node
Discusses how to remove client node(s) from a cluster.

Remove Compact Type
Discusses how to remove serializable objects.

Remove Custom Dependency
Discusses how to remove custom dependency.

Remove Loader Dataset
Discusses how to remove a loader dataset.

Remove Memory Dump
Discusses how to delete a memory dump file generated on a server.

Remove NCache User Or Group
Discussed how to remove a user or group from the NCache security configuration.

Remove Node
Discusses how to remove a server node from a cache.

Remove Portable Type
Discusses how to remove data sharing.

Remove Query Index
Discusses how to remove query indexes for the objects to be added in the cache.

Remove Startup Loader
Discusses how to remove preconfigured startup loader provider for a cache.

Resume NCache Data Persistence
Discusses how to resume NCache data persistence for a cache.

Set Bridge Cache Mode
Discusses how to start a bridge on a server.

Set Cache Configuration
Discusses how to configure a cache on a server.

Start Bridge
Discusses how to start a bridge on a server.

Start Bridge State Transfer
Discusses how to manually start state transfer from source to target cache on bridge.

Start Cache
Discusses how to start a cache on a server.

Start NCache Management Center
Explains how to start the NCache Management Center.

Start NCache Playground Process
Explains how to start the NCache Playground.

Stop Bridge
Discusses how to stop a bridge on a server.

Stop Cache
Discusses how to stop a cache on a server.

Stop NCache Management Center
Explains how to stop the NCache Management Center.

Stop NCache Playground Process
Explains how to stop the NCache Playground.

Suspend Cache Data Persistence
Explains how to suspend the NCache data persistence.

Test Stress
Discusses how to monitor NCache performance under stress.

Unregister NCache
Discusses deactivation of NCache license.

Write Backing Source Config
Explains how to display the configuration for backing source implementation.

Write Query Index Config
Discusses how to display the configuration for query-indexing implementation.