What does Export-CacheData do?

Export-CacheData creates a backup of the items currently present in an NCache cache and saves the backup to the specified path.

Which parameters are required for Export-CacheData?

The Name and Path parameters are required.

What is the default backup file size?

The default FileSize value is 5 MB.

What is the default ErrorThreshold?

The default ErrorThreshold value is 1.

Which server is used by default?

If Server is not specified, the IP address of the local machine is used.

Which cmdlet restores exported cache data?

Import-CacheData is used to restore the backed-up cache data.

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>`	Path to the client PEM certificate used to authenticate the machine running the NCache PowerShell cmdlet when connecting to an NCache server with mutual TLS (mTLS) enabled. The PEM file must contain the private key, leaf certificate, and any intermediate certificates. You can generate a certificate using `New-NCacheTlsCertificate`. This parameter is required when running the PowerShell module from a machine where NCache is not installed and the server requires mTLS. On a machine with an NCache server installation, the node's own certificate is used automatically. Relative paths are resolved against the current PowerShell location, and the file must exist. To configure the certificate presented by the server, use `-CustomCertificatePath`.	-
`-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

Export-CacheData

Examples

Properties

Note

Contact Us