# Documentation

> Learn how to define and manage KVM virtual machines with ansible-vms.

---

LLMS index: [llms.txt](/llms.txt)

---

Complete guide to defining and managing KVM virtual machines with Ansible and libvirt.

- [Getting Started](/docs/getting-started/) — Install dependencies and create your first VM
- [VM Definition](/docs/vm-definition/) — Configure VMs in `vms.csv`
- [VM Lifecycle](/docs/vm-lifecycle/) — List, start, stop, restart and destroy VMs
- [Base Images](/docs/base-images/) — Download Linux and Windows base images
- [Network](/docs/network/) — Bridge networking, DHCP and static IP
- [Data Disks](/docs/data-disks/) — Attach, resize and hot-plug data disks
- [Snapshots](/docs/snapshots/) — Create, restore and delete snapshots
- [User Accounts](/docs/setup-user/) — Create SSH users with passwordless sudo
- [VM Console](/docs/vm-console/) — VNC/SPICE and serial console access
- [Remote Desktop](/docs/remote-desktop/) — RDP access for Windows VMs
- [Firewall](/docs/firewall/) — Managed nftables firewall
- [macOS VMs](/docs/macos/) — Hackintosh guests with keyboard-free boot
- [macOS Base Image](/docs/macos-base-image/) — How the macOS base image was built
{.cards}

---

Section pages:

- [Getting Started](/docs/getting-started/): Install dependencies and create your first KVM virtual machine.
- [VM Definition (vms.csv)](/docs/vm-definition/): Configure virtual machines as rows in vms.csv.
- [VM Lifecycle](/docs/vm-lifecycle/): List, start, stop, restart, and destroy virtual machines.
- [Base Images](/docs/base-images/): Download Linux, Windows and macOS base images for VMs.
- [Network](/docs/network/): Bridge networking, DHCP, and static IP configuration for VMs.
- [Data Disks](/docs/data-disks/): Attach, resize, mount, and manage extra data disks.
- [Snapshots](/docs/snapshots/): Create, list, restore, and delete VM snapshots.
- [User Accounts](/docs/setup-user/): Create Linux user accounts with SSH key and passwordless sudo.
- [VM Console](/docs/vm-console/): Access the VM display console via SPICE or VNC.
- [Remote Desktop](/docs/remote-desktop/): RDP access to Windows virtual machines.
- [Firewall](/docs/firewall/): Manage the host firewall with nftables on Debian and RedHat family hosts.
- [macOS VMs](/docs/macos/): Run keyboard-free Hackintosh macOS guests alongside Linux and Windows VMs.
- [macOS Base Image](/docs/macos-base-image/): Build macos-sonoma-base.img from scratch with OSX-KVM on Debian 12.
