• Products
  • Solutions
  • Customers
  • Resources
  • Company
  • Pricing
  • Download
Try Playground
  • Cache Management
  • Export-CacheConfiguration
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

Export-CacheConfiguration - PowerShell Cmdlet

This PowerShell Cmdlet enables the user to copy the configuration of the specified cache. The PowerShell Cmdlet also exports the deployed server-side modules on the given path.

Important

NCache OSS has different parameters in some Cmdlet instances.

  • Windows PowerShell
  • Linux CLI
Export-CacheConfiguration [-Name] -Path [-Server] [-Port] [-DoNotExportModule] [-NoLogo] [-Credentials]

Examples of Export-CacheConfiguration - PowerShell Cmdlet

  • This PowerShell Cmdlet generates the configuration file and exports the deployed server-side modules for the demoCache in the specified directory.
Export-CacheConfiguration -Name demoCache -Server 20.200.20.11 -Path C:\Desktop\config.xml
  • This command uses port to generate the configuration file and exports the deployed server-side modules for the demoCache in the specified directory.
Export-CacheConfiguration -Name demoCache -Server 20.200.20.11 -Path C:\Desktop\config.xml -Port 8250
  • This command only generates the complete configuration file for demoCache in the specified directory.
Export-CacheConfiguration -Name demoCache -Server 20.200.20.11 -Path C:\Desktop\config -DoNotExportModule

Properties

Note

The parameters with asterisk (*) on their names are the required parameters and the rest are optional.

Parameters Data Types Description Default Value
-Name <String> Specifies the name of the cache for which the configuration file is to be generated. -
-Path* <String> Specifies the path where the user wants the configuration file to be placed after generation. In case of no path provided the user will be prompted. -
-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
-DoNotExportModule <SwitchParameter> This switch omits the export of server-side modules, allowing users to customize cache configuration exports based on specific requirements. False
-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. -
export-cacheconfiguration [-name] -path [-server] [-port] [-donotexportmodule] [-nologo] [-userid] [-password]

Examples of Export-CacheConfiguration

  • This command generates the configuration file and exports the deployed server-side modules for the demoCache in specified directory.
export-cacheconfiguration -name demoCache -server 20.200.20.11 -path /usr/config.xml
  • This command uses port to generate the configuration file and exports the deployed server-side modules for the demoCache in specified directory.
export-cacheconfiguration -name demoCache -server 20.200.20.11 -path /usr/config.xml -port 8250
  • This command only generates the complete configuration file for demoCache in the specified directory.
export-cacheconfiguration -name demoCache -server 20.200.20.11 -path /usr/config.xml -donotexportmodule

Properties

Note

The parameters with asterisk (*) on their names are the required parameters and the rest are optional.

Parameters Data Types Description Default Value
-name <String> Specifies the name of the cache for which the configuration file is to be generated. -
-path* <String> Specifies the path where the user wants the configuration file to be placed after generation. In case of no path provided the user will be prompted. -
-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
-donotexportmodule <SwitchParameter> This switch omits the export of server-side modules, allowing users to customize cache configuration exports based on specific requirements. False
-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 user id. -
-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. -
In This Article
  • Examples of Export-CacheConfiguration - PowerShell Cmdlet
  • Properties
  • Examples of Export-CacheConfiguration
  • 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