1
0
mirror of https://github.com/GNS3/gns3-server synced 2024-12-01 04:38:12 +00:00
gns3-server/gns3server/schemas/cloud.py

333 lines
11 KiB
Python

# -*- coding: utf-8 -*-
#
# Copyright (C) 2016 GNS3 Technologies Inc.
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
CLOUD_CREATE_SCHEMA = {
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Request validation to create a new cloud instance",
"type": "object",
"definitions": {
"EthernetInterfacePort": {
"description": "Ethernet interface port",
"properties": {
"name": {
"description": "Port name",
"type": "string",
"minLength": 1,
},
"port_number": {
"description": "Port number",
"type": "integer",
"minimum": 1
},
"type": {
"description": "Port type",
"enum": ["ethernet"]
},
"interface": {
"description": "Ethernet interface name e.g. eth0",
"type": "string",
"minLength": 1
},
},
"required": ["name", "port_number", "type", "interface"],
"additionalProperties": False
},
"TAPInterfacePort": {
"description": "TAP interface port",
"properties": {
"name": {
"description": "Port name",
"type": "string",
"minLength": 1,
},
"port_number": {
"description": "Port number",
"type": "integer",
"minimum": 1
},
"type": {
"description": "Port type",
"enum": ["tap"]
},
"interface": {
"description": "TAP interface name e.g. tap0",
"type": "string",
"minLength": 1
},
},
"required": ["name", "port_number", "type", "interface"],
"additionalProperties": False
},
"UDPTunnelPort": {
"description": "UDP tunnel port",
"properties": {
"name": {
"description": "Port name",
"type": "string",
"minLength": 1,
},
"port_number": {
"description": "Port number",
"type": "integer",
"minimum": 1
},
"type": {
"description": "Port type",
"enum": ["udp"]
},
"lport": {
"description": "Local UDP tunnel port",
"type": "integer",
"minimum": 1,
"maximum": 65535
},
"rhost": {
"description": "Remote UDP tunnel host",
"type": "string",
"minLength": 1
},
"rport": {
"description": "Remote UDP tunnel port",
"type": "integer",
"minimum": 1,
"maximum": 65535
}
},
"required": ["name", "port_number", "type", "lport", "rhost", "rport"],
"additionalProperties": False
},
"HostInterfaces": {
"description": "Interfaces on this host",
"properties": {
"name": {
"description": "Interface name",
"type": "string",
"minLength": 1,
},
"type": {
"enum": ["Ethernet", "TAP"]
},
},
"required": ["name", "type"],
"additionalProperties": False
},
},
"properties": {
"name": {
"description": "Cloud name",
"type": "string",
"minLength": 1,
},
"node_id": {
"description": "Node UUID",
"oneOf": [
{"type": "string",
"minLength": 36,
"maxLength": 36,
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"}
]
},
"ports": {
"type": "array",
"items": [
{"type": "object",
"oneOf": [
{"$ref": "#/definitions/EthernetInterfacePort"},
{"$ref": "#/definitions/TAPInterfacePort"},
{"$ref": "#/definitions/UDPTunnelPort"}
]},
]
},
"interfaces": {
"type": "array",
"items": [
{"type": "object",
"oneOf": [
{"$ref": "#/definitions/HostInterfaces"}
]},
]
},
},
"additionalProperties": False,
"required": ["name"]
}
CLOUD_OBJECT_SCHEMA = {
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Cloud instance",
"type": "object",
"definitions": {
"EthernetInterfacePort": {
"description": "Ethernet interface port",
"properties": {
"name": {
"description": "Port name",
"type": "string",
"minLength": 1,
},
"port_number": {
"description": "Port number",
"type": "integer",
"minimum": 1
},
"type": {
"description": "Port type",
"enum": ["ethernet"]
},
"interface": {
"description": "Ethernet interface name e.g. eth0",
"type": "string",
"minLength": 1
},
},
"required": ["name", "port_number", "type", "interface"],
"additionalProperties": False
},
"TAPInterfacePort": {
"description": "TAP interface port",
"properties": {
"name": {
"description": "Port name",
"type": "string",
"minLength": 1,
},
"port_number": {
"description": "Port number",
"type": "integer",
"minimum": 1
},
"type": {
"description": "Port type",
"enum": ["tap"]
},
"interface": {
"description": "TAP interface name e.g. tap0",
"type": "string",
"minLength": 1
},
},
"required": ["name", "port_number", "type", "interface"],
"additionalProperties": False
},
"UDPTunnelPort": {
"description": "UDP tunnel port",
"properties": {
"name": {
"description": "Port name",
"type": "string",
"minLength": 1,
},
"port_number": {
"description": "Port number",
"type": "integer",
"minimum": 1
},
"type": {
"description": "Port type",
"enum": ["udp"]
},
"lport": {
"description": "Local UDP tunnel port",
"type": "integer",
"minimum": 1,
"maximum": 65535
},
"rhost": {
"description": "Remote UDP tunnel host",
"type": "string",
"minLength": 1
},
"rport": {
"description": "Remote UDP tunnel port",
"type": "integer",
"minimum": 1,
"maximum": 65535
}
},
"required": ["name", "port_number", "type", "lport", "rhost", "rport"],
"additionalProperties": False
},
"HostInterfaces": {
"description": "Interfaces on this host",
"properties": {
"name": {
"description": "Interface name",
"type": "string",
"minLength": 1,
},
"type": {
"enum": ["ethernet", "tap"]
},
},
"required": ["name", "type"],
"additionalProperties": False
},
},
"properties": {
"name": {
"description": "Cloud name",
"type": "string",
"minLength": 1,
},
"node_id": {
"description": "Node UUID",
"type": "string",
"minLength": 36,
"maxLength": 36,
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"project_id": {
"description": "Project UUID",
"type": "string",
"minLength": 36,
"maxLength": 36,
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"ports": {
"type": "array",
"items": [
{"type": "object",
"oneOf": [
{"$ref": "#/definitions/EthernetInterfacePort"},
{"$ref": "#/definitions/TAPInterfacePort"},
{"$ref": "#/definitions/UDPTunnelPort"}
]},
]
},
"interfaces": {
"type": "array",
"items": [
{"type": "object",
"oneOf": [
{"$ref": "#/definitions/HostInterfaces"}
]},
]
},
"status": {
"description": "Node status",
"enum": ["started", "stopped", "suspended"]
},
},
"additionalProperties": False,
"required": ["name", "node_id", "project_id", "ports"]
}
CLOUD_UPDATE_SCHEMA = CLOUD_OBJECT_SCHEMA
del CLOUD_UPDATE_SCHEMA["required"]