Before running the command to license the LoadMaster (Request-LicenseOnline/Request-LicenseOffline) it is possible to retrieve the available license(s) for a specific Progress ID (formerly Kemp ID) from the Progress Kemp Licensing Server using the Get-LicenseType command.

The parameters for this command are:

  • KempId (mandatory)
  • Password (mandatory)
  • OrderId (optional)

The output of the command (when successful) has the following structure:

ReturnCode : 200
Response   : Command successfully executed.
Data       : @{License=}
Note: There is currently an issue with the Get-LicenseType command that returns an error (Item has already been added. Key in dictionary: 'description' Key being added: 'description'). If you run the command with the -Verbose parameter, you will see the content of the successful output including the license type IDs. You can proceed to license the LoadMaster successfully after this.

The field Data.License contains details about the the license(s) and it always includes the temporary license option. For example:

$licDet.Data.License
id            : 0632b88b577c71591798268bcd4e01132f082309
name          : VLM-5000 ESP GEO with Basic 2 Years
available     : 1
description   : VLM-5000 ESP GEO with Basic 2 Years
tethered      : False
LicenseStatus : Permanent License
BuyMoreAt     : https://www.kemptechnologies.com/buy-me-now?KempID=jbloggs@kemptechnologies.com
id            : fc488d991cffb7a5958625427d6bfb0b3edc008e
name          : VLM-5000 WAF GEO with Basic 3 Years
available     : 1
description   : VLM-5000 WAF GEO with Basic 3 Years
tethered      : False
LicenseStatus : Permanent License
BuyMoreAt     : https://www.kemptechnologies.com/buy-me-now?KempID= jbloggs@kemptechnologies.com
name          : VLM-5000 with Enterprise Plus subscription
available     : 1
tethered      : 0
id            : 3eb92178611573946b422cf8d0df69d04c07fede
LicenseStatus : Temp License
description   : VLM-5000 with Enterprise Plus subscription
BuyMoreAt     : https://www.kemptechnologies.com/buy-me-now?KempID= jbloggs@kemptechnologies.com

In this example, the customer purchased two licenses. The third entry is the temporary license.

If the Progress ID does not exist, the command returns the string “License type information not available”.

Example without Specifying an Order ID

Without an Order ID, the command only returns the temporary license details:

$licDet = Get-LicenseType -KempId jbloggs@kemptechnologies.com -Password supersecretpasswd `
                                            -LoadBalancer 172.21.59.85 -Credential bal
$licDet
ReturnCode Response                       Data                      
---------- --------                       ----                      
       200 Command successfully executed. @{License=System.Object[]}
$licDet.Data.License
name          : VLM-5000 with Enterprise Plus subscription
available     : 1
tethered      : 0
id            : 3eb92178611573946b422cf8d0df69d04c07fede
LicenseStatus : Temp License
description   : VLM-5000 with Enterprise Plus subscription
BuyMoreAt     : https://www.kemptechnologies.com/buy-me-now?KempID=jbloggs@kemptechnologies.com

Example with a Valid Order ID

If a valid Order ID is provided, the command returns an array of licenses containing the purchased license(s) and the temporary license details:

$licDet = Get-LicenseType -KempId jbloggs@kemptechnologies.com -Password supersecretpasswd `
                     -LoadBalancer 172.21.59.85 -Credential bal -OrderId Example20170517
$licDet | Format-List
ReturnCode : 200
Response   : Command successfully executed.
Data       : @{License=System.Object[]}
$licDet.Data.License
id            : 0632b88b577c71591798268bcd4e01132f082309
name          : VLM-5000 ESP GEO with Basic 2 Years
available     : 1
description   : VLM-5000 ESP GEO with Basic 2 Years
tethered      : False
LicenseStatus : Permanent License
BuyMoreAt     : https://www.kemptechnologies.com/buy-me-now?KempID=jbloggs@kemptechnologies.com
id            : fc488d991cffb7a5958625427d6bfb0b3edc008e
name          : VLM-5000 WAF GEO with Basic 3 Years
available     : 1
description   : VLM-5000 WAF GEO with Basic 3 Years
tethered      : False
LicenseStatus : Permanent License
BuyMoreAt     : https://www.kemptechnologies.com/buy-me-now?KempID= jbloggs@kemptechnologies.com
name          : VLM-5000 with Enterprise Plus subscription
available     : 1
tethered      : 0
id            : 3eb92178611573946b422cf8d0df69d04c07fede
LicenseStatus : Temp License
description   : VLM-5000 with Enterprise Plus subscription
BuyMoreAt     : https://www.kemptechnologies.com/buy-me-now?KempID= jbloggs@kemptechnologies.com

The answer is an array and you can retrieve each element of the array by using the usual array syntax, for example, to get the first element of the array:

$licDet.Data.License[0]
id            : 0632b88b577c71591798268bcd4e01132f082309
name          : VLM-5000 ESP GEO with Basic 2 Years
available     : 1
description   : VLM-5000 ESP GEO with Basic 2 Years
tethered      : False
LicenseStatus : Permanent License
BuyMoreAt     : https://www.kemptechnologies.com/buy-me-now?KempID= jbloggs@kemptechnologies.com

Example with an Invalid (Undefined) Progress ID

An example with an invalid (or non-existing) Progress ID is below:

$err = Get-LicenseType -KempId invalid@invalid.co.uk -Password bla2017bla `
                                       -LoadBalancer 172.21.59.85 -Credential bal
ReturnCode : 200
Response   : Command successfully executed.
Data       : @{Licenses=License type information not available}
$err.Data.Licenses
License type information not available

Retreive License Types when using Local Licensing Functionality

If you are licensing the LoadMaster using Kemp 360 Central, a similar command (Get-AslLicenseType) is used to retrieve the available licenses. The parameters for this command are:

  • aslhost (mandatory): IP address of the Kemp 360 Central server instance
  • aslport (optional): The Kemp 360 Central listening port. The default value for the aslport parameter is 443.