blob: de66517a6ad1ff924e32d0a1fbe58966a855dc07 [file] [log] [blame]
Andy Bavier03df22b2017-08-30 14:46:02 -07001option name = "volt";
Matteo Scandolobfc31332018-03-29 09:06:52 -07002option app_label = "volt";
Matteo Scandoloe2cb8a42018-05-18 16:30:06 -07003option legacy="True";
Andy Bavier03df22b2017-08-30 14:46:02 -07004
5message VOLTService (Service){
Matteo Scandolo43473812018-03-02 10:55:54 -08006 option verbose_name = "vOLT Service";
7 option kind = "vOLT";
Matteo Scandolo4a8b4d62018-03-06 17:18:46 -08008
Luca Preteca974c82018-05-01 18:06:16 -07009 required string voltha_url = 1 [help_text = "The Voltha API address. By default voltha.voltha.svc.cluster.local", default = "voltha.voltha.svc.cluster.local", max_length = 254, null = False, db_index = False, blank = False];
10 required int32 voltha_port = 2 [help_text = "The Voltha API port. By default 8882", default=8882, null = False, db_index = False, blank = False];
11 required string voltha_user = 3 [help_text = "The Voltha username. By default voltha", default="voltha", max_length = 254, null = False, db_index = False, blank = False];
12 required string voltha_pass = 4 [help_text = "The Voltha password. By default admin", default="admin", max_length = 254, null = False, db_index = False, blank = False];
13 required string onos_voltha_url = 5 [help_text = "The ONOS Voltha address. By default onos-voltha-ui.voltha.svc.cluster.local", default="onos-voltha-ui.voltha.svc.cluster.local", max_length = 254, null = False, db_index = False, blank = False];
14 required int32 onos_voltha_port = 6 [help_text = "The Voltha API port. By default 8181", default=8181, null = False, db_index = False, blank = False];
15 required string onos_voltha_user = 7 [help_text = "The ONOS Voltha username. By default sdn", max_length = 254, default="onos", null = True, db_index = False, blank = False];
16 required string onos_voltha_pass = 8 [help_text = "The ONOS Voltha password. By default rocks", max_length = 254, default="rocks", null = True, db_index = False, blank = False];
Andy Bavier03df22b2017-08-30 14:46:02 -070017}
18
Matteo Scandolo4a8b4d62018-03-06 17:18:46 -080019message OLTDevice (XOSBase){
20 option verbose_name = "OLT Device";
21 option description="Represents a physical OLT device";
Andy Bavier03df22b2017-08-30 14:46:02 -070022
Matteo Scandolo43473812018-03-02 10:55:54 -080023 required manytoone volt_service->VOLTService:volt_devices = 1 [db_index = True, null = False, blank = False];
Matteo Scandolo2c144932018-05-04 14:06:24 -070024 optional string name = 2 [help_text = "name of device", max_length = 254, null = True, db_index = False, blank = True, unique = True];
Matteo Scandolo88709c42018-06-20 16:59:38 -070025 required string device_type = 3 [help_text = "Device Type", default = "openolt", max_length = 254, null = False, db_index = False, blank = False];
Matteo Scandolo2ed64b92018-06-18 10:32:56 -070026 optional string host = 4 [help_text = "Device IP", max_length = 254, null = True, db_index = False, blank = True];
Matteo Scandolo88709c42018-06-20 16:59:38 -070027 optional int32 port = 5 [help_text = "Device port", null = True, db_index = False, blank = True];
28 optional string mac_address = 6 [help_text = "Device mac address", null = True, db_index = False, blank = True];
Matteo Scandolo4a8b4d62018-03-06 17:18:46 -080029
30 optional string device_id = 10 [help_text = "Device ID", null = True, db_index = False, blank = False, feedback_state = True];
31 optional string admin_state = 11 [help_text = "admin_state", null = True, db_index = False, blank = False, feedback_state = True];
32 optional string oper_status = 12 [help_text = "oper_status", null = True, db_index = False, blank = False, feedback_state = True];
33 optional string of_id = 13 [help_text = "openflow id", null = True, db_index = False, blank = False, feedback_state = True];
Matteo Scandolof6337eb2018-04-05 15:58:37 -070034 optional string dp_id = 14 [help_text = "datapath id", null = True, db_index = False, blank = False, feedback_state = True];
Matteo Scandolo4a8b4d62018-03-06 17:18:46 -080035
Matteo Scandolo88709c42018-06-20 16:59:38 -070036 required string uplink = 15 [help_text = "uplink port", null = False, db_index = False, blank = False];
Matteo Scandolo19466a02018-05-16 17:43:39 -070037 required string driver = 16 [default="voltha", help_text = "Olt driver", null = True, db_index = False, blank = False];
Matteo Scandolod3c768d2018-04-11 13:38:49 -070038
39 optional string switch_datapath_id = 17 [help_text = "Fabric switch to which the OLT is connected", null = False, db_index = False, blank = False];
40 optional string switch_port = 18 [help_text = "Fabric port to which the OLT is connected", null = False, db_index = False, blank = False];
41 optional string outer_tpid = 19 [help_text = "Outer VLAN id field EtherType", null = False, db_index = False, blank = False];
Andy Bavier03df22b2017-08-30 14:46:02 -070042}
43
Matteo Scandolo6be6ee92018-05-24 15:07:51 -070044message PortBase (XOSBase){
45 option gui_hidden = True;
46
47 required string name = 1 [db_index = True, null = False, blank = False];
48 required int32 port_no = 3 [help_text = "Port ID", null = False, db_index = False, blank = False];
49
50 optional string admin_state = 4 [help_text = "admin_state", null = True, db_index = False, blank = False, feedback_state = True];
51 optional string oper_status = 5 [help_text = "oper_status", null = True, db_index = False, blank = False, feedback_state = True];
52}
53
54message PONPort (PortBase){
Matteo Scandolod8ed60e2018-06-18 17:00:57 -070055 option verbose_name = "OLT PON Port";
56 option description="OLT Side PON Port";
Matteo Scandolo4a8b4d62018-03-06 17:18:46 -080057
Matteo Scandolo6be6ee92018-05-24 15:07:51 -070058 required manytoone olt_device->OLTDevice:pon_ports = 1 [db_index = True, null = False, blank = False];
59 required int32 s_tag = 2 [help_text = "S Tag", null = False, db_index = False, blank = False];
60}
61
62message NNIPort (PortBase) {
63 option verbose_name = "NNI Port";
64 required manytoone olt_device->OLTDevice:nni_ports = 1 [db_index = True, null = False, blank = False];
Andy Bavier03df22b2017-08-30 14:46:02 -070065}
Matteo Scandoloe2cb8a42018-05-18 16:30:06 -070066
67message ONUDevice (XOSBase){
68 option verbose_name = "ONU Device";
69 option description = "Represents a physical ONU device";
70
71 required manytoone pon_port->PONPort:onu_devices = 1 [db_index = True, null = False, blank = False];
72 required string serial_number = 2 [max_length = 254, null = False, db_index = False, blank = False, tosca_key=True, unique = True];
73 required string vendor = 3 [max_length = 254, null = False, db_index = False, blank = False];
74 required string device_type = 4 [help_text = "Device Type", default = "asfvolt16_olt", max_length = 254, null = False, db_index = False, blank = False];
75
76 optional string device_id = 5 [max_length = 254, null = True, db_index = False, blank = False, feedback_state = True];
Matteo Scandoloe3daaa22018-06-19 14:36:31 -070077 optional string admin_state = 6 [choices = "(('DISABLED', 'DISABLED'), ('ENABLED', 'ENABLED'))", default="ENABLED", help_text = "admin_state", null = True, db_index = False, blank = False];
Matteo Scandoloe2cb8a42018-05-18 16:30:06 -070078 optional string oper_status = 7 [help_text = "oper_status", null = True, db_index = False, blank = False, feedback_state = True];
79 optional string connect_status = 8 [help_text = "connect_status", null = True, db_index = False, blank = False, feedback_state = True];
Matteo Scandolo2360fd92018-05-29 17:27:51 -070080}
81
Matteo Scandolod8ed60e2018-06-18 17:00:57 -070082message PONONUPort (PortBase) {
83 option verbose_name = "ONU PON Port";
84 option description="ONU Side PON Port";
85 required manytoone onu_device->ONUDevice:pononu_ports = 1 [db_index = True, null = False, blank = False];
86}
87
88message UNIPort (PortBase) {
89 option verbose_name = "UNI Port";
90 required manytoone onu_device->ONUDevice:uni_ports = 1 [db_index = True, null = False, blank = False];
91}
92
Matteo Scandolo2360fd92018-05-29 17:27:51 -070093message VOLTServiceInstance (ServiceInstance){
94 option kind = "vOLT";
95 option owner_class_name = "VOLTService";
96 option verbose_name = "vOLT Service Instance";
97
98 optional string description = 1 [max_length = 254, null = True, db_index = False, blank = True];
99 optional manytoone onu_device->ONUDevice:volt_service_instances = 1 [db_index = True, null = True, blank = False];
Matteo Scandoloe2cb8a42018-05-18 16:30:06 -0700100}