Attach a Server to a Network

v1.0.0

Attaches a Server to a network. This will complement the fixed public Server interface by adding an additional ethernet interface to the Server which is connected to the specified network.

The Server will get an IP auto assigned from a subnet of type server in the same network_zone.

Using the alias_ips attribute you can also define one or more additional IPs to the Servers. Please note that you will have to configure these IPs by hand on your Server since only the primary IP will be given out by DHCP.

Call specific error codes

Code	Description
`server_already_attached`	The server is already attached to the network
`ip_not_available`	The provided Network IP is not available
`no_subnet_available`	No Subnet or IP is available for the Server within the network
`networks_overlap`	The network IP range overlaps with one of the server networks

Input

{
  "type": "object",
  "properties": {
    "alias_ips": {
      "type": "array",
      "description": "Additional IPs to be assigned to this Server",
      "items": {
        "type": "string"
      }
    },
    "id": {
      "type": "integer"
    },
    "ip": {
      "type": "string",
      "description": "IP to request to be assigned to this Server; if you do not provide this then you will be auto assigned an IP address"
    },
    "network": {
      "type": "integer",
      "description": "ID of an existing network to attach the Server to"
    }
  },
  "required": [
    "id",
    "network"
  ],
  "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"
          ]
        }
      }
    }
  }
}