Installer 10.15 | Complete Installation and Upgrade Information for Software AG Products | Command Central | Using the Command Line Interface | License Key Commands | sagcc list license-tools keys
 
sagcc list license-tools keys
Returns all license keys available in the license key manager or a list of license keys based on a set of filters. The filters include:
*Product code
*Product ID
*Operating system
*Platform
*Installation type
*License key type
Syntax
*Command Central syntax:
sagcc list license-tools keys [nodeAlias=nodeAlias] [productCode=productCode]
[productId=productId] [os=operatingSystemCode1,operatingSystemCode2...operatingSystemCodeN]
[release=releaseVersion|current] [platform=platformCode1,platformCode2...platformCodeN]
[installationType={Production|Development|Test}] [licenseKeyType={Standard|Custom}]
[aliasFilter=filter] [excludeExpired=true|false]  [options]
*Not supported on Platform Manager.
Arguments and Options
Argument or Option
Description
[nodeAlias=nodeAlias]
Optional. The alias of the node for which to retrieve license keys. The command lists only the license keys that match the operating system of the node alias.
The license keys with the same major version as the Platform Manager node are first of the list.
[productCode=productCode]
Optional. The product code of the product for which to retrieve license key information.
[productId=productId]
Optional. The ID of the product for which to retrieve license key information.

[os=operatingSystemCode1,operatingSystemCode2
...operatingSystemCodeN]
Optional. The operating system or systems for which to retrieve license key information.
[release=releaseVersion|current]
Optional. The release version of the product for which to retrieve license keys. For the current release version specify release=current

[platform=platformCode1,platformCode2...platformCodeN]
Optional. The operating system platform or platforms for which to retrieve license key information.
[installationType={Production|Development|Test}]
Optional. The type of installation for which to retrieve license key information. Values are:
*Production
*Development
*Test
[licenseKeyType={Standard|Custom}]
Optional. The type of license key for which to retrieve information. Values are:
*standard
*custom
[aliasFilter=filter]
Optional. A search string that filters the license keys by aliases matching the string.
[excludeExpired=true|false]
Optional. Specifies whether to include expired license keys in the search results. When set to true, the expired license keys are not included in the results.
Default: false
[options]
Optional. The command allows all options supported by the Command Line Interface. For a description of the options, see Common Options.
Usage Notes
*The license key manager supports the following types of license keys:
*Standard. Single license keys for Software AG products that are produced and managed using standard Software AG licensing tools and processes. The standard keys are in .xml format.
*Custom. License keys for Software AG products that have not yet adopted the standard Software AG licensing tools and processes, for example Terracotta. The custom keys are in any format that a product currently supports, for example a text file.
*You can use filters with the sagcc list license-tools keys command to retrieve information only about standard license keys.
*The command sorts the license keys in the search results in the following order:
1. By type. The custom license keys are filtered by their alias and are always last on the list.
2. By expiration date. Unlimited licenses are first on the list and expired licenses are last.
3. If nodeAlias is included, the command determines which license keys fit best the specified node alias on the following criteria: core license metric, platform, and version. When the license keys are even on all criteria, the command sorts them by product name and key alias.
If nodeAlias is not included, the command sorts by product name, version, core license metric, and key alias.
*The command returns a list of all license keys registered in Command Central.
Examples When Executing on Command Central
*To list all license keys for Integration Server:
sagcc list license-tools keys productCode=PIE
OR
sagcc list license-tools keys productId=integrationServer
*To list all license keys for Windows 7 and 8 operating systems:
sagcc list license-tools keys os=win7,win8
*To list all Windows license keys for Integration Server:
sagcc list license-tools keys productCode=PIE platform=W32,W64,WNT
*To list all license keys for Universal Messaging for the installation type “Production” on a MacOS operating system:
sagcc list license-tools keys productCode=NUM os=MacOS
installationType=Production