Retrieves a list of Libvirt machines

GET 
https://api.spectrocloud.com/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

Responses

200

An array of Libvirt machine items

application/json

Schema

Schema

items

undefined[]

required

Array [

apiVersionstring

kindstring

metadata

object

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

annotations

object

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations

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

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels

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 must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names

namespacestring

Namespace defines the space within each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces

resourceVersionstring

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency

selfLinkstring

SelfLink is a URL representing this object. Populated by the system. Read-only.

uidstring

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids

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

Defines CPU Passthrough Spec. A not null value enables CPU Passthrough for the libvirt domain. Further cache passthrough can be enabled with the CPU passthrough spec.

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

GPU configuration

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]

]

Example (from schema)

{
  "items": [
    {
      "apiVersion": "string",
      "kind": "string",
      "metadata": {
        "annotations": {},
        "creationTimestamp": "2024-07-02T20:32:02.203Z",
        "deletionTimestamp": "2024-07-02T20:32:02.203Z",
        "labels": {},
        "lastModifiedTimestamp": "2024-07-02T20:32:02.203Z",
        "name": "string",
        "namespace": "string",
        "resourceVersion": "string",
        "selfLink": "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-07-02T20:32:02.203Z",
          "state": "string"
        },
        "instanceState": "Pending"
      }
    }
  ]
}

• curl
• python
• go
• nodejs
• java

• CURL

curl -L -X GET 'https://api.spectrocloud.com/v1/cloudconfigs/libvirt/:configUid/machinePools/:machinePoolName/machines' \
-H 'Accept: application/json'

Request Collapse all

Base URL

https://api.spectrocloud.com

Parameters

configUid — pathrequired

machinePoolName — pathrequired