Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

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

Abierto
  • ¿Algo no está bien?
#2,113 1 comentario 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
35/100
Tipo de issue
Nueva funcionalidad
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
typescript
Área
api, backend

Línea de trabajo

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.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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
Lenguaje dominante
TypeScript
Estrellas
115
Forks
23
Merge medio
4 d 1 h
PR fusionados (30 d)
7

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de unraid/api

Todos los issues de unraid/api

Issues similares

Más issues de TypeScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.