VirtualMachine

A CloudStack virtual machine resource with its configuration and runtime state.

ApacheCloudIaaSInfrastructureOpen SourceVirtualization

Properties

Name	Type	Description
id	string	UUID of the virtual machine.
name	string	Display name of the virtual machine.
state	string	Current state of the virtual machine.
zoneid	string	UUID of the zone containing the virtual machine.
zonename	string	Name of the zone containing the virtual machine.
serviceofferingid	string	UUID of the service offering used by the virtual machine.
templateid	string	UUID of the template used to create the virtual machine.
cpunumber	integer	Number of CPU cores.
memory	integer	Memory in megabytes.
ipaddress	string	Primary IP address of the virtual machine.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/apache-cloudstack/refs/heads/main/json-schema/cloudstack-api-virtual-machine-schema.json",
  "title": "VirtualMachine",
  "description": "A CloudStack virtual machine resource with its configuration and runtime state.",
  "type": "object",
  "properties": {
    "id": { "type": "string", "description": "UUID of the virtual machine.", "example": "vm-uuid-1234" },
    "name": { "type": "string", "description": "Display name of the virtual machine.", "example": "web-server-01" },
    "state": { "type": "string", "description": "Current state of the virtual machine.", "enum": ["Running", "Stopped", "Starting", "Stopping", "Destroyed", "Expunging", "Migrating", "Error"], "example": "Running" },
    "zoneid": { "type": "string", "description": "UUID of the zone containing the virtual machine.", "example": "zone-uuid-abcd" },
    "zonename": { "type": "string", "description": "Name of the zone containing the virtual machine.", "example": "us-east-1" },
    "serviceofferingid": { "type": "string", "description": "UUID of the service offering used by the virtual machine.", "example": "so-uuid-5678" },
    "templateid": { "type": "string", "description": "UUID of the template used to create the virtual machine.", "example": "tmpl-uuid-9012" },
    "cpunumber": { "type": "integer", "description": "Number of CPU cores.", "example": 2 },
    "memory": { "type": "integer", "description": "Memory in megabytes.", "example": 2048 },
    "ipaddress": { "type": "string", "description": "Primary IP address of the virtual machine.", "example": "10.0.0.100" }
  }
}