Personal tools
     DOCUMENTATION

rPath Appliance Platform/Entitlement Service:Appliance/Administration Guide:Manage Entitlements

From rPath Wiki

Jump to: navigation, search
Entitlement Service Administration Guide --> Manage Entitlements

Administrators of an rPath Appliance Platform Entitlement Service appliance may or may not overlap with the regular rPath Appliance Platform/Entitlement Service users who are creating and managing entitlements for distributed software appliances. The following sections provide some entitlement management options for appliance administrators that go beyond that of typical appliance users.

Add Entitlements

Add entitlements to the Entitlement Service appliance in one of two ways: rPath Appliance Platform Agent or XML-RPC.

rPath Appliance Platform Agent

The rPath Appliance Platform Agent provides a web interface with options for bulk addition of entitlements. Use the Entitlement Service appliance to generate a specified number of random entitlement strings, or use the text input to paste entitlements generated from another source.

Each entitlement can have an optional comment associated with it that allows administrators to identify to which customer it belongs. The entitlement will be pushed to every service to which the product is associated so that when used on a system, the system can find updates on all of the appropriate repositories.

XML-RPC Interface

The Entitlement Service appliance provides XML-RPC for adding entitlements using the following parameters:

  • Call URL: https://admin:password@host.example.com:8003/rAA/entwebui/EntitledCustomers/
  • Method: addEntitlements(channel, keyArray, comment="") where channel is the name of the product channel, and keyArray is a list of entitlements to add to the channel; the comment parameter is optional and corresponds to the optional comment in the Appliance Agent.

Revoke Entitlements

Revoke an entitlement in the rPath Appliance Platform Agent by clicking the "Revoke" button corresponding to the entitlement. This immediately removes the entitlement from every service, and access is be denied.

The XML-RPC equivalent for revoking entitlements uses the following parameters:

  • Call URL: https://admin:password@host.example.com:8003/rAA/entwebui/EntitledCustomers/
  • Method: deleteEntitlements(channel, keyArray) where channel is the name of the product channel, and keyArray is a list of entitlements to add to the channel