PowerShell Reference

NCache provides integration with Windows PowerShell to easily automate its administrative processes. This guide briefly explains how to use PowerShell tools for NCache.

In this Section

Setting Up PowerShell Environment
Explains the pre-requisites and the setting up of environment for using NCache with Windows PowerShell.

Install NCache PowerShell Module without NCache Installation
Explains how to install NCache PowerShell Module without any NCache installation to use configure and use NCache using PowerShell tools remotely.

Add-BackingSource
Discusses how to add backing source using Windows PowerShell.

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-CacheSecurity
Discusses how to add cache security using Windows PowerShell.

Add-ClientNodeSecurity
Discusses how to add client node security.

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

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

Add-MapReduce
Discusses how to configure MapReduce on a cache.

Add-NodeSecurity
Discusses how to add node security to a node.

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 the cache.

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

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

Clear-Cache
Discusses how to clear the cache.

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.

Install-Module
Discusses how to deploy provider assemblies.

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.

Unregister-NCache
Discusses deactivation of NCache license.

Remove-BackingSource
Discusses how to remove pre-configured 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-MemoryDump
Discusses how to delete a memory dump file generated on a server.

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 the objects to be added in the cache.

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

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

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

Start-BridgeStateTransfer
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-NCacheWebManagementProcess
Explains how to start the process for NCache Web Management.

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

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

Stop-NCacheWebManagementProcess
Explains how to stop the process for NCache Web Management.

Test-Stress
Discusses how to monitor NCache performance under stress.

Unregister-NCache
Explains how to deactivate the license keys for NCache installation, using Windows PowerShell.

Write-BackingSourceConfig
Explains how to display the configuration for backing source implementation.

Write-QueryIndexConfig
Discusses how to display the configuration for query-indexing implementation.