A simple, powerful CLI tool to spin up OpenIndiana virtual machines with QEMU
Update README to include VM management commands and bridge networking details
+59
-1
+59
-1
README.md
+59
-1
README.md
···
16
16
- 🌐 **SSH Ready** - Pre-configured port forwarding (host:2222 → guest:22)
17
17
- 🎛️ **Customizable** - Configure CPU, memory, cores, and disk options
18
18
- 📥 **Smart Caching** - Skips re-downloading existing ISO files
19
+
- 🎮 **VM Management** - Start, stop, list, and inspect virtual machines
20
+
- 📊 **State Persistence** - SQLite database tracks VM state and configuration
21
+
- 🏷️ **Auto-naming** - Generates unique names for VMs automatically
22
+
- 🌉 **Bridge Networking** - Support for bridge networking with custom network
23
+
interfaces
24
+
- 🆔 **MAC Address Management** - Automatic MAC address generation for network
25
+
devices
19
26
20
27
## 📋 Requirements
21
28
···
63
70
| `-m, --memory <size>` | RAM allocation | `2G` |
64
71
| `-d, --drive <path>` | Path to virtual disk image | None |
65
72
| `--disk-format <format>` | Disk format (qcow2, raw, etc.) | `raw` |
66
-
| `--bridge <name>` | Name of the network bridge to use for networking (e.g., br0) | None |
73
+
| `--size <size>` | Size of the VM disk image to create if it does not exist | `20G` |
74
+
| `-b, --bridge <name>` | Name of the network bridge to use for networking (e.g., br0) | None |
75
+
76
+
### VM Management Commands
77
+
78
+
| Command | Description |
79
+
| ---------------------------------- | --------------------------------------------- |
80
+
| `openindiana-up ps` | List all running virtual machines |
81
+
| `openindiana-up ps --all` | List all virtual machines (including stopped) |
82
+
| `openindiana-up start <vm-name>` | Start a stopped virtual machine |
83
+
| `openindiana-up stop <vm-name>` | Stop a running virtual machine |
84
+
| `openindiana-up inspect <vm-name>` | Inspect virtual machine configuration |
67
85
68
86
## 💡 Examples
69
87
···
95
113
openindiana-up -o ~/isos/openindiana.iso
96
114
```
97
115
116
+
### VM Management Examples
117
+
118
+
```bash
119
+
# List all running VMs
120
+
openindiana-up ps
121
+
122
+
# List all VMs (including stopped ones)
123
+
openindiana-up ps --all
124
+
125
+
# Start a specific VM
126
+
openindiana-up start my-vm-name
127
+
128
+
# Stop a running VM
129
+
openindiana-up stop my-vm-name
130
+
131
+
# Inspect VM configuration
132
+
openindiana-up inspect my-vm-name
133
+
```
134
+
135
+
### Bridge Networking
136
+
137
+
```bash
138
+
# Use bridge networking (requires bridge setup)
139
+
openindiana-up --bridge br0
140
+
```
141
+
142
+
### Automatic Disk Creation
143
+
144
+
```bash
145
+
# Automatically create a 50GB disk if it doesn't exist
146
+
openindiana-up --drive my-disk.qcow2 --disk-format qcow2 --size 50G
147
+
```
148
+
98
149
## 🖥️ Console Setup
99
150
100
151
When OpenIndiana boots, you'll see the boot menu. For the best experience with
···
158
209
- Downloaded ISOs are cached and won't be re-downloaded if they exist
159
210
- KVM acceleration requires `/dev/kvm` access on your host system
160
211
- Serial console is connected to stdio for direct interaction
212
+
- VM state is automatically persisted in a SQLite database at
213
+
`~/.openindiana-up/state.sqlite`
214
+
- Each VM gets a unique randomly generated name using the Moniker library
215
+
- MAC addresses are automatically generated for network devices
216
+
- Bridge networking requires proper bridge configuration and may need sudo
217
+
privileges
218
+
- VMs can be managed independently with start/stop/inspect commands
161
219
162
220
## 📜 License
163
221