What does Import-CacheData do?

Import-CacheData restores items to an NCache cache from an existing cache backup created using Export-CacheData.

Which parameters are required for Import-CacheData?

The Name and Path parameters are required.

What does ErrorThreshold control?

ErrorThreshold specifies the number of errors that can be tolerated while importing files from the backup. Its default value is 1.

Which Expiry options are available?

The available Expiry options are None, Adjusted, and AsBefore. The default value is Adjusted.

Which server is used by default?

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

Import-CacheData

Import-CacheData is designed to populate NCache clusters from offline backups created via the Export-CacheData cmdlet. It is essential for disaster recovery and cluster migration, and uses bulk inserts to minimize performance restoration overhead. Additionally, administrators can ensure data integrity and consistency when re-populating distributed caches across diverse server environments by configuring Error Thresholds and Expiration Policies.

Import-CacheData -Name [-Server] `
                 -Path [-BulkSize] `
                 [-ErrorThreshold] [-Expiry] `
                 [-TlsCertPath] [-TlsCertPassword] `
                 [-NoLogo] [-Credentials]

Examples

This command reloads all the items to the cache from the path specified.

Import-CacheData -Name defaultCache -Path C:\Backup-path

This command reloads all the items to the cache from the path specified and will exit if 10 errors occur during the process.

Import-CacheData -Name defaultCache -Path C:\Backup-path `
                 -ErrorThreshold 10

This command reloads all the items in batches of 100 to the cache from the path specified.

Import-CacheData -Name defaultCache -Path C:\Backup-path `
                 -BulkSize 100

This command reloads all the items to the cache on server 20.200.20.11 from the path specified.

Import-CacheData -Name defaultCache -Path C:\Backup-path `
                 -Server 20.200.20.11

This command restores a backup of a cache configured with Pub/Sub Messaging as its store type. It restores all topics, their registered durable subscriptions, and the messages associated with each topic. Each restored message retains its original message ID, creation time, and expiration time from the backup. This allows subscribers that reconnect to a restored durable subscription to receive the messages available for that subscription.

Import-CacheData -Name pubSubCache -Path C:\Backup-path

This command imports data from C:\Backup-path into defaultCache 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.

Import-CacheData -Name defaultCache -Path C:\Backup-path `
                 -Server 20.200.20.11 -TlsCertPath "C:\certs\client.pem" `
                 -TlsCertPassword "clientKeyPassword"

This command reloads all the items to the cache from the path specified, using security credentials.

Import-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 is to be backed up or restored. NOTE: The cache must already exist on the source server.	-
`-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 data is currently present.	-
`-BulkSize`	`<Long>`	Specifies the bulk insertion size that can be restored back to the cache at one time.	1000
`-ErrorThreshold`	`<Long>`	Specifies the number of errors that can be tolerated during importing files from the backup.	1
`-Expiry`	`<String>`	Specifies the expiration policy that gives the time span of the expiry of the data that is restored to the cache. The possible options are - None - Adjusted - AsBefore	Adjusted
`-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.	-
`-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 with the appropriate permissions at the node.	-

Import-CacheData

Examples

Properties

Note

Contact Us