What does Export-CacheKeys do?

Export-CacheKeys displays the keys of a specified NCache cache in the console.

Which parameter is required for Export-CacheKeys?

The Name parameter is required.

What does KeyFilter do?

KeyFilter returns keys that contain the specified filter value as a substring.

Which server is used by default?

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

Is Export-CacheKeys available in NCache Open Source?

Yes. Export-CacheKeys is also available in the NCache Open Source edition, although parameters may differ between editions.

Export-CacheKeys

This PowerShell cmdlet enables the user to export the cache keys of a specific cache to the console. It is an essential tool for debugging data patterns, monitoring cache distribution, and verifying data integrity. The keys can be filtered on the basis of the key filter given using this PowerShell cmdlet.

Note

This feature is also available in the NCache Open Source edition. Please keep in mind that NCache Open Source has different parameters in some cmdlet instances.

Export-CacheKeys -Name [-KeyCount] `
                [-KeyFilter] [-NoLogo] `
                [-TlsCertPath] [-TlsCertPassword] `
                [-Credentials] [-Server]

Examples

This command dumps up to 1000 keys currently present in the cache.

Export-CacheKeys -Name defaultCache

This command dumps the 500 keys currently if present in the cache.

Export-CacheKeys -Name defaultCache -KeyCount 500

This command dumps the 500 keys currently present in the cache containing 11 as a substring in the keys.

Export-CacheKeys -Name defaultCache -KeyCount 500 `
                 -KeyFilter 11

This command dumps the keys currently present in the cache named defaultCache on server 20.200.20.11.

Export-CacheKeys -Name defaultCache -Server 20.200.20.11

This command exports the keys from 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.

Export-CacheKeys -Name defaultCache -Server 20.200.20.11 `
                 -TlsCertPath "C:\certs\client.pem" -TlsCertPassword "clientKeyPassword"

This command dumps the 1000 keys currently if present in the cache, using security credentials.

Export-CacheKeys -Name defaultCache -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 for which the keys need to be backed up or displayed. NOTE: The cache must already exist on the source server.	-
`-KeyCount`	`<Long>`	Specifies the number of keys the user intends to export or view at the particular instance.	1000
`-KeyFilter`	`<String>`	On specifying this parameter, the user gets the filtered keys which contain the key filter as the substring.	-
`-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
`-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.	-
`-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.	-

Export-CacheKeys

Note

Examples

Properties

Note

Contact Us