Get-NCacheVersion

This PowerShell cmdlet enables the user to verify the NCache license. It displays the registration details for the registered versions. For the evaluation mode, it displays the remaining days if the evaluation is still valid; otherwise, it displays an expiration message. You can also fetch the information about a remote NCache installation using this PowerShell cmdlet.

Note

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

Get-NCacheVersion [-Server] [-Port] `
                  [-TlsCertPath] [-TlsCertPassword] `
                  [-NoLogo] [-Credentials]

Examples

  • This command displays registration details.
Get-NCacheVersion
  • This command displays registration details of server 20.200.20.11.
Get-NCacheVersion -Server 20.200.20.11
  • This command displays registration details of server 20.200.20.11 on management port 9803 where the NCache Service is running.
Get-NCacheVersion -Server 20.200.20.11 -Port 9803
  • This command displays registration details without displaying the logo banner.
Get-NCacheVersion -NoLogo
  • This command displays the NCache version installed 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.
Get-NCacheVersion -Server 20.200.20.11 -TlsCertPath "C:\certs\client.pem" `
                  -TlsCertPassword "clientKeyPassword"
  • This command authenticates the credentials provided and displays registration details.
Get-NCacheVersion -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
-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
-Port <Long> Specifies the port on which the NCache Service is listening. 9803
-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 who has 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. -