Documentation on Cloudmin — Virtual Machine Management for Linux

FAQ

Wed, 28 Oct 2026 00:00:00 +0000

FAQ

General

What is Cloudmin 10?

A rewrite of Cloudmin around libvirt, the standard Linux API for managing virtual machines. It manages QEMU/KVM guests on a Linux host from inside Webmin, and adds images, templates, jobs, permissions, consoles, snapshots, clones and backups on top of libvirt. See What is Cloudmin 10.

Is Cloudmin 10 released?

Not yet. It is in development, and the installer uses the unstable channel. The feature status page lists what is implemented and what is still planned.

OS Support

Wed, 28 Oct 2026 00:00:00 +0000

Cloudmin runs on top of Webmin and manages virtual machines through libvirt, so it needs a Linux host with KVM, systemd and the distribution’s libvirt and QEMU packages. The automated installer and the host configuration are tested on a small set of current systems.

Supported host systems

Cloudmin 10 installs on these hosts, on x86-64 or ARM64, with CPU virtualization extensions enabled and a working /dev/kvm:

Enterprise Linux and derivatives

Rocky Linux 10 on x86_64 and aarch64
AlmaLinux 10 on x86_64 and aarch64

Rocky Linux and AlmaLinux also use EPEL and CRB for dependencies, which the installer enables.

Professional Features

Thu, 29 Oct 2026 00:00:00 +0000

Cloudmin GPL manages the host it runs on, with an unlimited number of virtual machines. Cloudmin Pro adds features for that host. Cloudmin Connect GPL and Pro are separate planned products for managing a fleet of Cloudmin hosts.

GPL and Pro share the same API, libvirt adapter and UI. Pro implementations install under server-manager/pro. Security fixes, safe cold migration, data export and restore are never Pro-only.

Available host features

Custom setup scripts

Pro Preparation and final setup scripts run inside a new guest, before and after its software installation. Scripts can be entered directly or read from an allowed host file. Guest packages and Virtualmin GPL/Pro installation remain available in Cloudmin GPL. See Templates and plans.

Feature Status and Roadmap

Wed, 28 Oct 2026 00:00:00 +0000

Cloudmin 10 is developed in the open and is not released yet. This page lists what works today and what is still planned, so the rest of the documentation can be read in context. Items marked Planned are design targets, not available features.

Implemented

Host

Automated installer for Rocky Linux 10, AlmaLinux 10, Debian 13 and Ubuntu 26.04 on x86-64 and ARM64, with repository setup, package groups, managed swap and a readiness report.
Cloudmin-Config prepares KVM, modular or monolithic libvirt, a default storage pool, a persistent NAT network, EFI firmware, Webmin, nftables and Fail2ban, and boots an isolated KVM appliance to verify the host.
Host readiness checks with actionable errors, shown on the overview.
Direct libvirt discovery through Sys::Virt, without parsing virsh output.

Images

Catalogue of AlmaLinux, Alpine, Arch, CentOS Stream, Debian, Fedora, openSUSE, Rocky Linux and Ubuntu cloud images for the host architecture, verified against the publishers’ SHA-256 or SHA-512 checksums.
Background imports from HTTPS URLs, browser uploads and host files into directory, filesystem and NFS pools, with progress pages, batch downloads, bulk deletion and custom catalogue entries.
Installer ISOs, with an empty system disk and the ISO in a read-only CD/DVD drive. Experimental.
Image capture from an existing Linux guest, in Cloudmin Pro.

Virtual machines

Creation from cloud images or ISOs with firmware selection, independent disks and recoverable jobs; cloud-init account setup, SSH keys, DHCP or static IPv4 and IPv6 including on-link gateways.
Machine templates and resource plans, including Default Template, Default Plan and Virtualmin GPL and Pro templates.
Guest packages and Virtualmin GPL/Pro installation run inside the guest after cloud-init. Preparation and final setup scripts require Cloudmin Pro. Pro
Power controls, pause and resume, confirmed hard reset, autostart, live CPU and balloon memory changes, offline resource maximums and boot settings.
Disk and network interface changes, disk growth, ISO insertion and ejection, and deletion with explicit disk selection and shared-storage checks.
Guest password reset through the QEMU Guest Agent.
Disk snapshots with creation, restore, deletion, per-machine history, a host overview and guest-agent preparation.
Full clones from stopped or running guests with fresh identities, or unchanged copies left stopped.
Full backups and restore with hourly to yearly schedules and retention, to local, SSH and S3 destinations, plus cloud destinations in Pro.

Access

Browser SSH terminals with pinned host keys, host-managed per-guest keys, remembered ports and optional automatic connection.
Serial consoles with recorded output replay and graphical VNC consoles that work during boot.
Guest Webmin through the host’s Servers Index proxy for Virtualmin guests behind NAT, root-only and behind a trust warning.
Delegation of individual virtual machines to Webmin users with separate grants; read-only mode blocks changes and consoles.
Live status over authenticated WebSockets: power state, guest agent, SSH reachability, resource usage and guest filesystem usage.

Networking and storage

NAT, routed and isolated virtual networks, and guided host bridge creation through NetworkManager, Netplan or ifupdown with connectivity confirmation and automatic rollback.
Storage pool and volume inventory; directory, filesystem and NFS pools for creation, cloning, backups and imports; registered LVM volume groups and thin pools for creation, cloning, backups, restore and native snapshots, with raw guest disks.

Platform

Durable jobs with reservations, progress, cancellation and recovery after a controller restart.
One versioned JSON API shared by the UI, the api.pl command line and remote clients.
Isolated systemd workers without root for downloads, inspection, seeds, consoles and relays.
Compatibility wrappers for frame-based themes and older Cloudmin function names.

Planned

First supported release

Clean-install validation across the full host matrix, including physical ARM64. Planned
One fully tested shared storage path, such as NFS on every supported host. Planned
VLAN tags on guest interfaces and anti-spoofing through libvirt network filters. Planned
Scheduled snapshots. Planned
Adopting guests defined outside Cloudmin. Planned
Machine-readable API schema and generated API documentation. Planned
Catalogue signature verification, an update schedule and an end-of-life policy. Planned
Legacy Cloudmin 9 KVM import with a per-machine report, cutover and rollback. Planned
A stable Cloudmin 10 package repository. Planned

Cloudmin Pro

Projects, quotas, self-service creation, usage tracking and automation credentials. Planned

Cloudmin Connect GPL

Cloudmin Connect is a separate planned fleet product. GPL will add host registration, combined inventory and search, consoles and terminals, resource views, safe cold moves and host backup/restore actions. It will have host and fleet VM limits; the numbers are not decided. Existing guests remain visible and recoverable after a limit is exceeded. Planned

License Manager

Sat, 31 Oct 2026 00:00:00 +0000

Open System → Settings → License Manager to view, recheck, replace or deregister a Cloudmin Pro license. GPL does not require a license. Host administrators can change licenses; read-only users can view their status.

Renewing or changing a license

Renew through your Virtualmin account, then select Recheck License. To use another license, enter its serial number and key. Cloudmin validates the replacement before saving it and updating existing Cloudmin package repository credentials. Credentials are stored in /etc/cloudmin-license. Administrators who can change the license can see its saved key; read-only users cannot.

Automated Installation

Wed, 28 Oct 2026 00:00:00 +0000

Recommended host specifications

A freshly installed supported OS with CPU virtualization extensions and a working /dev/kvm
Enough memory for the host plus the guests you plan to run; the installer can add managed swap
Local disk space for images and guest disks, or an NFS mount you intend to use as a pool
A fully qualified host name if you plan to install Virtualmin inside guests and reach them by name

Installation

Install Cloudmin with the automated cloudmin-install.sh script. It is the only supported installation method; there is no manual package walkthrough yet. If you haven’t already, read the Download page first, as it covers the steps most installations need.

Host Requirements

Wed, 28 Oct 2026 00:00:00 +0000

The installer satisfies these requirements on a supported host. This page explains what they are, so readiness failures and optional features make sense.

Core

KVM. CPU virtualization extensions enabled in firmware and a working /dev/kvm. Inside another hypervisor, nested virtualization must be enabled. Installation readiness boots a real isolated KVM appliance rather than only checking that /dev/kvm exists.
systemd 247 or later with systemd-run and working nss-systemd user lookup. Cloudmin’s isolated workers and console relays depend on it; if a worker cannot start with its restrictions, the operation fails rather than running the tool as root.
libvirt and QEMU from the distribution, with the Perl Sys::Virt bindings. Cloudmin connects as root to the system connection (qemu:///system). Distribution socket permissions are kept. Rocky Linux and AlmaLinux also use EPEL for dependencies; Debian supplies libsys-virt-perl in main and Ubuntu in universe.
Webmin at the version released with Cloudmin 10. Cloudmin uses Webmin’s authentication, permissions, UI widgets and HTTP APIs, and development installations need current Webmin sources for widgets such as ui_action_button and grouped image choices.
EFI firmware packages for UEFI guests, and the system CA certificate bundle for catalogue downloads.

Optional tools

Feature	Requires
Custom cloud image inspection	libguestfs and its Perl bindings, YAML::XS
Cloning and prepared clones	libguestfs, its Perl bindings, bsdtar, YAML::XS; access to `/dev/kvm` through the `kvm` group and the running kernel and modules for the appliance
Image capture (Pro)	libguestfs, its Perl bindings, YAML::XS 0.69 or later, bsdtar
SSH terminal	Webmin’s Terminal module, `Net::WebSocket::Server`, OpenSSH, Python 3
Graphical and serial consoles	Webmin’s Terminal module, `Net::WebSocket::Server`, Python 3; a VNC display for the graphical console
Serial output recording	`virtlogd` with `stdio_handler = "logd"`, a positive `max_size` and 1–32 backups
Host bridges on ifupdown	`bridge-utils`
Backup archives	`qemu-img`, Python 3

The root controller supplies a private kernel copy to each libguestfs worker; host kernel permissions stay unchanged.

What Is Cloudmin 10

Wed, 28 Oct 2026 00:00:00 +0000

Cloudmin 10 is a rewrite of Cloudmin around libvirt, the standard Linux API for managing virtual machines. It supports QEMU/KVM and runs as a module inside Webmin, using Webmin’s authentication, navigation, permissions and UI widgets.

The goal is simple: install Cloudmin on a supported Linux system, choose or supply an image, and get a safe, manageable KVM virtual machine without manual host setup. Cloudmin is useful on its own and integrates with Virtualmin for people who run hosting inside their guests.

How to Create a Virtual Machine

Wed, 28 Oct 2026 00:00:00 +0000

This guide walks through creating a KVM virtual machine from a cloud image on a freshly installed Cloudmin host.

Before you start

Log in to Webmin as a host administrator and open Cloudmin. The overview shows the host checks; fix any failed requirement first. Nothing else is needed: the installer already prepared a default storage pool, a NAT network and the EFI firmware, and the image catalogue is built in.

How to Delegate Access

Wed, 28 Oct 2026 00:00:00 +0000

Cloudmin uses Webmin users and module permissions. A host administrator sees and manages everything; a delegated user sees only the virtual machines assigned to them, with the actions you grant.

Host administrators

Granting the Cloudmin module to a Webmin user gives host administrator access by default, and existing users without saved Cloudmin permissions keep it. Creation, cloning, hardware editing, deletion, snapshots, backups, jobs, images, storage, networking and Module Configuration all require a host administrator.

Templates and Plans

Wed, 28 Oct 2026 00:00:00 +0000

Machine templates and resource plans are the presets behind the creation form. A template saves image, storage, network, guest access, software and boot defaults. A plan saves CPU, memory and system disk size. Both fill the form, where administrators can still change every value for one creation.

Where to find them

Both pages are under System Settings in the Cloudmin menu. The template editor uses a section selector with Previous, Next and Save and Next controls; resource plans use a collapsible Basic plan details section. Both use Webmin’s standard form widgets, Webmin configuration files, host access controls, form tokens, locking and audit logging. Reading presets never creates configuration files.

Virtualmin Templates and Guest Software

Wed, 28 Oct 2026 00:00:00 +0000

The Software section of a template or creation request can install packages, run scripts and install Virtualmin inside a new guest. Cloudmin tracks the work from the host and keeps the virtual machine if setup fails.

Guest software setup

Guest setup requires a cloud image and Start after creation. After cloud-init finishes, a dormant helper service inside the guest runs as root in this order: the preparation script, package installation, the optional Virtualmin installation, and the final setup script. Scripts use /bin/sh -e and can switch users for application work. A failed or interrupted step stops without repeating scripts and keeps the virtual machine, with the error naming the log location inside the guest.

Managing Virtual Machines

Wed, 28 Oct 2026 00:00:00 +0000

Select a virtual machine from the guest selector to open its details, actions and Remote Access above the host-wide navigation links. Everything below is also available through the API and command line.

Details and live status

The details page shows power state, guest agent status, SSH reachability, addresses, individual disks, guest filesystems, network interfaces, and disk and network transfer rates. Power state and inventory update through libvirt events over an authenticated WebSocket; browsers do not poll. CPU usage is normalized to the assigned CPUs, and memory usage comes from ten-second balloon reports and excludes reclaimable cache. Filesystem usage and guest OS details require the QEMU Guest Agent and refresh about once a minute.

Installer ISOs

Wed, 28 Oct 2026 00:00:00 +0000

Besides cloud images, Cloudmin can create a virtual machine that boots an installer ISO so you can install an operating system the traditional way.

Experimental
Installer ISO support is experimental. Alpine 3.24.2 ARM64 has passed a full installation and boot with the ISO ejected. Other installers still need testing.

Import the ISO

Open Image Manager and import the ISO from an HTTPS URL, a browser upload or a file on the host. Imports accept installer ISOs alongside standalone QCOW2 and raw disk images. A host-file import must be readable without root; use a browser upload for a private file.

Cloning

Wed, 28 Oct 2026 00:00:00 +0000

Cloning copies a virtual machine’s private writable disks into a new, independent machine. Choose Clone virtual machine from a guest’s action menu or Clone Virtual Machine on Edit Virtual Machine.

Requirements

Cloning works into directory, filesystem, NFS, LVM and LVM-thin pools; copies placed in an LVM pool become raw logical volumes. It requires libguestfs and its Perl bindings, bsdtar, and exactly one Linux installation that libguestfs can inspect. Prepared clones also require YAML::XS, enabled cloud-init inside the guest and one network interface.

Snapshots

Wed, 28 Oct 2026 00:00:00 +0000

Disk snapshots save the state of a virtual machine’s disks so you can return to it later. Open Snapshots from a guest’s menu for its history, or the host overview to see snapshots across all virtual machines.

Creating a snapshot

Snapshots cover private raw or QCOW2 file disks and managed LVM disks. On a running guest, Cloudmin asks the QEMU Guest Agent to freeze filesystem writes before the snapshot and thaws it afterwards, so the copy is filesystem-consistent. When the agent is not available you can choose an explicit clean shutdown first, or take an unprepared snapshot of the running disks. Filesystem freezing does not guarantee database consistency.

Image Manager

Wed, 28 Oct 2026 00:00:00 +0000

Image Manager holds the disk images that virtual machines are created from: catalogue cloud images, your own imports and installer ISOs. Importing an image does not create a virtual machine; use Create Virtual Machine to choose a catalogue image or an existing import.

The catalogue

The built-in catalogue lists cloud images of AlmaLinux, Alpine, Arch, CentOS Stream, Debian, Fedora, openSUSE, Rocky Linux and Ubuntu for the host’s architecture. Each entry records a stable ID, name, operating system, architecture, disk format, download size, minimum disk capacity, firmware and guest capabilities, release and support dates, and source URL. Catalogue downloads use HTTPS and are verified against the publisher’s SHA-256 or SHA-512 checksum manifest before import. Detached signature verification is Planned .

Creating Images from Virtual Machines

Wed, 28 Oct 2026 00:00:00 +0000

Pro Create Image turns an existing virtual machine’s system disk into a reusable image in Image Manager. It is part of the Cloudmin Pro extension; the shared module rejects capture when the extension is absent, including direct API requests.

Capturing an image

Choose Create image from a guest’s action menu or Create Image on Edit Virtual Machine. Enter an image name and a destination file pool (directory, filesystem or NFS), choose whether to remove login credentials for all local accounts, then choose whether to keep the source running with guest-agent preparation or shut it down cleanly before copying. Capture reuses the clone preparation, recovery and isolated guest preparation code, and requires libguestfs with its Perl bindings, YAML::XS 0.69 or later and bsdtar on the host. Host administrator access is required, and read-only sessions cannot submit a capture.

SSH Terminal

Wed, 28 Oct 2026 00:00:00 +0000

Open Remote Access → SSH terminal on a running virtual machine to connect from your browser using its host-managed key or a guest password. The terminal requires Webmin’s Terminal module, Net::WebSocket::Server, OpenSSH, Python 3 and systemd with systemd-run.

Connecting

The connection form offers the guest’s current IP addresses, the SSH port, the username and the authentication method. The default username comes from the virtual machine’s creation settings when available, and the SSH service card shows whether SSH answers on the saved port before you connect. Choose the host SSH key created for this virtual machine or password login; passwords are typed into the terminal and are never saved or logged by Cloudmin.

Serial and Graphical Consoles

Wed, 28 Oct 2026 00:00:00 +0000

The serial and graphical consoles reach a local virtual machine without a guest network, SSH service or guest agent. Both require the virtual machine’s console permission, a local libvirt connection, Webmin’s Terminal module, Net::WebSocket::Server, Python 3 and systemd with systemd-run.

Graphical console

Remote Access → Graphical console shows the guest’s screen and lets you use its keyboard and mouse, including during boot and OS installation. It requires a VNC display on the guest. Webmin authenticates the connection and libvirt opens the display directly, so VNC passwords stay on the host and no public VNC port is needed. Use Fullscreen for a larger view and the keyboard menu to send shortcuts such as Ctrl+Alt+Delete or Ctrl+Alt+F1; their effect depends on the guest. Select the tab again after a connection closes.

Webmin Access

Wed, 28 Oct 2026 00:00:00 +0000

The Webmin tab in Remote Access opens a Virtualmin guest’s Webmin from the host, either directly in a new tab or embedded through the host’s Webmin Servers Index proxy. The embedded view works for guests on private NAT networks that your browser cannot reach.

Who can use it

Only the host’s root Webmin login can register guests or use the Webmin tab, and Servers Index permissions apply on top, including read-only restrictions. Other users with creation permission can create virtual machines, but registration is skipped and their Remote Access page has no Webmin tab.

Virtual Networks and Bridges

Wed, 28 Oct 2026 00:00:00 +0000

Open Networking to see libvirt networks, host bridges, their addressing and the virtual machines attached to each. Cloudmin uses libvirt to manage virtual networks and guest interfaces, and Webmin’s network backends to create host bridges.

Virtual networks

The installer creates a persistent default NAT network after checking host routes, without changing the host’s management interface. On the Networking page you can create more NAT, routed and isolated networks. Networks referenced by stopped or running guests are protected from deletion.

Storage Pools

Wed, 28 Oct 2026 00:00:00 +0000

Storage in Cloudmin is a set of named libvirt pools. Storage lists each pool with its type, state, capacity, free space and volumes, and Module Configuration chooses the columns shown for pools and volumes.

Supported pools today

The installer prepares a default directory pool and tests it with a volume creation and deletion. Virtual machine creation, extra disks, cloning, snapshots, backups and restore work with directory, filesystem and NFS pools, using QCOW2 or raw files, and with LVM and LVM-thin pools, using raw logical volumes. Imported images, installation media, captured images and copied UEFI variable files always live in a file pool, so keep at least one directory, filesystem or NFS pool active. Mount NFS storage before using it as a pool, and mount remote storage before using a directory on it as a backup destination.

Backups and Restore

Wed, 28 Oct 2026 00:00:00 +0000

Open Backups and Restore from the Cloudmin menu, or choose Back up virtual machines from a machine’s actions. Each selected machine gets a separate full archive whose filename includes the guest name, the UTC date and the job ID.

What a backup contains

A full backup archives the virtual machine’s managed disks, whether QCOW2 or raw files or LVM logical volumes, its libvirt definition, UEFI variables for firmware-backed guests and a manifest with checksums. Backups use the same source preparation and recovery as cloning: a stopped source is archived directly, and a running source is frozen through the guest agent and snapshotted, through temporary overlays for file disks or native snapshots with a brief pause for LVM disks, or shut down cleanly if you prefer. A running source with both file and LVM disks needs the clean shutdown. Unlike clones, backups preserve the guest identity and license credentials.

Migrating from Cloudmin 9

Wed, 28 Oct 2026 00:00:00 +0000

Planned feature
The legacy import tool described here is a design target and is not available yet. Cloudmin 10 does not upgrade a Cloudmin 9 host in place, and a package upgrade never imports existing virtual machines.

Why import is explicit

Cloudmin 10 breaks internal compatibility with Cloudmin 9 on purpose, but it must not break user data. Existing KVM installations get a visible, tested import and rollback path, and Cloudmin 9 stays available and maintained for Xen users while the KVM line matures.

Virtual Machine API and CLI

Wed, 28 Oct 2026 00:00:00 +0000

The web interface, the command line and remote clients share one versioned API for virtual machine creation, power controls, management, cloning, backups, restore and host storage. The UI calls it internally; api.cgi exposes it over HTTP. The cloudmin command uses the same API on the host.

Requests and responses

Send a JSON object or form fields with an action. Responses are JSON with version: 1 and either result or error. Always check the error field: Webmin’s CGI server returns HTTP 200 for JSON responses. Actions that make changes require POST and a signed token returned by the options action, which also lists the images, pools, networks, templates and plans available to the caller.

Command Line API

Fri, 30 Oct 2026 00:00:00 +0000

Run cloudmin as root on the Cloudmin host. Lists use tables by default; --multiline shows details. --json returns an object with command, status and data fields; data holds the API result. Success exits 0, operation failures exit 1, and usage errors exit 2.

Commands wait for jobs by default; --no-wait returns the job ID immediately. Passwords and license credentials are read from files or standard input.

Each command has its own page with syntax, options and examples. cloudmin help COMMAND shows the same text on the host, and cloudmin COMMAND --help shows the syntax alone.

Privilege Separation

Wed, 28 Oct 2026 00:00:00 +0000

Cloudmin’s page handlers run as root, like other Webmin modules, but the risky work does not. Image and provisioning tools, consoles and relays run as separate processes without root privileges, even when the administrator is logged into Webmin as root.

What runs as root

Webmin, Cloudmin’s CGI scripts, the command line, the status collector and the controller jobs. They use normal Webmin initialization, authentication and permission checks, validate form tokens and input, record progress and make the libvirt changes. The module never installs host packages from a page request; cloudmin-install and Cloudmin-Config prepare the host.

list-systems

Fri, 30 Oct 2026 00:00:00 +0000

Lists the virtual machines on this host

cloudmin list-systems [--multiline | --json]
 [--name-only | --id-only]
 [--name name]*
 [--id uuid]*
 [--state running|stopped|paused]
 [--template ID|name]
 [--plan ID|name]

With no filters, lists the virtual machines visible to the caller, ordered by name. The default table shows each machine’s name, power state, CPU count, memory allocation and known IP addresses.

Use --name or --id to select exact names or UUIDs. Repeat either option to select several machines. Multiple values of the same option are alternatives; different filters must all match. For example, two --name options with --state running show only the named machines that are running. An empty result means no machines matched.

get-system

Fri, 30 Oct 2026 00:00:00 +0000

Shows a virtual machine and its saved settings

cloudmin get-system [--multiline | --json]
 (--name name | --id uuid)

Select one virtual machine with --name or --id. The result combines its inventory summary with its saved configuration, including resources, disks, network interfaces and boot settings. Use list-systems to find its name or UUID.

For a running machine, the result also includes running resource settings and any differences from the saved settings. Pending changes take effect after a full shutdown and start; an operating system reboot may not apply them. Use restart-system to perform that full restart.

start-system

Fri, 30 Oct 2026 00:00:00 +0000

Starts a stopped virtual machine

cloudmin start-system [--multiline | --json]
 [--no-wait]
 (--name name | --id uuid)

Select a stopped virtual machine with --name or --id. It starts with its saved hardware configuration, applying settings that were waiting for the next start. This command does not change whether the machine starts automatically when the host boots; use modify-system --autostart yes for that.

By default, waits up to two minutes for the host to report the machine running. That state does not mean the guest operating system, network, cloud-init or software installation is ready. --no-wait returns once the start request is accepted. It does not return a background job ID.

shutdown-system

Fri, 30 Oct 2026 00:00:00 +0000

Shuts down a virtual machine cleanly

cloudmin shutdown-system [--multiline | --json]
 [--no-wait]
 (--name name | --id uuid)

Requests a clean shutdown of the machine selected by --name or --id. The guest operating system must respond to the shutdown request. Its disks, saved hardware settings and automatic startup setting are retained.

By default, waits up to two minutes for the host to report the machine stopped. A timeout fails the command but does not cancel the shutdown request: the guest can still stop later. Cloudmin never turns a timed-out clean shutdown into a forced power-off.

reboot-system

Fri, 30 Oct 2026 00:00:00 +0000

Requests a guest operating system reboot

cloudmin reboot-system [--multiline | --json]
 (--name name | --id uuid)

Requests an operating system reboot of the running machine selected by --name or --id. This is a clean reboot request; the guest must respond to it. The command returns when libvirt accepts the request, without waiting for the guest to reboot or its services to become ready.

An operating system reboot does not guarantee that pending CPU, memory or boot configuration changes take effect. Use restart-system for a complete shutdown and start with the saved hardware configuration. Use reset-system only when an immediate hardware reset is intended.

pause-system

Fri, 30 Oct 2026 00:00:00 +0000

Pauses a running virtual machine

cloudmin pause-system [--multiline | --json]
 [--no-wait]
 (--name name | --id uuid)

Pauses execution of a running machine selected by --name or --id. Its memory and virtual devices remain allocated on the host. This is not a saved state on disk and does not survive stopping the machine or shutting down the host.

The guest cannot process requests while paused. Network connections and application operations may time out. Resume execution with unpause-system; use shutdown-system when the goal is to stop the operating system cleanly and release its resources.

unpause-system

Fri, 30 Oct 2026 00:00:00 +0000

Resumes a paused virtual machine

cloudmin unpause-system [--multiline | --json]
 [--no-wait]
 (--name name | --id uuid)

Resumes execution of a paused machine selected by --name or --id, using its existing memory and running hardware state. It does not boot the operating system again or apply settings saved for the next start.

By default, waits for the host to report the machine running. --no-wait returns after the resume request is accepted. Applications may need to reconnect after the pause, so a running state does not prove that all services have recovered.

restart-system

Fri, 30 Oct 2026 00:00:00 +0000

Shuts down and starts with the saved settings

cloudmin restart-system [--multiline | --json]
 [--no-wait]
 (--name name | --id uuid)

Performs a full shutdown and start of the machine selected by --name or --id. Use this to apply saved CPU, memory or boot settings that get-system shows as pending. A guest operating system reboot alone may leave those changes pending.

The operation runs as a background job. If the machine is running, the worker requests a clean shutdown and waits up to two minutes. A timeout fails the job without forcing the guest off or starting it again. A delayed guest shutdown may still finish after the job reports failure.

reset-system

Fri, 30 Oct 2026 00:00:00 +0000

Resets virtual hardware immediately

cloudmin reset-system [--multiline | --json]
 (--name name | --id uuid)
 --yes

Immediately resets the virtual hardware of the machine selected by --name or --id. The guest has no opportunity to stop applications or flush pending writes. Unsaved data can be lost. --yes is required to confirm this operation.

Use reboot-system for a clean operating system reboot. A hardware reset does not guarantee that pending saved hardware changes are applied; use a full shutdown and start for those changes.

poweroff-system

Fri, 30 Oct 2026 00:00:00 +0000

Powers off immediately without a clean shutdown

cloudmin poweroff-system [--multiline | --json]
 [--no-wait]
 (--name name | --id uuid)
 --yes

Immediately stops the machine selected by --name or --id, without asking the guest operating system to shut down. Unsaved data can be lost. --yes is required. Use shutdown-system when the guest can shut down cleanly.

The machine definition, disks and automatic startup setting are retained. Use start-system to start the machine again.

modify-system

Fri, 30 Oct 2026 00:00:00 +0000

Changes saved resources, boot settings or automatic startup

cloudmin modify-system [--multiline | --json]
 [--no-wait]
 (--name name | --id uuid)
 [--autostart yes|no]
 [--boot value]
 [--bootmenu yes|no]
 [--changes-file file|-]
 [--cpu-limit number]
 [--cpus number]
 [--desc value]
 [--enable-live]
 [--memory size]
 [--memory-limit size]

Changes selected settings of the machine identified by --name or --id. Omitted fields keep their existing values. The command reads the current configuration revision before submitting the update, so a conflicting concurrent edit can still cause the request to fail.

passwd-system

Fri, 30 Oct 2026 00:00:00 +0000

Changes an existing guest account password through its agent

cloudmin passwd-system [--multiline | --json]
 (--name name | --id uuid)
 --password-file file|-
 --user value

Changes the login password of an existing account inside the machine selected by --name or --id. --user names the guest account, not a Webmin user. The machine must be running with a responding QEMU guest agent. This command cannot create an account or reset a password in a stopped guest.

create-system

Fri, 30 Oct 2026 00:00:00 +0000

Creates a virtual machine from a cloud image or installer ISO

cloudmin create-system [--multiline | --json]
 [--no-wait]
 [--address-mode dhcp|static]
 [--after-script-file file|-]
 [--after-script-mode none|file|inline]
 [--after-script-path value]
 [--auth-type keys|password|both]
 [--autostart | --no-autostart]
 [--before-script-file file|-]
 [--before-script-mode none|file|inline]
 [--before-script-path value]
 [--cpus number]
 [--desc value]
 [--disk size]
 [--dns value]
 [--firmware auto|efi|bios]
 [--gateway4 value]
 [--gateway6 value]
 [--host-ssh-key | --no-host-ssh-key]
 [--hostname value]
 [--image ID|name]
 [--install-source cloud|iso]
 [--ipv4 value]
 [--ipv6 value]
 [--license-file file|-]
 [--license-serial-file file|-]
 [--mac value]
 [--memory size]
 --name value
 [--network ID|name]
 [--packages value]
 [--password-file file|-]
 [--plan ID|name]
 [--pool ID|name]
 [--require-fqdn | --no-require-fqdn]
 [--review]
 [--software none|virtualmin-gpl|virtualmin-pro]
 [--ssh-key value]*
 [--ssh-keys-file file|-]
 [--start | --no-start]
 [--template ID|name]
 [--username value]
 [--virtualmin-bundle LAMP|LEMP]
 [--virtualmin-postgres | --no-virtualmin-postgres]
 [--virtualmin-ssl | --no-virtualmin-ssl]
 [--virtualmin-type full|mini]
 [--webmin-register | --no-webmin-register]

Creates a new virtual machine named by --name. This name must be unused on the host. The operation runs as a background job; by default the command waits for creation and any selected software setup to finish. --no-wait returns the job ID instead.

clone-system

Fri, 30 Oct 2026 00:00:00 +0000

Copies a virtual machine to independent disks

cloudmin clone-system [--multiline | --json]
 [--no-wait]
 (--name name | --id uuid)
 [--address-mode dhcp|static]
 [--auth-type keys|password|both]
 [--autostart | --no-autostart]
 [--confirm-license]
 [--confirm-unchanged]
 [--cpus number]
 [--desc value]
 [--disk size]
 [--dns value]
 [--gateway4 value]
 [--gateway6 value]
 [--host-ssh-key | --no-host-ssh-key]
 [--hostname value]
 [--ipv4 value]
 [--ipv6 value]
 [--mac value]
 [--memory size]
 [--mode prepared|unchanged]
 [--network ID|name]
 --new-name value
 [--nvram-mode fresh|copy]
 [--password-file file|-]
 [--plan ID|name]
 [--pool ID|name]
 [--require-fqdn | --no-require-fqdn]
 [--shutdown]
 [--ssh-key value]*
 [--ssh-keys-file file|-]
 [--start | --no-start]
 [--template ID|name]
 [--username value]

Select the source with --name or --id, and give the destination an unused --new-name. Writable disks are copied to independent volumes with no backing files. The copy includes the source’s applications and data.

delete-system

Fri, 30 Oct 2026 00:00:00 +0000

Deletes a virtual machine and only the selected disk targets

cloudmin delete-system [--multiline | --json]
 [--no-wait]
 (--name name | --id uuid)
 [--disk value]*
 [--shutdown]
 --yes

Removes the definition of the machine selected by --name or --id. --yes is required. Disk deletion is a separate choice: with no --disk options, every disk is kept, including the cloud-init seed. Repeat --disk with attached target names such as vda to permanently delete only those disks. Use list-disks to inspect the targets first.

list-disks

Fri, 30 Oct 2026 00:00:00 +0000

Lists a virtual machine’s disks and removable drives

cloudmin list-disks [--multiline | --json]
 [--name-only | --id-only]
 (--name name | --id uuid)

Lists saved disk and removable-drive attachments for the machine selected by --name or --id. The default table shows the target, device type, role, format and path. Use it to distinguish writable disks, cloud-init seed media and CD/DVD drives before changing storage.

--target in disk commands refers to a guest device such as vda or sda, not a pool volume name, image ID or host path. --multiline or --json includes available volume details. --name-only and --id-only both print attachment targets, one per line.

create-disk

Fri, 30 Oct 2026 00:00:00 +0000

Creates and attaches a disk

cloudmin create-disk [--multiline | --json]
 [--no-wait]
 (--name name | --id uuid)
 [--disk size]
 [--image ID|name]
 --pool ID|name

Creates a disk in --pool and attaches it to the machine selected by --name or --id. Specify --disk for an empty disk, or --image for an independent copy of a ready imported image. File pools use QCOW2; LVM and LVM-thin pools use raw logical volumes. Catalogue entries must be imported before they can be used as additional disks.

attach-disk

Fri, 30 Oct 2026 00:00:00 +0000

Attaches an unused storage volume

cloudmin attach-disk [--multiline | --json]
 [--no-wait]
 (--name name | --id uuid)
 --pool ID|name
 --volume value

Attaches an existing unused volume to the machine selected by --name or --id. --pool identifies its storage pool, and --volume is the volume’s name inside that pool, not a host filesystem path. Use this when reusing a disk kept by detach-disk or machine deletion.

The volume must be a supported raw or QCOW2 disk and pass ownership and dependency checks. Cloudmin protects imported images and disks referenced by other machines or storage. To create a separate copy of an imported image, use create-disk --image instead.

detach-disk

Fri, 30 Oct 2026 00:00:00 +0000

Detaches a disk while keeping its data

cloudmin detach-disk [--multiline | --json]
 [--no-wait]
 (--name name | --id uuid)
 --target value

Removes an attachment from the machine selected by --name or --id while keeping the storage volume and its data. --target is an attached device name from list-disks, such as vdb. This is different from delete-disk, which also removes the volume permanently.

Before detaching a disk in use, stop the guest applications using it and unmount it. For live removal, Cloudmin waits for the device to disappear from libvirt’s running definition before updating the saved configuration. If the guest does not acknowledge removal, the job can fail and require recovery.

delete-disk

Fri, 30 Oct 2026 00:00:00 +0000

Detaches and permanently deletes one disk

cloudmin delete-disk [--multiline | --json]
 [--no-wait]
 (--name name | --id uuid)
 --target value
 --yes

Detaches and permanently deletes one managed disk from the machine selected by --name or --id. --target must be an attached disk target from list-disks. --yes confirms deletion. Other disks and the machine itself are retained.

Use detach-disk when the data should be kept. Deletion cannot be undone by job recovery. Imported images, shared disks and disks with protected dependencies are refused. Snapshot or checkpoint history can also block the operation.

resize-disk

Fri, 30 Oct 2026 00:00:00 +0000

Grows a disk to the specified total capacity

cloudmin resize-disk [--multiline | --json]
 [--no-wait]
 (--name name | --id uuid)
 --disk size
 --target value

Grows an attached disk on the machine selected by --name or --id. --target identifies the disk, and --disk is its new total capacity, not the amount to add. Bare sizes are GiB; for example, --disk 50G makes the disk 50 GiB.

Shrinking is not supported. Snapshots, checkpoints, shared storage or unsupported disk types can block growth. File disks can grow through libvirt while the guest runs. LVM and LVM-thin disks require the guest to be shut down first.

insert-media

Fri, 30 Oct 2026 00:00:00 +0000

Inserts an ISO in an existing CD/DVD drive

cloudmin insert-media [--multiline | --json]
 [--no-wait]
 (--name name | --id uuid)
 --pool ID|name
 --target value
 --volume value

Inserts an ISO volume into an existing CD/DVD drive on the machine selected by --name or --id. Find the drive target with list-disks, then supply that --target, the --pool containing the ISO and its --volume name. The volume name is not an image ID or a host path.

eject-media

Fri, 30 Oct 2026 00:00:00 +0000

Ejects media without removing the drive

cloudmin eject-media [--multiline | --json]
 [--no-wait]
 (--name name | --id uuid)
 --target value

Ejects the media from the CD/DVD target on the machine selected by --name or --id. Find the target with list-disks. The drive stays attached, and the ISO volume remains in its storage pool for later use.

This does not detach a writable disk or change the saved boot order. Supported guests can eject media while running. The command waits for the hardware job by default; --no-wait returns the job ID.

list-interfaces

Fri, 30 Oct 2026 00:00:00 +0000

Lists a virtual machine’s network interfaces

cloudmin list-interfaces [--multiline | --json]
 [--name-only | --id-only]
 (--name name | --id uuid)

Lists saved network interfaces for the machine selected by --name or --id. The default table shows each MAC address, source type, network or bridge, device model and link state. --multiline and --json include available bandwidth and other interface settings.

Interface commands identify an existing interface by its MAC address, not a guest name such as eth0. --name-only and --id-only therefore both print MAC addresses. Use list-networks to find network choices for adding or moving an interface.

add-interface

Fri, 30 Oct 2026 00:00:00 +0000

Adds a virtio network interface

cloudmin add-interface [--multiline | --json]
 [--no-wait]
 (--name name | --id uuid)
 [--mac value]
 --network ID|name

Adds a virtio network interface to the machine selected by --name or --id. --network selects an available virtual network or host bridge from list-networks. It accepts a network key, UUID, unambiguous name or bridge:NAME.

Cloudmin generates a MAC address unless --mac supplies one. The new interface can be attached live when the guest and host support it. The guest may need network configuration for the new device; this command does not rewrite its cloud-init seed or assign an IP address inside it.

modify-interface

Fri, 30 Oct 2026 00:00:00 +0000

Changes an interface’s network, link or bandwidth

cloudmin modify-interface [--multiline | --json]
 [--no-wait]
 (--name name | --id uuid)
 [--inbound-kib number]
 [--link up|down]
 --mac value
 [--network ID|name]
 [--outbound-kib number]

Changes the interface identified by --mac on the machine selected by --name or --id. Find the MAC address with list-interfaces. Omitted fields keep their current values; --mac selects the interface and does not change its address.

delete-interface

Fri, 30 Oct 2026 00:00:00 +0000

Removes a network interface

cloudmin delete-interface [--multiline | --json]
 [--no-wait]
 (--name name | --id uuid)
 --mac value

Removes the interface identified by --mac from the machine selected by --name or --id. Use list-interfaces to find its MAC address. This removes the virtual device; it does not delete the host network or bridge.

Removing an interface can disconnect the guest, including an SSH session using that interface. To disconnect it temporarily while keeping its configuration, use modify-interface --link down instead. Guest network configuration is not rewritten automatically.

list-snapshots

Fri, 30 Oct 2026 00:00:00 +0000

Lists snapshots for the host or one virtual machine

cloudmin list-snapshots [--multiline | --json]
 [--name-only | --id-only]
 [--name name | --id uuid]

With no machine selector, lists snapshots across the host. Supply --name or --id to limit the list to one virtual machine. --id is the machine UUID; a restore point’s own identifier is passed as --snapshot to restore or delete commands.

The default table shows snapshot ID, machine, label, state and creation time. --multiline or --json provides detailed records. --id-only and --name-only both print snapshot IDs, since labels need not be unique.

create-snapshot

Fri, 30 Oct 2026 00:00:00 +0000

Creates a disk snapshot

cloudmin create-snapshot [--multiline | --json]
 [--no-wait]
 (--name name | --id uuid)
 [--desc value]
 --label value
 [--mode prepared|unprepared]
 [--restart]
 [--shutdown]

Creates a disk restore point for the machine selected by --name or --id. --label is required; --desc adds an optional description. The label describes the restore point, while its generated ID is used for later restore and deletion.

The default --mode prepared uses the guest agent to freeze filesystems briefly when the machine is running. --shutdown permits a clean shutdown when the agent is unavailable. It does not force a shutdown when agent preparation is available. A stopped guest does not need an agent. Add --restart to start the machine after a successful snapshot if it was stopped for the operation.

restore-snapshot

Fri, 30 Oct 2026 00:00:00 +0000

Restores a saved snapshot

cloudmin restore-snapshot [--multiline | --json]
 [--no-wait]
 (--name name | --id uuid)
 [--restart]
 [--shutdown]
 --snapshot value
 --yes

Restores the machine selected by --name or --id to the restore point identified by --snapshot. Use list-snapshots to obtain that ID. --yes confirms replacing current disk contents and saved hardware settings with the snapshot’s state.

The machine must be stopped, or --shutdown must permit a clean shutdown first. Add --restart to start it after a successful restore. Without that flag, it remains stopped. A failed clean shutdown does not become a forced power-off.

delete-snapshot

Fri, 30 Oct 2026 00:00:00 +0000

Deletes a snapshot while keeping current disk data

cloudmin delete-snapshot [--multiline | --json]
 [--no-wait]
 (--name name | --id uuid)
 --snapshot value
 --yes

Removes the restore point identified by --snapshot from the machine selected by --name or --id. --yes is required. Use list-snapshots to select the snapshot ID, rather than its label.

Deleting a file snapshot merges its disk layers. Deleting an LVM snapshot removes its saved volumes. Both preserve the machine’s current disk contents and hardware settings. The selected restore point is no longer available afterward.

list-backups

Fri, 30 Oct 2026 00:00:00 +0000

Lists completed backup archives

cloudmin list-backups [--multiline | --json]
 [--name-only | --id-only]

Lists completed backup archives recorded by this Cloudmin host. The table includes backup job ID, source machine name, creation time, archive size and destination. Use the ID with inspect-backup --backup before restoring.

This is the local backup inventory, not a scan of every destination. An archive removed outside Cloudmin can still have a record here; inspection verifies that it is available and usable. Backups created on another host can be inspected by supplying their destination and filename directly.

backup-systems

Fri, 30 Oct 2026 00:00:00 +0000

Creates a full backup of one virtual machine

cloudmin backup-systems [--multiline | --json]
 [--no-wait]
 (--name name | --id uuid)
 [--compression | --no-compression]
 [--dest-access-file file|-]
 [--dest-account value]
 [--dest-bucket value]
 [--dest-ca-file value]
 [--dest-endpoint value]
 [--dest-host value]
 [--dest-key-file value]
 --dest-mode local|ssh|s3|gcs|azure|bb|dropbox|drive
 [--dest-password-file file|-]
 --dest-path value
 [--dest-port number]
 [--dest-project value]
 [--dest-refresh-token-file file|-]
 [--dest-region value]
 [--dest-secret-file file|-]
 [--dest-session-token-file file|-]
 [--dest-subscription value]
 [--dest-user value]
 [--shutdown]

Creates one complete virtual machine backup per command. Select the machine with --name or --id. The archive includes writable disks, the saved hardware definition and supported firmware state. It retains the guest’s identity and login settings for restoration.

inspect-backup

Fri, 30 Oct 2026 00:00:00 +0000

Verifies a backup archive before restoring it

cloudmin inspect-backup [--multiline | --json]
 [--no-wait]
 [--backup value]
 [--dest-access-file file|-]
 [--dest-account value]
 [--dest-bucket value]
 [--dest-ca-file value]
 [--dest-endpoint value]
 [--dest-host value]
 [--dest-key-file value]
 [--dest-mode local|ssh|s3|gcs|azure|bb|dropbox|drive]
 [--dest-password-file file|-]
 [--dest-path value]
 [--dest-port number]
 [--dest-project value]
 [--dest-refresh-token-file file|-]
 [--dest-region value]
 [--dest-secret-file file|-]
 [--dest-session-token-file file|-]
 [--dest-subscription value]
 [--dest-user value]
 [--filename value]

Retrieves and verifies a backup before restoration. --backup selects a backup job ID from list-backups and uses its saved destination. To inspect an archive that is not in this host’s inventory, supply destination options and --filename instead. The filename is the archive’s name within the destination, not the destination directory itself.

restore-systems

Fri, 30 Oct 2026 00:00:00 +0000

Restores an inspected backup with its original identity

cloudmin restore-systems [--multiline | --json]
 [--no-wait]
 --inspection value
 --pool ID|name
 --yes

Restores one backup that has already completed inspect-backup. --inspection is the inspection job ID, and --pool selects the destination storage pool. --yes confirms restoring the archived machine and disks.

Restoration preserves the original machine name, UUID, MAC addresses, guest credentials and supported firmware state. It refuses a conflicting existing name or UUID even if that machine is stopped. This command is for recovering a machine; use clone-system when you need another machine with a new identity.

list-images

Fri, 30 Oct 2026 00:00:00 +0000

Lists imported and catalogue images

cloudmin list-images [--multiline | --json]
 [--name-only | --id-only]

Lists ready imported images and available catalogue images that can be selected for machine creation. The default table shows ID, name and format. --multiline or --json includes the available image metadata and compatibility information.

Imported images use their stored image ID. Catalogue entries use catalogue:IMAGE_ID; create-system downloads or reuses the selected catalogue image as part of creation. An unambiguous display name is also accepted by image-selection options, but use the ID when names are duplicated.

list-networks

Fri, 30 Oct 2026 00:00:00 +0000

Lists usable virtual networks and host bridges

cloudmin list-networks [--multiline | --json]
 [--name-only | --id-only]

Lists available virtual networks and host bridges that Cloudmin offers for guest network interfaces. The default table shows a selection key, name, type and forwarding mode. Use it before create-system, add-interface or modify-interface.

A libvirt network key has the form network:UUID; a host bridge uses bridge:NAME. --id-only prints these selection keys, not just bare UUIDs. --name-only prints display names. Network options also accept a UUID or an unambiguous name.

get-host

Fri, 30 Oct 2026 00:00:00 +0000

Shows host capabilities

cloudmin get-host [--multiline | --json]

Shows host capabilities reported by Cloudmin, including relevant virtualization and image-handling support. Use this to check the host side of a creation or management requirement before choosing guest settings.

--multiline expands the capability fields, and --json returns structured data for scripts.

Use list-pools, list-networks and list-images for selectable resources. cloudmin api options returns the complete raw options response, including templates and plans, when a script needs those choices.

create-image

Fri, 30 Oct 2026 00:00:00 +0000

Creates a reusable image from a virtual machine (Cloudmin Pro)

cloudmin create-image [--multiline | --json]
 [--no-wait]
 (--name name | --id uuid)
 [--clean-credentials yes|no]
 --image-name value
 --pool ID|name
 [--shutdown]

Captures a reusable image from the machine selected by --name or --id. --image-name names the new image and --pool selects its storage pool. This operation requires Cloudmin Pro. Use backup-systems instead to preserve a complete machine for restoration.

list-jobs

Fri, 30 Oct 2026 00:00:00 +0000

Lists recent and unfinished jobs

cloudmin list-jobs [--multiline | --json]
 [--name-only | --id-only]

Lists recent and unfinished jobs recorded by Cloudmin. Jobs include creation, software setup, hardware changes, cloning, snapshots, image capture and backup operations. The default table shows ID, name, operation, state and phase.

Use --multiline for details, or --json for scripts. Results exclude private requests, credentials and recovery backups. --id-only prints job IDs for later get-job, cancel-job or recover-job calls. --name-only prints job names, which need not be unique.

get-job

Fri, 30 Oct 2026 00:00:00 +0000

Shows a job’s current progress

cloudmin get-job [--multiline | --json]
 --job value

Reads the current public record for --job. This is a job ID returned by a submitted operation or list-jobs, not a virtual machine UUID. It reports state, phase, recorded events, errors and available cleanup information.

The command reads once and returns; it does not keep following the worker. Use it after submitting an operation with --no-wait or after losing a terminal connection. --multiline expands details, while --json is suitable for polling from a script.

cancel-job

Fri, 30 Oct 2026 00:00:00 +0000

Requests cancellation at the next safe point

cloudmin cancel-job [--multiline | --json]
 [--no-wait]
 [--cleanup]
 --job value
 [--yes]

Requests cancellation of the unfinished job identified by --job. Cancellation takes effect at a safe point in the worker; it is not an immediate process kill. Copying and backup operations may need to restore source disk state before releasing their reservations.

Started hardware changes cannot be cancelled after their first write. If such a change fails, use recover-job. Completed, failed or already cancelled jobs cannot receive a new cancellation request.

recover-job

Fri, 30 Oct 2026 00:00:00 +0000

Resumes interrupted work or retries cleanup

cloudmin recover-job [--multiline | --json]
 [--no-wait]
 --job value

Reattaches or restarts work for the job identified by --job, including retrying cleanup marked as pending. It uses the original job’s recorded operation and resource identities rather than submitting a new request.

The result depends on the operation. Recovery can finish an interrupted hardware write, restore a source after copying, or remove incomplete creation resources. It checks the recorded state before proceeding and refuses unrelated changes. It cannot shrink a disk back after growth or recover data that was permanently deleted.

discard-job

Fri, 30 Oct 2026 00:00:00 +0000

Keeps completed disk growth and discards the remaining failed edits

cloudmin discard-job [--multiline | --json]
 --job value

Abandons the remaining edits of an eligible failed settings-update job while keeping disk growth that already completed. --job identifies that update. Use this only when you want to stop recovery of the remaining edits; recover-job attempts to finish them instead.

Cloudmin first checks that the original hardware definition is unchanged. It removes new disks allocated by the job only after verifying their identity and that nothing uses them. Completed disk growth remains because it cannot be undone safely.

list-pools

Fri, 30 Oct 2026 00:00:00 +0000

Lists active and inactive storage pools

cloudmin list-pools [--multiline | --json]
 [--name-only | --id-only]

Lists all registered storage pools, including stopped pools and LVM-thin destinations. The table shows each pool’s name, UUID, backend, active state and available space. Free space is unavailable for inactive pools.

Use --multiline for pool settings, volumes and references, or --json for the full records. --name-only and --id-only print one name or UUID per line. Creating a virtual machine requires an active pool with a supported backend.

list-volumes

Sat, 31 Oct 2026 00:00:00 +0000

Lists storage volumes and their owners

cloudmin list-volumes [--multiline | --json]
 [--name-only | --id-only]
 [--pool ID|name]

Lists volumes from active storage pools, with their pool, capacity, allocated space and owners. --pool accepts a UUID or a name that identifies exactly one pool, including LVM-thin destinations such as guests/thin. Omit it to list volumes across pools. Stopped pools cannot report their volumes.

--multiline and --json include ownership records and any reason deletion is blocked. A stopped virtual machine, imported image, snapshot or dependent disk can keep a volume in use. Cloudmin also blocks deletion when it cannot check these references. Listing volumes does not change storage.

list-volume-groups

Sat, 31 Oct 2026 00:00:00 +0000

Lists LVM volume groups available for registration

cloudmin list-volume-groups [--multiline | --json]
 [--name-only | --id-only]

Lists existing local LVM volume groups that have no libvirt registration. Groups already registered are excluded even when their pool is stopped. Thin pools appear as storage destinations after their parent group is registered.

Create and extend groups with Webmin’s Logical Volume Management module or the LVM tools. This command lists groups without allocating or formatting disks. If discovery fails, it reports an error.

create-pool

Sat, 31 Oct 2026 00:00:00 +0000

Registers a directory or an existing LVM volume group

cloudmin create-pool [--multiline | --json]
 [--autostart | --no-autostart]
 [--group value]
 --name value
 [--path value]

Registers a storage destination and starts it immediately. Supply a unique --name and exactly one of --path or --group. Directory paths must be absolute, have an existing parent and not overlap another pool. A missing directory is created; existing files and permissions are preserved.

start-pool

Sat, 31 Oct 2026 00:00:00 +0000

Starts a directory pool

cloudmin start-pool [--multiline | --json]
 --pool ID|name

Starts a stopped local directory pool with a saved registration. --pool accepts its UUID or a name that identifies exactly one pool. This includes pools unavailable for machine creation. The command reads the pool’s revision before starting it. If its settings change in the meantime, run the command again.

Starting does not create or format the directory or change its start-at-boot setting. This command does not start LVM pools.

stop-pool

Sat, 31 Oct 2026 00:00:00 +0000

Stops a directory pool without deleting its files

cloudmin stop-pool [--multiline | --json]
 --pool ID|name

Stops a local directory pool while keeping its saved registration and all files. Stop virtual machines using the pool and finish or cancel pending operations and image imports first. Start the pool again before using it for new storage operations.

The command checks the current revision and finishes before returning. It does not stop LVM pools. Use unregister-pool --stop to stop an unused LVM pool and remove its registration after checking for host and guest use.

set-pool-autostart

Sat, 31 Oct 2026 00:00:00 +0000

Changes whether a directory pool starts at boot

cloudmin set-pool-autostart [--multiline | --json]
 --enabled yes|no
 --pool ID|name

Changes whether a local directory pool with a saved registration starts with the host. Supply --pool as a UUID or unambiguous name and --enabled yes or --enabled no. This setting does not immediately start or stop the pool.

The command reads and checks the current revision before saving. LVM registrations receive their start-at-boot setting during create-pool; this command manages directory pools only.

delete-volume

Sat, 31 Oct 2026 00:00:00 +0000

Deletes an unused storage volume after a review

cloudmin delete-volume [--multiline | --json]
 (--review | --yes)
 --pool ID|name
 --volume value

Permanently deletes one unused volume from an active local directory or LVM destination. Supply --pool and the exact --volume name. --review shows owners and any refusal reason without changing anything or requiring --yes.

Deletion requires --yes. The command reviews the volume, then sends its revision for a final check under the host storage lock. A replaced volume, new reference or pending operation prevents deletion. Host mounts, swap and Cloudmin snapshots also block deletion. Deleting the volume destroys its data and cannot be undone.

unregister-pool

Sat, 31 Oct 2026 00:00:00 +0000

Removes a pool registration and keeps its data

cloudmin unregister-pool [--multiline | --json]
 (--review | --yes)
 --pool ID|name
 [--stop]

Removes the saved libvirt registration for a local directory or LVM pool. Files, logical volumes, volume groups and thin pools are preserved. Supply the parent pool’s UUID or unambiguous name with --pool. LVM-thin destinations cannot be unregistered separately.

--review shows references and any reason removal is blocked without requiring --yes. Removing the registration requires --yes and repeats the revision and reference checks. References from running or stopped guests, images, snapshots and dependent disks block removal, as do pending operations. Other inactive pools may need to be started so their references can be checked.

list-bridges

Fri, 30 Oct 2026 00:00:00 +0000

Lists host bridges outside libvirt-managed networks

cloudmin list-bridges [--multiline | --json]
 [--name-only | --id-only]

Lists host bridges outside libvirt-managed virtual networks. These bridges connect guests to the host’s existing network. Libvirt-managed NAT or routed bridges belong to their virtual networks and are not removal targets here.

The default table shows each bridge’s name, whether it is active, its addresses and its ports. --multiline and --json include saved-configuration and dependency details. --name-only and --id-only both print bridge names, such as br0.

get-bridge-status

Fri, 30 Oct 2026 00:00:00 +0000

Shows the current bridge transaction

cloudmin get-bridge-status [--multiline | --json]
 [--id value]

Shows the current host bridge transaction, including its state and available confirmation or recovery information. Without --id, selects the current transaction. With --id, requires that specific transaction so a stale script does not act on a newer change.

The transaction ID is returned by bridge changes; it is not the bridge name or a normal background job ID. The result can be empty when there is no transaction. --json returns structured status for scripts, and --multiline expands human-readable details.

remove-bridge

Fri, 30 Oct 2026 00:00:00 +0000

Moves the bridge’s network settings back to its Ethernet port

cloudmin remove-bridge [--multiline | --json]
 [--no-wait]
 --name value
 [--review]

Removes an unused, saved host bridge with one supported Ethernet port. --name is the bridge name from list-bridges, not a virtual machine name. The bridge’s current addresses, routes and DNS settings move back to its Ethernet port.

Cloudmin supports bridge removal with NetworkManager, Netplan and Debian ifupdown. It refuses unsupported layouts, bridges used by virtual machines or virtual networks, and VLANs or macvlans attached to the bridge or its port. A virtual machine can block removal even when stopped.

confirm-bridge

Fri, 30 Oct 2026 00:00:00 +0000

Keeps the new network settings after checking connectivity

cloudmin confirm-bridge [--multiline | --json]
 --id value

Keeps the new network settings for the pending bridge transaction identified by --id. Use the transaction ID returned by the change or get-bridge-status, not the bridge name. The transaction must still be awaiting confirmation and within its deadline.

Confirm only after reconnecting and checking the host’s network access. Cloudmin performs its connectivity checks before accepting confirmation. A confirmed change no longer rolls back automatically when the original deadline passes.

rollback-bridge

Fri, 30 Oct 2026 00:00:00 +0000

Requests recovery of the previous network settings

cloudmin rollback-bridge [--multiline | --json]
 [--no-wait]
 --id value

Requests restoration of the previous network settings for the bridge transaction identified by --id. Use the transaction ID from get-bridge-status. The transaction must still allow recovery; this is not an undo command for an already confirmed change.

Recovery runs on the host and can interrupt the SSH connection again as addresses move back. By default, the command waits for the transaction’s recovery result. --no-wait returns immediately; check get-bridge-status after reconnecting.

get-license

Sat, 31 Oct 2026 00:00:00 +0000

Shows the Cloudmin license status

cloudmin get-license [--multiline | --json]

Shows the Cloudmin license status, expiry and any grace deadline. The license key is never returned. GPL does not require a license.

cloudmin get-license

check-license

Sat, 31 Oct 2026 00:00:00 +0000

Rechecks the Cloudmin license with the license server

cloudmin check-license [--multiline | --json]

Checks the saved license with www.virtualmin.com. Use this after renewal or after fixing a connection problem. This command remains available when license restrictions block other changes.

cloudmin check-license

change-license

Sat, 31 Oct 2026 00:00:00 +0000

Validates and saves a Cloudmin Pro license

cloudmin change-license [--multiline | --json]
 --key-file file|-
 --serial value

Checks a new Cloudmin Pro license before saving it. Read the key from a private file or standard input. Failed validation leaves the current license in place.

cloudmin change-license --serial 12345 --key-file /root/cloudmin-key

Expiry grace lasts seven days after the expiry date ends in UTC. Migration grace lasts 21 days from when this host first detects use on too many hosts. A failed check allows up to 21 days from the last successful check, without extending expiry or migration deadlines. Existing machines, accepted jobs, scheduled backups, job recovery and network rollback keep working when new changes are blocked.

deregister-license

Sun, 01 Nov 2026 00:00:00 +0000

Removes this host’s Cloudmin license

cloudmin deregister-license [--multiline | --json]
 --yes

Removes this host’s saved license and repository credentials. Running machines, scheduled backups and accepted jobs continue. Pro updates and new changes through Cloudmin require a license again. Deregistration does not cancel your subscription or immediately remove the host from the license server’s count.

cloudmin deregister-license --yes

Options:

--yes: Confirm this operation.

api

Fri, 30 Oct 2026 00:00:00 +0000

Runs the raw JSON API with a request on standard input

cloudmin api [action] < request.json

Runs the raw JSON API entry point. Use cloudmin api ACTION with a JSON request object on standard input. This is useful for API fields that have no named-command option or for clients that already construct API requests. With no action, it returns options.

The raw response is a JSON object with version and result fields. Named commands use command, status and data instead. Raw errors are written to standard error and exit 1. Do not add named-command output flags such as --json or --multiline.