Register-NCache
This PowerShell cmdlet enables the user to activate/reactivate licenses, or extend evaluation for NCache, both online or offline.
Note
This feature is also available in the NCache Community and Open Source editions, please keep in mind that NCache Open Source has different parameters in some cmdlet instances.
Register-NCache -Key [-Environment] -Clients [-Address] [-City] [-Company] [-Country] -Email -FirstName -LastName [-Phone] [-Reactivate] [-State] [-ZipCode] -AuthCode [-Server] [-Port] [-Credentials] [-OfflineActivate] [-KeyType] [-RegisterAs] [-LicenseDuration] [-Recurring] [-NoLogo]
Examples
- This command registers NCache on a local server with the given Server-Only license key for Production environment.
Register-NCache -Key xxxxxxxx-xxxxxx-xxxxxxxx -FirstName John -LastName Smith -Email john@alachisoft.com -Company Alachisoft -Environment Production
- This command registers NCache on server 20.200.20.11 with the given Client-Server license key for a Production environment with 4 client licenses.
Important
Client Server Licensing:
For containerized Client-Server licensing, you also need to specify the Client Licenses to activate on cache server.
Register-NCache -Key xxxxxxxx-xxxxxx-xxxxxxxx -FirstName John -LastName Smith -Email john@alachisoft.com -Company Alachisoft -Server 20.200.20.11 -Environment Production -Clients 4
- This command reactivates NCache on an already activated machine using the NCache license key.
Register-NCache -Key xxxxxxxx-xxxxxx-xxxxxxxx -FirstName John -LastName Smith -Email john@alachisoft.com -Company Alachisoft -Server 20.200.20.11 -Environment Production -Clients 4 -Reactivate
- This command activates the NCache image as a Remote Client installation when deploying on a Cloud platform.
Register-NCache -Key xxxxxxxx-xxxxxx-xxxxxxxx -FirstName John -LastName Smith -Email john@yourdomain.com -RegisterAs RemoteClient -Company your_company_name -Server 20.200.20.11 -Environment Production
- This command generates an Activation Request Code URL for offline activation of NCache using NCache license key. Copy this URL to another computer with internet access, open that URL to obtain Activation Authorization Code. Then paste that Authorization Code to this computer and complete your activation by running the following command.
Register-NCache -Key xxxxxxxx-xxxxxx-xxxxxxxx -FirstName John -LastName Smith -Email john@alachisoft.com -Company Alachisoft -Server 20.200.20.11 -Environment Production -OfflineActivate
- This command activates NCache license on local server with the given Authorization Code.
Register-NCache -AuthCode xxxxxxxxxxxxxx -OfflineActivate
- This command extends evaluation of NCache on local server with the given extension key.
Register-NCache -Key xxxxxxxx-xxxxxx-xxxxxxxx -FirstName John -LastName Smith -Email john@alachisoft.com -Company Alachisoft -KeyType Extension
- This command generates an Evaluation Extension Request Code URL to extend their NCache trial using NCache evaluation extension key. Copy this URL to another computer with Internet access, open that URL to obtain an Evaluation Extension Authorization Code. Then paste that Authorization Code to this computer and complete your activation by running the following command.
Register-NCache -Key xxxxxxxx-xxxxxx-xxxxxxxx -FirstName John -LastName Smith -Email john@alachisoft.com -Company Alachisoft -Server 20.200.20.11 -KeyType Extension -OfflineActivate
Tip
You can reactivate NCache online/offline by specifying the Reactivate parameter in the Register-NCache command.
- This command registers NCache with a Standard license duration, i.e., an Annual Subscription on the local server.
Register-NCache -Key xxxxxxxx-xxxxxx-xxxxxxxx -FirstName John -LastName Smith -Email john@alachisoft.com -Company Alachisoft -Environment Production -LicenseDuration Standard
Note
The default NCache license type is Annual. If you do not explicitly specify a license type during activation, the system will attempt to activate an Annual license by default.
- This command registers NCache with a Hourly license duration.
Register-NCache -Key xxxxxxxx-xxxxxx-xxxxxxxx -FirstName John -LastName Smith -Email john@alachisoft.com -Company Alachisoft -Environment Production -LicenseDuration Hourly
- This command registers NCache with a Monthly license that is set to recur.
Register-NCache -Key xxxxxxxx-xxxxxx-xxxxxxxx -FirstName John -LastName Smith -Email john@alachisoft.com -Company Alachisoft -Environment Production -LicenseDuration Monthly -Recurring
Properties
Note
The parameters with asterisk (*) on their names are required parameters and the rest are optional.
| Parameters | Data Types | Description | Default Value |
|---|---|---|---|
-Key* |
<String> |
Specifies the license key received from Alachisoft. | - |
-Environment |
<String> |
Specifies the environment name for which the machine is being activated. Only required at the time of activation/reactivation. | - |
-Clients* |
<Integer> |
Specifies the number of client licenses to be activated with the specified environment. Only required at the time of activation/reactivation for Client-Server (Containerized) licensing. | - |
-Address |
<String> |
Specifies user's address to be registered. | - |
-City |
<String> |
Specifies user's city to be registered. | - |
-Company |
<String> |
Specifies user's company name to be registered. | |
-Country |
<String> |
Specifies user's country name to be registered. | - |
-Email* |
<String> |
Specifies user's email to be registered. | - |
-FirstName* |
<String> |
Specifies user's first name to be registered. | - |
-LastName* |
<String> |
Specifies user's last name to be registered. | - |
-Phone |
<String> |
Specifies user's phone number to be registered. | - |
-Reactivate |
<SwitchParameter> |
Represents reactivation of given license. | False |
-State |
<String> |
Specifies user's state to be registered. | - |
-Zip Code |
<String> |
Specifies user's zip code to be registered. | - |
-AuthCode* |
<String> |
Auth code is generated from the URL which is obtained when the Register-NCache command is executed with the OfflineActivate parameter. This is provided by Alachisoft support department for offline activation. |
- |
-Server |
<String> |
Specifies server name address. | Local Machine |
-Port |
<Long> |
Specifies the server port where the NCache Service is listening. | 8250 |
-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. | - |
-OfflineActivate |
<SwitchParameter> |
Represents offline activation/reactivation of a given license or extension of evaluation. When this switch is used, the command generates an Activation/Extension Request Code URL. The user then needs to copy this URL to another computer with an internet access, open that URL to obtain Activation/Extension Authorization Code. Then paste that code to the machine you are trying to activate/extend the evaluation for and complete your activation/reactivation or extension. | False |
-KeyType |
<String> |
Specifies whether the given key is either an Extension key or a License key. | License |
-RegisterAs |
<String> |
Specifies the installation type when registering a Docker container or on a cloud image. This parameter is applicable only for Docker or cloud image installations. Acceptable values include the following: |
Cache Server |
-LicenseDuration |
<String> |
Specifies the duration of the license. Accepted values are as follows: |
Standard |
-Recurring |
<SwitchParameter> |
Specifies whether the license is recurring. Required when the LicenseDuration is set to Monthly. |
False |
-NoLogo |
<SwitchParameter> |
Suppresses display of the logo banner. | True |
