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 http_schema
={"type":"string", "pattern":"^https?://[^'\"=]+$"}
41 bandwidth_schema
={"type":"string", "pattern" : "^[0-9]+ *([MG]bps)?$"}
42 memory_schema
={"type":"string", "pattern" : "^[0-9]+ *([MG]i?[Bb])?$"}
43 integer0_schema
={"type":"integer","minimum":0}
44 integer1_schema
={"type":"integer","minimum":1}
45 path_schema
={"type":"string", "pattern":"^(\.){0,2}(/[^/\"':{}\(\)]+)+$"}
46 vlan_schema
={"type":"integer","minimum":1,"maximum":4095}
47 vlan1000_schema
={"type":"integer","minimum":1000,"maximum":4095}
48 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
49 #mac_schema={"type":"string", "pattern":"^([0-9a-fA-F]{2}:){5}[0-9a-fA-F]{2}$"}
50 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]?)$"}
51 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])$"}
52 port_schema
={"type":"integer","minimum":1,"maximum":65534}
53 object_schema
={"type":"object"}
54 schema_version_2
={"type":"integer","minimum":2,"maximum":2}
55 #schema_version_string={"type":"string","enum": ["0.1", "2", "0.2", "3", "0.3"]}
56 log_level_schema
={"type":"string", "enum":["DEBUG", "INFO", "WARNING","ERROR","CRITICAL"]}
57 checksum_schema
={"type":"string", "pattern":"^[0-9a-fA-F]{32}$"}
58 size_schema
={"type":"integer","minimum":1,"maximum":100}
63 "architecture": {"type":"string"},
64 "use_incremental": {"type":"string","enum":["yes","no"]},
66 "os_distro": {"type":"string"},
67 "os_type": {"type":"string"},
68 "os_version": {"type":"string"},
69 "bus": {"type":"string"},
70 "topology": {"type":"string", "enum": ["oneSocket"]}
74 #Schema for the configuration file
76 "title":"configuration response information schema",
77 "$schema": "http://json-schema.org/draft-04/schema#",
80 "http_port": port_schema
,
81 "http_admin_port": port_schema
,
82 "http_host": nameshort_schema
,
83 "auto_push_VNF_to_VIMs": {"type":"boolean"},
84 "vnf_repository": path_schema
,
85 "db_host": nameshort_schema
,
86 "db_user": nameshort_schema
,
87 "db_passwd": {"type":"string"},
88 "db_name": nameshort_schema
,
89 "db_ovim_host": nameshort_schema
,
90 "db_ovim_user": nameshort_schema
,
91 "db_ovim_passwd": {"type":"string"},
92 "db_ovim_name": nameshort_schema
,
93 # Next fields will disappear once the MANO API includes appropriate primitives
94 "vim_url": http_schema
,
95 "vim_url_admin": http_schema
,
96 "vim_name": nameshort_schema
,
97 "vim_tenant_name": nameshort_schema
,
98 "mano_tenant_name": nameshort_schema
,
99 "mano_tenant_id": id_schema
,
100 "http_console_proxy": {"type":"boolean"},
101 "http_console_host": nameshort_schema
,
102 "http_console_ports": {
104 "items": {"OneOf" : [
106 {"type":"object", "properties":{"from": port_schema
, "to": port_schema
}, "required": ["from","to"]}
109 "log_level": log_level_schema
,
110 "log_socket_level": log_level_schema
,
111 "log_level_db": log_level_schema
,
112 "log_level_vim": log_level_schema
,
113 "log_level_nfvo": log_level_schema
,
114 "log_level_http": log_level_schema
,
115 "log_level_console": log_level_schema
,
116 "log_level_ovim": log_level_schema
,
117 "log_file_db": path_schema
,
118 "log_file_vim": path_schema
,
119 "log_file_nfvo": path_schema
,
120 "log_file_http": path_schema
,
121 "log_file_console": path_schema
,
122 "log_file_ovim": path_schema
,
123 "log_socket_host": nameshort_schema
,
124 "log_socket_port": port_schema
,
125 "log_file": path_schema
,
127 "required": ['db_user', 'db_passwd', 'db_name'],
128 "additionalProperties": False
132 "title":"tenant information schema",
133 "$schema": "http://json-schema.org/draft-04/schema#",
139 "name": nameshort_schema
,
140 "description": description_schema
,
142 "required": ["name"],
143 "additionalProperties": True
146 "required": ["tenant"],
147 "additionalProperties": False
150 tenant_edit_schema
= {
151 "title":"tenant edit information schema",
152 "$schema": "http://json-schema.org/draft-04/schema#",
159 "description": description_schema
,
161 "additionalProperties": False
164 "required": ["tenant"],
165 "additionalProperties": False
168 datacenter_schema_properties
={
170 "description": description_schema
,
171 "type": nameshort_schema
, #currently "openvim" or "openstack", can be enlarged with plugins
172 "vim_url": description_schema
,
173 "vim_url_admin": description_schema
,
174 "config": { "type":"object" }
177 datacenter_schema
= {
178 "title":"datacenter information schema",
179 "$schema": "http://json-schema.org/draft-04/schema#",
184 "properties":datacenter_schema_properties
,
185 "required": ["name", "vim_url"],
186 "additionalProperties": True
189 "required": ["datacenter"],
190 "additionalProperties": False
194 datacenter_edit_schema
= {
195 "title":"datacenter edit nformation schema",
196 "$schema": "http://json-schema.org/draft-04/schema#",
201 "properties":datacenter_schema_properties
,
202 "additionalProperties": False
205 "required": ["datacenter"],
206 "additionalProperties": False
210 netmap_new_schema
= {
211 "title":"netmap new information schema",
212 "$schema": "http://json-schema.org/draft-04/schema#",
215 "netmap":{ #delete from datacenter
218 "name": name_schema
, #name or uuid of net to change
220 "vim_name": name_schema
223 "additionalProperties": False
226 "required": ["netmap"],
227 "additionalProperties": False
230 netmap_edit_schema
= {
231 "title":"netmap edit information schema",
232 "$schema": "http://json-schema.org/draft-04/schema#",
235 "netmap":{ #delete from datacenter
238 "name": name_schema
, #name or uuid of net to change
241 "additionalProperties": False
244 "required": ["netmap"],
245 "additionalProperties": False
248 datacenter_action_schema
= {
249 "title":"datacenter action information schema",
250 "$schema": "http://json-schema.org/draft-04/schema#",
253 "net-update":{"type":"null",},
257 "net": name_schema
, #name or uuid of net to change
259 "description": description_schema
,
260 "shared": {"type": "boolean"}
263 "additionalProperties": False
268 "net": name_schema
, #name or uuid of net to change
271 "additionalProperties": False
276 "additionalProperties": False
280 datacenter_associate_schema
={
281 "title":"datacenter associate information schema",
282 "$schema": "http://json-schema.org/draft-04/schema#",
288 "vim_tenant": name_schema
,
289 "vim_tenant_name": name_schema
,
290 "vim_username": nameshort_schema
,
291 "vim_password": nameshort_schema
,
292 "config": {"type": "object"}
294 # "required": ["vim_tenant"],
295 "additionalProperties": True
298 "required": ["datacenter"],
299 "additionalProperties": False
303 "title":"DHCP schema",
304 "$schema": "http://json-schema.org/draft-04/schema#",
307 "enabled": {"type": "boolean"},
308 "start-address": ip_schema
,
309 "count": integer1_schema
311 "required": ["enabled", "start-address", "count"],
314 ip_profile_schema
= {
315 "title":"IP profile schema",
316 "$schema": "http://json-schema.org/draft-04/schema#",
319 "ip-version": {"type": "string", "enum": ["IPv4","IPv6"]},
320 "subnet-address": ip_prefix_schema
,
321 "gateway-address": ip_schema
,
322 "dns-address": {"oneOf": [ip_schema
, # for backward compatibility
323 {"type": "array", "items": ip_schema
}]},
329 "title": "Key-pair schema for cloud-init configuration schema",
330 "$schema": "http://json-schema.org/draft-04/schema#",
334 "key": {"type":"string"}
337 "additionalProperties": False
340 cloud_config_user_schema
= {
341 "title": "User schema for cloud-init configuration schema",
342 "$schema": "http://json-schema.org/draft-04/schema#",
345 "name": nameshort_schema
,
346 "user-info": {"type":"string"},
347 #"key-pairs": {"type" : "array", "items": key_pair_schema}
348 "key-pairs": {"type" : "array", "items": {"type":"string"}}
350 "required": ["name"],
351 "additionalProperties": False
354 cloud_config_schema
= {
355 "title": "Cloud-init configuration schema",
356 "$schema": "http://json-schema.org/draft-04/schema#",
359 #"key-pairs": {"type" : "array", "items": key_pair_schema},
360 "key-pairs": {"type" : "array", "items": {"type":"string"}},
361 "users": {"type" : "array", "items": cloud_config_user_schema
}
363 "additionalProperties": False
366 internal_connection_element_schema
= {
370 "local_iface_name": name_schema
374 internal_connection_element_schema_v02
= {
378 "local_iface_name": name_schema
,
379 "ip_address": ip_schema
383 internal_connection_schema
= {
387 "description":description_schema
,
388 "type":{"type":"string", "enum":["bridge","data","ptp"]},
389 "elements": {"type" : "array", "items": internal_connection_element_schema
, "minItems":1}
391 "required": ["name", "type", "elements"],
392 "additionalProperties": False
395 internal_connection_schema_v02
= {
399 "description":description_schema
,
400 "type": {"type": "string", "enum":["e-line", "e-lan"]},
401 "implementation": {"type": "string", "enum":["overlay", "underlay"]},
402 "ip-profile": ip_profile_schema
,
403 "elements": {"type" : "array", "items": internal_connection_element_schema_v02
, "minItems":1}
405 "required": ["name", "type", "implementation", "elements"],
406 "additionalProperties": False
409 external_connection_schema
= {
413 "type":{"type":"string", "enum":["mgmt","bridge","data"]},
415 "local_iface_name": name_schema
,
416 "description":description_schema
418 "required": ["name", "type", "VNFC", "local_iface_name"],
419 "additionalProperties": False
423 external_connection_schema_v02
= {
427 "mgmt": {"type":"boolean"},
428 "type": {"type": "string", "enum":["e-line", "e-lan"]},
429 "implementation": {"type": "string", "enum":["overlay", "underlay"]},
431 "local_iface_name": name_schema
,
432 "description":description_schema
434 "required": ["name", "type", "VNFC", "local_iface_name"],
435 "additionalProperties": False
444 "dedicated":{"type":"string","enum":["yes","no","yes:sriov"]},
445 "bandwidth":bandwidth_schema
,
447 "mac_address": mac_schema
449 "additionalProperties": False,
450 "required": ["name","dedicated", "bandwidth"]
454 bridge_interfaces_schema
={
460 "bandwidth":bandwidth_schema
,
462 "mac_address": mac_schema
,
463 "model": {"type":"string", "enum":["virtio","e1000","ne2k_pci","pcnet","rtl8139"]},
464 "port-security": {"type" : "boolean"},
465 "floating-ip": {"type" : "boolean"}
467 "additionalProperties": False,
477 "type":{"type":"string", "enum":["disk","cdrom","xml"] },
478 "image": path_schema
,
479 "image name": name_schema
,
480 "image checksum": checksum_schema
,
481 "image metadata": metadata_schema
,
484 "xml":xml_text_schema
,
486 "additionalProperties": False,
495 "memory":integer1_schema
,
496 "cores":integer1_schema
,
497 "paired-threads":integer1_schema
,
498 "threads":integer1_schema
,
499 "cores-id":{"type":"array","items":integer0_schema
},
500 "paired-threads-id":{"type":"array","items":{"type":"array","minItems":2,"maxItems":2,"items":integer0_schema
}},
501 "threads-id":{"type":"array","items":integer0_schema
},
502 "interfaces":interfaces_schema
504 "additionalProperties": False,
505 #"required": ["memory"]
508 config_files_schema
= {
509 "title": "Config files for cloud init schema",
510 "$schema": "http://json-schema.org/draft-04/schema#",
514 "encoding": {"type": "string", "enum": ["b64", "base64", "gz", "gz+b64", "gz+base64", "gzip+b64", "gzip+base64"]}, #by default text
515 "content": {"type": "string"},
516 "permissions": {"type": "string"}, # tiypically octal notation '0644'
517 "owner": {"type": "string"}, # format: owner:group
520 "additionalProperties": False,
521 "required": ["dest", "content"],
524 boot_data_vdu_schema
= {
525 "title": "Boot data (Cloud-init) configuration schema",
526 "$schema": "http://json-schema.org/draft-04/schema#",
529 "key-pairs": {"type" : "array", "items": {"type":"string"}},
530 "users": {"type" : "array", "items": cloud_config_user_schema
},
531 "user-data": {"type" : "string"}, # scrip to run
532 "config-files": {"type": "array", "items": config_files_schema
},
533 # NOTE: “user-data” are mutually exclusive with users and config-files because user/files are injected using user-data
534 "boot-data-drive": {"type": "boolean"},
536 "additionalProperties": False,
543 "description": description_schema
,
544 "count": integer1_schema
,
545 "image name": name_schema
,
546 "availability_zone": name_schema
,
547 "VNFC image": {"oneOf": [path_schema
, http_schema
]},
548 "image checksum": checksum_schema
,
549 "image metadata": metadata_schema
,
550 #"cloud-config": cloud_config_schema, #common for all vnfs in the scenario
554 "model":description_schema
,
555 "features":{"type":"array","items":nameshort_schema
}
557 "required": ["model"],
558 "additionalProperties": False
563 "type":nameshort_schema
,
564 "version":description_schema
567 "ram":integer0_schema
,
568 "vcpus":integer0_schema
,
569 "disk": integer1_schema
,
574 "bridge-ifaces": bridge_interfaces_schema
,
575 "devices": devices_schema
,
576 "boot-data" : boot_data_vdu_schema
579 "required": ["name"],
581 {"required": ["VNFC image"]},
582 {"required": ["image name"]}
584 "additionalProperties": False
588 "title":"vnfd information schema v0.1",
589 "$schema": "http://json-schema.org/draft-04/schema#",
596 "description": description_schema
,
598 "class": nameshort_schema
,
599 "public": {"type" : "boolean"},
600 "physical": {"type" : "boolean"},
601 "tenant_id": id_schema
, #only valid for admin
602 "external-connections": {"type" : "array", "items": external_connection_schema
, "minItems":1},
603 "internal-connections": {"type" : "array", "items": internal_connection_schema
, "minItems":1},
604 "VNFC":{"type" : "array", "items": vnfc_schema
, "minItems":1}
606 "required": ["name","external-connections"],
607 "additionalProperties": True
611 "additionalProperties": False
614 #VNFD schema for OSM R1
616 "title":"vnfd information schema v0.2",
617 "$schema": "http://json-schema.org/draft-04/schema#",
620 "schema_version": {"type": "string", "enum": ["0.2"]},
625 "description": description_schema
,
626 "class": nameshort_schema
,
627 "public": {"type" : "boolean"},
628 "physical": {"type" : "boolean"},
629 "tenant_id": id_schema
, #only valid for admin
630 "external-connections": {"type" : "array", "items": external_connection_schema
, "minItems":1},
631 "internal-connections": {"type" : "array", "items": internal_connection_schema_v02
, "minItems":1},
632 # "cloud-config": cloud_config_schema, #common for all vnfcs
633 "VNFC":{"type" : "array", "items": vnfc_schema
, "minItems":1}
635 "required": ["name"],
636 "additionalProperties": True
639 "required": ["vnf", "schema_version"],
640 "additionalProperties": False
643 #vnfd_schema = vnfd_schema_v01
645 # "title":"vnfd information schema v0.2",
646 # "$schema": "http://json-schema.org/draft-04/schema#",
647 # "oneOf": [vnfd_schema_v01, vnfd_schema_v02]
651 "title":"graphical scenario descriptor information schema",
652 "$schema": "http://json-schema.org/draft-04/schema#",
655 "x": integer0_schema
,
656 "y": integer0_schema
,
660 "left": {"type":"array"},
661 "right": {"type":"array"},
662 "bottom": {"type":"array"},
666 "required": ["x","y"]
670 "title":"network scenario descriptor information schema v0.1",
671 "$schema": "http://json-schema.org/draft-04/schema#",
675 "description": description_schema
,
676 "tenant_id": id_schema
, #only valid for admin
677 "public": {"type": "boolean"},
683 "patternProperties":{
687 "type":{"type":"string", "enum":["VNF", "other_network", "network", "external_network"]},
689 "graph": graph_schema
,
691 "patternProperties":{
692 "^(VNF )?model$": {"type": "string"}
700 "patternProperties":{
704 "nodes":{"oneOf":[{"type":"object", "minProperties":2}, {"type":"array", "minLength":1}]},
705 "type": {"type": "string", "enum":["link", "external_network", "dataplane_net", "bridge_net"]},
706 "graph": graph_schema
708 "required": ["nodes"]
713 "required": ["nodes"],
714 "additionalProperties": False
717 "required": ["name","topology"],
718 "additionalProperties": False
722 "title":"network scenario descriptor information schema v0.2",
723 "$schema": "http://json-schema.org/draft-04/schema#",
726 "schema_version": schema_version_2
,
731 "description": description_schema
,
732 "tenant_id": id_schema
, #only valid for admin
733 "public": {"type": "boolean"},
736 "patternProperties":{
741 "graph": graph_schema
,
742 "vnf_name": name_schema
,
750 "patternProperties":{
754 "interfaces":{"type":"array", "minLength":1},
755 "type": {"type": "string", "enum":["dataplane", "bridge"]},
756 "external" : {"type": "boolean"},
757 "graph": graph_schema
759 "required": ["interfaces"]
765 "required": ["vnfs", "name"],
766 "additionalProperties": False
769 "required": ["scenario","schema_version"],
770 "additionalProperties": False
773 #NSD schema for OSM R1
775 "title":"network scenario descriptor information schema v0.3",
776 "$schema": "http://json-schema.org/draft-04/schema#",
779 "schema_version": {"type": "string", "enum": ["0.3"]},
784 "description": description_schema
,
785 "tenant_id": id_schema
, #only valid for admin
786 "public": {"type": "boolean"},
787 "cloud-config": cloud_config_schema
, #common for all vnfs in the scenario
788 #"datacenter": name_schema,
791 "patternProperties":{
796 "graph": graph_schema
,
797 "vnf_name": name_schema
,
798 #"cloud-config": cloud_config_schema, #particular for a vnf
799 #"datacenter": name_schema,
800 "internal-connections": {
802 "patternProperties": {
806 "ip-profile": ip_profile_schema
,
813 "local_iface_name": name_schema
,
814 "ip_address": ip_schema
816 "required": ["VNFC", "local_iface_name"],
830 "patternProperties":{
841 "vnf_interface": name_schema
,
842 "ip_address": ip_schema
844 "required": ["vnf", "vnf_interface"],
847 "type": {"type": "string", "enum":["e-line", "e-lan"]},
848 "implementation": {"type": "string", "enum":["overlay", "underlay"]},
849 "external" : {"type": "boolean"},
850 "graph": graph_schema
,
851 "ip-profile": ip_profile_schema
853 "required": ["interfaces"]
859 "required": ["vnfs", "networks","name"],
860 "additionalProperties": False
863 "required": ["scenario","schema_version"],
864 "additionalProperties": False
867 #scenario_new_schema = {
868 # "title":"new scenario information schema",
869 # "$schema": "http://json-schema.org/draft-04/schema#",
870 # #"oneOf": [nsd_schema_v01, nsd_schema_v02]
871 # "oneOf": [nsd_schema_v01]
874 scenario_edit_schema
= {
875 "title":"edit scenario information schema",
876 "$schema": "http://json-schema.org/draft-04/schema#",
880 "description": description_schema
,
886 "patternProperties":{
887 "^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$": {
893 "x": integer0_schema
,
894 "y": integer0_schema
,
895 "ifaces":{ "type": "object"}
898 "description": description_schema
,
905 "required": ["nodes"],
906 "additionalProperties": False
909 "additionalProperties": False
912 scenario_action_schema
= {
913 "title":"scenario action information schema",
914 "$schema": "http://json-schema.org/draft-04/schema#",
920 "instance_name":name_schema
,
921 "description":description_schema
,
922 "datacenter": {"type": "string"}
924 "required": ["instance_name"]
929 "instance_name":name_schema
,
930 "description":description_schema
,
931 "datacenter": {"type": "string"}
933 "required": ["instance_name"]
938 "instance_name":name_schema
,
939 "description":description_schema
,
940 "datacenter": {"type": "string"}
942 "required": ["instance_name"]
947 "instance_name":name_schema
,
948 "description":description_schema
,
949 "datacenter": {"type": "string"}
951 "required": ["instance_name"]
956 "additionalProperties": False
959 instance_scenario_create_schema_v01
= {
960 "title":"instance scenario create information schema v0.1",
961 "$schema": "http://json-schema.org/draft-04/schema#",
964 "schema_version": {"type": "string", "enum": ["0.1"]},
969 "description":description_schema
,
970 "datacenter": name_schema
,
971 "scenario" : name_schema
, #can be an UUID or name
972 "action":{"enum": ["deploy","reserve","verify" ]},
973 "connect_mgmt_interfaces": {"oneOf": [{"type":"boolean"}, {"type":"object"}]},# can be true or a dict with datacenter: net_name
974 "cloud-config": cloud_config_schema
, #common to all vnfs in the instance scenario
975 "vnfs":{ #mapping from scenario to datacenter
977 "patternProperties":{
981 "name": name_schema
, #override vnf name
982 "datacenter": name_schema
,
983 #"metadata": {"type": "object"},
984 #"user_data": {"type": "string"}
985 #"cloud-config": cloud_config_schema, #particular for a vnf
986 "external-connections": {
988 "patternProperties": {
992 "vim-network-name": name_schema
,
993 "ip_address": ip_schema
998 "internal-connections": {
1000 "patternProperties": {
1004 "ip-profile": ip_profile_schema
,
1010 "VNFC": name_schema
,
1011 "local_iface_name": name_schema
,
1012 "ip_address": ip_schema
1014 "required": ["VNFC", "local_iface_name"],
1025 "networks":{ #mapping from scenario to datacenter
1027 "patternProperties":{
1037 "ip_address": ip_schema
,
1038 "datacenter": name_schema
,
1039 "vim-network-name": name_schema
1041 "patternProperties":{
1042 ".": {"type": "string"}
1046 "ip-profile": ip_profile_schema
,
1047 #if the network connects VNFs deployed at different sites, you must specify one entry per site that this network connect to
1054 # By default for an scenario 'external' network openmano looks for an existing VIM network to map this external scenario network,
1055 # for other networks openamno creates at VIM
1056 # Use netmap-create to force to create an external scenario network
1057 "netmap-create": {"oneOf":[name_schema
,{"type": "null"}]}, #datacenter network to use. Null if must be created as an internal net
1058 #netmap-use: Indicates an existing VIM network that must be used for this scenario network.
1059 #Can use both the VIM network name (if it is not ambiguous) or the VIM net UUID
1060 #If both 'netmap-create' and 'netmap-use'are supplied, netmap-use precedes, but if fails openmano follows the netmap-create
1061 #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)
1062 "netmap-use": name_schema
, #
1063 "vim-network-name": name_schema
, #override network name
1064 #"ip-profile": ip_profile_schema,
1065 "datacenter": name_schema
,
1077 "additionalProperties": False,
1078 "required": ["name"]
1081 "required": ["instance"],
1082 "additionalProperties": False
1085 instance_scenario_action_schema
= {
1086 "title":"instance scenario action information schema",
1087 "$schema": "http://json-schema.org/draft-04/schema#",
1090 "start":{"type": "null"},
1091 "pause":{"type": "null"},
1092 "resume":{"type": "null"},
1093 "shutoff":{"type": "null"},
1094 "shutdown":{"type": "null"},
1095 "forceOff":{"type": "null"},
1096 "rebuild":{"type": "null"},
1098 "type": ["object","null"],
1100 "console": {"type": ["string", "null"], "enum": ["novnc", "xvpvnc", "rdp-html5", "spice-html5", None]},
1101 "vnfs":{"type": "array", "items":{"type":"string"}},
1102 "vms":{"type": "array", "items":{"type":"string"}}
1105 #"maxProperties": 1,
1106 "additionalProperties": False
1109 sdn_controller_properties
={
1110 "name": name_schema
,
1111 "dpid": {"type":"string", "pattern":"^[0-9a-fA-F]{2}(:[0-9a-fA-F]{2}){7}$"},
1113 "port": port_schema
,
1114 "type": {"type": "string", "enum": ["opendaylight","floodlight","onos"]},
1115 "version": {"type" : "string", "minLength":1, "maxLength":12},
1116 "user": nameshort_schema
,
1117 "password": passwd_schema
1119 sdn_controller_schema
= {
1120 "title":"sdn controller information schema",
1121 "$schema": "http://json-schema.org/draft-04/schema#",
1126 "properties":sdn_controller_properties
,
1127 "required": ["name", "port", 'ip', 'dpid', 'type'],
1128 "additionalProperties": False
1131 "required": ["sdn_controller"],
1132 "additionalProperties": False
1135 sdn_controller_edit_schema
= {
1136 "title":"sdn controller update information schema",
1137 "$schema": "http://json-schema.org/draft-04/schema#",
1142 "properties":sdn_controller_properties
,
1143 "additionalProperties": False
1146 "required": ["sdn_controller"],
1147 "additionalProperties": False
1150 sdn_port_mapping_schema
= {
1151 "$schema": "http://json-schema.org/draft-04/schema#",
1152 "title":"sdn port mapping information schema",
1155 "sdn_port_mapping": {
1160 "compute_node": nameshort_schema
,
1167 "switch_port": nameshort_schema
,
1168 "switch_mac": mac_schema
1174 "required": ["compute_node", "ports"]
1178 "required": ["sdn_port_mapping"]
1181 sdn_external_port_schema
= {
1182 "$schema": "http://json-schema.org/draft-04/schema#",
1183 "title":"External port ingformation",
1186 "port": {"type" : "string", "minLength":1, "maxLength":60},
1187 "vlan": vlan_schema
,
1190 "required": ["port"]