Attach an ISO to a Server

v1.0.0

Attaches an ISO to a Server. The Server will immediately see it as a new disk. An already attached ISO will automatically be detached before the new ISO is attached.

Servers with attached ISOs have a modified boot order: They will try to boot from the ISO first before falling back to hard disk.

Input

{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer"
    },
    "iso": {
      "type": "string",
      "description": "ID or name of ISO to attach to the Server as listed in GET `/isos`"
    }
  },
  "required": [
    "id",
    "iso"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "required": [
    "action"
  ],
  "properties": {
    "action": {
      "type": "object",
      "required": [
        "command",
        "error",
        "finished",
        "id",
        "progress",
        "resources",
        "started",
        "status"
      ],
      "properties": {
        "command": {
          "type": "string",
          "description": "Command executed in the Action"
        },
        "error": {
          "type": "object",
          "description": "Error message for the Action if error occurred, otherwise null",
          "required": [
            "code",
            "message"
          ],
          "properties": {
            "code": {
              "type": "string",
              "description": "Fixed machine readable code"
            },
            "message": {
              "type": "string",
              "description": "Humanized error message"
            }
          }
        },
        "finished": {
          "type": "string",
          "description": "Point in time when the Action was finished (in ISO-8601 format). Only set if the Action is finished otherwise null."
        },
        "id": {
          "type": "integer",
          "description": "ID of the Resource"
        },
        "progress": {
          "type": "number",
          "description": "Progress of Action in percent"
        },
        "resources": {
          "type": "array",
          "description": "Resources the Action relates to",
          "items": {
            "type": "object",
            "required": [
              "id",
              "type"
            ],
            "properties": {
              "id": {
                "type": "integer",
                "description": "ID of the Resource"
              },
              "type": {
                "type": "string",
                "description": "Type of resource referenced"
              }
            }
          }
        },
        "started": {
          "type": "string",
          "description": "Point in time when the Action was started (in ISO-8601 format)"
        },
        "status": {
          "type": "string",
          "description": "Status of the Action",
          "enum": [
            "success",
            "running",
            "error"
          ]
        }
      }
    }
  }
}