Hacktoberfest 2026：メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

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

オープン
  • 何か問題がありますか？
#2,113 コメント 1 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
35/100
issue の種類
機能追加
明瞭さ
明確に書かれている
活発さ
活発
技術スタック
typescript
領域
api, backend

調査の方向性

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.

索引モデルが issue の本文から書いたものです。

説明

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
主要言語
TypeScript
スター
115
フォーク
23
平均マージ
4日 1時間
マージ済み PR（30日）
7

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

unraid/api のほかの issue

unraid/api の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。