gns3-server/gns3server/handlers/api/compute/vpcs_handler.py

398 lines
14 KiB
Python
Raw Normal View History

2015-01-14 00:05:26 +00:00
# -*- 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 os
from aiohttp.web import HTTPConflict
2016-05-14 00:00:07 +00:00
from gns3server.web.route import Route
from gns3server.schemas.nio import NIO_SCHEMA
from gns3server.schemas.node import NODE_CAPTURE_SCHEMA
from gns3server.compute.vpcs import VPCS
2016-05-14 00:00:07 +00:00
from gns3server.schemas.vpcs import (
VPCS_CREATE_SCHEMA,
VPCS_UPDATE_SCHEMA,
VPCS_OBJECT_SCHEMA
)
2015-01-14 00:05:26 +00:00
class VPCSHandler:
"""
API entry points for VPCS.
"""
2015-01-14 00:05:26 +00:00
@Route.post(
r"/projects/{project_id}/vpcs/nodes",
2015-02-05 00:13:35 +00:00
parameters={
2016-05-14 00:00:07 +00:00
"project_id": "Project UUID"
2015-02-05 00:13:35 +00:00
},
2015-01-14 00:05:26 +00:00
status_codes={
201: "Instance created",
2015-02-05 00:13:35 +00:00
400: "Invalid request",
2015-01-14 00:05:26 +00:00
409: "Conflict"
},
description="Create a new VPCS instance",
2015-01-14 00:05:26 +00:00
input=VPCS_CREATE_SCHEMA,
output=VPCS_OBJECT_SCHEMA)
async def create(request, response):
2015-01-14 00:05:26 +00:00
vpcs = VPCS.instance()
vm = await vpcs.create_node(request.json["name"],
2016-05-14 00:00:07 +00:00
request.match_info["project_id"],
request.json.get("node_id"),
console=request.json.get("console"),
2018-03-24 11:11:21 +00:00
console_type=request.json.get("console_type", "telnet"),
2016-05-14 00:00:07 +00:00
startup_script=request.json.get("startup_script"))
response.set_status(201)
2016-05-14 00:00:07 +00:00
response.json(vm)
2015-01-14 00:05:26 +00:00
2015-01-21 16:21:17 +00:00
@Route.get(
r"/projects/{project_id}/vpcs/nodes/{node_id}",
2015-01-21 16:21:17 +00:00
parameters={
2016-05-14 00:00:07 +00:00
"project_id": "Project UUID",
"node_id": "Node UUID"
2015-01-21 16:21:17 +00:00
},
status_codes={
200: "Success",
2015-02-05 00:13:35 +00:00
400: "Invalid request",
404: "Instance doesn't exist"
2015-01-21 16:21:17 +00:00
},
description="Get a VPCS instance",
output=VPCS_OBJECT_SCHEMA)
2015-01-21 16:21:17 +00:00
def show(request, response):
vpcs_manager = VPCS.instance()
vm = vpcs_manager.get_node(request.match_info["node_id"], project_id=request.match_info["project_id"])
2015-01-21 16:21:17 +00:00
response.json(vm)
2015-01-21 20:46:16 +00:00
@Route.put(
r"/projects/{project_id}/vpcs/nodes/{node_id}",
2015-01-23 09:11:40 +00:00
parameters={
2016-05-14 00:00:07 +00:00
"project_id": "Project UUID",
"node_id": "Node UUID"
2015-01-23 09:11:40 +00:00
},
2015-01-21 20:46:16 +00:00
status_codes={
200: "Instance updated",
2015-02-05 00:13:35 +00:00
400: "Invalid request",
404: "Instance doesn't exist",
2015-01-21 20:46:16 +00:00
409: "Conflict"
},
description="Update a VPCS instance",
input=VPCS_UPDATE_SCHEMA,
output=VPCS_OBJECT_SCHEMA)
def update(request, response):
vpcs_manager = VPCS.instance()
vm = vpcs_manager.get_node(request.match_info["node_id"], project_id=request.match_info["project_id"])
2015-01-21 20:46:16 +00:00
vm.name = request.json.get("name", vm.name)
vm.console = request.json.get("console", vm.console)
2018-03-24 11:11:21 +00:00
vm.console_type = request.json.get("console_type", vm.console_type)
vm.updated()
2015-01-21 20:46:16 +00:00
response.json(vm)
2015-01-22 10:34:10 +00:00
@Route.delete(
r"/projects/{project_id}/vpcs/nodes/{node_id}",
2015-01-23 09:11:40 +00:00
parameters={
2016-05-14 00:00:07 +00:00
"project_id": "Project UUID",
"node_id": "Node UUID"
2015-01-23 09:11:40 +00:00
},
2015-01-22 10:34:10 +00:00
status_codes={
204: "Instance deleted",
2015-02-05 00:13:35 +00:00
400: "Invalid request",
404: "Instance doesn't exist"
2015-01-22 10:34:10 +00:00
},
description="Delete a VPCS instance")
async def delete(request, response):
2015-01-22 10:34:10 +00:00
await VPCS.instance().delete_node(request.match_info["node_id"])
2015-01-22 10:34:10 +00:00
response.set_status(204)
@Route.post(
r"/projects/{project_id}/vpcs/nodes/{node_id}/duplicate",
parameters={
"project_id": "Project UUID",
"node_id": "Node UUID"
},
status_codes={
201: "Instance duplicated",
404: "Instance doesn't exist"
},
description="Duplicate a VPCS instance")
async def duplicate(request, response):
new_node = await VPCS.instance().duplicate_node(
request.match_info["node_id"],
request.json["destination_node_id"]
)
response.set_status(201)
response.json(new_node)
2015-01-14 17:52:02 +00:00
@Route.post(
r"/projects/{project_id}/vpcs/nodes/{node_id}/start",
2015-01-14 17:52:02 +00:00
parameters={
2016-05-14 00:00:07 +00:00
"project_id": "Project UUID",
"node_id": "Node UUID"
2015-01-14 17:52:02 +00:00
},
status_codes={
204: "Instance started",
2015-02-05 00:13:35 +00:00
400: "Invalid request",
404: "Instance doesn't exist"
2015-01-14 17:52:02 +00:00
},
description="Start a VPCS instance",
output=VPCS_OBJECT_SCHEMA)
async def start(request, response):
2015-01-14 17:52:02 +00:00
vpcs_manager = VPCS.instance()
vm = vpcs_manager.get_node(request.match_info["node_id"], project_id=request.match_info["project_id"])
await vm.start()
response.json(vm)
2015-01-14 17:52:02 +00:00
@Route.post(
r"/projects/{project_id}/vpcs/nodes/{node_id}/stop",
2015-01-14 17:52:02 +00:00
parameters={
2016-05-14 00:00:07 +00:00
"project_id": "Project UUID",
"node_id": "Node UUID"
2015-01-14 17:52:02 +00:00
},
status_codes={
204: "Instance stopped",
2015-02-05 00:13:35 +00:00
400: "Invalid request",
404: "Instance doesn't exist"
2015-01-14 17:52:02 +00:00
},
description="Stop a VPCS instance")
async def stop(request, response):
2015-01-14 17:52:02 +00:00
vpcs_manager = VPCS.instance()
vm = vpcs_manager.get_node(request.match_info["node_id"], project_id=request.match_info["project_id"])
await vm.stop()
response.set_status(204)
2015-01-14 17:52:02 +00:00
2016-09-05 14:55:38 +00:00
@Route.post(
r"/projects/{project_id}/vpcs/nodes/{node_id}/suspend",
parameters={
"project_id": "Project UUID",
"node_id": "Node UUID"
},
status_codes={
2018-01-18 03:43:04 +00:00
204: "Instance suspended",
2016-09-05 14:55:38 +00:00
400: "Invalid request",
404: "Instance doesn't exist"
},
2018-01-18 03:43:04 +00:00
description="Suspend a VPCS instance (does nothing)")
def suspend(request, response):
2016-09-05 14:55:38 +00:00
vpcs_manager = VPCS.instance()
2018-01-18 03:43:04 +00:00
vpcs_manager.get_node(request.match_info["node_id"], project_id=request.match_info["project_id"])
2016-09-05 14:55:38 +00:00
response.set_status(204)
@Route.post(
r"/projects/{project_id}/vpcs/nodes/{node_id}/reload",
parameters={
2016-05-14 00:00:07 +00:00
"project_id": "Project UUID",
"node_id": "Node UUID",
},
status_codes={
204: "Instance reloaded",
2015-02-05 00:13:35 +00:00
400: "Invalid request",
404: "Instance doesn't exist"
},
description="Reload a VPCS instance")
async def reload(request, response):
vpcs_manager = VPCS.instance()
vm = vpcs_manager.get_node(request.match_info["node_id"], project_id=request.match_info["project_id"])
await vm.reload()
response.set_status(204)
2015-01-14 00:05:26 +00:00
@Route.post(
r"/projects/{project_id}/vpcs/nodes/{node_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio",
2015-01-14 00:05:26 +00:00
parameters={
2016-05-14 00:00:07 +00:00
"project_id": "Project UUID",
"node_id": "Node UUID",
"adapter_number": "Network adapter where the nio is located",
"port_number": "Port where the nio should be added"
2015-01-14 00:05:26 +00:00
},
status_codes={
201: "NIO created",
2015-02-05 00:13:35 +00:00
400: "Invalid request",
404: "Instance doesn't exist"
2015-01-14 00:05:26 +00:00
},
description="Add a NIO to a VPCS instance",
input=NIO_SCHEMA,
output=NIO_SCHEMA)
async def create_nio(request, response):
2015-01-16 15:20:10 +00:00
vpcs_manager = VPCS.instance()
vm = vpcs_manager.get_node(request.match_info["node_id"], project_id=request.match_info["project_id"])
nio_type = request.json["type"]
if nio_type not in ("nio_udp", "nio_tap"):
raise HTTPConflict(text="NIO of type {} is not supported".format(nio_type))
port_number = int(request.match_info["port_number"])
nio = vpcs_manager.create_nio(request.json)
await vm.port_add_nio_binding(port_number, nio)
response.set_status(201)
2015-01-16 16:09:45 +00:00
response.json(nio)
2015-01-14 00:05:26 +00:00
@Route.put(
r"/projects/{project_id}/vpcs/nodes/{node_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio",
parameters={
"project_id": "Project UUID",
"node_id": "Node UUID",
"adapter_number": "Network adapter where the nio is located",
"port_number": "Port from where the nio should be updated"
},
status_codes={
201: "NIO updated",
400: "Invalid request",
404: "Instance doesn't exist"
},
input=NIO_SCHEMA,
output=NIO_SCHEMA,
description="Update a NIO on a VPCS instance")
async def update_nio(request, response):
vpcs_manager = VPCS.instance()
vm = vpcs_manager.get_node(request.match_info["node_id"], project_id=request.match_info["project_id"])
port_number = int(request.match_info["port_number"])
nio = vm.get_nio(port_number)
if "filters" in request.json:
nio.filters = request.json["filters"]
await vm.port_update_nio_binding(port_number, nio)
response.set_status(201)
response.json(request.json)
2015-01-16 20:39:58 +00:00
@Route.delete(
r"/projects/{project_id}/vpcs/nodes/{node_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio",
2015-01-14 00:05:26 +00:00
parameters={
2016-05-14 00:00:07 +00:00
"project_id": "Project UUID",
"node_id": "Node UUID",
"adapter_number": "Network adapter where the nio is located",
"port_number": "Port from where the nio should be removed"
2015-01-14 00:05:26 +00:00
},
status_codes={
204: "NIO deleted",
2015-02-05 00:13:35 +00:00
400: "Invalid request",
404: "Instance doesn't exist"
2015-01-14 00:05:26 +00:00
},
description="Remove a NIO from a VPCS instance")
async def delete_nio(request, response):
2015-01-16 20:39:58 +00:00
vpcs_manager = VPCS.instance()
vm = vpcs_manager.get_node(request.match_info["node_id"], project_id=request.match_info["project_id"])
port_number = int(request.match_info["port_number"])
await vm.port_remove_nio_binding(port_number)
2015-01-22 09:55:11 +00:00
response.set_status(204)
@Route.post(
r"/projects/{project_id}/vpcs/nodes/{node_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/start_capture",
parameters={
"project_id": "Project UUID",
"node_id": "Node UUID",
"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 VPCS instance",
input=NODE_CAPTURE_SCHEMA)
async def start_capture(request, response):
vpcs_manager = VPCS.instance()
vm = vpcs_manager.get_node(request.match_info["node_id"], project_id=request.match_info["project_id"])
port_number = int(request.match_info["port_number"])
pcap_file_path = os.path.join(vm.project.capture_working_directory(), request.json["capture_file_name"])
await vm.start_capture(port_number, pcap_file_path)
response.json({"pcap_file_path": pcap_file_path})
@Route.post(
r"/projects/{project_id}/vpcs/nodes/{node_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/stop_capture",
parameters={
"project_id": "Project UUID",
"node_id": "Node UUID",
"adapter_number": "Adapter to stop a packet capture",
"port_number": "Port on the adapter"
},
status_codes={
204: "Capture stopped",
400: "Invalid request",
404: "Instance doesn't exist",
},
description="Stop a packet capture on a VPCS instance")
async def stop_capture(request, response):
vpcs_manager = VPCS.instance()
vm = vpcs_manager.get_node(request.match_info["node_id"], project_id=request.match_info["project_id"])
port_number = int(request.match_info["port_number"])
await vm.stop_capture(port_number)
response.set_status(204)
@Route.get(
r"/projects/{project_id}/vpcs/nodes/{node_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/pcap",
description="Stream the pcap capture file",
parameters={
"project_id": "Project UUID",
"node_id": "Node UUID",
"adapter_number": "Adapter to steam a packet capture",
"port_number": "Port on the adapter"
},
status_codes={
200: "File returned",
403: "Permission denied",
404: "The file doesn't exist"
})
async def stream_pcap_file(request, response):
vpcs_manager = VPCS.instance()
vm = vpcs_manager.get_node(request.match_info["node_id"], project_id=request.match_info["project_id"])
port_number = int(request.match_info["port_number"])
nio = vm.get_nio(port_number)
await vpcs_manager.stream_pcap_file(nio, vm.project.id, request, response)
2020-01-31 09:31:27 +00:00
@Route.get(
r"/projects/{project_id}/vpcs/nodes/{node_id}/console/ws",
description="WebSocket for console",
parameters={
"project_id": "Project UUID",
"node_id": "Node UUID",
})
async def console_ws(request, response):
vpcs_manager = VPCS.instance()
vm = vpcs_manager.get_node(request.match_info["node_id"], project_id=request.match_info["project_id"])
return await vm.start_websocket_console(request)
@Route.post(
r"/projects/{project_id}/vpcs/nodes/{node_id}/console/reset",
description="Reset console",
parameters={
"project_id": "Project UUID",
"node_id": "Node UUID",
},
status_codes={
204: "Console has been reset",
400: "Invalid request",
404: "Instance doesn't exist",
409: "Container not started"
})
async def reset_console(request, response):
vpcs_manager = VPCS.instance()
vm = vpcs_manager.get_node(request.match_info["node_id"], project_id=request.match_info["project_id"])
await vm.reset_console()
response.set_status(204)