virtualization/json-structure/virtualization-virtual-machine-structure.json at main · api-evangelist/virtualization · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/virtualization/refs/heads/main/json-structure/virtualization-virtual-machine-structure.json",
  "name": "VirtualMachine",
  "description": "Represents a virtual machine instance running on a hypervisor or cloud VM platform, including identity, sizing, image, networking, and lifecycle state.",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Provider-assigned unique identifier for the virtual machine.",
      "example": "i-0abcd1234ef567890"
    },
    "name": {
      "type": "string",
      "description": "Human-readable name of the virtual machine.",
      "example": "web-prod-01"
    },
    "platform": {
      "type": "string",
      "description": "Hypervisor or cloud platform that hosts this virtual machine.",
      "enum": [
        "vmware-vsphere",
        "microsoft-hyper-v",
        "kvm",
        "xen",
        "qemu",
        "proxmox-ve",
        "nutanix-ahv",
        "citrix-hypervisor",
        "amazon-ec2",
        "azure-vm",
        "google-compute-engine",
        "digitalocean",
        "linode",
        "hetzner",
        "scaleway",
        "ovhcloud",
        "openstack-nova",
        "kubevirt",
        "firecracker",
        "lima",
        "vagrant",
        "other"
      ],
      "example": "amazon-ec2"
    },
    "region": {
      "type": "string",
      "description": "Region or datacenter location of the virtual machine.",
      "example": "us-east-1"
    },
    "image": {
      "type": "object",
      "description": "Operating system image or template used to launch the VM.",
      "properties": {
        "id": {
          "type": "string",
          "example": "ami-0c55b159cbfafe1f0"
        },
        "name": {
          "type": "string",
          "example": "Ubuntu 24.04 LTS"
        },
        "os_family": {
          "type": "string",
          "enum": [
            "linux",
            "windows",
            "bsd",
            "other"
          ],
          "example": "linux"
        }
      }
    },
    "instance_type": {
      "type": "string",
      "description": "Provider-specific size or flavor of the VM.",
      "example": "t3.medium"
    },
    "cpu": {
      "type": "int32",
      "description": "Number of vCPUs allocated to the VM.",
      "example": 2
    },
    "memory_mb": {
      "type": "int32",
      "description": "Memory allocated to the VM in megabytes.",
      "example": 4096
    },
    "storage_gb": {
      "type": "int32",
      "description": "Primary disk size allocated to the VM in gigabytes.",
      "example": 80
    },
    "network": {
      "type": "object",
      "description": "Networking configuration for the VM.",
      "properties": {
        "private_ip": {
          "type": "string",
          "example": "10.0.1.42"
        },
        "public_ip": {
          "type": "string",
          "example": "203.0.113.10"
        },
        "vpc_id": {
          "type": "string",
          "example": "vpc-0e123abc456def789"
        }
      }
    },
    "state": {
      "type": "string",
      "description": "Current lifecycle state of the VM.",
      "enum": [
        "pending",
        "running",
        "stopping",
        "stopped",
        "rebooting",
        "terminating",
        "terminated",
        "error"
      ],
      "example": "running"
    },
    "tags": {
      "type": "map",
      "values": {
        "type": "string"
      },
      "description": "Free-form tags applied to the VM for grouping and policy."
    },
    "created_at": {
      "type": "datetime",
      "description": "Timestamp when the VM was created.",
      "example": "2026-05-18T14:32:10Z"
    }
  },
  "required": [
    "name",
    "platform",
    "state"
  ]
}