Retrieves a list of Libvirt machines

GET 
/v1/cloudconfigs/libvirt/:configUid/machinePools/:machinePoolName/machines

Retrieves a list of Libvirt machines

Request

Path Parameters

configUid stringrequired

Cluster's cloud config uid

machinePoolName stringrequired

Machine pool name

Header Parameters

ProjectUid string

Scope the request to the specified project uid

Responses

200

An array of Libvirt machine items

application/json

Schema

Schema

items

undefined[]

required

Array [

apiVersionstring

Deprecated. Not used for the resource info.

kindstring

Deprecated. Cloud type of the machine.

metadata

object

ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

annotations

object

Annotations are system generated key value metadata for the resource. As an input certain annotations like description can be set.

property name*string

creationTimestampdate-time

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

deletionTimestampdate-time

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

labels

object

Labels are key value data to organize and categorize resources. Providing spectro__tag as value for a label is considered as a kubernetes compliant tag

property name*string

lastModifiedTimestampdate-time

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

namestring

Name of the resource.

uidstring

UID is the unique identifier generated for the resource. This is not an input field for any request.

spec

object

libvirt cloud VM definition spec

disks

object[]

Array [

dataStoragePoolstring

DataStoragePool is the storage pool from which additional disks are assigned

managedboolean

Managed indicates if the disk is a persistent or not. By default its false indicating all disks are ephemeral.

sizeInGBint32required

SizeInGB is the target size in GB of the disk to be added

]

edgeHostUidstring

failureDomainstring

imageNamestring

instanceType

object

LibvirtInstanceType defines the instance configuration for a virtual machine

cpuPassthroughSpec

object

cachePassthroughboolean

isEnabledboolean

Enables the CPU Passthrough for the libvirt domain

cpusetstring

CPUSet defines cpuset for an instance which allows allocation specific set of cpus E.g cpuset="1-4,^3,6" See https://libvirt.org/formatdomain.html#cpu-allocation

gpuConfig

object

addresses

object

Addresses is a map of PCI device entry name to its addresses. Example entry would be "11:00.0 VGA compatible controller [0300]: NVIDIA Corporation Device [10de:1eb1] (rev a1)"- > 0000_11_00_0" The address is BDF (Bus Device Function) identifier format seperated by underscores. The first 4 bits are almost always 0000. In the above example 11 is Bus, 00 is Device,0 is function. The values of these addreses are expected in hexadecimal format

property name*string

deviceModelstring

DeviceModel is the model of GPU, for a given vendor, for eg., TU104GL [Tesla T4]

numGPUsint32

NumGPUs is the number of GPUs

vendorNamestring

VendorName is the GPU vendor, for eg., NVIDIA or AMD

memoryInMBint32required

MemoryinMB is the memory in megabytes

numCPUsint32required

NumCPUs is the number of CPUs

nics

object[]

Array [

indexint8

macAddressstringrequired

privateIPsstring[]

]

targetStoragePoolstring

status

object

cloud machine status

health

object

Machine health state

conditions

object[]

Array [

messagestring

reasonstring

statusstring

typestring

]

lastHeartBeatTimestampdate-time

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

statestring

instanceStatestring

Possible values: [Pending, Provisioning, Provisioned, Running, Deleting, Deleted, Failed, Unknown]

maintenanceStatus

object

Machine maintenance status

actionstring

messagestring

statestring

]

Example (from schema)

{
  "items": [
    {
      "apiVersion": "string",
      "kind": "string",
      "metadata": {
        "annotations": {},
        "creationTimestamp": "2024-04-16T17:49:00.385Z",
        "deletionTimestamp": "2024-04-16T17:49:00.385Z",
        "labels": {},
        "lastModifiedTimestamp": "2024-04-16T17:49:00.385Z",
        "name": "string",
        "uid": "string"
      },
      "spec": {
        "disks": [
          {
            "dataStoragePool": "string",
            "managed": true,
            "sizeInGB": 0
          }
        ],
        "edgeHostUid": "string",
        "failureDomain": "string",
        "imageName": "string",
        "instanceType": {
          "cpuPassthroughSpec": {
            "cachePassthrough": true,
            "isEnabled": true
          },
          "cpuset": "string",
          "gpuConfig": {
            "addresses": {},
            "deviceModel": "string",
            "numGPUs": 0,
            "vendorName": "string"
          },
          "memoryInMB": 0,
          "numCPUs": 0
        },
        "nics": [
          {
            "index": 0,
            "macAddress": "string",
            "privateIPs": [
              "string"
            ]
          }
        ],
        "targetStoragePool": "string"
      },
      "status": {
        "health": {
          "conditions": [
            {
              "message": "string",
              "reason": "string",
              "status": "string",
              "type": "string"
            }
          ],
          "lastHeartBeatTimestamp": "2024-04-16T17:49:00.385Z",
          "state": "string"
        },
        "instanceState": "Pending",
        "maintenanceStatus": {
          "action": "string",
          "message": "string",
          "state": "string"
        }
      }
    }
  ]
}

Loading...