Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Expose per-VM details and stats on VmDomain (vCPUs, memory, disks, IPs, autostart, live usage)

Đang mở
  • Có gì không ổn?
#2,113 1 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
35/100
Loại issue
Tính năng
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
typescript
Lĩnh vực
api, backend

Hướng nghiên cứu

Start with vms.model.ts and VmsService, which the issue identifies as the VM model and existing libvirt connection entry point. Review the current VmDomain fields and how vm.start and vm.stop use that connection. Done means exposing the requested per-VM configuration, disk, network and uptime details, with optional live stats and nullable IPs; the issue does not name tests to run.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

Is your feature request related to a problem?

VmDomain exposes only id, name and state (uuid was added on main). A client can list VMs and start or stop them, but it can't show anything about a VM: how many vCPUs or how much memory it has, its disks, its IP address, whether it autostarts, or how busy it is. Docker containers get far more (image, status, ports and mounts, plus dockerContainerStats for live CPU and memory), so remote clients can show a useful container detail view but not a VM one.

I'm building an Android remote for Unraid (urrt) on the official API, and the VM tab can't go beyond a name, a state pill and action buttons.

Describe the solution you'd like

Add fields to VmDomain, all of which libvirt already provides on the server:

  • Configuration (from the domain XML / virDomainGetInfo): vcpus, memory and maxMemory (bytes), autostart, osType / machine, and the template icon (as the webGUI shows).
  • Disks: a list of { target (vda), source path, bus, capacity, allocation } (virDomainGetBlockInfo).
  • Network: a list of { mac, model, bridge or network, ipAddresses }, where the guest agent or DHCP lease reports them (virDomainInterfaceAddresses).
  • Live stats (optional, e.g. a vmStats subscription mirroring dockerContainerStats): CPU percent, memory in use, disk read/write and network rx/tx bytes per second (virConnectGetAllDomainStats / virDomainGetCPUStats).
  • Uptime / last state change, if available.

Everything can be nullable, so a VM without a guest agent simply returns null for its IPs.

Describe alternatives you've considered

  • Reading the webGUI's VM pages: needs a browser session, not an API key, and isn't a stable interface.
  • A companion plugin calling virsh on the server: works, but asks every user to install and trust another service for data the API process already has access to.
  • SSH from the client: not acceptable for a phone app.

Additional context

  • Related, not duplicate: #2036 adds a server-wide memory breakdown that includes VMs as a whole; this asks for per-VM detail.
  • Mutations like vm.start and vm.stop already use the same libvirt connection (VmsService), so the data is one call away.
  • Read access could stay behind the existing VMS:READ_ANY permission.

Environment (if relevant)

Unraid OS Version: 7.3.3 and 7.4.0-rc.1 (API 4.37.5); fields checked by schema introspection and in vms.model.ts on main.

Pre-submission Checklist

  • I have searched existing issues to ensure this feature hasn't already been requested
  • This is not an Unraid Connect related feature (if it is, please submit via the support form instead)
  • I have provided clear examples or use cases for the feature
Ngôn ngữ chính
TypeScript
Star
115
Fork
23
Merge trung bình
4 ngày 1 giờ
Pull request đã merge (30 ngày)
7

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của unraid/api

Tất cả issue của unraid/api

Issue tương tự

Thêm issue về TypeScript

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.