How to Use Virtualmin APIs for Automation

Virtualmin is a comprehensive web server administration tool that allows for efficient management of various server aspects. One of its most powerful features is the API, which enables task automation through scripts and integration with other tools. In this article, we will explore how to use Virtualmin APIs for automation, providing API documentation, usage examples, script creation, and how to integrate it with other tools.

API Documentation

Virtualmin offers a robust API that allows users to execute a variety of commands and tasks via HTTP requests. This API is extremely useful for automating repetitive processes, managing multiple servers, and performing administrative tasks without manual intervention.

Accessing the API Documentation

The Virtualmin API documentation can be found at the official page and provides detailed information on all available commands, necessary parameters, and request examples.

Basic API Commands

Some of the most commonly used commands in the Virtualmin API include:

• create-domain: To create a new domain.
• delete-domain: To delete an existing domain.
• list-domains: To list all domains.
• modify-domain: To modify a domain.

Each command has a specific set of parameters that must be provided for correct execution.

Authentication

To use the API, authentication is required. Virtualmin uses basic HTTP authentication or API tokens. Make sure you have the correct credentials and necessary permissions to execute the desired commands.

Usage Examples

To illustrate how we can use the Virtualmin API, let's look at some practical examples. These examples will cover everything from creating a domain to deleting it.

Create a Domain

curl --user root:password "https://your-server:10000/virtual-server/remote.cgi?program=create-domain&domain=example.com&pass=yourpassword"

This command will create a new domain named example.com with the password yourpassword.

List Domains

curl --user root:password "https://your-server:10000/virtual-server/remote.cgi?program=list-domains"

This command will return a list of all domains configured on the server.

Delete a Domain

curl --user root:password "https://your-server:10000/virtual-server/remote.cgi?program=delete-domain&domain=example.com"

This command will delete the domain example.com from the server.

Script Creation

Using scripts can greatly simplify server administration. Scripts allow for the automation of complex and repetitive tasks, reducing the possibility of human error.

Script to Create Multiple Domains

Below is an example of a bash script that creates multiple domains:

!/bin/bash

# Text file with a list of domains and passwords, separated by commas
input="domains.csv"

while IFS=',' read -r domain password
do
  curl --user root:password "https://your-server:10000/virtual-server/remote.cgi?program=create-domain&domain=${domain}&pass=${password}"
done < "${input}";

This script reads a CSV file named domains.csv that contains domains and passwords, and creates each domain on the server using the Virtualmin API.

Script to Perform Backups

A script to automate backups can be very helpful. Here is an example in bash:

!/bin/bash

# Domain name and backup destination path
domain="example.com"
backup_dir="/path/to/backup"

curl --user root:password "https://your-server:10000/virtual-server/remote.cgi?program=backup-domain&domain=${domain}&dest=${backup_dir}/${domain}-backup.tgz";

This script backs up the domain example.com and saves the file to the specified location.

Integration with Other Tools

Integrating the Virtualmin API with other tools can further enhance its functionality and efficiency. Next, we will see how we can integrate Virtualmin with some popular tools.

Integration with Jenkins

Jenkins is a continuous integration tool that can be used alongside Virtualmin to automate the deployment of web applications.

Example Usage with Jenkins

1. Configure Jenkins: Install Jenkins on your server.
2. Create a Job: Create a new job in Jenkins.
3. Configure Post-build Actions: Add a post-build action in Jenkins to execute a script that uses the Virtualmin API.

!/bin/bash

# Project and server addresses
project_dir="/path/to/project"
server_url="https://your-server:10000"

# Upload the project to the server
scp -r ${project_dir} user@your-server:/path/to/deploy

# Execute a script on the server to configure the domain
ssh user@your-server "sh /path/to/deploy-script.sh";

Integration with Ansible

Ansible is a configuration management tool that can be used to manage servers automatically.

Example Usage with Ansible

1. Install Ansible: Install Ansible on your machine.
2. Configure Inventories: Specify the servers in the inventory file.
3. Create a Playbook: Create a playbook file to execute tasks on the servers.

- name: Manage Domains in Virtualmin
  hosts: all
  become: yes
  tasks:

    - name: Create Domain
      command: curl --user root:password "https://your-server:10000/virtual-server/remote.cgi?program=create-domain&domain=example.com&pass=yourpassword"

    - name: List Domains
      command: curl --user root:password "https://your-server:10000/virtual-server/remote.cgi?program=list-domains";

This Ansible playbook creates a domain and lists all existing domains on the server.

Conclusion

The Virtualmin API is a valuable tool for any server administrator looking to automate tasks and improve operational efficiency. With access to detailed documentation, practical examples, and the ability to create custom scripts, you can streamline your processes and reduce time spent on repetitive tasks. Furthermore, its integration with tools like Jenkins and Ansible allows for the creation of automated workflows that can manage multiple servers effectively.

Explore the Virtualmin API, experiment with scripts, and discover how you can take your server administration to the next level.