Host.json

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "#Host",
  "description": "A compute instance that itself owns a whole network stack and serves as an environment for workloads. Typically it runs an operating system. The exact host type is described in the _type property of the Entity. The UUID of the host should be captured in the _id property of the Entity",
  "type": "object",
  "allOf": [
    { "$ref": "#Entity" },
    {
      "properties": {
        "fqdn": {
          "description": "Fully qualified domain name(s)",
          "anyOf": [
            { "type": "string" },
            {
              "type": "array",
              "uniqueItems": true,
              "items": {
                "type": "string"
              }
            }
          ]
        },
        "hostname": {
          "description": "The primary/local hostname",
          "type": ["string", "null"]
        },
        "ipAddress": {
          "description": "A listing of all IP addresses associated with this Host",
          "anyOf": [
            { "type": "string", "format": "ip" },
            { "type": "string", "format": "ipCidr" },
            {
              "type": "array",
              "uniqueItems": true,
              "items": {
                "type": "string",
                "format": "ip"
              }
            },
            {
              "type": "array",
              "uniqueItems": true,
              "items": {
                "type": "string",
                "format": "ipCidr"
              }
            }
          ]
        },
        "publicDnsName": {
          "description": "The public DNS name",
          "type": "string",
          "format": "hostname"
        },
        "privateDnsName": {
          "description": "The private DNS name",
          "type": "string",
          "format": "hostname"
        },
        "publicIpAddress": {
          "description": "The public IP address or addresses",
          "anyOf": [
            { "type": "string", "format": "ip" },
            {
              "type": "array",
              "uniqueItems": true,
              "items": {
                "type": "string",
                "format": "ip"
              }
            }
          ]
        },
        "privateIpAddress": {
          "description": "The private IP address or addresses",
          "anyOf": [
            { "type": "string", "format": "ip" },
            {
              "type": "array",
              "uniqueItems": true,
              "items": {
                "type": "string",
                "format": "ip"
              }
            }
          ]
        },
        "macAddress": {
          "description": "A listing of all MAC addresses associated with this Host",
          "anyOf": [
            { "type": "string" },
            {
              "type": "array",
              "uniqueItems": true,
              "items": {
                "type": "string"
              }
            }
          ]
        },
        "platform": {
          "description": "Operating System Platform",
          "type": "string",
          "enum": [
            "darwin",
            "linux",
            "unix",
            "windows",
            "android",
            "ios",
            "embedded",
            "other"
          ]
        },
        "osDetails": {
          "description": "Operating System Full Details (e.g. macOS High Sierra version 10.13.6)",
          "type": "string"
        },
        "osName": {
          "description": "Operating System Name (e.g. macOS)",
          "type": "string"
        },
        "osVersion": {
          "description": "Operating System Version (e.g. 10.13.6)",
          "type": "string"
        },
        "physical": {
          "description": "Indicates if this is a physical host, such as a physical server.",
          "type": "boolean"
        },
        "state": {
          "description": "The current state of a host (e.g. pending, running, shutting-down, terminated, stopping, stopped)",
          "type": "string"
        }
      },
      "required": ["hostname"]
    }
  ]
}