gns3-server/docs/file_format.rst

65 lines
1.3 KiB
ReStructuredText
Raw Permalink Normal View History

2018-03-12 06:38:50 +00:00
The GNS3 files
===============
2018-03-12 06:38:50 +00:00
.gns3 files
############
2018-03-12 06:38:50 +00:00
GNS3 project files in JSON file format with all
the information necessary to save a project.
A minimal version:
.. code:: json
{
"name": "untitled",
"project_id": null,
"revision": 5,
"topology": {},
"type": "topology",
"version": "2.0.0"
}
The revision is the version of file format:
* 9: GNS3 2.2
* 8: GNS3 2.1
* 7: GNS3 2.0
* 6: GNS3 2.0 < beta 3
* 5: GNS3 2.0 < alpha 4
* 4: GNS3 1.5
* 3: GNS3 1.4
* 2: GNS3 1.3
2018-03-12 06:38:50 +00:00
* 1: GNS3 1.0, 1.1, 1.2 (Not mentioned in the file)
2018-03-12 06:38:50 +00:00
The full JSON schema can be found there:
2016-07-11 13:37:57 +00:00
.. literalinclude:: gns3_file.json
2018-03-12 06:38:50 +00:00
.net files
###########
2018-03-12 06:38:50 +00:00
Topology files made for GNS3 <= version 1.0. Not supported.
2018-03-12 06:38:50 +00:00
.gns3p or .gns3project files
#############################
2018-03-12 06:38:50 +00:00
This this a zipped version of a.gns3 file and includes all the required files to easily share a project.
The binary images can optionally be included.
2018-03-12 06:38:50 +00:00
The zip can be a ZIP64 if the project is too big for standard zip file.
.gns3a or .gns3appliance files
##############################
2018-03-12 06:38:50 +00:00
These files contain everything needed to create a new appliance template in GNS3.
2018-03-12 06:38:50 +00:00
A JSON schema is available there:
2020-06-03 11:46:48 +00:00
https://github.com/GNS3/gns3-registry/blob/master/schemas/appliance_v6.json
2018-03-12 06:38:50 +00:00
And samples there:
https://github.com/GNS3/gns3-registry/tree/master/appliances