gns3-server/gns3server/schemas/link.py

113 lines
4.1 KiB
Python
Raw Normal View History

2016-03-11 15:51:35 +00:00
#!/usr/bin/env python
#
# Copyright (C) 2015 GNS3 Technologies Inc.
#
# This program 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.
#
# This program 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 this program. If not, see <http://www.gnu.org/licenses/>.
from .label import LABEL_OBJECT_SCHEMA
from .filter import FILTER_OBJECT_SCHEMA
2016-03-11 15:51:35 +00:00
LINK_OBJECT_SCHEMA = {
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "A link object",
"type": "object",
"properties": {
"link_id": {
2016-05-13 01:07:25 +00:00
"description": "Link UUID",
2016-03-11 15:51:35 +00:00
"type": "string",
"minLength": 36,
"maxLength": 36,
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"project_id": {
"description": "Project UUID",
"type": "string",
"minLength": 36,
"maxLength": 36,
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"nodes": {
2016-03-11 15:51:35 +00:00
"description": "List of the VMS",
"type": "array",
"items": {
"type": "object",
"properties": {
"node_id": {
2016-05-13 01:07:25 +00:00
"description": "Node UUID",
2016-03-11 15:51:35 +00:00
"type": "string",
"minLength": 36,
"maxLength": 36,
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"adapter_number": {
"description": "Adapter number",
"type": "integer"
},
"port_number": {
"description": "Port number",
"type": "integer"
},
"label": LABEL_OBJECT_SCHEMA
2016-03-11 15:51:35 +00:00
},
"required": ["node_id", "adapter_number", "port_number"],
2016-03-11 15:51:35 +00:00
"additionalProperties": False
}
},
2017-07-19 15:30:25 +00:00
"suspend": {
"type": "boolean",
"description": "Suspend the link"
2017-07-19 15:30:25 +00:00
},
"filters": FILTER_OBJECT_SCHEMA,
"capturing": {
2016-05-13 01:07:25 +00:00
"description": "Read only property. True if a capture running on the link",
"type": "boolean"
},
"capture_file_name": {
"description": "Read only property. The name of the capture file if a capture is running",
"type": ["string", "null"]
2016-04-26 15:36:24 +00:00
},
"capture_file_path": {
"description": "Read only property. The full path of the capture file if a capture is running",
"type": ["string", "null"]
},
"capture_compute_id": {
"description": "Read only property. The compute identifier where a capture is running",
2016-04-26 15:36:24 +00:00
"type": ["string", "null"]
},
"link_type": {
"description": "Type of link",
"enum": ["ethernet", "serial"]
}
2016-03-11 15:51:35 +00:00
},
"additionalProperties": False
}
LINK_CAPTURE_SCHEMA = {
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Request validation to start a packet capture on a link",
"type": "object",
"properties": {
"data_link_type": {
"description": "PCAP data link type (http://www.tcpdump.org/linktypes.html)",
"enum": ["DLT_ATM_RFC1483", "DLT_EN10MB", "DLT_FRELAY", "DLT_C_HDLC", "DLT_PPP_SERIAL"]
},
"capture_file_name": {
2016-05-13 01:07:25 +00:00
"description": "Read only property. The name of the capture file if capture is running",
"type": "string"
}
},
"additionalProperties": False
}