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_nfvo": log_level_schema
,
116 "log_level_http": log_level_schema
,
117 "log_level_console": log_level_schema
,
118 "log_level_ovim": log_level_schema
,
119 "log_file_db": path_schema
,
120 "log_file_vim": path_schema
,
121 "log_file_nfvo": path_schema
,
122 "log_file_http": path_schema
,
123 "log_file_console": path_schema
,
124 "log_file_ovim": path_schema
,
125 "log_socket_host": nameshort_schema
,
126 "log_socket_port": port_schema
,
127 "log_file": path_schema
,
129 "required": ['db_user', 'db_passwd', 'db_name'],
130 "additionalProperties": False
134 "title":"tenant information schema",
135 "$schema": "http://json-schema.org/draft-04/schema#",
141 "name": nameshort_schema
,
142 "description": description_schema
,
144 "required": ["name"],
145 "additionalProperties": True
148 "required": ["tenant"],
149 "additionalProperties": False
152 tenant_edit_schema
= {
153 "title":"tenant edit information schema",
154 "$schema": "http://json-schema.org/draft-04/schema#",
161 "description": description_schema
,
163 "additionalProperties": False
166 "required": ["tenant"],
167 "additionalProperties": False
170 datacenter_schema_properties
={
172 "description": description_schema
,
173 "type": nameshort_schema
, #currently "openvim" or "openstack", can be enlarged with plugins
174 "vim_url": description_schema
,
175 "vim_url_admin": description_schema
,
176 "config": { "type":"object" }
179 datacenter_schema
= {
180 "title":"datacenter information schema",
181 "$schema": "http://json-schema.org/draft-04/schema#",
186 "properties":datacenter_schema_properties
,
187 "required": ["name", "vim_url"],
188 "additionalProperties": True
191 "required": ["datacenter"],
192 "additionalProperties": False
196 datacenter_edit_schema
= {
197 "title":"datacenter edit nformation schema",
198 "$schema": "http://json-schema.org/draft-04/schema#",
203 "properties":datacenter_schema_properties
,
204 "additionalProperties": False
207 "required": ["datacenter"],
208 "additionalProperties": False
212 netmap_new_schema
= {
213 "title":"netmap new information schema",
214 "$schema": "http://json-schema.org/draft-04/schema#",
217 "netmap":{ #delete from datacenter
220 "name": name_schema
, #name or uuid of net to change
222 "vim_name": name_schema
225 "additionalProperties": False
228 "required": ["netmap"],
229 "additionalProperties": False
232 netmap_edit_schema
= {
233 "title":"netmap edit information schema",
234 "$schema": "http://json-schema.org/draft-04/schema#",
237 "netmap":{ #delete from datacenter
240 "name": name_schema
, #name or uuid of net to change
243 "additionalProperties": False
246 "required": ["netmap"],
247 "additionalProperties": False
250 datacenter_action_schema
= {
251 "title":"datacenter action information schema",
252 "$schema": "http://json-schema.org/draft-04/schema#",
255 "net-update":{"type":"null",},
259 "net": name_schema
, #name or uuid of net to change
261 "description": description_schema
,
262 "shared": {"type": "boolean"}
265 "additionalProperties": False
270 "net": name_schema
, #name or uuid of net to change
273 "additionalProperties": False
278 "additionalProperties": False
282 datacenter_associate_schema
={
283 "title":"datacenter associate information schema",
284 "$schema": "http://json-schema.org/draft-04/schema#",
292 "vim_tenant": name_schema
,
293 "vim_tenant_name": name_schema
,
294 "vim_username": nameshort_schema
,
295 "vim_password": nameshort_schema
,
296 "config": {"type": "object"}
298 # "required": ["vim_tenant"],
299 "additionalProperties": True
302 "required": ["datacenter"],
303 "additionalProperties": False
307 "title": "DHCP schema",
308 "$schema": "http://json-schema.org/draft-04/schema#",
311 "enabled": {"type": "boolean"},
312 "start-address": {"OneOf": [{"type": "null"}, ip_schema
]},
313 "count": integer0_schema
315 # "required": ["start-address", "count"],
318 ip_profile_schema
= {
319 "title": "IP profile schema",
320 "$schema": "http://json-schema.org/draft-04/schema#",
323 "ip-version": {"type": "string", "enum": ["IPv4", "IPv6"]},
324 "subnet-address": ip_prefix_schema
,
325 "gateway-address": ip_schema
,
326 "dns-address": {"oneOf": [ip_schema
, # for backward compatibility
327 {"type": "array", "items": ip_schema
}]},
333 "title": "Key-pair schema for cloud-init configuration schema",
334 "$schema": "http://json-schema.org/draft-04/schema#",
338 "key": {"type":"string"}
341 "additionalProperties": False
344 cloud_config_user_schema
= {
345 "title": "User schema for cloud-init configuration schema",
346 "$schema": "http://json-schema.org/draft-04/schema#",
349 "name": nameshort_schema
,
350 "user-info": {"type":"string"},
351 #"key-pairs": {"type" : "array", "items": key_pair_schema}
352 "key-pairs": {"type" : "array", "items": {"type":"string"}}
354 "required": ["name"],
355 "additionalProperties": False
358 cloud_config_schema
= {
359 "title": "Cloud-init configuration schema",
360 "$schema": "http://json-schema.org/draft-04/schema#",
363 #"key-pairs": {"type" : "array", "items": key_pair_schema},
364 "key-pairs": {"type" : "array", "items": {"type":"string"}},
365 "users": {"type" : "array", "items": cloud_config_user_schema
}
367 "additionalProperties": False
370 internal_connection_element_schema
= {
374 "local_iface_name": name_schema
378 internal_connection_element_schema_v02
= {
382 "local_iface_name": name_schema
,
383 "ip_address": ip_schema
387 internal_connection_schema
= {
391 "description":description_schema
,
392 "type":{"type":"string", "enum":["bridge","data","ptp"]},
393 "elements": {"type" : "array", "items": internal_connection_element_schema
, "minItems":1}
395 "required": ["name", "type", "elements"],
396 "additionalProperties": False
399 internal_connection_schema_v02
= {
403 "description":description_schema
,
404 "type": {"type": "string", "enum":["e-line", "e-lan"]},
405 "implementation": {"type": "string", "enum":["overlay", "underlay"]},
406 "ip-profile": ip_profile_schema
,
407 "elements": {"type" : "array", "items": internal_connection_element_schema_v02
, "minItems":1}
409 "required": ["name", "type", "implementation", "elements"],
410 "additionalProperties": False
413 external_connection_schema
= {
417 "type":{"type":"string", "enum":["mgmt","bridge","data"]},
419 "local_iface_name": name_schema
,
420 "description":description_schema
422 "required": ["name", "type", "VNFC", "local_iface_name"],
423 "additionalProperties": False
427 external_connection_schema_v02
= {
431 "mgmt": {"type":"boolean"},
432 "type": {"type": "string", "enum":["e-line", "e-lan"]},
433 "implementation": {"type": "string", "enum":["overlay", "underlay"]},
435 "local_iface_name": name_schema
,
436 "description":description_schema
438 "required": ["name", "type", "VNFC", "local_iface_name"],
439 "additionalProperties": False
448 "dedicated":{"type":"string","enum":["yes","no","yes:sriov"]},
449 "bandwidth":bandwidth_schema
,
451 "mac_address": mac_schema
453 "additionalProperties": False,
454 "required": ["name","dedicated", "bandwidth"]
458 bridge_interfaces_schema
={
464 "bandwidth":bandwidth_schema
,
466 "mac_address": mac_schema
,
467 "model": {"type":"string", "enum":["virtio","e1000","ne2k_pci","pcnet","rtl8139"]},
468 "port-security": {"type" : "boolean"},
469 "floating-ip": {"type" : "boolean"}
471 "additionalProperties": False,
481 "type":{"type":"string", "enum":["disk","cdrom","xml"] },
482 "image": path_schema
,
483 "image name": name_schema
,
484 "image checksum": checksum_schema
,
485 "image metadata": metadata_schema
,
488 "xml":xml_text_schema
,
491 "additionalProperties": False,
500 "memory":integer1_schema
,
501 "cores":integer1_schema
,
502 "paired-threads":integer1_schema
,
503 "threads":integer1_schema
,
504 "cores-id":{"type":"array","items":integer0_schema
},
505 "paired-threads-id":{"type":"array","items":{"type":"array","minItems":2,"maxItems":2,"items":integer0_schema
}},
506 "threads-id":{"type":"array","items":integer0_schema
},
507 "interfaces":interfaces_schema
509 "additionalProperties": False,
510 #"required": ["memory"]
513 config_files_schema
= {
514 "title": "Config files for cloud init schema",
515 "$schema": "http://json-schema.org/draft-04/schema#",
519 "encoding": {"type": "string", "enum": ["b64", "base64", "gz", "gz+b64", "gz+base64", "gzip+b64", "gzip+base64"]}, #by default text
520 "content": {"type": "string"},
521 "permissions": {"type": "string"}, # tiypically octal notation '0644'
522 "owner": {"type": "string"}, # format: owner:group
525 "additionalProperties": False,
526 "required": ["dest", "content"],
529 boot_data_vdu_schema
= {
530 "title": "Boot data (Cloud-init) configuration schema",
531 "$schema": "http://json-schema.org/draft-04/schema#",
534 "key-pairs": {"type" : "array", "items": {"type":"string"}},
535 "users": {"type" : "array", "items": cloud_config_user_schema
},
536 "user-data": {"type" : "string"}, # scrip to run
537 "config-files": {"type": "array", "items": config_files_schema
},
538 # NOTE: “user-data” are mutually exclusive with users and config-files because user/files are injected using user-data
539 "boot-data-drive": {"type": "boolean"},
541 "additionalProperties": False,
548 "description": description_schema
,
549 "count": integer1_schema
,
550 "image name": name_schema
,
551 "availability_zone": name_schema
,
552 "VNFC image": {"oneOf": [path_schema
, http_schema
]},
553 "image checksum": checksum_schema
,
554 "image metadata": metadata_schema
,
555 #"cloud-config": cloud_config_schema, #common for all vnfs in the scenario
559 "model":description_schema
,
560 "features":{"type":"array","items":nameshort_schema
}
562 "required": ["model"],
563 "additionalProperties": False
568 "type":nameshort_schema
,
569 "version":description_schema
572 "ram":integer0_schema
,
573 "vcpus":integer0_schema
,
574 "disk": integer1_schema
,
579 "bridge-ifaces": bridge_interfaces_schema
,
580 "devices": devices_schema
,
581 "boot-data" : boot_data_vdu_schema
584 "required": ["name"],
586 {"required": ["VNFC image"]},
587 {"required": ["image name"]}
589 "additionalProperties": False
593 "title":"vnfd information schema v0.1",
594 "$schema": "http://json-schema.org/draft-04/schema#",
601 "description": description_schema
,
603 "class": nameshort_schema
,
604 "public": {"type" : "boolean"},
605 "physical": {"type" : "boolean"},
606 "default_user": name_schema
,
607 "tenant_id": id_schema
, #only valid for admin
608 "external-connections": {"type" : "array", "items": external_connection_schema
, "minItems":1},
609 "internal-connections": {"type" : "array", "items": internal_connection_schema
, "minItems":1},
610 "VNFC":{"type" : "array", "items": vnfc_schema
, "minItems":1}
612 "required": ["name","external-connections"],
613 "additionalProperties": True
617 "additionalProperties": False
620 #VNFD schema for OSM R1
622 "title":"vnfd information schema v0.2",
623 "$schema": "http://json-schema.org/draft-04/schema#",
626 "schema_version": {"type": "string", "enum": ["0.2"]},
631 "description": description_schema
,
632 "class": nameshort_schema
,
633 "public": {"type" : "boolean"},
634 "physical": {"type" : "boolean"},
635 "tenant_id": id_schema
, #only valid for admin
636 "external-connections": {"type" : "array", "items": external_connection_schema
, "minItems":1},
637 "internal-connections": {"type" : "array", "items": internal_connection_schema_v02
, "minItems":1},
638 # "cloud-config": cloud_config_schema, #common for all vnfcs
639 "VNFC":{"type" : "array", "items": vnfc_schema
, "minItems":1}
641 "required": ["name"],
642 "additionalProperties": True
645 "required": ["vnf", "schema_version"],
646 "additionalProperties": False
649 #vnfd_schema = vnfd_schema_v01
651 # "title":"vnfd information schema v0.2",
652 # "$schema": "http://json-schema.org/draft-04/schema#",
653 # "oneOf": [vnfd_schema_v01, vnfd_schema_v02]
657 "title":"graphical scenario descriptor information schema",
658 "$schema": "http://json-schema.org/draft-04/schema#",
661 "x": integer0_schema
,
662 "y": integer0_schema
,
666 "left": {"type":"array"},
667 "right": {"type":"array"},
668 "bottom": {"type":"array"},
672 "required": ["x","y"]
676 "title":"network scenario descriptor information schema v0.1",
677 "$schema": "http://json-schema.org/draft-04/schema#",
681 "description": description_schema
,
682 "tenant_id": id_schema
, #only valid for admin
683 "public": {"type": "boolean"},
689 "patternProperties":{
693 "type":{"type":"string", "enum":["VNF", "other_network", "network", "external_network"]},
695 "graph": graph_schema
,
697 "patternProperties":{
698 "^(VNF )?model$": {"type": "string"}
706 "patternProperties":{
710 "nodes":{"oneOf":[{"type":"object", "minProperties":2}, {"type":"array", "minLength":1}]},
711 "type": {"type": "string", "enum":["link", "external_network", "dataplane_net", "bridge_net"]},
712 "graph": graph_schema
714 "required": ["nodes"]
719 "required": ["nodes"],
720 "additionalProperties": False
723 "required": ["name","topology"],
724 "additionalProperties": False
728 "title":"network scenario descriptor information schema v0.2",
729 "$schema": "http://json-schema.org/draft-04/schema#",
732 "schema_version": schema_version_2
,
737 "description": description_schema
,
738 "tenant_id": id_schema
, #only valid for admin
739 "public": {"type": "boolean"},
742 "patternProperties":{
747 "graph": graph_schema
,
748 "vnf_name": name_schema
,
756 "patternProperties":{
760 "interfaces":{"type":"array", "minLength":1},
761 "type": {"type": "string", "enum":["dataplane", "bridge"]},
762 "external" : {"type": "boolean"},
763 "graph": graph_schema
765 "required": ["interfaces"]
771 "required": ["vnfs", "name"],
772 "additionalProperties": False
775 "required": ["scenario","schema_version"],
776 "additionalProperties": False
779 #NSD schema for OSM R1
781 "title":"network scenario descriptor information schema v0.3",
782 "$schema": "http://json-schema.org/draft-04/schema#",
785 "schema_version": {"type": "string", "enum": ["0.3"]},
790 "description": description_schema
,
791 "tenant_id": id_schema
, #only valid for admin
792 "public": {"type": "boolean"},
793 "cloud-config": cloud_config_schema
, #common for all vnfs in the scenario
794 #"datacenter": name_schema,
797 "patternProperties":{
802 "graph": graph_schema
,
803 "vnf_name": name_schema
,
804 #"cloud-config": cloud_config_schema, #particular for a vnf
805 #"datacenter": name_schema,
806 "internal-connections": {
808 "patternProperties": {
812 "ip-profile": ip_profile_schema
,
819 "local_iface_name": name_schema
,
820 "ip_address": ip_schema
,
822 "required": ["VNFC", "local_iface_name"],
836 "patternProperties":{
847 "vnf_interface": name_schema
,
848 "ip_address": ip_schema
850 "required": ["vnf", "vnf_interface"],
853 "type": {"type": "string", "enum":["e-line", "e-lan"]},
854 "implementation": {"type": "string", "enum":["overlay", "underlay"]},
855 "external" : {"type": "boolean"},
856 "graph": graph_schema
,
857 "ip-profile": ip_profile_schema
859 "required": ["interfaces"]
865 "required": ["vnfs", "networks","name"],
866 "additionalProperties": False
869 "required": ["scenario","schema_version"],
870 "additionalProperties": False
873 #scenario_new_schema = {
874 # "title":"new scenario information schema",
875 # "$schema": "http://json-schema.org/draft-04/schema#",
876 # #"oneOf": [nsd_schema_v01, nsd_schema_v02]
877 # "oneOf": [nsd_schema_v01]
880 scenario_edit_schema
= {
881 "title":"edit scenario information schema",
882 "$schema": "http://json-schema.org/draft-04/schema#",
886 "description": description_schema
,
892 "patternProperties":{
893 "^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$": {
899 "x": integer0_schema
,
900 "y": integer0_schema
,
901 "ifaces":{ "type": "object"}
904 "description": description_schema
,
911 "required": ["nodes"],
912 "additionalProperties": False
915 "additionalProperties": False
918 scenario_action_schema
= {
919 "title":"scenario action information schema",
920 "$schema": "http://json-schema.org/draft-04/schema#",
926 "instance_name":name_schema
,
927 "description":description_schema
,
928 "datacenter": {"type": "string"}
930 "required": ["instance_name"]
935 "instance_name":name_schema
,
936 "description":description_schema
,
937 "datacenter": {"type": "string"}
939 "required": ["instance_name"]
944 "instance_name":name_schema
,
945 "description":description_schema
,
946 "datacenter": {"type": "string"}
948 "required": ["instance_name"]
953 "instance_name":name_schema
,
954 "description":description_schema
,
955 "datacenter": {"type": "string"}
957 "required": ["instance_name"]
962 "additionalProperties": False
965 instance_scenario_create_schema_v01
= {
966 "title":"instance scenario create information schema v0.1",
967 "$schema": "http://json-schema.org/draft-04/schema#",
970 "schema_version": {"type": "string", "enum": ["0.1"]},
975 "description":description_schema
,
976 "datacenter": name_schema
,
977 "scenario" : name_schema
, #can be an UUID or name
978 "action":{"enum": ["deploy","reserve","verify" ]},
979 "connect_mgmt_interfaces": {"oneOf": [{"type":"boolean"}, {"type":"object"}]},# can be true or a dict with datacenter: net_name
980 "cloud-config": cloud_config_schema
, #common to all vnfs in the instance scenario
981 "vnfs":{ #mapping from scenario to datacenter
983 "patternProperties":{
987 "name": name_schema
, #override vnf name
988 "datacenter": name_schema
,
989 #"metadata": {"type": "object"},
990 #"user_data": {"type": "string"}
991 #"cloud-config": cloud_config_schema, #particular for a vnf
994 "patternProperties": {
998 "name": name_schema
, # overrides vdu name schema
1001 "patternProperties": {
1003 "vim_id": name_schema
,
1009 "patternProperties": {
1011 "ip_address": ip_schema
,
1012 "mac_address": mac_schema
,
1013 "floating-ip": {"type": "boolean"},
1023 "patternProperties": {
1027 "vim-network-name": name_schema
,
1028 "ip-profile": ip_profile_schema
,
1029 "name": name_schema
,
1038 "networks":{ #mapping from scenario to datacenter
1040 "patternProperties":{
1050 "ip_address": ip_schema
,
1051 "datacenter": name_schema
,
1052 "vim-network-name": name_schema
1054 "patternProperties":{
1055 ".": {"type": "string"}
1059 "ip-profile": ip_profile_schema
,
1060 #if the network connects VNFs deployed at different sites, you must specify one entry per site that this network connect to
1067 # By default for an scenario 'external' network openmano looks for an existing VIM network to map this external scenario network,
1068 # for other networks openamno creates at VIM
1069 # Use netmap-create to force to create an external scenario network
1070 "netmap-create": {"oneOf":[name_schema
,{"type": "null"}]}, #datacenter network to use. Null if must be created as an internal net
1071 #netmap-use: Indicates an existing VIM network that must be used for this scenario network.
1072 #Can use both the VIM network name (if it is not ambiguous) or the VIM net UUID
1073 #If both 'netmap-create' and 'netmap-use'are supplied, netmap-use precedes, but if fails openmano follows the netmap-create
1074 #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)
1075 "netmap-use": name_schema
, #
1076 "vim-network-name": name_schema
, #override network name
1077 #"ip-profile": ip_profile_schema,
1078 "datacenter": name_schema
,
1087 "additionalProperties": False,
1088 "required": ["name"]
1091 "required": ["instance"],
1092 "additionalProperties": False
1095 instance_scenario_action_schema
= {
1096 "title": "instance scenario action information schema",
1097 "$schema": "http://json-schema.org/draft-04/schema#",
1100 "start": {"type": "null"},
1101 "pause": {"type": "null"},
1102 "resume": {"type": "null"},
1103 "shutoff": {"type": "null"},
1104 "shutdown": {"type": "null"},
1105 "forceOff": {"type": "null"},
1106 "rebuild": {"type": "null"},
1108 "type": ["object", "null"],
1110 "add_public_key": description_schema
,
1111 "console": {"type": ["string", "null"], "enum": ["novnc", "xvpvnc", "rdp-html5", "spice-html5", None]},
1117 "vdu-id": id_schema
,
1118 "osm_vdu_id": name_schema
,
1119 "member-vnf-index": name_schema
,
1120 "count": integer1_schema
,
1121 "type": {"enum": ["create", "delete"]}
1123 "additionalProperties": False,
1125 "required": ["type"]
1128 "vnfs": {"type": "array", "items": {"type": "string"}},
1129 "vms": {"type": "array", "items": {"type": "string"}}
1132 #"maxProperties": 1,
1133 "additionalProperties": False
1136 sdn_controller_properties
={
1137 "name": name_schema
,
1138 "dpid": {"type":"string", "pattern":"^[0-9a-fA-F]{2}(:[0-9a-fA-F]{2}){7}$"},
1140 "port": port_schema
,
1141 "type": {"type": "string", "enum": ["opendaylight","floodlight","onos"]},
1142 "version": {"type" : "string", "minLength":1, "maxLength":12},
1143 "user": nameshort_schema
,
1144 "password": passwd_schema
1146 sdn_controller_schema
= {
1147 "title":"sdn controller information schema",
1148 "$schema": "http://json-schema.org/draft-04/schema#",
1153 "properties":sdn_controller_properties
,
1154 "required": ["name", "port", 'ip', 'dpid', 'type'],
1155 "additionalProperties": False
1158 "required": ["sdn_controller"],
1159 "additionalProperties": False
1162 sdn_controller_edit_schema
= {
1163 "title":"sdn controller update information schema",
1164 "$schema": "http://json-schema.org/draft-04/schema#",
1169 "properties":sdn_controller_properties
,
1170 "additionalProperties": False
1173 "required": ["sdn_controller"],
1174 "additionalProperties": False
1177 sdn_port_mapping_schema
= {
1178 "$schema": "http://json-schema.org/draft-04/schema#",
1179 "title":"sdn port mapping information schema",
1182 "sdn_port_mapping": {
1187 "compute_node": nameshort_schema
,
1193 "pci": pci_extended_schema
, # pci_schema,
1194 "switch_port": nameshort_schema
,
1195 "switch_mac": mac_schema
1201 "required": ["compute_node", "ports"]
1205 "required": ["sdn_port_mapping"]
1208 sdn_external_port_schema
= {
1209 "$schema": "http://json-schema.org/draft-04/schema#",
1210 "title":"External port ingformation",
1213 "port": {"type" : "string", "minLength":1, "maxLength":60},
1214 "vlan": vlan_schema
,
1217 "required": ["port"]