NgTech-LTD/gns3-server
2
0
Fork 0
mirror of https://github.com/GNS3/gns3-server.git synced 2026-09-02 16:15:15 +03:00
Code Issues Packages Projects Releases Wiki Activity

docs: Fix appliance_install description - it does NOT download images

Browse Source
This commit is contained in:
YueGuobin 2026-06-11 12:13:31 +08:00
parent f0b0de2a91
commit 0b2c784b81
No known key found for this signature in database
1 changed files with 7 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
gns3server/api/routes/mcp/__init__.py
View File

@ -1137,7 +1137,13 @@ async def appliance_get(
async def appliance_install(
appliance_id: Annotated[str, Field(description="UUID of the appliance to install")],
) -> list[dict[str, Any]]:
"""Install (download and set up) an appliance from the template library."""
"""Create a template from a GNS3 appliance definition.
NOTE: This does NOT download images. Images must be placed in the
GNS3 images directory (e.g. ~/GNS3/images/) beforehand.
The appliance definition is read from local .gns3a files bundled with the server.
Use get_appliance first to see what images are required.
"""
return await asyncio.to_thread(_run_handler_sync, install_appliance_handler, {
"appliance_id": appliance_id,
})