blob: 874e523f49d49ecdc72876b5eaf35832f70bfe05 [file] [log] [blame]
Andy Bavier03df22b2017-08-30 14:46:02 -07001option name = "volt";
Matteo Scandolobfc31332018-03-29 09:06:52 -07002option app_label = "volt";
Andy Bavier03df22b2017-08-30 14:46:02 -07003
4message VOLTService (Service){
Matteo Scandolo43473812018-03-02 10:55:54 -08005 option verbose_name = "vOLT Service";
6 option kind = "vOLT";
Matteo Scandolo4a8b4d62018-03-06 17:18:46 -08007
Luca Preteca974c82018-05-01 18:06:16 -07008 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];
9 required int32 voltha_port = 2 [help_text = "The Voltha API port. By default 8882", default=8882, null = False, db_index = False, blank = False];
10 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];
11 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];
12 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];
13 required int32 onos_voltha_port = 6 [help_text = "The Voltha API port. By default 8181", default=8181, null = False, db_index = False, blank = False];
14 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];
15 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];
16 required string onu_provisioning = 9 [help_text = "If to automatically discover and provision the ONU or not", default = "allow_all", choices = "(('allow_all', 'Allow All'), ('pre_provisioned', 'Pre-provisione'), ('oss', 'OSS'))", null = False, db_index = False, blank = False];
Andy Bavier03df22b2017-08-30 14:46:02 -070017}
18
Matteo Scandolod2458012018-03-01 13:40:36 -080019message VOLTServiceInstance (ServiceInstance){
Matteo Scandolo43473812018-03-02 10:55:54 -080020 option kind = "vOLT";
21 option owner_class_name = "VOLTService";
22 option verbose_name = "vOLT Service Instance";
Andy Bavier03df22b2017-08-30 14:46:02 -070023
Matteo Scandolo4a8b4d62018-03-06 17:18:46 -080024 optional string description = 1 [max_length = 254, null = True, db_index = False, blank = True];
Andy Bavier03df22b2017-08-30 14:46:02 -070025}
26
Matteo Scandolo4a8b4d62018-03-06 17:18:46 -080027message OLTDevice (XOSBase){
28 option verbose_name = "OLT Device";
29 option description="Represents a physical OLT device";
Andy Bavier03df22b2017-08-30 14:46:02 -070030
Matteo Scandolo43473812018-03-02 10:55:54 -080031 required manytoone volt_service->VOLTService:volt_devices = 1 [db_index = True, null = False, blank = False];
Matteo Scandolo2c144932018-05-04 14:06:24 -070032 optional string name = 2 [help_text = "name of device", max_length = 254, null = True, db_index = False, blank = True, unique = True];
Matteo Scandolo33523412018-04-12 15:21:13 -070033 required string device_type = 3 [help_text = "Device Type", default = "asfvolt16_olt", max_length = 254, null = False, db_index = False, blank = False, tosca_key=True];
34 required string host = 4 [help_text = "Host", max_length = 254, null = False, db_index = False, blank = False, tosca_key=True];
35 required int32 port = 5 [help_text = "Fabric port", null = False, db_index = False, blank = False, tosca_key=True];
Matteo Scandolo4a8b4d62018-03-06 17:18:46 -080036
37 optional string device_id = 10 [help_text = "Device ID", null = True, db_index = False, blank = False, feedback_state = True];
38 optional string admin_state = 11 [help_text = "admin_state", null = True, db_index = False, blank = False, feedback_state = True];
39 optional string oper_status = 12 [help_text = "oper_status", null = True, db_index = False, blank = False, feedback_state = True];
40 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 -070041 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 -080042
Matteo Scandolof6337eb2018-04-05 15:58:37 -070043 required string uplink = 15 [default="129", help_text = "uplink port", null = False, db_index = False, blank = False];
Matteo Scandolo19466a02018-05-16 17:43:39 -070044 required string driver = 16 [default="voltha", help_text = "Olt driver", null = True, db_index = False, blank = False];
Matteo Scandolod3c768d2018-04-11 13:38:49 -070045
46 optional string switch_datapath_id = 17 [help_text = "Fabric switch to which the OLT is connected", null = False, db_index = False, blank = False];
47 optional string switch_port = 18 [help_text = "Fabric port to which the OLT is connected", null = False, db_index = False, blank = False];
48 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 -070049}
50
Matteo Scandolo4a8b4d62018-03-06 17:18:46 -080051message ONUDevice (XOSBase){
52 option verbose_name = "ONU Device";
53 option description = "Represents a physical ONU device";
Andy Bavier03df22b2017-08-30 14:46:02 -070054
Matteo Scandolo4a8b4d62018-03-06 17:18:46 -080055 required manytoone volt_device->OLTDevice:onu_devices = 1 [db_index = True, null = False, blank = False];
56 required string serial_number = 1 [max_length = 254, null = False, db_index = False, blank = False];
57}
58
59message PONPort (XOSBase){
60 option verbose_name = "PON Port";
61
Scott Baker01b06212018-04-27 13:23:38 -070062 required string name = 1 [db_index = True, null = False, blank = False, unique_with="olt_device"];
Matteo Scandolob8621cd2018-04-04 17:12:37 -070063 required manytoone olt_device->OLTDevice:ports = 2 [db_index = True, null = False, blank = False];
64 required string port_id = 3 [help_text = "Port ID", max_length = 254, null = False, db_index = False, blank = False];
Matteo Scandolo4a8b4d62018-03-06 17:18:46 -080065 required int32 s_tag = 4 [help_text = "S Tag", null = False, db_index = False, blank = False];
Andy Bavier03df22b2017-08-30 14:46:02 -070066}