get_network
Retrieve detailed network configuration and status information from VergeOS virtualization platforms by specifying the network ID.
Instructions
Get detailed information about a specific network
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Network ID |
Implementation Reference
- src/index.js:142-144 (handler)The core handler implementation for the 'get_network' tool. This method in the VergeOSAPI class makes an HTTP GET request to the VergeOS API endpoint to fetch detailed information about a specific virtual network by its ID.async getNetwork(id) { return this.request(`/api/v4/vnets/${id}?fields=most`); }
- src/index.js:374-386 (registration)Registration of the 'get_network' tool in the TOOLS array, including name, description, and inputSchema specifying that a numeric 'id' is required.name: "get_network", description: "Get detailed information about a specific network", inputSchema: { type: "object", properties: { id: { type: "number", description: "Network ID", }, }, required: ["id"], }, },
- local-proxy/index-direct.js:254-254 (handler)Alternative direct handler for 'get_network' in the local proxy, performing the same API request.async function getNetwork(id) { return apiRequest(`/api/v4/vnets/${id}?fields=most`); }
- local-proxy/index-direct.js:372-372 (registration)Tool registration entry for 'get_network' in the local-proxy TOOLS array.{ name: "get_network", description: "Get network details", inputSchema: { type: "object", properties: { id: { type: "number" } }, required: ["id"] } },
- src/index.js:568-570 (helper)Dispatch logic in the tool call handler switch statement that invokes the getNetwork handler.case "get_network": result = await api.getNetwork(args.id); break;