API libraries
The Webmin API has a set of core functions that are available to all modules, and functions exported by other modules that yours can optionally use.
| API | Description |
|---|---|
| WebminCore | Library containing essential libraries and functionalities required for Webmin’s operation |
| acl:: | Library for editing Webmin users, passwords and access rights |
| backup_config:: | Library for creating configuration file backups |
| cron:: | Library for listing, creating and managing Unix users’ cron jobs |
| init:: | Library for Linux services boot management |
| passwd:: | Library with functionalities for changing user passwords |
| quota:: | Library for Unix user and group quota management |
| servers:: | Library for managing and monitoring remote Webmin servers with RPC |
| smart_status:: | Library for getting SMART status |
| useradmin:: | Library for user and group management |
| usermin:: | Library for configuring Usermin running on this system |
| webmin:: | Library for configuring miniserv and adjusting global Webmin settings |
| webmin_log:: | Library for parsing the Webmin actions log file |
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.
API in standalone Perl scripts
The steps to install and use this module are:
- Download the
Webmin::APIPerl module - Extract and install it with the following commands, run as root:
tar xvzf Webmin-API-1.0.tar.gz
cd Webmin-API
perl Makefile.PL
make install
- Create a new Perl script, starting with:
#!/usr/bin/perl
use Webmin::API;
Your script can then call all the core Webmin functions, like find_byname, foreign_require and etc. There is no need to call init_config, as it will be run for you when the module is imported.