PowerShell Reference

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

In this Section

NCache PowerShell Cmdlets in Different Editions
Explains which Cmdlets/Tools are supported in which version of NCache.

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

Add-BackingSource
Discusses how to add backing source using Command Line.

Add-BridgeCache
Discusses how to add a clustered cache to a registered bridge.

Add-BridgeNode
Discusses how to add a bridge server node to a registered bridge.

Add-ClientNode
Discusses how to add a client node to a cache.

Add-ClientNodeSecurity
Discusses how to add client node security.

Add-CompactType
Discusses how to add compact serialization to the cache.

Add-CustomDependency
Discusses how to add custom dependency.

Add-LoaderDataset
Discusses how to add a loader dataset.

Add-MapReduce [Deprecated]
Discusses how to configure MapReduce on a cache.

Add-NCacheUserOrGroup
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-PortableType
Discusses how to enable data sharing for different classes.

Add-QueryIndex
Discusses how to add query indexes for the objects to be added in a cache.

Add-StartupLoader
Discusses how to configure startup loader provider for a cache.

Add-TestData
Discusses how to add some test data to a cache.

Clear-Cache
Discusses how to clear a cache.

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

Disable-NCacheTLS
Discusses how to disable TLS encryption on specified nodes.

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

Enable-NCacheTLS
Discusses how to enable TLS encryption on specified nodes.

Export-CacheConfiguration
Discusses how to export the cache configuration to the specified path.

Export-CacheData
Discuesses how to export cache data to the specified path.

Export-CacheKeys
Discusses how to export the cache keys to the specified path.

Get-CacheClientStatistics
Discusses how to fetch the client statistics for a specified cache.

Get-CacheCount
Discusses how to get the total cache count of a particular cache.

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

Get-CacheLogsList
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-CacheServerStatistics
Discusses how to fetch the server statistics for a specified cache.

Get-ClusterHealth
Discusses how to display the cluster health of a specific cache.

Get-ConnectedClients
Discusses how to list connected clients for server based licensing.

Get-MemoryDumpList
Discusses how to get a list of all memory dumps generated on a server.

Get-NCacheVersion
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-CacheData
Discusses how to get the cache data from the backup.

Import-DistributedLuceneIndex
Discusses how to get the distributed lucene index.

Import-LuceneIndex
Discusses how to get the lucene index.

Install-Module
Discusses how to deploy provider assemblies.

Invoke-RefresherDataset
Discusses how to enable refresher dataset.

Invoke-ServerLogger
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-ClientCache
Discusses how to create a new client cache.

New-MemoryDump
Discusses how to generate a memory dump on a server for a cache or process.

Register-NCache
Discusses activation/reactivation of NCache license.

Register-NCacheEvaluation
Discusses registration of NCache evaluation.

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

Remove-Bridge
Discusses how to remove an already registered bridge.

Remove-BridgeCache
Discusses how to remove an existing clustered cache from a registered bridge.

Remove-BridgeNode
Discusses how to remove an existing bridge server node from a registered bridge.

Remove-Cache
Discusses how to remove an already existing cache.

Remove-ClientCache
Discusses how to remove an already existing client cache.

Remove-ClientNode
Discusses how to remove client node(s) from a cluster.

Remove-CompactType
Discusses how to remove serializable objects.

Remove-CustomDependency
Discusses how to remove custom dependency.

Remove-LoaderDataset
Discusses how to remove a loader dataset.

Remove-MemoryDump
Discusses how to delete a memory dump file generated on a server.

Remove-NCacheUserOrGroup
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-PortableType
Discusses how to remove data sharing.

Remove-QueryIndex
Discusses how to remove query indexes for objects to be added in the cache.

Remove-StartupLoader
Discusses how to remove a preconfigured startup loader provider for a cache.

Resume-NCacheDataPersistence
Discusses how to resume NCache data persistence for a cache.

Set-BridgeCacheMode
Discusses how to start a bridge on a server.

Set-CacheConfiguration
Discusses how to configure a cache on a server.

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

Start-BridgeStateTransfer
Discusses how to manually start the state transfer process from a source to target cache on bridge.

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

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

Start-NCachePlaygroundProcess
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-NCacheManagementCenter
Explains how to stop the NCache Management Center.

Stop-NCachePlaygroundProcess
Explains how to stop the NCache Playground.

Suspend-CacheDataPersistence
Explains how to suspend the NCache data persistence.

Test-Stress
Discusses how to simulate stress to test NCache performance.

Unregister-NCache
Discusses the deactivation of NCache licenses.