Register-NCache

The Register-NCache PowerShell cmdlet registers an NCache installation for free evaluation. It also supports extending the evaluation period on machines without internet access using an authorization code provided by NCache Support. For Docker containers and cloud images, you can specify whether the installation is registered as a Server, Client, or Developer. The cmdlet supports client certificate authentication when connecting to a server configured for mutual TLS (mTLS).

Note

To register NCache Open Source, use the Register-NCacheOpenSource cmdlet.

Register-NCache [-Key] [-OfflineAuthCode] `
                [-Server] [-Port] `
                [-TlsCertPath] [-TlsCertPassword]`
                [-NoLogo]

Examples

• This command registers NCache for free evaluation using the installation key.

Register-NCache -Key xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

• This command extends the NCache evaluation period on a machine without internet access using the Evaluation Extension Authorization Code provided by NCache Support. Replace the placeholder with the supplied code.

Register-NCache -Key xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx -OfflineAuthCode "xxxxxxxxxxxxxxxxxxxxx"

• This command registers NCache for free evaluation from a machine where NCache is not installed, connecting to a server with mutual TLS (mTLS) enabled. The client certificate authenticates the machine running the cmdlet, and the password decrypts the private key. Omit -TlsCertPassword if the private key is not encrypted.

Register-NCache -Key xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx `
                -TlsCertPath "C:\certs\client.pem" `
                -TlsCertPassword "clientKeyPassword"

Properties

Parameters	Data Types	Description	Default Value
-Key	<String>	Specifies the installation key received from Alachisoft.	-
-OfflineAuthCode	<String>	Specifies the Evaluation Extension Authorization Code provided by NCache Support to extend evaluation on a machine without internet access. Use it together with the original installation key.	-
-Server	<String>	Specifies the IP address of the local machine configured for the NCache Service. Use this parameter when the machine has multiple network interfaces. Only a local machine IP address is accepted.	Local machine
-Port	<Long>	Specifies the port used to contact the NCache Service.	-
-TlsCertPath	<String>	Specifies the path to a client PEM certificate for authenticating the machine running the cmdlet against an mTLS-enabled NCache server. 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 on a machine without NCache installed if the server requires mTLS. On an NCache server installation, the node certificate is used automatically. Relative paths resolve against the current PowerShell location.	-
-TlsCertPassword	<String>	Specifies the password used to decrypt the encrypted private key in the PEM file supplied through -TlsCertPath. It is required only for password-protected private keys and is not saved in the NCache server configuration.	-
-NoLogo	<SwitchParameter>	Suppresses display of the logo banner.	False

Note

To configure the certificate presented by the server, use -CustomCertificatePath with the applicable TLS configuration command. It is not a parameter of Register-NCache.