Where is the NCache backup saved?

The backup is saved to the location specified in the -Path parameter. This can be a local directory on the cache server or a shared network path. Ensure the NCache service account has sufficient write permissions to the destination.

When should I use the ErrorThreshold parameter?

Use -ErrorThreshold to provide fault tolerance during large data exports. It defines the number of individual item export failures the cmdlet can tolerate before the entire backup operation is aborted, which is essential for maintaining data integrity during unstable network conditions.

How does file size control work in NCache exports?

The -FileSize parameter allows you to specify the maximum size (in MB) for each generated backup file. This creates segmented data files, making it easier to manage storage, transfer backups over limited bandwidth, or move data across environments.

Can I export data from a specific server node?

Yes, by using the -Server parameter, you can target a specific node in a distributed NCache cluster. This is useful for segmented backups or performing node-level maintenance without affecting the entire cluster.

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 Cache Data PowerShell cmdlet.

Windows PowerShell
Linux CLI

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

Examples

This command backs up all the keys currently present in the cache.

Export-CacheData -Name demoCache -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 demoCache -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 demoCache -Path C:\Backup-path -Server 20.200.20.11

This command backs up all the keys currently present in the cache, using security credentials.

Export-CacheData -Name demoCache -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.	-
`-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 -name [-errorthreshold] [-filesize] [-server] -path [-userid] [-password] [-nologo]

Examples

This command backs up all the keys currently present in the cache.

export-cachedata -name demoCache -path /usr/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 demoCache -path /usr/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 demoCache -path /usr/Backup-path -server 20.200.20.11

This command backs up all the keys currently present in the cache, using security credentials.

export-cachedata -name demoCache -path /usr/Backup-path -userid john_smith -password pass123

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.	-
`-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.	-
`-nologo`	`<SwitchParameter>`	Suppresses display of the logo banner.	False

Export-CacheData

Examples

Properties

Note

Contact Us