...
| Method | GET |
|---|---|
| URL | /guests/$GUEST_ID |
| Request contents | Empty |
| Successful answer | GuestInfo Object |
| Non-successful answer | ErrorMessage Object |
| Unexpected error | HTTP 500 |
...
GuestInfo Object
...
Schema
| guest_id | String | Identificador único del Guest unique identifier |
|---|---|---|
| guest_type | String | Tipo de Guest type. Puede ser Either "normal", "template" o or "clone" |
| uuid | StringIdentificador | único por compatibilidad con libVirtlibVirt's unique identifier |
| description | StringCampo definido por el usuario, cuyo propósito original es describir el propósito del Guest | User defined field |
| sockets | StringNúmero | de sockets virtualesNumber of CPU sockets to be emulated |
| cores | String | Número de Number of cores por per socket to be emulated |
| vram | StringCantidad de memoria virtual en GB. | Amount (GB) of vRAM assigned to this Guest |
| audio_drv | String | Nombre del driver de audio asociado a este Guest. Puede ser Emulated audio device. Either "rtl8139" o or "ich6". |
| rtc_type | String | Nombre de la referencia base del reloj RTC. Puede ser RTC clock base reference. Either "local", "utc", o vacío or empty (legacy). |
| keyboard_drv | String | Nombre del driver de teclado asociado a este Guest. Puede ser Emulated keyboard device. Either "ps2", "usb", o vacío or empty (legacy). |
| cpu_emul | String | Nombre del modo de emulación de CPU de este Guest. Puede ser CPU emulation mode. Either "kvm", "amd" o vació or empty (legacy). |
| pool_id | String | Identificador único del Pool al que pertenece el GuestPool's unique identifier to where this Guest is assigned |
| desired_state | String | Estado deseado. Puede ser Desired state. Either "running", "stopped", "paused" o or "suspended" |
| current_state | String | Estado actual. Puede ser Current state. Either "unknown", "running", "stopped", "paused", "suspended" o or "migrating" |
| current_host | String | Host en el que está corriendo el Guest. Puede estar vacío.'s unique identifier where this Guest is running. Can be empty |
| current_host_address | String | Dirección VDI del Host que figura en current_host, si es distinta de la dirección de administraciónHost's VDI address, if different from management address |
| preferred_host | StringNombre | del Host preferido de este Guest.Preferred Host's unique identifier |
| parent_template | String | Para For Guests de tipo of type "clone", este campo especifica la plantilla padre.this field contains the unique identifier of parent template |
| clone_list | String Array de String | Para For Guests de tipo of type "template", este campo contiene una lista de Guests hijos.this field contains a list of child Guests |
| boot_from | String | Nombre del dispositivo de arranque. Puede ser First boot device. Either "cdrom", "hd" o or "network" |
| spice_port | String | Puerto TCP en port on current_host para la conexión a este Guest for SPICE connection |
| password | String | Ticket empleado para la conexión de for SPICE connection |
| disk_list | DiskInfo Array de DiskInfoListado de imágenes de disco asociadas | List of associated disk images |
| direct_disk_list | DirectDiskInfo Array de DirectDiskInfoListado de discos directos asociados | List of associated direct disks |
| iso_list | ISOInfo Array de ISOInfoListado de ISOs asociadas | List of associated ISOs |
| net_list | NetworkInfo Array de NetworkInfo | Listado de interfaces de red asociados |
...
| List of associated virtual network interfaces |
JSON example
{ "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"} |
...
DiskInfo Object
...
Schema
| devnum | String | Número para la ordenación del dispositivo en su busBus order number |
|---|---|---|
| bus | StringNombre | del bus para la conexión de este discoBus identifier |
| image_storage_id | StringIdentificador | único del ImageStorage que contiene el Volume especificado en volume_idImageStorage's unique idenfitier |
| volume_id | StringIdentificador | único del Volume que contiene la imagen de discoVolume's unique identifier |
| image_id | String | Identificador único de la imagen de disco |
...
| Image's unique identifier |
JSON example
{ "devnum": "0", "bus": "virtio", "volume_id": "home_flexvdi", "image_id": "corus", "image_storage_id": "internal"} |
...
DirectDiskInfo Object
Esquema de datos
| devnum | String | Número para la ordenación del dispositivo en su busBus order number |
|---|---|---|
| bus | StringNombre | del bus para la conexión de este discoBus identifier |
| direct_storage_id | StringIdentificador | único del DirectStorage que contiene el PhysicalDisk especificado en physical_disk_idDirectStorage's unique identifier |
| physical_disk_id | String | Identificador único del disco físico compartido |
...
| PhysicalDisk's unique identifier |
JSON example
{ "devnum": "1", "bus": "virtio", "direct_storage_id": "dstorage01", "physical_disk_id": "4021V3WF"} |
...
ISOInfo Object
...
Schema
| devnum | String | Número para la ordenación del dispositivo en su busBus order number |
|---|---|---|
| bus | StringNombre | del bus para la conexión de este discoBus identifier |
| media_storage_id | String | Identificador único del MediaStorage que contiene la ISO especificada en filename. Puede ser el valor especial MediaStorage's unique identifier. Can be "ms-empty, indicando que el dispositivo óptico está presente, pero vacío", which means the optical device is present, but empty. |
| filename | String | Nombre de la ISO. Puede ser el valor especial ISO's file name. Can be "ms-empty, indicando que el dispositivo óptico está presente, pero vacío. |
...
| ", which means the optical device is present, but empty. |
JSON example
{ "media_storage_id": "ms-empty", "filename": "ms-empty", "devnum": "0", "bus": "ide"} |
...
NetworkInfo Object
Esquema de datos
| device | String | Nombre del dispositivo para su ordenación en el S.O. invitadoDevice order number |
|---|---|---|
| hwaddr | String | Dirección MAC de la interfaz virtualaddress |
| bridge | StringPuente de red del Host al que se anclará este interfaz | Host's network bridge attached to this interface |
| driver | String | Nombre del driver que será emulado de cara al S.O. invitado. Puede ser Emulated network device. Either "virtio", "rtl8139" o or "e1000" |
| vlan_mode | String | Modo de VLAN para este interfaz. Puede ser mode. Either "none", "access" o or "trunk" |
| vlan_list | String Array de StringPara los modos de VLAN | For VLAN modes "access" o or "trunk", contiene la lista de VLANs permitidas |
...
| list of allowed VLANs |
JSON example
{ "device": "eth0", "hwaddr": "02:f1:00:14:00:05", "bridge": "virbr0", "driver": "virtio", "vlan_mode": "none", "vlan_list": ""} |