Format
| Method | GET |
|---|---|
| URL | /guests/$GUEST_ID |
| Request contents | Empty |
| Successful answer | GuestInfo Object |
| Non-successful answer | ErrorMessage Object |
| Unexpected error | HTTP 500 |
Objeto GuestInfo
Esquema de datos
| guest_id | String | Identificador único del Guest |
|---|---|---|
| guest_type | String | Tipo de Guest. Puede ser "normal", "template" o "clone" |
| uuid | String | Identificador único por compatibilidad con libVirt |
| description | String | Campo definido por el usuario, cuyo propósito original es describir el propósito del Guest |
| sockets | String | Número de sockets virtuales |
| cores | String | Número de cores por socket |
| vram | String | Cantidad de memoria virtual en GB. |
| audio_drv | String | Nombre del driver de audio asociado a este Guest. Puede ser "rtl8139" o "ich6". |
| rtc_type | String | Nombre de la referencia base del reloj RTC. Puede ser "local", "utc", o vacío (legacy). |
| keyboard_drv | String | Nombre del driver de teclado asociado a este Guest. Puede ser "ps2", "usb", o vacío (legacy). |
| cpu_emul | String | Nombre del modo de emulación de CPU de este Guest. Puede ser "kvm", "amd" o vació (legacy). |
| pool_id | String | Identificador único del Pool al que pertenece el Guest |
| desired_state | String | Estado deseado. Puede ser "running", "stopped", "paused" o "suspended" |
| current_state | String | Estado actual. Puede ser "unknown", "running", "stopped", "paused", "suspended" o "migrating" |
| current_host | String | Host en el que está corriendo el Guest. Puede estar vacío. |
| current_host_address | String | Dirección VDI del Host que figura en current_host, si es distinta de la dirección de administración |
| preferred_host | String | Nombre del Host preferido de este Guest. |
| parent_template | String | Para Guests de tipo "clone", este campo especifica la plantilla padre. |
| clone_list | Array de String | Para Guests de tipo "template", este campo contiene una lista de Guests hijos. |
| boot_from | String | Nombre del dispositivo de arranque. Puede ser "cdrom", "hd" o "network" |
| spice_port | String | Puerto TCP en current_host para la conexión a este Guest |
| password | String | Ticket empleado para la conexión de SPICE |
| disk_list | Array de DiskInfo | Listado de imágenes de disco asociadas |
| direct_disk_list | Array de DirectDiskInfo | Listado de discos directos asociados |
| iso_list | Array de ISOInfo | Listado de ISOs asociadas |
| net_list | Array de NetworkInfo | Listado de interfaces de red asociados |
Ejemplo en JSON
{ "rtc_type": "", "vram": "2", "desired_state": "stopped", "current_state": "stopped", "audio_drv": "ich6", "sockets": "1", "description": "", "cores": "2", "uuid": "e0f66dfb-cd6a-4683-b129-de00eb169da5", "current_host_address": "", "current_host": "None", "guest_type": "template", "preferred_host": "", "direct_disk_list": [], "parent_template": "", "guest_id": "corus", "disk_list": [{ "devnum": "0", "bus": "virtio", "volume_id": "home_flexvdi", "image_id": "corus", "image_storage_id": "internal" }], "iso_list": [{ "media_storage_id": "ms-empty", "filename": "ms-empty", "devnum": "0", "bus": "ide" }], "spice_port": "5905", "boot_from": "cdrom", "net_list": [{ "vlan_list": "", "vlan_mode": "none", "bridge": "virbr0", "driver": "virtio", "hwaddr": "02:f1:00:14:00:05", "device": "eth0" }], "clone_list": ["corus_demo"], "pool_id": "templates", "password": "ef176fc1-f2a5-4bbd-83d1-2279cc1228ef"} |
Objeto DiskInfo
Esquema de datos
| devnum | String | Número para la ordenación del dispositivo en su bus |
|---|---|---|
| bus | String | Nombre del bus para la conexión de este disco |
| image_storage_id | String | Identificador único del ImageStorage que contiene el Volume especificado en volume_id |
| volume_id | String | Identificador único del Volume que contiene la imagen de disco |
| image_id | String | Identificador único de la imagen de disco |
Ejemplo en JSON
{ "devnum": "0", "bus": "virtio", "volume_id": "home_flexvdi", "image_id": "corus", "image_storage_id": "internal"} |
Objeto DirectDiskInfo
Esquema de datos
| devnum | String | Número para la ordenación del dispositivo en su bus |
|---|---|---|
| bus | String | Nombre del bus para la conexión de este disco |
| direct_storage_id | String | Identificador único del DirectStorage que contiene el PhysicalDisk especificado en physical_disk_id |
| physical_disk_id | String | Identificador único del disco físico compartido |
Ejemplo en JSON
{ "devnum": "1", "bus": "virtio", "direct_storage_id": "dstorage01", "physical_disk_id": "4021V3WF"} |
Objeto ISOInfo
Esquema de datos
| devnum | String | Número para la ordenación del dispositivo en su bus |
|---|---|---|
| bus | String | Nombre del bus para la conexión de este disco |
| media_storage_id | String | Identificador único del MediaStorage que contiene la ISO especificada en filename. Puede ser el valor especial ms-empty, indicando que el dispositivo óptico está presente, pero vacío. |
| filename | String | Nombre de la ISO. Puede ser el valor especial ms-empty, indicando que el dispositivo óptico está presente, pero vacío. |
Ejemplo en JSON
{ "media_storage_id": "ms-empty", "filename": "ms-empty", "devnum": "0", "bus": "ide"} |
Objeto NetworkInfo
Esquema de datos
| device | String | Nombre del dispositivo para su ordenación en el S.O. invitado |
|---|---|---|
| hwaddr | String | Dirección MAC de la interfaz virtual |
| bridge | String | Puente de red del Host al que se anclará este interfaz |
| driver | String | Nombre del driver que será emulado de cara al S.O. invitado. Puede ser "virtio", "rtl8139" o "e1000" |
| vlan_mode | String | Modo de VLAN para este interfaz. Puede ser "none", "access" o "trunk" |
| vlan_list | Array de String | Para los modos de VLAN "access" o "trunk", contiene la lista de VLANs permitidas |
Ejemplo en JSON
{ "device": "eth0", "hwaddr": "02:f1:00:14:00:05", "bridge": "virbr0", "driver": "virtio", "vlan_mode": "none", "vlan_list": ""} |