Using the API in Standalone Perl Scripts

From Webmin Documentation
Jump to: navigation, search
Webmin development

Creating Overlay Themes
Creating Webmin Themes
MSC Theme
The Webmin API

Module Development
Advanced Module Development
Job Scheduling
Translating Webmin
Development Ideas


API Backup-Config
API Change-User
API Cpan
API Cron
API Init
API Passwd
API Quota
API Servers
API Smart-Status
API Useradmin
API Usermin
API Webmin
API Webmin-Core
API Webmin-Log

The extensive Webmin API can also be called from your own Perl scripts that do not run under miniserv, as long as they run as root. The easiest way to do this is to install the Webmin::API Perl module, which takes care of a lot of the boilerplate code that would be otherwise required.

The steps to install and use this module are:

  1. Download the Webmin::API Perl module from:
  2. Extract and install it with the following commands, run as root:
# tar xvzf Webmin-API-1.0.tar.gz
# cd Webmin-API<br>perl Makefile.PL
# make install
  1. Create a new Perl script, starting with:
use Webmin::API;

Your script can then call all the core Webmin functions, like find_byname, foreign_require and so on. There is no need to call init_config - it will be run for you when the module is imported