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.
Virtual machines
- list-systems: Lists the virtual machines on this host.
- get-system: Shows a virtual machine and its saved settings.
- start-system: Starts a stopped virtual machine.
- shutdown-system: Shuts down a virtual machine cleanly.
- reboot-system: Requests a guest operating system reboot.
- pause-system: Pauses a running virtual machine.
- unpause-system: Resumes a paused virtual machine.
- restart-system: Shuts down and starts with the saved settings.
- reset-system: Resets virtual hardware immediately.
- poweroff-system: Powers off immediately without a clean shutdown.
- modify-system: Changes saved resources, boot settings or automatic startup.
- passwd-system: Changes an existing guest account password through its agent.
- create-system: Creates a virtual machine from a cloud image or installer ISO.
- clone-system: Copies a virtual machine to independent disks.
- delete-system: Deletes a virtual machine and only the selected disk targets.
Disks and interfaces
- list-disks: Lists a virtual machine’s disks and removable drives.
- create-disk: Creates and attaches a disk.
- attach-disk: Attaches an unused storage volume.
- detach-disk: Detaches a disk while keeping its data.
- delete-disk: Detaches and permanently deletes one disk.
- resize-disk: Grows a disk to the specified total capacity.
- insert-media: Inserts an ISO in an existing CD/DVD drive.
- eject-media: Ejects media without removing the drive.
- list-interfaces: Lists a virtual machine’s network interfaces.
- add-interface: Adds a virtio network interface.
- modify-interface: Changes an interface’s network, link or bandwidth.
- delete-interface: Removes a network interface.
Snapshots
- list-snapshots: Lists snapshots for the host or one virtual machine.
- create-snapshot: Creates a disk snapshot.
- restore-snapshot: Restores a saved snapshot.
- delete-snapshot: Deletes a snapshot while keeping current disk data.
Backups
- list-backups: Lists completed backup archives.
- backup-systems: Creates a full backup of one virtual machine.
- inspect-backup: Verifies a backup archive before restoring it.
- restore-systems: Restores an inspected backup with its original identity.
Host and images
- list-images: Lists imported and catalogue images.
- list-networks: Lists usable virtual networks and host bridges.
- get-host: Shows host capabilities.
- create-image: Creates a reusable image from a virtual machine (Cloudmin Pro).
Jobs
- list-jobs: Lists recent and unfinished jobs.
- get-job: Shows a job’s current progress.
- cancel-job: Requests cancellation at the next safe point.
- recover-job: Resumes interrupted work or retries cleanup.
- discard-job: Keeps completed disk growth and discards the remaining failed edits.
Host storage
- list-pools: Lists active and inactive storage pools.
- list-volumes: Lists storage volumes and their owners.
- list-volume-groups: Lists LVM volume groups available for registration.
- create-pool: Registers a directory or an existing LVM volume group.
- start-pool: Starts a directory pool.
- stop-pool: Stops a directory pool without deleting its files.
- set-pool-autostart: Changes whether a directory pool starts at boot.
- delete-volume: Deletes an unused storage volume after a review.
- unregister-pool: Removes a pool registration and keeps its data.
Host bridges
- list-bridges: Lists host bridges outside libvirt-managed networks.
- get-bridge-status: Shows the current bridge transaction.
- remove-bridge: Moves the bridge’s network settings back to its Ethernet port.
- confirm-bridge: Keeps the new network settings after checking connectivity.
- rollback-bridge: Requests recovery of the previous network settings.
License Manager
- get-license: Shows the Cloudmin license status.
- check-license: Rechecks the Cloudmin license with the license server.
- change-license: Validates and saves a Cloudmin Pro license.
- deregister-license: Removes this host’s Cloudmin license.
Raw API
- api: Runs the raw JSON API with a request on standard input.