mirror of https://github.com/GNS3/gns3-server
grossmj
9 years ago
parent
4f38d96522
commit
f99e834c37
@ -0,0 +1,234 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
#
|
||||
# Copyright (C) 2015 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/>.
|
||||
|
||||
|
||||
import asyncio
|
||||
from ..web.route import Route
|
||||
from ..schemas.dynamips_device import DEVICE_CREATE_SCHEMA
|
||||
from ..schemas.dynamips_device import DEVICE_UPDATE_SCHEMA
|
||||
from ..schemas.dynamips_device import DEVICE_CAPTURE_SCHEMA
|
||||
from ..schemas.dynamips_device import DEVICE_OBJECT_SCHEMA
|
||||
from ..schemas.dynamips_device import DEVICE_NIO_SCHEMA
|
||||
from ..modules.dynamips import Dynamips
|
||||
|
||||
|
||||
class DynamipsDeviceHandler:
|
||||
|
||||
"""
|
||||
API entry points for Dynamips devices.
|
||||
"""
|
||||
|
||||
@classmethod
|
||||
@Route.post(
|
||||
r"/projects/{project_id}/dynamips/devices",
|
||||
parameters={
|
||||
"project_id": "UUID for the project"
|
||||
},
|
||||
status_codes={
|
||||
201: "Instance created",
|
||||
400: "Invalid request",
|
||||
409: "Conflict"
|
||||
},
|
||||
description="Create a new Dynamips device instance",
|
||||
input=DEVICE_CREATE_SCHEMA,
|
||||
output=DEVICE_OBJECT_SCHEMA)
|
||||
def create(request, response):
|
||||
|
||||
dynamips_manager = Dynamips.instance()
|
||||
device = yield from dynamips_manager.create_device(request.json.pop("name"),
|
||||
request.match_info["project_id"],
|
||||
request.json.get("device_id"),
|
||||
request.json.get("device_type"))
|
||||
|
||||
response.set_status(201)
|
||||
response.json(device)
|
||||
|
||||
@classmethod
|
||||
@Route.get(
|
||||
r"/projects/{project_id}/dynamips/devices/{device_id}",
|
||||
parameters={
|
||||
"project_id": "UUID for the project",
|
||||
"device_id": "UUID for the instance"
|
||||
},
|
||||
status_codes={
|
||||
200: "Success",
|
||||
400: "Invalid request",
|
||||
404: "Instance doesn't exist"
|
||||
},
|
||||
description="Get a Dynamips device instance",
|
||||
output=DEVICE_OBJECT_SCHEMA)
|
||||
def show(request, response):
|
||||
|
||||
dynamips_manager = Dynamips.instance()
|
||||
device = dynamips_manager.get_device(request.match_info["device_id"], project_id=request.match_info["project_id"])
|
||||
response.json(device)
|
||||
|
||||
@classmethod
|
||||
@Route.put(
|
||||
r"/projects/{project_id}/dynamips/devices/{device_id}",
|
||||
parameters={
|
||||
"project_id": "UUID for the project",
|
||||
"device_id": "UUID for the instance"
|
||||
},
|
||||
status_codes={
|
||||
200: "Instance updated",
|
||||
400: "Invalid request",
|
||||
404: "Instance doesn't exist",
|
||||
409: "Conflict"
|
||||
},
|
||||
description="Update a Dynamips device instance",
|
||||
input=DEVICE_UPDATE_SCHEMA,
|
||||
output=DEVICE_OBJECT_SCHEMA)
|
||||
def update(request, response):
|
||||
|
||||
dynamips_manager = Dynamips.instance()
|
||||
device = dynamips_manager.get_device(request.match_info["device_id"], project_id=request.match_info["project_id"])
|
||||
|
||||
if "name" in request.json:
|
||||
yield from device.set_name(request.json["name"])
|
||||
|
||||
if "ports" in request.json:
|
||||
for port in request.json["ports"]:
|
||||
yield from device.set_port_settings(port["port"], port)
|
||||
|
||||
response.json(device)
|
||||
|
||||
@classmethod
|
||||
@Route.delete(
|
||||
r"/projects/{project_id}/dynamips/devices/{device_id}",
|
||||
parameters={
|
||||
"project_id": "UUID for the project",
|
||||
"device_id": "UUID for the instance"
|
||||
},
|
||||
status_codes={
|
||||
204: "Instance deleted",
|
||||
400: "Invalid request",
|
||||
404: "Instance doesn't exist"
|
||||
},
|
||||
description="Delete a Dynamips device instance")
|
||||
def delete(request, response):
|
||||
|
||||
dynamips_manager = Dynamips.instance()
|
||||
yield from dynamips_manager.delete_device(request.match_info["device_id"])
|
||||
response.set_status(204)
|
||||
|
||||
@Route.post(
|
||||
r"/projects/{project_id}/dynamips/devices/{device_id}/ports/{port_number:\d+}/nio",
|
||||
parameters={
|
||||
"project_id": "UUID for the project",
|
||||
"device_id": "UUID for the instance",
|
||||
"port_number": "Port on the device"
|
||||
},
|
||||
status_codes={
|
||||
201: "NIO created",
|
||||
400: "Invalid request",
|
||||
404: "Instance doesn't exist"
|
||||
},
|
||||
description="Add a NIO to a Dynamips device instance",
|
||||
input=DEVICE_NIO_SCHEMA)
|
||||
def create_nio(request, response):
|
||||
|
||||
dynamips_manager = Dynamips.instance()
|
||||
device = dynamips_manager.get_device(request.match_info["device_id"], project_id=request.match_info["project_id"])
|
||||
nio = yield from dynamips_manager.create_nio(device, request.json["nio"])
|
||||
port_number = int(request.match_info["port_number"])
|
||||
port_settings = request.json.get("port_settings")
|
||||
mappings = request.json.get("mappings")
|
||||
|
||||
if asyncio.iscoroutinefunction(device.add_nio):
|
||||
yield from device.add_nio(nio, port_number)
|
||||
else:
|
||||
device.add_nio(nio, port_number)
|
||||
|
||||
if port_settings:
|
||||
yield from device.set_port_settings(port_number, port_settings)
|
||||
elif mappings:
|
||||
yield from device.set_mappings(mappings)
|
||||
|
||||
response.set_status(201)
|
||||
response.json(nio)
|
||||
|
||||
@classmethod
|
||||
@Route.delete(
|
||||
r"/projects/{project_id}/dynamips/devices/{device_id}/ports/{port_number:\d+}/nio",
|
||||
parameters={
|
||||
"project_id": "UUID for the project",
|
||||
"device_id": "UUID for the instance",
|
||||
"port_number": "Port on the device"
|
||||
},
|
||||
status_codes={
|
||||
204: "NIO deleted",
|
||||
400: "Invalid request",
|
||||
404: "Instance doesn't exist"
|
||||
},
|
||||
description="Remove a NIO from a Dynamips device instance")
|
||||
def delete_nio(request, response):
|
||||
|
||||
dynamips_manager = Dynamips.instance()
|
||||
device = dynamips_manager.get_device(request.match_info["device_id"], project_id=request.match_info["project_id"])
|
||||
port_number = int(request.match_info["port_number"])
|
||||
yield from device.remove_nio(port_number)
|
||||
response.set_status(204)
|
||||
|
||||
# @Route.post(
|
||||
# r"/projects/{project_id}/dynamips/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/start_capture",
|
||||
# parameters={
|
||||
# "project_id": "UUID for the project",
|
||||
# "vm_id": "UUID for the instance",
|
||||
# "adapter_number": "Adapter to start a packet capture",
|
||||
# "port_number": "Port on the adapter"
|
||||
# },
|
||||
# status_codes={
|
||||
# 200: "Capture started",
|
||||
# 400: "Invalid request",
|
||||
# 404: "Instance doesn't exist"
|
||||
# },
|
||||
# description="Start a packet capture on a Dynamips VM instance",
|
||||
# input=VM_CAPTURE_SCHEMA)
|
||||
# def start_capture(request, response):
|
||||
#
|
||||
# dynamips_manager = Dynamips.instance()
|
||||
# vm = dynamips_manager.get_vm(request.match_info["vm_id"], project_id=request.match_info["project_id"])
|
||||
# slot_number = int(request.match_info["adapter_number"])
|
||||
# port_number = int(request.match_info["port_number"])
|
||||
# pcap_file_path = os.path.join(vm.project.capture_working_directory(), request.json["capture_file_name"])
|
||||
# yield from vm.start_capture(slot_number, port_number, pcap_file_path, request.json["data_link_type"])
|
||||
# response.json({"pcap_file_path": pcap_file_path})
|
||||
#
|
||||
# @Route.post(
|
||||
# r"/projects/{project_id}/dynamips/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/stop_capture",
|
||||
# parameters={
|
||||
# "project_id": "UUID for the project",
|
||||
# "vm_id": "UUID for the instance",
|
||||
# "adapter_number": "Adapter to stop a packet capture",
|
||||
# "port_number": "Port on the adapter (always 0)"
|
||||
# },
|
||||
# status_codes={
|
||||
# 204: "Capture stopped",
|
||||
# 400: "Invalid request",
|
||||
# 404: "Instance doesn't exist"
|
||||
# },
|
||||
# description="Stop a packet capture on a Dynamips VM instance")
|
||||
# def start_capture(request, response):
|
||||
#
|
||||
# dynamips_manager = Dynamips.instance()
|
||||
# vm = dynamips_manager.get_vm(request.match_info["vm_id"], project_id=request.match_info["project_id"])
|
||||
# slot_number = int(request.match_info["adapter_number"])
|
||||
# port_number = int(request.match_info["port_number"])
|
||||
# yield from vm.stop_capture(slot_number, port_number)
|
||||
# response.set_status(204)
|
||||
|
||||
@ -0,0 +1,341 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
#
|
||||
# Copyright (C) 2014 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/>.
|
||||
|
||||
|
||||
DEVICE_CREATE_SCHEMA = {
|
||||
"$schema": "http://json-schema.org/draft-04/schema#",
|
||||
"description": "Request validation to create a new Dynamips device instance",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"name": {
|
||||
"description": "Dynamips device name",
|
||||
"type": "string",
|
||||
"minLength": 1,
|
||||
},
|
||||
"device_id": {
|
||||
"description": "Dynamips device instance identifier",
|
||||
"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}$"
|
||||
},
|
||||
"device_type": {
|
||||
"description": "Dynamips device type",
|
||||
"type": "string",
|
||||
"minLength": 1,
|
||||
},
|
||||
},
|
||||
"additionalProperties": False,
|
||||
"required": ["name", "device_type"]
|
||||
}
|
||||
|
||||
DEVICE_UPDATE_SCHEMA = {
|
||||
"$schema": "http://json-schema.org/draft-04/schema#",
|
||||
"description": "Dynamips device instance",
|
||||
"type": "object",
|
||||
"definitions": {
|
||||
"EthernetSwitchPort": {
|
||||
"description": "Ethernet switch port",
|
||||
"properties": {
|
||||
"port": {
|
||||
"description": "Port number",
|
||||
"type": "integer",
|
||||
"minimum": 1
|
||||
},
|
||||
"type": {
|
||||
"description": "Port type",
|
||||
"enum": ["access", "dot1q", "qinq"],
|
||||
},
|
||||
"vlan": {"description": "VLAN number",
|
||||
"type": "integer",
|
||||
"minimum": 1
|
||||
},
|
||||
},
|
||||
"required": ["port", "type", "vlan"],
|
||||
"additionalProperties": False
|
||||
},
|
||||
},
|
||||
"properties": {
|
||||
"name": {
|
||||
"description": "Dynamips device instance name",
|
||||
"type": "string",
|
||||
"minLength": 1,
|
||||
},
|
||||
"ports": {
|
||||
"type": "array",
|
||||
"items": [
|
||||
{"type": "object",
|
||||
"oneOf": [
|
||||
{"$ref": "#/definitions/EthernetSwitchPort"}
|
||||
]},
|
||||
]
|
||||
}
|
||||
},
|
||||
"additionalProperties": False,
|
||||
}
|
||||
|
||||
DEVICE_OBJECT_SCHEMA = {
|
||||
"$schema": "http://json-schema.org/draft-04/schema#",
|
||||
"description": "Dynamips device instance",
|
||||
"type": "object",
|
||||
"definitions": {
|
||||
"EthernetSwitchPort": {
|
||||
"description": "Ethernet switch port",
|
||||
"properties": {
|
||||
"port": {
|
||||
"description": "Port number",
|
||||
"type": "integer",
|
||||
"minimum": 1
|
||||
},
|
||||
"type": {
|
||||
"description": "Port type",
|
||||
"enum": ["access", "dot1q", "qinq"],
|
||||
},
|
||||
"vlan": {"description": "VLAN number",
|
||||
"type": "integer",
|
||||
"minimum": 1
|
||||
},
|
||||
},
|
||||
"required": ["port", "type", "vlan"],
|
||||
"additionalProperties": False
|
||||
},
|
||||
},
|
||||
"properties": {
|
||||
"device_id": {
|
||||
"description": "Dynamips router instance 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}$"
|
||||
},
|
||||
"name": {
|
||||
"description": "Dynamips device instance name",
|
||||
"type": "string",
|
||||
"minLength": 1,
|
||||
},
|
||||
"ports": {
|
||||
# only Ethernet switches have ports
|
||||
"type": "array",
|
||||
"items": [
|
||||
{"type": "object",
|
||||
"oneOf": [
|
||||
{"$ref": "#/definitions/EthernetSwitchPort"}
|
||||
]},
|
||||
]
|
||||
},
|
||||
"mappings": {
|
||||
# only Frame-Relay and ATM switches have mappings
|
||||
"type": "object",
|
||||
}
|
||||
},
|
||||
"additionalProperties": False,
|
||||
"required": ["name", "device_id", "project_id"]
|
||||
}
|
||||
|
||||
DEVICE_NIO_SCHEMA = {
|
||||
"$schema": "http://json-schema.org/draft-04/schema#",
|
||||
"description": "Request validation to add a NIO for a Dynamips device instance",
|
||||
"type": "object",
|
||||
"definitions": {
|
||||
"UDP": {
|
||||
"description": "UDP Network Input/Output",
|
||||
"properties": {
|
||||
"type": {
|
||||
"enum": ["nio_udp"]
|
||||
},
|
||||
"lport": {
|
||||
"description": "Local port",
|
||||
"type": "integer",
|
||||
"minimum": 1,
|
||||
"maximum": 65535
|
||||
},
|
||||
"rhost": {
|
||||
"description": "Remote host",
|
||||
"type": "string",
|
||||
"minLength": 1
|
||||
},
|
||||
"rport": {
|
||||
"description": "Remote port",
|
||||
"type": "integer",
|
||||
"minimum": 1,
|
||||
"maximum": 65535
|
||||
}
|
||||
},
|
||||
"required": ["type", "lport", "rhost", "rport"],
|
||||
"additionalProperties": False
|
||||
},
|
||||
"Ethernet": {
|
||||
"description": "Generic Ethernet Network Input/Output",
|
||||
"properties": {
|
||||
"type": {
|
||||
"enum": ["nio_generic_ethernet"]
|
||||
},
|
||||
"ethernet_device": {
|
||||
"description": "Ethernet device name e.g. eth0",
|
||||
"type": "string",
|
||||
"minLength": 1
|
||||
},
|
||||
},
|
||||
"required": ["type", "ethernet_device"],
|
||||
"additionalProperties": False
|
||||
},
|
||||
"LinuxEthernet": {
|
||||
"description": "Linux Ethernet Network Input/Output",
|
||||
"properties": {
|
||||
"type": {
|
||||
"enum": ["nio_linux_ethernet"]
|
||||
},
|
||||
"ethernet_device": {
|
||||
"description": "Ethernet device name e.g. eth0",
|
||||
"type": "string",
|
||||
"minLength": 1
|
||||
},
|
||||
},
|
||||
"required": ["type", "ethernet_device"],
|
||||
"additionalProperties": False
|
||||
},
|
||||
"TAP": {
|
||||
"description": "TAP Network Input/Output",
|
||||
"properties": {
|
||||
"type": {
|
||||
"enum": ["nio_tap"]
|
||||
},
|
||||
"tap_device": {
|
||||
"description": "TAP device name e.g. tap0",
|
||||
"type": "string",
|
||||
"minLength": 1
|
||||
},
|
||||
},
|
||||
"required": ["type", "tap_device"],
|
||||
"additionalProperties": False
|
||||
},
|
||||
"UNIX": {
|
||||
"description": "UNIX Network Input/Output",
|
||||
"properties": {
|
||||
"type": {
|
||||
"enum": ["nio_unix"]
|
||||
},
|
||||
"local_file": {
|
||||
"description": "path to the UNIX socket file (local)",
|
||||
"type": "string",
|
||||
"minLength": 1
|
||||
},
|
||||
"remote_file": {
|
||||
"description": "path to the UNIX socket file (remote)",
|
||||
"type": "string",
|
||||
"minLength": 1
|
||||
},
|
||||
},
|
||||
"required": ["type", "local_file", "remote_file"],
|
||||
"additionalProperties": False
|
||||
},
|
||||
"VDE": {
|
||||
"description": "VDE Network Input/Output",
|
||||
"properties": {
|
||||
"type": {
|
||||
"enum": ["nio_vde"]
|
||||
},
|
||||
"control_file": {
|
||||
"description": "path to the VDE control file",
|
||||
"type": "string",
|
||||
"minLength": 1
|
||||
},
|
||||
"local_file": {
|
||||
"description": "path to the VDE control file",
|
||||
"type": "string",
|
||||
"minLength": 1
|
||||
},
|
||||
},
|
||||
"required": ["type", "control_file", "local_file"],
|
||||
"additionalProperties": False
|
||||
},
|
||||
"NULL": {
|
||||
"description": "NULL Network Input/Output",
|
||||
"properties": {
|
||||
"type": {
|
||||
"enum": ["nio_null"]
|
||||
},
|
||||
},
|
||||
"required": ["type"],
|
||||
"additionalProperties": False
|
||||
},
|
||||
},
|
||||
"properties": {
|
||||
"nio": {
|
||||
"type": "object",
|
||||
"oneOf": [
|
||||
{"$ref": "#/definitions/UDP"},
|
||||
{"$ref": "#/definitions/Ethernet"},
|
||||
{"$ref": "#/definitions/LinuxEthernet"},
|
||||
{"$ref": "#/definitions/TAP"},
|
||||
{"$ref": "#/definitions/UNIX"},
|
||||
{"$ref": "#/definitions/VDE"},
|
||||
{"$ref": "#/definitions/NULL"},
|
||||
]
|
||||
},
|
||||
"port_settings": {
|
||||
# only Ethernet switches have port settings
|
||||
"type": "object",
|
||||
"description": "Ethernet switch",
|
||||
"properties": {
|
||||
"type": {
|
||||
"description": "Port type",
|
||||
"enum": ["access", "dot1q", "qinq"],
|
||||
},
|
||||
"vlan": {"description": "VLAN number",
|
||||
"type": "integer",
|
||||
"minimum": 1
|
||||
},
|
||||
},
|
||||
"required": ["type", "vlan"],
|
||||
"additionalProperties": False
|
||||
},
|
||||
"mappings": {
|
||||
# only Frame-Relay and ATM switches have mappings
|
||||
"type": "object",
|
||||
}
|
||||
},
|
||||
"additionalProperties": False,
|
||||
"required": ["nio"]
|
||||
}
|
||||
|
||||
DEVICE_CAPTURE_SCHEMA = {
|
||||
"$schema": "http://json-schema.org/draft-04/schema#",
|
||||
"description": "Request validation to start a packet capture on an Device instance port",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"capture_file_name": {
|
||||
"description": "Capture file name",
|
||||
"type": "string",
|
||||
"minLength": 1,
|
||||
},
|
||||
"data_link_type": {
|
||||
"description": "PCAP data link type",
|
||||
"type": "string",
|
||||
"minLength": 1,
|
||||
},
|
||||
},
|
||||
"additionalProperties": False,
|
||||
"required": ["capture_file_name"]
|
||||
}
|
||||
Loading…
Reference in new issue