#Command List
#Listing All VMs
Pretty Output
JSON Output
Command
crownpanel-cli vm listExample
+-------+---------+-------------------------+-----------------+----------------------------+----------------+----------+----------+-----------+
| VMID | STATUS | HOSTNAME | IP ADDRESS | LOCATION | VIRTUALIZATION | RAM (MB) | HDD (GB) | CPU CORES |
+-------+---------+-------------------------+-----------------+----------------------------+----------------+----------+----------+-----------+
| 1111 | Offline | test.vps.com | 185.243.114.134 | Frankfurt, Germany | KVM | 6144 | 50 | 6 |
| 2222 | Online | vps.server.com | 104.200.67.114 | Los Angeles, CA | KVM | 2048 | 40 | 3 |
+-------+---------+-------------------------+-----------------+----------------------------+----------------+----------+----------+-----------+Apply the --json flag to the command to receive output in JSON format
Command
crownpanel-cli vm list --jsonExample
[{"vmid":"1111","status":"Offline","hostname":"test.vps.com","ipaddress":"185.243.114.134","location":"Frankfurt, Germany","virtualization":"KVM","ram":"6144","hdd":"50","cpu":"6","bandwidth":"1024"},{"vmid":"2222","status":"Online","hostname":"vps.server.com","ipaddress":"104.200.67.114","location":"Los Angeles, CA","virtualization":"KVM","ram":"2048","hdd":"40","cpu":"3","bandwidth":"1024"}]#Specific VM Information
Pretty Output
JSON Output
Command
crownpanel-cli vm info 2222Example
user@home ~ # crownpanel-cli vm info 2222
+----------------+-----------------+
| FIELD | VALUE |
+----------------+-----------------+
| VMID | 2222 |
| Status | Online |
| Hostname | vps.server.com |
| IP Address | 104.200.67.114 |
| Location | Los Angeles, CA |
| Virtualization | KVM |
| RAM (MB) | 2048 |
| HDD (GB) | 40 |
| CPU Cores | 3 |
+----------------+-----------------+Apply the --json flag to the command to receive output in JSON format
Command
crownpanel-cli vm info 2222 --jsonExample
[{"vmid":"2222","status":"Online","hostname":"vps.server.com","ipaddress":"104.200.67.114","location":"Los Angeles, CA","virtualization":"KVM","ram":"2048","hdd":"40","cpu":"3","bandwidth":"1024"}]#Boot/Shutdown/Reboot/Hard Reboot
Pretty Output
JSON Output
Possible Errors
Boot
crownpanel-cli vm boot 2222Shutdown
crownpanel-cli vm shutdown 2222Reboot
crownpanel-cli vm reboot 2222Hard
crownpanel-cli vm hard_reboot 2222Example
user@home ~ # crownpanel-cli vm boot 53790
✅ query_status: Success | Success, Task Added. Please wait for 1-2 minutes for it to complete.Apply the --json flag to the command to receive output in JSON format
Command
crownpanel-cli vm boot 2222 --jsonExample
{"query_status":"Success","query":"boot","query_result":"Success, Task Added. Please wait for 1-2 minutes for it to complete."}If there is an existing task pending on the VM, you will recieve an error similar to the following,
Example
❌ query_status: Error | Error, There is an existing task pending for your VPS. Please wait 2 - 3 minutes for it to complete.#Specific VM Information
Pretty Output
JSON Output
Command
crownpanel-cli vm info 2222Example
user@home ~ # crownpanel-cli vm info 2222
+----------------+-----------------+
| FIELD | VALUE |
+----------------+-----------------+
| VMID | 2222 |
| Status | Online |
| Hostname | vps.server.com |
| IP Address | 104.200.67.114 |
| Location | Los Angeles, CA |
| Virtualization | KVM |
| RAM (MB) | 2048 |
| HDD (GB) | 40 |
| CPU Cores | 3 |
+----------------+-----------------+Apply the --json flag to the command to receive output in JSON format
Command
crownpanel-cli vm info 2222 --jsonExample
[{"vmid":"2222","status":"Online","hostname":"vps.server.com","ipaddress":"104.200.67.114","location":"Los Angeles, CA","virtualization":"KVM","ram":"2048","hdd":"40","cpu":"3","bandwidth":"1024"}]#VM Task Log
Pretty Output
JSON Output
Command
crownpanel-cli vm task-log 2222Example
user@home ~ # crownpanel-cli vm task-log 2222
+---------+--------------------------------+---------------------+----------+
| TASK ID | TASK | ADDED ON | STATUS |
+---------+--------------------------------+---------------------+----------+
| 3274223 | Restart VNC | 2025-08-11 22:08:12 | Complete |
| 3274197 | Change CPU Mode | 2025-08-11 22:00:22 | Complete |
| | [host-passthrough] | | |
| 3169925 | Hard Reboot | 2025-07-26 18:31:53 | Complete |
| 3111091 | Hard Reboot | 2025-07-17 23:51:11 | Complete |
| 3104408 | Boot | 2025-07-16 22:18:34 | Complete |
| 3104319 | Boot | 2025-07-16 21:53:10 | Complete |
| 3104317 | Boot | 2025-07-16 21:52:54 | Complete |
| 3104308 | Boot | 2025-07-16 21:50:13 | Complete |
| 3104307 | Boot | 2025-07-16 21:50:00 | Complete |
| 3104302 | Boot | 2025-07-16 21:48:41 | Complete |
| 3102865 | Boot | 2025-07-16 15:26:10 | Complete |
| 3102860 | Shutdown | 2025-07-16 15:24:23 | Complete |
+---------+--------------------------------+---------------------+----------+Apply the --json flag to the command to receive output in JSON format
Command
crownpanel-cli vm task-log 2222 --jsonExample
[{"task_id":"3274223","task":"Restart VNC","task_added_on":"2025-08-11 22:08:12","task_status":"1"},{"task_id":"3274197","task":"Change CPU Mode [host-passthrough]","task_added_on":"2025-08-11 22:00:22","task_status":"1"},{"task_id":"3169925","task":"Hard Reboot","task_added_on":"2025-07-26 18:31:53","task_status":"1"},{"task_id":"3111091","task":"Hard Reboot","task_added_on":"2025-07-17 23:51:11","task_status":"1"},{"task_id":"3104408","task":"Boot","task_added_on":"2025-07-16 22:18:34","task_status":"1"},{"task_id":"3104319","task":"Boot","task_added_on":"2025-07-16 21:53:10","task_status":"1"},{"task_id":"3104317","task":"Boot","task_added_on":"2025-07-16 21:52:54","task_status":"1"},{"task_id":"3104308","task":"Boot","task_added_on":"2025-07-16 21:50:13","task_status":"1"},{"task_id":"3104307","task":"Boot","task_added_on":"2025-07-16 21:50:00","task_status":"1"},{"task_id":"3104302","task":"Boot","task_added_on":"2025-07-16 21:48:41","task_status":"1"},{"task_id":"3102865","task":"Boot","task_added_on":"2025-07-16 15:26:10","task_status":"1"},{"task_id":"3102860","task":"Shutdown","task_added_on":"2025-07-16 15:24:23","task_status":"1"}]#VM Bandwidth Usage
Pretty Output
JSON Output
Command
crownpanel-cli vm bandwidth-usage 2222Example
user@home ~ # crownpanel-cli vm bandwidth-usage 2222
1719.99Apply the --json flag to the command to receive output in JSON format
Command
crownpanel-cli vm bandwidth-usage 2222 --jsonExample
1719.99#VM Bandwidth Usage Percentage
Pretty Output
JSON Output
Command
crownpanel-cli vm bandwidth-usage-percentage 2222Example
user@home ~ # crownpanel-cli vm bandwidth-usage-percentage 2222
0.1640625Apply the --json flag to the command to receive output in JSON format
Command
crownpanel-cli vm bandwidth-usage-percentage 2222 --jsonExample
0.1640625