1 # -*- coding: utf-8 -*-
4 # Copyright 2015 Telefónica Investigación y Desarrollo, S.A.U.
5 # This file is part of openmano
8 # Licensed under the Apache License, Version 2.0 (the "License"); you may
9 # not use this file except in compliance with the License. You may obtain
10 # a copy of the License at
12 # http://www.apache.org/licenses/LICENSE-2.0
14 # Unless required by applicable law or agreed to in writing, software
15 # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
16 # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
17 # License for the specific language governing permissions and limitations
20 # For those usages not covered by the Apache License, Version 2.0 please
21 # contact with: nfvlabs@tid.es
25 JSON schemas used by openmano httpserver.py module to parse the different files and messages sent through the API
27 __author__
="Alfonso Tierno, Gerardo Garcia, Pablo Montes"
28 __date__
="$09-oct-2014 09:09:48$"
31 patern_name
="^[ -~]+$"
32 passwd_schema
={"type" : "string", "minLength":1, "maxLength":60}
33 nameshort_schema
={"type" : "string", "minLength":1, "maxLength":60, "pattern" : "^[^,;()'\"]+$"}
34 name_schema
={"type" : "string", "minLength":1, "maxLength":255, "pattern" : "^[^,;()'\"]+$"}
35 xml_text_schema
={"type" : "string", "minLength":1, "maxLength":1000, "pattern" : "^[^']+$"}
36 description_schema
={"type" : ["string","null"], "maxLength":255, "pattern" : "^[^'\"]+$"}
37 id_schema_fake
= {"type" : "string", "minLength":2, "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}$"
38 id_schema
= {"type" : "string", "pattern": "^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$"}
39 pci_schema
={"type":"string", "pattern":"^[0-9a-fA-F]{4}(:[0-9a-fA-F]{2}){2}\.[0-9a-fA-F]$"}
40 pci_extended_schema
= {"type": "string", "pattern": "^[0-9a-fA-F.:-\[\]]$"}
42 http_schema
={"type":"string", "pattern":"^https?://[^'\"=]+$"}
43 bandwidth_schema
={"type":"string", "pattern" : "^[0-9]+ *([MG]bps)?$"}
44 memory_schema
={"type":"string", "pattern" : "^[0-9]+ *([MG]i?[Bb])?$"}
45 integer0_schema
={"type":"integer","minimum":0}
46 integer1_schema
={"type":"integer","minimum":1}
47 path_schema
={"type":"string", "pattern":"^(\.){0,2}(/[^/\"':{}\(\)]+)+$"}
48 vlan_schema
={"type":"integer","minimum":1,"maximum":4095}
49 vlan1000_schema
={"type":"integer","minimum":1000,"maximum":4095}
50 mac_schema
={"type":"string", "pattern":"^[0-9a-fA-F][02468aceACE](:[0-9a-fA-F]{2}){5}$"} #must be unicast LSB bit of MSB byte ==0
51 #mac_schema={"type":"string", "pattern":"^([0-9a-fA-F]{2}:){5}[0-9a-fA-F]{2}$"}
52 ip_schema
={"type":"string","pattern":"^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$"}
53 ip_prefix_schema
={"type":"string","pattern":"^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)/(30|[12]?[0-9])$"}
54 port_schema
={"type":"integer","minimum":1,"maximum":65534}
55 object_schema
={"type":"object"}
56 schema_version_2
={"type":"integer","minimum":2,"maximum":2}
57 #schema_version_string={"type":"string","enum": ["0.1", "2", "0.2", "3", "0.3"]}
58 log_level_schema
={"type":"string", "enum":["DEBUG", "INFO", "WARNING","ERROR","CRITICAL"]}
59 checksum_schema
={"type":"string", "pattern":"^[0-9a-fA-F]{32}$"}
60 size_schema
={"type":"integer","minimum":1,"maximum":100}
65 "architecture": {"type":"string"},
66 "use_incremental": {"type":"string","enum":["yes","no"]},
68 "os_distro": {"type":"string"},
69 "os_type": {"type":"string"},
70 "os_version": {"type":"string"},
71 "bus": {"type":"string"},
72 "topology": {"type":"string", "enum": ["oneSocket"]}
76 #Schema for the configuration file
78 "title":"configuration response information schema",
79 "$schema": "http://json-schema.org/draft-04/schema#",
82 "http_port": port_schema
,
83 "http_admin_port": port_schema
,
84 "http_host": nameshort_schema
,
85 "auto_push_VNF_to_VIMs": {"type":"boolean"},
86 "vnf_repository": path_schema
,
87 "db_host": nameshort_schema
,
88 "db_user": nameshort_schema
,
89 "db_passwd": {"type":"string"},
90 "db_name": nameshort_schema
,
91 "db_ovim_host": nameshort_schema
,
92 "db_ovim_user": nameshort_schema
,
93 "db_ovim_passwd": {"type":"string"},
94 "db_ovim_name": nameshort_schema
,
95 # Next fields will disappear once the MANO API includes appropriate primitives
96 "vim_url": http_schema
,
97 "vim_url_admin": http_schema
,
98 "vim_name": nameshort_schema
,
99 "vim_tenant_name": nameshort_schema
,
100 "mano_tenant_name": nameshort_schema
,
101 "mano_tenant_id": id_schema
,
102 "http_console_proxy": {"type":"boolean"},
103 "http_console_host": nameshort_schema
,
104 "http_console_ports": {
108 {"type": "object", "properties": {"from": port_schema
, "to": port_schema
}, "required": ["from", "to"]}
111 "log_level": log_level_schema
,
112 "log_socket_level": log_level_schema
,
113 "log_level_db": log_level_schema
,
114 "log_level_vim": log_level_schema
,
115 "log_level_wim": log_level_schema
,
116 "log_level_nfvo": log_level_schema
,
117 "log_level_http": log_level_schema
,
118 "log_level_console": log_level_schema
,
119 "log_level_ovim": log_level_schema
,
120 "log_file_db": path_schema
,
121 "log_file_vim": path_schema
,
122 "log_file_wim": path_schema
,
123 "log_file_nfvo": path_schema
,
124 "log_file_http": path_schema
,
125 "log_file_console": path_schema
,
126 "log_file_ovim": path_schema
,
127 "log_socket_host": nameshort_schema
,
128 "log_socket_port": port_schema
,
129 "log_file": path_schema
,
131 "required": ['db_user', 'db_passwd', 'db_name'],
132 "additionalProperties": False
136 "title":"tenant information schema",
137 "$schema": "http://json-schema.org/draft-04/schema#",
143 "name": nameshort_schema
,
144 "description": description_schema
,
146 "required": ["name"],
147 "additionalProperties": True
150 "required": ["tenant"],
151 "additionalProperties": False
154 tenant_edit_schema
= {
155 "title":"tenant edit information schema",
156 "$schema": "http://json-schema.org/draft-04/schema#",
163 "description": description_schema
,
165 "additionalProperties": False
168 "required": ["tenant"],
169 "additionalProperties": False
172 datacenter_schema_properties
={
174 "description": description_schema
,
175 "type": nameshort_schema
, #currently "openvim" or "openstack", can be enlarged with plugins
176 "vim_url": description_schema
,
177 "vim_url_admin": description_schema
,
178 "config": { "type":"object" }
181 datacenter_schema
= {
182 "title":"datacenter information schema",
183 "$schema": "http://json-schema.org/draft-04/schema#",
188 "properties":datacenter_schema_properties
,
189 "required": ["name", "vim_url"],
190 "additionalProperties": True
193 "required": ["datacenter"],
194 "additionalProperties": False
198 datacenter_edit_schema
= {
199 "title":"datacenter edit nformation schema",
200 "$schema": "http://json-schema.org/draft-04/schema#",
205 "properties":datacenter_schema_properties
,
206 "additionalProperties": False
209 "required": ["datacenter"],
210 "additionalProperties": False
214 netmap_new_schema
= {
215 "title":"netmap new information schema",
216 "$schema": "http://json-schema.org/draft-04/schema#",
219 "netmap":{ #delete from datacenter
222 "name": name_schema
, #name or uuid of net to change
224 "vim_name": name_schema
227 "additionalProperties": False
230 "required": ["netmap"],
231 "additionalProperties": False
234 netmap_edit_schema
= {
235 "title":"netmap edit information schema",
236 "$schema": "http://json-schema.org/draft-04/schema#",
239 "netmap":{ #delete from datacenter
242 "name": name_schema
, #name or uuid of net to change
245 "additionalProperties": False
248 "required": ["netmap"],
249 "additionalProperties": False
252 datacenter_action_schema
= {
253 "title":"datacenter action information schema",
254 "$schema": "http://json-schema.org/draft-04/schema#",
257 "net-update":{"type":"null",},
261 "net": name_schema
, #name or uuid of net to change
263 "description": description_schema
,
264 "shared": {"type": "boolean"}
267 "additionalProperties": False
272 "net": name_schema
, #name or uuid of net to change
275 "additionalProperties": False
280 "additionalProperties": False
284 datacenter_associate_schema
={
285 "title":"datacenter associate information schema",
286 "$schema": "http://json-schema.org/draft-04/schema#",
294 "vim_tenant": name_schema
,
295 "vim_tenant_name": name_schema
,
296 "vim_username": nameshort_schema
,
297 "vim_password": nameshort_schema
,
298 "config": {"type": "object"}
300 # "required": ["vim_tenant"],
301 "additionalProperties": True
304 "required": ["datacenter"],
305 "additionalProperties": False
309 "title": "DHCP schema",
310 "$schema": "http://json-schema.org/draft-04/schema#",
313 "enabled": {"type": "boolean"},
314 "start-address": {"OneOf": [{"type": "null"}, ip_schema
]},
315 "count": integer0_schema
317 # "required": ["start-address", "count"],
320 ip_profile_schema
= {
321 "title": "IP profile schema",
322 "$schema": "http://json-schema.org/draft-04/schema#",
325 "ip-version": {"type": "string", "enum": ["IPv4", "IPv6"]},
326 "subnet-address": ip_prefix_schema
,
327 "gateway-address": ip_schema
,
328 "dns-address": {"oneOf": [ip_schema
, # for backward compatibility
329 {"type": "array", "items": ip_schema
}]},
335 "title": "Key-pair schema for cloud-init configuration schema",
336 "$schema": "http://json-schema.org/draft-04/schema#",
340 "key": {"type":"string"}
343 "additionalProperties": False
346 cloud_config_user_schema
= {
347 "title": "User schema for cloud-init configuration schema",
348 "$schema": "http://json-schema.org/draft-04/schema#",
351 "name": nameshort_schema
,
352 "user-info": {"type":"string"},
353 #"key-pairs": {"type" : "array", "items": key_pair_schema}
354 "key-pairs": {"type" : "array", "items": {"type":"string"}}
356 "required": ["name"],
357 "additionalProperties": False
360 cloud_config_schema
= {
361 "title": "Cloud-init configuration schema",
362 "$schema": "http://json-schema.org/draft-04/schema#",
365 #"key-pairs": {"type" : "array", "items": key_pair_schema},
366 "key-pairs": {"type" : "array", "items": {"type":"string"}},
367 "users": {"type" : "array", "items": cloud_config_user_schema
}
369 "additionalProperties": False
372 internal_connection_element_schema
= {
376 "local_iface_name": name_schema
380 internal_connection_element_schema_v02
= {
384 "local_iface_name": name_schema
,
385 "ip_address": ip_schema
389 internal_connection_schema
= {
393 "description":description_schema
,
394 "type":{"type":"string", "enum":["bridge","data","ptp"]},
395 "elements": {"type" : "array", "items": internal_connection_element_schema
, "minItems":1}
397 "required": ["name", "type", "elements"],
398 "additionalProperties": False
401 internal_connection_schema_v02
= {
405 "description":description_schema
,
406 "type": {"type": "string", "enum":["e-line", "e-lan"]},
407 "implementation": {"type": "string", "enum":["overlay", "underlay"]},
408 "ip-profile": ip_profile_schema
,
409 "elements": {"type" : "array", "items": internal_connection_element_schema_v02
, "minItems":1}
411 "required": ["name", "type", "implementation", "elements"],
412 "additionalProperties": False
415 external_connection_schema
= {
419 "type":{"type":"string", "enum":["mgmt","bridge","data"]},
421 "local_iface_name": name_schema
,
422 "description":description_schema
424 "required": ["name", "type", "VNFC", "local_iface_name"],
425 "additionalProperties": False
429 external_connection_schema_v02
= {
433 "mgmt": {"type":"boolean"},
434 "type": {"type": "string", "enum":["e-line", "e-lan"]},
435 "implementation": {"type": "string", "enum":["overlay", "underlay"]},
437 "local_iface_name": name_schema
,
438 "description":description_schema
440 "required": ["name", "type", "VNFC", "local_iface_name"],
441 "additionalProperties": False
450 "dedicated":{"type":"string","enum":["yes","no","yes:sriov"]},
451 "bandwidth":bandwidth_schema
,
453 "mac_address": mac_schema
455 "additionalProperties": False,
456 "required": ["name","dedicated", "bandwidth"]
460 bridge_interfaces_schema
={
466 "bandwidth":bandwidth_schema
,
468 "mac_address": mac_schema
,
469 "model": {"type":"string", "enum":["virtio","e1000","ne2k_pci","pcnet","rtl8139"]},
470 "port-security": {"type" : "boolean"},
471 "floating-ip": {"type" : "boolean"}
473 "additionalProperties": False,
483 "type":{"type":"string", "enum":["disk","cdrom","xml"] },
484 "image": path_schema
,
485 "image name": name_schema
,
486 "image checksum": checksum_schema
,
487 "image metadata": metadata_schema
,
490 "xml":xml_text_schema
,
493 "additionalProperties": False,
502 "memory":integer1_schema
,
503 "cores":integer1_schema
,
504 "paired-threads":integer1_schema
,
505 "threads":integer1_schema
,
506 "cores-id":{"type":"array","items":integer0_schema
},
507 "paired-threads-id":{"type":"array","items":{"type":"array","minItems":2,"maxItems":2,"items":integer0_schema
}},
508 "threads-id":{"type":"array","items":integer0_schema
},
509 "interfaces":interfaces_schema
511 "additionalProperties": False,
512 #"required": ["memory"]
515 config_files_schema
= {
516 "title": "Config files for cloud init schema",
517 "$schema": "http://json-schema.org/draft-04/schema#",
521 "encoding": {"type": "string", "enum": ["b64", "base64", "gz", "gz+b64", "gz+base64", "gzip+b64", "gzip+base64"]}, #by default text
522 "content": {"type": "string"},
523 "permissions": {"type": "string"}, # tiypically octal notation '0644'
524 "owner": {"type": "string"}, # format: owner:group
527 "additionalProperties": False,
528 "required": ["dest", "content"],
531 boot_data_vdu_schema
= {
532 "title": "Boot data (Cloud-init) configuration schema",
533 "$schema": "http://json-schema.org/draft-04/schema#",
536 "key-pairs": {"type" : "array", "items": {"type":"string"}},
537 "users": {"type" : "array", "items": cloud_config_user_schema
},
538 "user-data": {"type" : "string"}, # scrip to run
539 "config-files": {"type": "array", "items": config_files_schema
},
540 # NOTE: “user-data” are mutually exclusive with users and config-files because user/files are injected using user-data
541 "boot-data-drive": {"type": "boolean"},
543 "additionalProperties": False,
550 "description": description_schema
,
551 "count": integer1_schema
,
552 "image name": name_schema
,
553 "availability_zone": name_schema
,
554 "VNFC image": {"oneOf": [path_schema
, http_schema
]},
555 "image checksum": checksum_schema
,
556 "image metadata": metadata_schema
,
557 #"cloud-config": cloud_config_schema, #common for all vnfs in the scenario
561 "model":description_schema
,
562 "features":{"type":"array","items":nameshort_schema
}
564 "required": ["model"],
565 "additionalProperties": False
570 "type":nameshort_schema
,
571 "version":description_schema
574 "ram":integer0_schema
,
575 "vcpus":integer0_schema
,
576 "disk": integer1_schema
,
581 "bridge-ifaces": bridge_interfaces_schema
,
582 "devices": devices_schema
,
583 "boot-data" : boot_data_vdu_schema
586 "required": ["name"],
588 {"required": ["VNFC image"]},
589 {"required": ["image name"]}
591 "additionalProperties": False
595 "title":"vnfd information schema v0.1",
596 "$schema": "http://json-schema.org/draft-04/schema#",
603 "description": description_schema
,
605 "class": nameshort_schema
,
606 "public": {"type" : "boolean"},
607 "physical": {"type" : "boolean"},
608 "default_user": name_schema
,
609 "tenant_id": id_schema
, #only valid for admin
610 "external-connections": {"type" : "array", "items": external_connection_schema
, "minItems":1},
611 "internal-connections": {"type" : "array", "items": internal_connection_schema
, "minItems":1},
612 "VNFC":{"type" : "array", "items": vnfc_schema
, "minItems":1}
614 "required": ["name","external-connections"],
615 "additionalProperties": True
619 "additionalProperties": False
622 #VNFD schema for OSM R1
624 "title":"vnfd information schema v0.2",
625 "$schema": "http://json-schema.org/draft-04/schema#",
628 "schema_version": {"type": "string", "enum": ["0.2"]},
633 "description": description_schema
,
634 "class": nameshort_schema
,
635 "public": {"type" : "boolean"},
636 "physical": {"type" : "boolean"},
637 "tenant_id": id_schema
, #only valid for admin
638 "external-connections": {"type" : "array", "items": external_connection_schema
, "minItems":1},
639 "internal-connections": {"type" : "array", "items": internal_connection_schema_v02
, "minItems":1},
640 # "cloud-config": cloud_config_schema, #common for all vnfcs
641 "VNFC":{"type" : "array", "items": vnfc_schema
, "minItems":1}
643 "required": ["name"],
644 "additionalProperties": True
647 "required": ["vnf", "schema_version"],
648 "additionalProperties": False
651 #vnfd_schema = vnfd_schema_v01
653 # "title":"vnfd information schema v0.2",
654 # "$schema": "http://json-schema.org/draft-04/schema#",
655 # "oneOf": [vnfd_schema_v01, vnfd_schema_v02]
659 "title":"graphical scenario descriptor information schema",
660 "$schema": "http://json-schema.org/draft-04/schema#",
663 "x": integer0_schema
,
664 "y": integer0_schema
,
668 "left": {"type":"array"},
669 "right": {"type":"array"},
670 "bottom": {"type":"array"},
674 "required": ["x","y"]
678 "title":"network scenario descriptor information schema v0.1",
679 "$schema": "http://json-schema.org/draft-04/schema#",
683 "description": description_schema
,
684 "tenant_id": id_schema
, #only valid for admin
685 "public": {"type": "boolean"},
691 "patternProperties":{
695 "type":{"type":"string", "enum":["VNF", "other_network", "network", "external_network"]},
697 "graph": graph_schema
,
699 "patternProperties":{
700 "^(VNF )?model$": {"type": "string"}
708 "patternProperties":{
712 "nodes":{"oneOf":[{"type":"object", "minProperties":2}, {"type":"array", "minLength":1}]},
713 "type": {"type": "string", "enum":["link", "external_network", "dataplane_net", "bridge_net"]},
714 "graph": graph_schema
716 "required": ["nodes"]
721 "required": ["nodes"],
722 "additionalProperties": False
725 "required": ["name","topology"],
726 "additionalProperties": False
730 "title":"network scenario descriptor information schema v0.2",
731 "$schema": "http://json-schema.org/draft-04/schema#",
734 "schema_version": schema_version_2
,
739 "description": description_schema
,
740 "tenant_id": id_schema
, #only valid for admin
741 "public": {"type": "boolean"},
744 "patternProperties":{
749 "graph": graph_schema
,
750 "vnf_name": name_schema
,
758 "patternProperties":{
762 "interfaces":{"type":"array", "minLength":1},
763 "type": {"type": "string", "enum":["dataplane", "bridge"]},
764 "external" : {"type": "boolean"},
765 "graph": graph_schema
767 "required": ["interfaces"]
773 "required": ["vnfs", "name"],
774 "additionalProperties": False
777 "required": ["scenario","schema_version"],
778 "additionalProperties": False
781 #NSD schema for OSM R1
783 "title":"network scenario descriptor information schema v0.3",
784 "$schema": "http://json-schema.org/draft-04/schema#",
787 "schema_version": {"type": "string", "enum": ["0.3"]},
792 "description": description_schema
,
793 "tenant_id": id_schema
, #only valid for admin
794 "public": {"type": "boolean"},
795 "cloud-config": cloud_config_schema
, #common for all vnfs in the scenario
796 #"datacenter": name_schema,
799 "patternProperties":{
804 "graph": graph_schema
,
805 "vnf_name": name_schema
,
806 #"cloud-config": cloud_config_schema, #particular for a vnf
807 #"datacenter": name_schema,
808 "internal-connections": {
810 "patternProperties": {
814 "ip-profile": ip_profile_schema
,
821 "local_iface_name": name_schema
,
822 "ip_address": ip_schema
,
824 "required": ["VNFC", "local_iface_name"],
838 "patternProperties":{
849 "vnf_interface": name_schema
,
850 "ip_address": ip_schema
852 "required": ["vnf", "vnf_interface"],
855 "type": {"type": "string", "enum":["e-line", "e-lan"]},
856 "implementation": {"type": "string", "enum":["overlay", "underlay"]},
857 "external" : {"type": "boolean"},
858 "graph": graph_schema
,
859 "ip-profile": ip_profile_schema
861 "required": ["interfaces"]
867 "required": ["vnfs", "networks","name"],
868 "additionalProperties": False
871 "required": ["scenario","schema_version"],
872 "additionalProperties": False
875 #scenario_new_schema = {
876 # "title":"new scenario information schema",
877 # "$schema": "http://json-schema.org/draft-04/schema#",
878 # #"oneOf": [nsd_schema_v01, nsd_schema_v02]
879 # "oneOf": [nsd_schema_v01]
882 scenario_edit_schema
= {
883 "title":"edit scenario information schema",
884 "$schema": "http://json-schema.org/draft-04/schema#",
888 "description": description_schema
,
894 "patternProperties":{
895 "^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$": {
901 "x": integer0_schema
,
902 "y": integer0_schema
,
903 "ifaces":{ "type": "object"}
906 "description": description_schema
,
913 "required": ["nodes"],
914 "additionalProperties": False
917 "additionalProperties": False
920 scenario_action_schema
= {
921 "title":"scenario action information schema",
922 "$schema": "http://json-schema.org/draft-04/schema#",
928 "instance_name":name_schema
,
929 "description":description_schema
,
930 "datacenter": {"type": "string"}
932 "required": ["instance_name"]
937 "instance_name":name_schema
,
938 "description":description_schema
,
939 "datacenter": {"type": "string"}
941 "required": ["instance_name"]
946 "instance_name":name_schema
,
947 "description":description_schema
,
948 "datacenter": {"type": "string"}
950 "required": ["instance_name"]
955 "instance_name":name_schema
,
956 "description":description_schema
,
957 "datacenter": {"type": "string"}
959 "required": ["instance_name"]
964 "additionalProperties": False
967 instance_scenario_create_schema_v01
= {
968 "title":"instance scenario create information schema v0.1",
969 "$schema": "http://json-schema.org/draft-04/schema#",
972 "schema_version": {"type": "string", "enum": ["0.1"]},
977 "description":description_schema
,
978 "datacenter": name_schema
,
979 "scenario" : name_schema
, #can be an UUID or name
980 "action":{"enum": ["deploy","reserve","verify" ]},
981 "connect_mgmt_interfaces": {"oneOf": [{"type":"boolean"}, {"type":"object"}]},# can be true or a dict with datacenter: net_name
982 "cloud-config": cloud_config_schema
, #common to all vnfs in the instance scenario
983 "vnfs":{ #mapping from scenario to datacenter
985 "patternProperties":{
989 "name": name_schema
, #override vnf name
990 "datacenter": name_schema
,
991 #"metadata": {"type": "object"},
992 #"user_data": {"type": "string"}
993 #"cloud-config": cloud_config_schema, #particular for a vnf
996 "patternProperties": {
1000 "name": name_schema
, # overrides vdu name schema
1003 "patternProperties": {
1005 "vim_id": name_schema
,
1011 "patternProperties": {
1013 "ip_address": ip_schema
,
1014 "mac_address": mac_schema
,
1015 "floating-ip": {"type": "boolean"},
1025 "patternProperties": {
1029 "vim-network-name": name_schema
,
1030 "ip-profile": ip_profile_schema
,
1031 "name": name_schema
,
1040 "networks":{ #mapping from scenario to datacenter
1042 "patternProperties":{
1052 "ip_address": ip_schema
,
1053 "datacenter": name_schema
,
1054 "vim-network-name": name_schema
1056 "patternProperties":{
1057 ".": {"type": "string"}
1061 "ip-profile": ip_profile_schema
,
1062 #if the network connects VNFs deployed at different sites, you must specify one entry per site that this network connect to
1069 # By default for an scenario 'external' network openmano looks for an existing VIM network to map this external scenario network,
1070 # for other networks openamno creates at VIM
1071 # Use netmap-create to force to create an external scenario network
1072 "netmap-create": {"oneOf":[name_schema
,{"type": "null"}]}, #datacenter network to use. Null if must be created as an internal net
1073 #netmap-use: Indicates an existing VIM network that must be used for this scenario network.
1074 #Can use both the VIM network name (if it is not ambiguous) or the VIM net UUID
1075 #If both 'netmap-create' and 'netmap-use'are supplied, netmap-use precedes, but if fails openmano follows the netmap-create
1076 #In oder words, it is the same as 'try to map to the VIM network (netmap-use) if exist, and if not create the network (netmap-create)
1077 "netmap-use": name_schema
, #
1078 "vim-network-name": name_schema
, #override network name
1079 #"ip-profile": ip_profile_schema,
1080 "datacenter": name_schema
,
1089 "additionalProperties": False,
1090 "required": ["name"]
1093 "required": ["instance"],
1094 "additionalProperties": False
1097 instance_scenario_action_schema
= {
1098 "title": "instance scenario action information schema",
1099 "$schema": "http://json-schema.org/draft-04/schema#",
1102 "start": {"type": "null"},
1103 "pause": {"type": "null"},
1104 "resume": {"type": "null"},
1105 "shutoff": {"type": "null"},
1106 "shutdown": {"type": "null"},
1107 "forceOff": {"type": "null"},
1108 "rebuild": {"type": "null"},
1110 "type": ["object", "null"],
1112 "add_public_key": description_schema
,
1113 "console": {"type": ["string", "null"], "enum": ["novnc", "xvpvnc", "rdp-html5", "spice-html5", None]},
1119 "vdu-id": id_schema
,
1120 "osm_vdu_id": name_schema
,
1121 "member-vnf-index": name_schema
,
1122 "count": integer1_schema
,
1123 "type": {"enum": ["create", "delete"]}
1125 "additionalProperties": False,
1127 "required": ["type"]
1130 "vnfs": {"type": "array", "items": {"type": "string"}},
1131 "vms": {"type": "array", "items": {"type": "string"}}
1134 #"maxProperties": 1,
1135 "additionalProperties": False
1138 sdn_controller_properties
={
1139 "name": name_schema
,
1140 "dpid": {"type":"string", "pattern":"^[0-9a-fA-F]{2}(:[0-9a-fA-F]{2}){7}$"},
1142 "port": port_schema
,
1143 "type": {"type": "string", "enum": ["opendaylight","floodlight","onos"]},
1144 "version": {"type" : "string", "minLength":1, "maxLength":12},
1145 "user": nameshort_schema
,
1146 "password": passwd_schema
1148 sdn_controller_schema
= {
1149 "title":"sdn controller information schema",
1150 "$schema": "http://json-schema.org/draft-04/schema#",
1155 "properties":sdn_controller_properties
,
1156 "required": ["name", "port", 'ip', 'dpid', 'type'],
1157 "additionalProperties": False
1160 "required": ["sdn_controller"],
1161 "additionalProperties": False
1164 sdn_controller_edit_schema
= {
1165 "title":"sdn controller update information schema",
1166 "$schema": "http://json-schema.org/draft-04/schema#",
1171 "properties":sdn_controller_properties
,
1172 "additionalProperties": False
1175 "required": ["sdn_controller"],
1176 "additionalProperties": False
1179 sdn_port_mapping_schema
= {
1180 "$schema": "http://json-schema.org/draft-04/schema#",
1181 "title":"sdn port mapping information schema",
1184 "sdn_port_mapping": {
1189 "compute_node": nameshort_schema
,
1195 "pci": pci_extended_schema
, # pci_schema,
1196 "switch_port": nameshort_schema
,
1197 "switch_mac": mac_schema
1203 "required": ["compute_node", "ports"]
1207 "required": ["sdn_port_mapping"]
1210 sdn_external_port_schema
= {
1211 "$schema": "http://json-schema.org/draft-04/schema#",
1212 "title":"External port ingformation",
1215 "port": {"type" : "string", "minLength":1, "maxLength":60},
1216 "vlan": vlan_schema
,
1219 "required": ["port"]