rPath Appliance Platform Agent:XML-RPC Exposed Methods

From rPath Wiki

Use this page to reference XML-RPC methods provided by rPath Appliance Platform Agent (rAPA) version 3.0. Each item listed links to the appropriate location in the rAPA 3.0 API documentation. Upon future rAPA releases, this page will link to version-specific rAPA documentation so that each supported version will continue to have a dedicated resource.

Previous Documentation Available:

• rAPA 2.1 API documenation

How to Locate Exposed Methods in Version 3.0

Throughout the rAPA 3.0 API documentation, exposed methods can be identified by locating decorators that indicate the method is available using XML-RPC. Such decorators have the following features:

1. Start with @raa.web.expose
2. Include allow_xmlrpc=True as an argument to @raa.web.expose.

@raa.web.expose(allow_xmlrpc= True, allow_json= False)

If the method indicates LocalhostOnly()as an argument to @raa.web.require, it is not available for public XML-RPC; the only thing that should call those methods is the service backend on the same system as rAPA.

@raa.web.require(raa.authorization.LocalhostOnly())

On the rAPA 3.0 API documentation main page, there is a series of modules listed in the Table of Contents frame in the upper left browser frame. Exposed methods can be located in classes under the following modules:

raa.controllers

Select this module, then, in the pane below the Table of Contents, select Root under Classes.

raaplugins.<plugin>.web.<plugin>

In the module name, "plugin" is the name of one of the rAPA standard plugins. In the case of configure plugins, the last part is the name of that portion of the configuration plugin (such as network, which would be in raaplugins.configure.web.network).

Select this module, then, in pane below the Table of Contents, select the plugin name under Classes. This represents the web component for that plugin, as described in rAPA Plugin Structure.

How to Locate Exposed Methods in Version 2.1

Throughout the rAPA 2.1 API documentation, exposed methods can be identified by locating decorators that indicate the method is available using XML-RPC. Such decorators have the following features:

1. Start with @raa.web.expose
2. Include allow_xmlrpc=True as an argument to @raa.web.expose.

If the method indicates localhost_only()as an argument to @raa.web.require, it is not available for public XML-RPC; the only thing that should call those methods is the service backend on the same system as rAPA.

The method should include information about how it should be called. Note that XML-RPC uses positional parameters, requiring an XML-RPC call to pass arguments in the same order as they are positioned in the method. This is in contrast to Python, in which rAPA is written, which uses named parameters and does not require a specific order for arguments.

Classes with XML-RPC Exposed Methods

The following is a list of classes in the rAPA API where XML-RPC exposed methods can be found. Each class is linked to the its page where exposed methods can be found.