Tools for GNS3 GUI
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

0004-Tool-documentation.patch 2.1KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465
  1. From 65bf0075e87c92f998a611736dd418d612120fa3 Mon Sep 17 00:00:00 2001
  2. From: Bernhard Ehlers <be@bernhard-ehlers.de>
  3. Date: Fri, 29 Dec 2017 16:14:14 +0100
  4. Subject: [PATCH 4/7] Tool documentation
  5. ---
  6. tools.md | 46 ++++++++++++++++++++++++++++++++++++++++++++++
  7. 1 file changed, 46 insertions(+)
  8. create mode 100644 tools.md
  9. diff --git a/tools.md b/tools.md
  10. new file mode 100644
  11. index 0000000..dd1f2ce
  12. --- /dev/null
  13. +++ b/tools.md
  14. @@ -0,0 +1,46 @@
  15. +# Tools for GNS3 GUI
  16. +
  17. +Tools are executables, that are called by the GNS3 GUI.
  18. +They normally use the GNS3 API (http://api.gns3.net/) to
  19. +query and/or modify the current project.
  20. +
  21. +The tools are stored in the GNS3 -> tools folder.
  22. +A project must be open, to use/start them. They are
  23. +called by the GUI with the following parameters:
  24. +
  25. +| No. | Parameter |
  26. +|------|--------------------------------------------|
  27. +| 1 | GNS3 version (for compatibility checks) |
  28. +| 2 | Project UUID |
  29. +| 3+ | List of selected items, can be empty |
  30. +
  31. +An item consists of it's UUID prefixed by `nodes/`
  32. +for node items, `text_drawings/` for text items
  33. +and `drawings/` for all other graphical elements.
  34. +Links are currently not included in the item list.
  35. +
  36. +The tool can be accompanied by a JSON file, with the
  37. +same base name as the tool, but with the .json extension.
  38. +
  39. +It can set the following options:
  40. +
  41. +| Option | Meaning | Allowed Values | Default |
  42. +|----------|----------------------|-------------------------------|-----------|
  43. +| name | name of tool | any string | base name |
  44. +| menu | show in main menu | false / true | true |
  45. +| context | show in context menu | "disable" / "enable" / "node" | "enable" |
  46. +| terminal | run in terminal | false / true | false |
  47. +
  48. +With the context option "node" a tool is only shown in
  49. +the context menu, when at least one node is selected.
  50. +
  51. +Example of a .json file:
  52. +
  53. +```
  54. +{
  55. + "name": "Test tool",
  56. + "menu": false,
  57. + "context": "node",
  58. + "terminal": true
  59. +}
  60. +```
  61. --
  62. 2.10.1 (Apple Git-78)