R1Soft Licensing Portal API for Server Backup 5.0

h3. XML-RPC Method Calls

*XML-RPC* is a Remote Procedure Calling protocol that works over the internet. An XML-RPC message is an HTTP-POST request. The body of the request is in XML. A procedure executes on the server and the value it returns is also formatted in XML. Procedure parameters can be numbers, strings, etc.; and can also be complex record and list structures.

|| Method Calls\\ || Method Parameters\\ ||
| {{[licensing.createPooledLicense|5.0 Licensing API Example - createPooledLicense]}} | {{struct createPooledLicense(string poolID, string product, Map features)}} |
| {{[licensing.disableLicense|5.0 Licensing API Example - disableLicense]}} | {{struct disableLicense(String licenseID)}} |
| {{[licensing.enableLicense|5.0 Licensing API Example - enableLicense]}} | {{struct enableLicense(String licenseID)}} |
| {{[licensing.getLicense|5.0 Licensing API Example - getLicense]}} | {{struct getLicense(String licenseID)}} |
| {{[licensing.getLicensePool|5.0 Licensing API Example - getLicensePool]}} | {{struct getLicensePool(String poolID)}} |
| {{[licensing.getLicensePools|5.0 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|5.0 Licensing API Example - returnPooledLicenseFeatures]}} | {{struct returnPooledLicenseFeatures(String licenseID, Map features)}} |
| {{[licensing.upgradePooledLicense|5.0 Licensing API Example - upgradePooledLicense]}} | {{struct upgradePooledLicense(String licenseID, Map features)}} |
| {{[licensing.deletePooledLicense|5.0 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|#features]* \- Key/value map of features and their quantity value.
* *[Map filter|#filter]* \- Key/value map of filters and their value.
* *String poolID* \- ID (UUID) of the license pool you allocate Server Backup licenses from.
* *String licenseID* \- ID (UUID) of the Server Backup license key you created from a pool.
* *[String product|#product]* \- The product type of the license ('{{Enterprise Edition (Win)}}', '{{Enterprise Edition (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. {anchor:features}Features Map

|| Name || Type || Description ||
| Physical Servers | Integer | Number of physical servers. \\ |
| Virtual Servers | Integer | Number of virtual servers. |

Example of usage: {{$VIRTUAL_SERVERES = '1'; $PHYSICAL_SERVERS = '1';}}

h5. {anchor:filter}Filter Map


|| 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. {anchor:product}Product Map


|| Name || Type || Description ||
| Enterprise Edition (Win) \\ | String | Enterprise Edition Key for Windows |
| Enterprise Edition (Linux) \\ | String | Enterprise Edition key for Linux |

Example of usage: {{$LICENSETYPE = "Enterprise Edition (Win)";}}














{toc-zone}
\\ {excerpt:hidden=true}Description of XML-RPC method calls for Server Backup 5.0.
{excerpt}