View Source

This document explains how to use the Licensing API to get updates on licenses for CDP 3.0 (Server Backup) application. This includes querying for creating, returning, upgrade, enabling, disabling, getting, deleting pool/specific licenses and license pools.


h3. XML-RPC Method Calls


| {{[licensing.createPooledLicense|R1SL:CDP 3 Licensing API Example - createPooledLicense]}} | {{struct createPooledLicense(string poolID, string product, Map features)}} |
| {{[licensing.disableLicense|R1SL:CDP 3 Licensing API Example - disableLicense]}} | {{struct disableLicense(String licenseID)}} |
| {{[licensing.enableLicense|CDP 3 Licensing API Example - enableLicense]}} | {{struct enableLicense(String licenseID)}} |
| {{[licensing.getLicense|R1SL:CDP 3 Licensing API Example - getLicense]}} | {{struct getLicense(String licenseID)}} |
| {{[licensing.getLicensePool|R1SL:CDP 3 Licensing API Example - getLicensePool]}} | {{struct getLicensePool(String poolID)}} |
| {{[licensing.getLicensePools|R1SL:CDP 3 Licensing API Example - getLicensePool]}} | * {{array getLicensePools()}}
* {{array getLicensePools(Map filter)}} |
| {{licensing.getLicenses}} | * {{array getLicenses()}}
* {{array getLicenses(Map filter)}}
* {{array getLicenses(String poolID)}}
* {{array getLicenses(String poolID, Map filter)}} |
| {{[licensing.returnPooledLicenseFeatures|R1SL:CDP 3 Licensing API Example - returnPooledLicenseFeatures]}} | {{struct returnPooledLicenseFeatures(String licenseID, Map features)}} |
| {{[licensing.upgradePooledLicense|R1SL:CDP 3 Licensing API Example - upgradePooledLicense]}} | {{struct upgradePooledLicense(String licenseID, Map features)}} |
| {{[licensing.deletePooledLicense|R1SL:CDP 3 Licensing API Example - deletePooledLicense]}} | {{boolean deletePooledLicense(String poolID, String licenseID)}} |



{panel:title=Licensing API Examples}

{children:excerpt=true}

{panel}

h4. Method Parameter Descriptions

* {{Map features}} \- Key/value map of features and their quantity value.
* {{Map filter}} \- Key/value map of filters and their value.
* {{String poolID}} \- ID (UUID) of the license pool you allocate CDP licenses from.
* {{String licenseID}} \- ID (UUID) of the CDP license key you created from a pool.
* {{String product}} \- The product type of the license ('CDP Server Stand Alone (Windows)', 'CDP Server Stand Alone (Linux)').

Many of the methods return Maps or take Maps as arguments. These maps may have different key/value mappings depending on the context. The maps basically represent different objects. These objects and their corresponding key/value mappings are described below.

----
{toc-zone:location=top|maxLevel=5|minLevel=5|type=flat|separator=pipe|style=border:1}

----

h5. Filter Map

The Filter Map can be used for both the products CDP 2.x and 3.x.

|| Name || Type || Description ||
| Type | String | Type of License ('Perpetual', 'Heartbeat', 'Trial', 'Pooled License'). |
| Enabled | Boolean | Whether or not license is enabled. |
| Installed | Boolean | Whether or not license is installed. |
| Server Description | String | Description of server on which license is installed. |
| Product | String | Product type of the license. |

h5. Features Map

|| Name || Type || Description ||
| CDP 3 Generic Agents | Integer | Number of Generic Agents. \\ |
| CDP 3 MySql Backups | Integer | Number of MySQL add-ons. |











{toc-zone}
\\ {excerpt:hidden=true}Description of XML-RPC method calls for CDP 3.0.
{excerpt}