• Facebook
  • Twitter
  • Youtube
  • LinkedIn
  • RSS
  • Docs
  • Comparisons
  • Blogs
  • Try NCache
  • Contact Us
Try NCache
Show / Hide Table of Contents

Export-CacheData

The Export-CacheData PowerShell cmdlet creates a backup of all items currently present in the cache, and saves them to a specified local or network path. This cmdlet is useful for scenarios such as disaster recovery, data migration, and long-term data storage. It supports multi-server environments and allows you to control the file size of the backup (default is 5MB per file). The cmdlet is designed to handle errors gracefully, ensuring that the backup process is not interrupted. In order to restore the backed up data, use the Import-CacheData PowerShell cmdlet.

Export-CacheData -Name [-ErrorThreshold] `
                  [-FileSize] [-Server] `
                  -Path [-Credentials] `
                  [-TlsCertPath] [-TlsCertPassword] `
                  [-NoLogo]

Examples

  • This command backs up all the keys currently present in the cache.
Export-CacheData -Name defaultCache -Path C:\Backup-path
  • This command backs up all the keys currently present in the cache with a maximum of 2 MB data files.
Export-CacheData -Name defaultCache -Path C:\Backup-path `
                 -FileSize 2
  • This command backs up all the keys currently present in the cache on server 20.200.20.11.
Export-CacheData -Name defaultCache -Path C:\Backup-path `
                 -Server 20.200.20.11
  • This command backs up a cache configured with Pub/Sub Messaging as its store type. In addition to the cache items, it backs up all topics, their registered durable subscriptions, and the messages associated with each topic. The topic and message data is stored in the Topics and Messages folders within the backup.
Export-CacheData -Name pubSubCache -Path C:\Backup-path
  • This command exports data from defaultCache to C:\Backup-path on the specified server with mutual TLS (mTLS) enabled. It runs from a machine where NCache is not installed and uses C:\certs\client.pem to authenticate the machine running the cmdlet. The -TlsCertPassword parameter decrypts the certificate’s password-protected private key. Omit this parameter if the private key is not encrypted.
Export-CacheData -Name defaultCache -Path C:\Backup-path `
                 -Server 20.200.20.11 -TlsCertPath "C:\certs\client.pem" `
                 -TlsCertPassword "clientKeyPassword"
  • This command backs up all the keys currently present in the cache, using security credentials.
Export-CacheData -Name defaultCache -Path C:\Backup-path `
                 -Credentials(Get-Credential john_smith)

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 which has to be backed up.
NOTE: The cache must already exist on the source server.
-
-ErrorThreshold <Long> Specifies the number of errors that can be tolerated during exporting files to the backup. 1
-FileSize <Long> Specifies the maximum file size that can be generated during backup. 5MB
-Server <String> Specifies a server name where the NCache Service is running and a cache with the specified cache-name is registered. IP of local machine
-Path* <String> Specifies the path where the backup is to be created. -
-TlsCertPath <string> Specifies the path to the client PEM certificate used to authenticate this cmdlet when the target NCache server requires Mutual TLS. This parameter is required for Mutual TLS connections even when the cmdlet runs on an NCache server. The PEM file must contain the private key, leaf certificate, and any intermediate certificates. Relative paths are resolved against the current PowerShell location, and the file must exist. You can generate a client certificate using New-NCacheTlsCertificate. -
-TlsCertPassword <string> Password used to load the encrypted private key in the PEM file specified by -TlsCertPath. Required only when the private key is password-protected. Not needed for an unencrypted private key. The password is used only to load the client certificate for the current command's connections. It is not saved in the NCache server configuration. -
-Credentials <pscredential> Specifies the user credentials required to authorize access for the specified operation. These credentials should belong to a user with the appropriate permissions at the node. -
-NoLogo <SwitchParameter> Suppresses display of the logo banner. False

Contact Us

PHONE

+1 214-619-2601   (US)

+44 20 7993 8327   (UK)

 
EMAIL

sales@alachisoft.com

support@alachisoft.com

NCache
  • Edition Comparison
  • NCache Architecture
  • Benchmarks
Try NCache
Pricing
NCache Playground

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

  • EnglishChinese (Simplified)FrenchGermanItalianJapaneseKoreanPortugueseSpanish

  • Terms of Use
  •  
  • Privacy Policy
  •  
  • Cookie Policy
© Copyright Alachisoft 2002 - . All rights reserved. NCache is a registered trademark of Diyatech Corp.
  • Facebook
  • Twitter
  • Youtube
  • LinkedIn
  • RSS