XML-RPC Calls

From Webmin Documentation
Jump to: navigation, search
Webmin development

Creating Overlay Themes
Creating Webmin Themes
XML-RPC Calls
MSC Theme
The Webmin API
API-usage

Module Development
Advanced Module Development
Job Scheduling
Translating Webmin
Development Ideas

Since Webmin 1.300, it has been possible to call Webmin API functions via XML-RPC. The base URL is http://yourserver:10000/xmlrpc.cgi, which then selects the Webmin function to call based on it's parameters. This can be invoked from any language that supports basic data structures like hashes and arrays.

An example of Perl code that does this is :

#!/usr/bin/perl
# Demo program to list mail aliases, and either create or delete one

use Frontier::Client;
use Data::Dumper;

chop($url = `cat url.txt`);
eval {
  $server = Frontier::Client->new('url' => $url);
  };
$@ && die "Failed to create server : $@";

$jobs = $server->call("cron::list_cron_jobs");
print "Found ",scalar(@$jobs)," cron jobs\n";
($already) = grep { $_->{'user'} eq 'root' &&
                    $_->{'command'} eq 'echo foo' } @$jobs;

if ($already) {
        print "Deleting cron job for $already->{'user'}\n";
        $server->call("cron::delete_cron_job", $already);
        print "Done deletion\n";
        }
else {
        print "Adding cron job for root\n";
        $job = { 'user' => 'root',
                 'active' => 1,
                 'command' => 'echo foo',
                 'special' => 'weekly' };
        $server->call("cron::create_cron_job", $job);
        print "Done\n";
        }

More examples can be found at http://www.webmin.com/xmlrpc.zip . In all these examples, login details for the Webmin server are in the url.txt file, which must contain a URL with a username and password like :

http://root:password@yourserver:10000/xmlrpc.cgi