mirror of
https://github.com/GNS3/gns3-server.git
synced 2026-09-08 02:59:02 +03:00
a841175fbf
The waiting variant blocked on a fixed progress bar (up to 120s) even when every start command had already failed (e.g. the uBridge >= 1.2.3 409), burying the error behind two minutes of silence. Drop it: the single start_gns3_node now sends the commands and returns per-node results immediately (GNS3StartNodeQuickTool kept as an alias). Boot waiting moves to a dedicated wait_seconds tool the agent calls explicitly between start and status checks, with a 600s ceiling and liveness logging every 5s.
260 lines
9.2 KiB
Python
260 lines
9.2 KiB
Python
# SPDX-License-Identifier: GPL-3.0-or-later
|
|
#
|
|
# GNS3-Copilot - AI-powered Network Lab Assistant for GNS3
|
|
#
|
|
# This file is part of GNS3-Copilot project.
|
|
#
|
|
# GNS3-Copilot 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.
|
|
#
|
|
# GNS3-Copilot 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 GNS3-Copilot. If not, see <https://www.gnu.org/licenses/>.
|
|
#
|
|
# Copyright (C) 2025 Yue Guobin (岳国宾)
|
|
# Author: Yue Guobin (岳国宾)
|
|
#
|
|
# Project Home: https://github.com/yueguobin/gns3-copilot
|
|
#
|
|
"""
|
|
|
|
GNS3 node startup tool for network device activation.
|
|
|
|
Sends start commands and returns immediately — it never blocks on a fixed
|
|
boot timer. A failed start command (e.g. a 409 from the compute) is
|
|
reported in the same round-trip instead of after a two-minute progress
|
|
bar. Use the wait_seconds tool between this and any status check to give
|
|
nodes time to boot.
|
|
"""
|
|
|
|
import json
|
|
import logging
|
|
from pprint import pprint
|
|
from typing import Any
|
|
|
|
from langchain.tools import BaseTool
|
|
from langchain_core.callbacks import CallbackManagerForToolRun
|
|
|
|
from gns3server.agent.gns3_copilot.gns3_client.api_handlers import (
|
|
build_gns3_ctx,
|
|
get_nodes_handler,
|
|
start_node_handler,
|
|
)
|
|
|
|
# Configure logging
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
class GNS3StartNodeTool(BaseTool):
|
|
"""
|
|
A LangChain tool to start one or multiple nodes in a GNS3 project.
|
|
|
|
Sends the start commands in a parallel batch and returns each node's
|
|
status immediately — nodes keep booting in the background. It does NOT
|
|
wait for boot completion: follow up with the wait_seconds tool and a
|
|
status/topology check to confirm nodes actually came up.
|
|
|
|
**Input**:
|
|
A JSON object with project_id and node_ids (list of node IDs).
|
|
Example:
|
|
{
|
|
"project_id": "uuid-of-project",
|
|
"node_ids": ["uuid-of-node-1", "uuid-of-node-2"]
|
|
}
|
|
|
|
**Output**:
|
|
A dict with nodes' details immediately after sending start commands:
|
|
{
|
|
"project_id": "...",
|
|
"total_nodes": 2,
|
|
"successful": 2,
|
|
"failed": 0,
|
|
"nodes": [
|
|
{"node_id": "...", "name": "...", "status": "started"},
|
|
{"node_id": "...", "name": "...", "status": "error", "error": "..."}
|
|
],
|
|
"note": "Start commands sent. Nodes are booting in background."
|
|
}
|
|
"""
|
|
|
|
name: str = "start_gns3_node"
|
|
description: str = """
|
|
Starts one or multiple nodes in a GNS3 project and returns immediately
|
|
(nodes boot in the background; start failures are reported right away).
|
|
After calling this, use wait_seconds (VPCS/IOU ~15-30s, IOS routers
|
|
~60-120s, heavy NOS images 2-5min) before checking node status.
|
|
Input: JSON with project_id and node_ids (list of node IDs).
|
|
Returns: Dict with per-node start command results.
|
|
"""
|
|
|
|
def _run(
|
|
self,
|
|
tool_input: str,
|
|
run_manager: CallbackManagerForToolRun | None = None,
|
|
) -> dict[str, Any]:
|
|
try:
|
|
# Parse input JSON
|
|
input_data = json.loads(tool_input)
|
|
project_id = input_data.get("project_id")
|
|
node_ids = input_data.get("node_ids")
|
|
|
|
# Validate input
|
|
if not project_id or not node_ids:
|
|
logger.error(
|
|
"Missing required fields: project_id or node_ids."
|
|
)
|
|
return {
|
|
"error": "Missing required fields: "
|
|
"project_id and node_ids."
|
|
}
|
|
|
|
if not isinstance(node_ids, list):
|
|
logger.error("node_ids must be a list.")
|
|
return {"error": "node_ids must be a list."}
|
|
|
|
# Build handler context (JWT + server URL from request context)
|
|
logger.info("Connecting to GNS3 server...")
|
|
gns3_ctx = build_gns3_ctx()
|
|
|
|
if gns3_ctx is None:
|
|
logger.error("Failed to create GNS3 connector")
|
|
return {
|
|
"error": "Failed to connect to GNS3 server. "
|
|
"Please check your configuration."
|
|
}
|
|
|
|
# Verify nodes exist and capture pre-start info (one call)
|
|
listing = get_nodes_handler({"project_id": project_id}, gns3_ctx)
|
|
if "error" in listing:
|
|
return {"error": listing["error"]}
|
|
nodes_by_id = {n["node_id"]: n for n in listing["nodes"]}
|
|
|
|
# Send start commands for all nodes (parallel batch)
|
|
logger.info(
|
|
"Sending start commands for %d nodes in project %s...",
|
|
len(node_ids),
|
|
project_id,
|
|
)
|
|
results = []
|
|
known_ids = [nid for nid in node_ids if nid in nodes_by_id]
|
|
start_results = start_node_handler(
|
|
{"project_id": project_id, "node_ids": known_ids}, gns3_ctx
|
|
)
|
|
start_errors = {
|
|
r["node_id"]: r.get("error")
|
|
for r in start_results
|
|
if r.get("status") == "error"
|
|
}
|
|
|
|
# Get immediate status (likely 'starting' or 'stopped') — one call
|
|
listing = get_nodes_handler({"project_id": project_id}, gns3_ctx)
|
|
if "error" in listing:
|
|
return {"error": listing["error"]}
|
|
after_by_id = {n["node_id"]: n for n in listing["nodes"]}
|
|
|
|
for node_id in node_ids:
|
|
if node_id not in nodes_by_id:
|
|
logger.error(
|
|
"Node %s not found in project %s", node_id, project_id
|
|
)
|
|
results.append(
|
|
{
|
|
"node_id": node_id,
|
|
"name": "N/A",
|
|
"status": "error",
|
|
"error": "Node not found",
|
|
}
|
|
)
|
|
continue
|
|
|
|
if node_id in start_errors:
|
|
logger.error(
|
|
"Failed to start node %s: %s",
|
|
node_id,
|
|
start_errors[node_id],
|
|
)
|
|
results.append(
|
|
{
|
|
"node_id": node_id,
|
|
"name": nodes_by_id[node_id].get("name") or "N/A",
|
|
"status": "error",
|
|
"error": start_errors[node_id],
|
|
}
|
|
)
|
|
continue
|
|
|
|
logger.info(
|
|
"Start command sent for node %s (%s)",
|
|
node_id,
|
|
nodes_by_id[node_id].get("name"),
|
|
)
|
|
current = after_by_id.get(node_id, nodes_by_id[node_id])
|
|
results.append(
|
|
{
|
|
"node_id": node_id,
|
|
"name": current.get("name") or "N/A",
|
|
"status": current.get("status") or "unknown",
|
|
}
|
|
)
|
|
|
|
# Analyze results (count based on successful command sending)
|
|
successful_nodes = [
|
|
r for r in results if r.get("status") != "error"
|
|
]
|
|
failed_nodes = [r for r in results if r.get("status") == "error"]
|
|
|
|
# Construct final response
|
|
response = {
|
|
"project_id": project_id,
|
|
"total_nodes": len(node_ids),
|
|
"successful": len(successful_nodes),
|
|
"failed": len(failed_nodes),
|
|
"nodes": results,
|
|
"note": (
|
|
"Start commands sent. Nodes are booting in background. "
|
|
"Use wait_seconds, then check node status."
|
|
),
|
|
}
|
|
|
|
logger.info(
|
|
"Quick start commands sent: %d successful, %d failed",
|
|
len(successful_nodes),
|
|
len(failed_nodes),
|
|
)
|
|
|
|
return response
|
|
|
|
except json.JSONDecodeError as e:
|
|
logger.error("Invalid JSON input: %s", e)
|
|
return {"error": f"Invalid JSON input: {e}"}
|
|
except Exception as e:
|
|
logger.error("Failed to start nodes: %s", e)
|
|
return {"error": f"Failed to start nodes: {str(e)}"}
|
|
|
|
|
|
# Backward-compat alias: the waiting variant was removed; both names now
|
|
# point at the immediate-return tool.
|
|
GNS3StartNodeQuickTool = GNS3StartNodeTool
|
|
|
|
|
|
if __name__ == "__main__":
|
|
# Test with single node
|
|
print("=== Testing single node startup ===")
|
|
test_input_single = json.dumps(
|
|
{
|
|
"project_id": "<PROJECT_UUID>", # Replace with actual project UUID
|
|
"node_ids": [
|
|
"fbeda109-9a74-4d8c-a749-cc3847911a90"
|
|
], # Replace with actual node UUID
|
|
}
|
|
)
|
|
tool = GNS3StartNodeTool()
|
|
result_single = tool._run(test_input_single)
|
|
pprint(result_single)
|