• Products
  • Solutions
  • Customers
  • Resources
  • Company
  • Pricing
  • Download
Try Playground
  • Install-NCacheModule
Show / Hide Table of Contents
  • Command-Line Interface
  • Cmdlets in Different Editions
  • PowerShell on Windows
    • Setting Up PowerShell Environment
    • Install PowerShell without NCache Installation
  • Install-NCacheModule
  • Client Management
    • Add-ClientNode
    • Remove-ClientNode
    • Add-ClientNodeSecurity
  • Cache Management
    • New-Cache
    • Start-Cache
    • Stop-Cache
    • Set-CacheConfiguration
    • Export-CacheData
    • Export-CacheKeys
    • Export-CacheConfiguration
    • Get-CacheCount
    • Clear-Cache
    • Remove-Cache
    • Set-NCServiceConfigSetting
  • Client Cache
    • New-ClientCache
    • Add-ClientCacheRefDatatype
    • Remove-ClientCacheRefDatatype
    • Remove-ClientCache
  • Node Management
    • Add-Node
    • Remove-Node
  • Query Index
    • Add-QueryIndex
    • Remove-QueryIndex
  • Loader & Refresher
    • Add-LoaderDataSet
    • Invoke-RefresherDataset
    • Remove-LoaderDataSet
    • Add-StartupLoader
    • Remove-StartupLoader
  • DataSource Providers
    • Add-BackingSource
    • Remove-BackingSource
  • Custom Dependency
    • Add-CustomDependency
    • Remove-CustomDependency
  • Pub/Sub Messaging
    • Get-Topics
  • Bridge
    • New-Bridge
    • Add-BridgeNode
    • Add-BridgeCache
    • Start-Bridge
    • Set-BridgeCacheMode
    • Start-BridgeStateTransfer
    • Stop-Bridge
    • Remove-Bridge
    • Remove-BridgeCache
    • Remove-BridgeNode
  • Mapreduce
    • Add-MapReduce
  • Compact Serilaization
    • Add-CompactType
    • Add-PortableType
    • Remove-PortableType
    • Remove-CompactType
  • Security
    • Enable-NCacheSecurity
    • Add-NCacheUserOrGroup
    • Remove-NCacheUserOrGroup
    • Enable-NCacheTLS
    • Disable-NCacheTLS
    • Disable-NCacheSecurity
    • Enable-NCEncryption
    • Disable-NCEncryption
  • Data Persistence
    • Suspend-NCacheDataPersistence
    • Resume-NCacheDataPersistence
  • Monitoring
    • Get-Caches
    • Get-CacheLogs
    • Get-CacheLogsList
    • Get-ConnectedClients
    • Get-CacheClientStatistics
    • Get-CacheServerStatistics
    • Add-TestData
    • Test-Stress
    • Get-ClusterHealth
    • New-MemoryDump
    • Get-MemoryDumpList
    • Send-MemoryDump
    • Remove-MemoryDump
    • Measure-CachePerformance
    • Invoke-ServerLogger
    • Import-CacheData
  • Management Center
    • Start-NCacheManagementCenter
    • Stop-NCacheManagementCenter
    • Set-CacheServerPublicIP
  • NCache Playground
    • Start-NCachePlaygroundProcess
    • Stop-NCachePlaygroundProcess
  • NCache Registration
    • Register-NCache
    • Register-NCacheEvaluation
    • Unregister-NCache
    • Get-NCacheVersion

Install-NCacheModule - PowerShell Cmdlet

This PowerShell Cmdlet enables the user to deploy provider assemblies from the specified assembly path to the deployment folder named 'deploy' in NCache installed directory.

Note

This feature is only available in NCache Enterprise.

Note

Please note that when using the NCache Java Edition, you will require .jar libraries instead of .dll assemblies for this PowerShell Cmdlet.

  • Windows PowerShell
  • Linux CLI
Install-NCacheModule -AssemblyPath [-CacheName] [-NoLogo] [-Port] [-Server] [-Credentials] [-WriteToServiceConfig]

Examples of Install-NCacheModule - PowerShell Cmdlet

  • This PowerShell Cmdlet deploys the assembly for demoCache.
Install-NCacheModule -CacheName demoCache -AssemblyPath C:\Provider.dll
  • This command deploys the assembly for a cache named demoCache on server 20.200.20.11.
Install-NCacheModule -CacheName demoCache -AssemblyPath C:\Provider.dll –Server 20.200.20.11

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 for assembly deployment. -
-AssemblyPath* <String> Specifies the path of the assembly to be imported. -
-Server <String> Specifies the NCache server name or ip as per user requirement. -
-Port <Integer> Specifies the server port where NCache server is listening. 8250
-NoLogo <SwitchParameter> Suppresses display of the logo banner. False
-Credentials <pscredential> Specifies the user credentials required to authorize access for the specified operation. These credentials should belong to a user who has appropriate permissions at the node. -
-WriteToServiceConfig <SwitchParameter> Specifies whether to write to service configurations. -
install-ncachemodule -assemblypath [-cachename] [-nologo] [-port] [-server] [-userid] [-password] [-writetoserviceconfig]

Examples of Install-NCacheModule

  • This command deploys the assembly for demoCache.
install-ncachemodule -cachename demoCache -assemblypath /usr/Provider.jar
  • This command deploys the assembly for a cache named demoCache on server 20.200.20.11.
install-ncachemodule -cachename demoCache -assemblypath /usr/Provider.jar –server 20.200.20.11

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 for assembly deployment. -
-assemblypath* <String> Specifies the path of the assembly to be imported. -
-server <String> Specifies the NCache server name or ip as per user requirement. -
-port <Integer> Specifies the server port where NCache server is listening. 8250
-nologo <SwitchParameter> Suppresses display of the logo banner. False
-userid <String> Specifies the user id used to authorize the user for this operation. It is required in case security is enabled on Cache Server. This user id must be the active directory. -
-password <String> Specifies the password of the user that is used to authorize the user for this operation. It is required in case security is enabled on Cache Server. This password must be the same as the active directory user password. -
-writetoserviceconfig <SwitchParameter> Specifies whether to write to service configurations. -
In This Article
  • Examples of Install-NCacheModule - PowerShell Cmdlet
  • Properties
  • Examples of Install-NCacheModule
  • Properties

Contact Us

PHONE

+1 (214) 764-6933   (US)

+44 20 7993 8327   (UK)

 
EMAIL

sales@alachisoft.com

support@alachisoft.com

NCache
  • NCache Enterprise
  • NCache Professional
  • Edition Comparison
  • NCache Architecture
  • Benchmarks
Download
Pricing
Try Playground

Deployments
  • Cloud (SaaS & Software)
  • On-Premises
  • Kubernetes
  • Docker
Technical Use Cases
  • ASP.NET Sessions
  • ASP.NET Core Sessions
  • Pub/Sub Messaging
  • Real-Time ASP.NET SignalR
  • Internet of Things (IoT)
  • NoSQL Database
  • Stream Processing
  • Microservices
Resources
  • Magazine Articles
  • Third-Party Articles
  • Articles
  • Videos
  • Whitepapers
  • Shows
  • Talks
  • Blogs
  • Docs
Customer Case Studies
  • Testimonials
  • Customers
Support
  • Schedule a Demo
  • Forum (Google Groups)
  • Tips
Company
  • Leadership
  • Partners
  • News
  • Events
  • Careers
Contact Us

  • EnglishChinese (Simplified)FrenchGermanItalianJapaneseKoreanPortugueseSpanish

  • Contact Us
  •  
  • Sitemap
  •  
  • Terms of Use
  •  
  • Privacy Policy
© Copyright Alachisoft 2002 - 2025. All rights reserved. NCache is a registered trademark of Diyatech Corp.
Back to top