Andy Bavier | 03df22b | 2017-08-30 14:46:02 -0700 | [diff] [blame] | 1 | option name = "volt"; |
Matteo Scandolo | bfc3133 | 2018-03-29 09:06:52 -0700 | [diff] [blame] | 2 | option app_label = "volt"; |
Matteo Scandolo | e2cb8a4 | 2018-05-18 16:30:06 -0700 | [diff] [blame] | 3 | option legacy="True"; |
Andy Bavier | 03df22b | 2017-08-30 14:46:02 -0700 | [diff] [blame] | 4 | |
| 5 | message VOLTService (Service){ |
Matteo Scandolo | 4347381 | 2018-03-02 10:55:54 -0800 | [diff] [blame] | 6 | option verbose_name = "vOLT Service"; |
| 7 | option kind = "vOLT"; |
Scott Baker | 2108e75 | 2019-01-17 07:00:32 -0800 | [diff] [blame] | 8 | option description = "OLT Access Service"; |
Matteo Scandolo | 4a8b4d6 | 2018-03-06 17:18:46 -0800 | [diff] [blame] | 9 | |
Matteo Scandolo | d8b4875 | 2018-08-28 16:24:36 -0700 | [diff] [blame] | 10 | 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, db_index = False]; |
| 11 | required int32 voltha_port = 2 [help_text = "The Voltha API port. By default 8882", default=8882, db_index = False]; |
| 12 | required string voltha_user = 3 [help_text = "The Voltha username. By default voltha", default="voltha", max_length = 254, db_index = False]; |
| 13 | required string voltha_pass = 4 [help_text = "The Voltha password. By default admin", default="admin", max_length = 254, db_index = False]; |
| 14 | 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, db_index = False]; |
| 15 | required int32 onos_voltha_port = 6 [help_text = "The Voltha API port. By default 8181", default=8181, db_index = False]; |
| 16 | required string onos_voltha_user = 7 [help_text = "The ONOS Voltha username. By default sdn", max_length = 254, default="onos", db_index = False]; |
| 17 | required string onos_voltha_pass = 8 [help_text = "The ONOS Voltha password. By default rocks", max_length = 254, default="rocks", db_index = False]; |
Andy Bavier | 03df22b | 2017-08-30 14:46:02 -0700 | [diff] [blame] | 18 | } |
| 19 | |
Matteo Scandolo | 4a8b4d6 | 2018-03-06 17:18:46 -0800 | [diff] [blame] | 20 | message OLTDevice (XOSBase){ |
| 21 | option verbose_name = "OLT Device"; |
| 22 | option description="Represents a physical OLT device"; |
Andy Bavier | 03df22b | 2017-08-30 14:46:02 -0700 | [diff] [blame] | 23 | |
Scott Baker | 2108e75 | 2019-01-17 07:00:32 -0800 | [diff] [blame] | 24 | required manytoone volt_service->VOLTService:volt_devices = 1:1001 [help_text = "VOLTService that owns this OLT", db_index = True]; |
| 25 | optional string name = 2 [help_text = "Human-readable name of device", max_length = 254, db_index = False, unique = True]; |
| 26 | required string device_type = 3 [help_text = "Phyiscal Device Type", default = "openolt", max_length = 254, db_index = False]; |
| 27 | optional string host = 4 [help_text = "IP Address of physical OLT Device", max_length = 254, db_index = False]; |
| 28 | optional int32 port = 5 [help_text = "Port Number of physical OLT Device", db_index = False, unique_with = "host"]; |
| 29 | optional string mac_address = 6 [help_text = "Mac address of physical OLT Device", db_index = False]; |
Matteo Scandolo | 4a8b4d6 | 2018-03-06 17:18:46 -0800 | [diff] [blame] | 30 | |
Matteo Scandolo | f140ded | 2018-10-17 15:37:15 -0700 | [diff] [blame] | 31 | optional string serial_number = 9 [help_text = "Serial Number", db_index = False]; |
Scott Baker | 2108e75 | 2019-01-17 07:00:32 -0800 | [diff] [blame] | 32 | optional string device_id = 10 [help_text = "Voltha Device ID", db_index = False, feedback_state = True]; |
Scott Baker | 09798d8 | 2019-01-17 08:34:59 -0800 | [diff] [blame^] | 33 | optional string admin_state = 11 [help_text = "admin state, whether OLT should be enabled", choices = "(('DISABLED', 'DISABLED'), ('ENABLED', 'ENABLED'))", default="ENABLED", db_index = False]; |
Scott Baker | 2108e75 | 2019-01-17 07:00:32 -0800 | [diff] [blame] | 34 | optional string oper_status = 12 [help_text = "operational status, whether OLT is active", db_index = False, feedback_state = True]; |
| 35 | optional string of_id = 13 [help_text = "Logical device openflow id", db_index = False, feedback_state = True]; |
| 36 | optional string dp_id = 14 [help_text = "Logical device datapath id", db_index = False]; |
Matteo Scandolo | 4a8b4d6 | 2018-03-06 17:18:46 -0800 | [diff] [blame] | 37 | |
Scott Baker | 2108e75 | 2019-01-17 07:00:32 -0800 | [diff] [blame] | 38 | required string uplink = 15 [help_text = "uplink port, exposed via sadis", db_index = False]; |
| 39 | required string driver = 16 [help_text = "DEPRECATED", default="voltha", db_index = False]; // Used to be sent to ONOS, now unused. |
Matteo Scandolo | d3c768d | 2018-04-11 13:38:49 -0700 | [diff] [blame] | 40 | |
Matteo Scandolo | d8b4875 | 2018-08-28 16:24:36 -0700 | [diff] [blame] | 41 | optional string switch_datapath_id = 17 [help_text = "Fabric switch to which the OLT is connected", db_index = False]; |
| 42 | optional string switch_port = 18 [help_text = "Fabric port to which the OLT is connected", db_index = False]; |
| 43 | optional string outer_tpid = 19 [help_text = "Outer VLAN id field EtherType", db_index = False]; |
Matteo Scandolo | 610c11d | 2018-08-31 07:33:43 -0700 | [diff] [blame] | 44 | |
| 45 | optional string nas_id = 20 [help_text = "Authentication ID (propagated to the free-radius server via sadis)", db_index = False]; |
Andy Bavier | 03df22b | 2017-08-30 14:46:02 -0700 | [diff] [blame] | 46 | } |
| 47 | |
Matteo Scandolo | 6be6ee9 | 2018-05-24 15:07:51 -0700 | [diff] [blame] | 48 | message PortBase (XOSBase){ |
| 49 | option gui_hidden = True; |
| 50 | |
Scott Baker | 2108e75 | 2019-01-17 07:00:32 -0800 | [diff] [blame] | 51 | required string name = 1 [help_text = "Human-readable name of port", db_index = True]; |
| 52 | required int32 port_no = 3 [help_text = "Port Number", db_index = False]; |
Matteo Scandolo | 6be6ee9 | 2018-05-24 15:07:51 -0700 | [diff] [blame] | 53 | |
Scott Baker | 2108e75 | 2019-01-17 07:00:32 -0800 | [diff] [blame] | 54 | optional string admin_state = 4 [help_text = "admin state, whether port should be enabled", db_index = False, feedback_state = True]; |
| 55 | optional string oper_status = 5 [help_text = "operational status, whether port is active", db_index = False, feedback_state = True]; |
Matteo Scandolo | 6be6ee9 | 2018-05-24 15:07:51 -0700 | [diff] [blame] | 56 | } |
| 57 | |
| 58 | message PONPort (PortBase){ |
Matteo Scandolo | 8091294 | 2018-07-25 20:51:30 -0700 | [diff] [blame] | 59 | option verbose_name = "PON Port"; |
| 60 | option description="PON Port"; |
Matteo Scandolo | 4a8b4d6 | 2018-03-06 17:18:46 -0800 | [diff] [blame] | 61 | |
Scott Baker | 2108e75 | 2019-01-17 07:00:32 -0800 | [diff] [blame] | 62 | required manytoone olt_device->OLTDevice:pon_ports = 1:1001 [help_text = "OLTDevice that owns this PONPort", db_index = True]; |
Matteo Scandolo | 6be6ee9 | 2018-05-24 15:07:51 -0700 | [diff] [blame] | 63 | } |
| 64 | |
| 65 | message NNIPort (PortBase) { |
| 66 | option verbose_name = "NNI Port"; |
Scott Baker | 2108e75 | 2019-01-17 07:00:32 -0800 | [diff] [blame] | 67 | required manytoone olt_device->OLTDevice:nni_ports = 1:1002 [help_text = "OLTDevice that owns this NNIPort", db_index = True]; |
Andy Bavier | 03df22b | 2017-08-30 14:46:02 -0700 | [diff] [blame] | 68 | } |
Matteo Scandolo | e2cb8a4 | 2018-05-18 16:30:06 -0700 | [diff] [blame] | 69 | |
| 70 | message ONUDevice (XOSBase){ |
| 71 | option verbose_name = "ONU Device"; |
| 72 | option description = "Represents a physical ONU device"; |
| 73 | |
Scott Baker | 2108e75 | 2019-01-17 07:00:32 -0800 | [diff] [blame] | 74 | required manytoone pon_port->PONPort:onu_devices = 1:1001 [help_text = "PONPort that connects this ONUDevice to an OLTDevice", db_index = True]; |
| 75 | required string serial_number = 2 [help_text = "Serial number of ONU Device", max_length = 254, db_index = False, tosca_key=True, unique = True]; |
| 76 | required string vendor = 3 [help_text = "Vendor of ONU Device", max_length = 254, db_index = False]; |
Matteo Scandolo | d8b4875 | 2018-08-28 16:24:36 -0700 | [diff] [blame] | 77 | required string device_type = 4 [help_text = "Device Type", default = "asfvolt16_olt", max_length = 254, db_index = False]; |
Matteo Scandolo | e2cb8a4 | 2018-05-18 16:30:06 -0700 | [diff] [blame] | 78 | |
Scott Baker | 2108e75 | 2019-01-17 07:00:32 -0800 | [diff] [blame] | 79 | optional string device_id = 5 [help_text = "Voltha Device ID", max_length = 254, db_index = False, feedback_state = True]; |
| 80 | optional string admin_state = 6 [help_text = "admin state, whether port should be enabled", choices = "(('DISABLED', 'DISABLED'), ('ENABLED', 'ENABLED'))", default="ENABLED", db_index = False]; |
Matteo Scandolo | d8b4875 | 2018-08-28 16:24:36 -0700 | [diff] [blame] | 81 | optional string oper_status = 7 [help_text = "oper_status", db_index = False, feedback_state = True]; |
Scott Baker | 2108e75 | 2019-01-17 07:00:32 -0800 | [diff] [blame] | 82 | optional string connect_status = 8 [help_text = "operational status, whether port is active", db_index = False, feedback_state = True]; |
Scott Baker | 3db0eef | 2019-01-15 11:56:41 -0800 | [diff] [blame] | 83 | optional string reason = 9 [help_text = "ONU device configuration state machine status message", db_index = False, feedback_state = True]; |
Matteo Scandolo | 2360fd9 | 2018-05-29 17:27:51 -0700 | [diff] [blame] | 84 | } |
| 85 | |
Matteo Scandolo | d8ed60e | 2018-06-18 17:00:57 -0700 | [diff] [blame] | 86 | message PONONUPort (PortBase) { |
Matteo Scandolo | 8091294 | 2018-07-25 20:51:30 -0700 | [diff] [blame] | 87 | option verbose_name = "ANI Port"; |
Scott Baker | 2108e75 | 2019-01-17 07:00:32 -0800 | [diff] [blame] | 88 | option description="Access Node Interface Port"; |
| 89 | required manytoone onu_device->ONUDevice:pononu_ports = 1:1001 [help_text = "ONUDevice that owns this PONONUPort", db_index = True]; |
Matteo Scandolo | d8ed60e | 2018-06-18 17:00:57 -0700 | [diff] [blame] | 90 | } |
| 91 | |
| 92 | message UNIPort (PortBase) { |
| 93 | option verbose_name = "UNI Port"; |
Scott Baker | 2108e75 | 2019-01-17 07:00:32 -0800 | [diff] [blame] | 94 | option description = "User Network Interface Port"; |
| 95 | required manytoone onu_device->ONUDevice:uni_ports = 1:1002 [help_text = "ONUDevice that owns this UNIPort", db_index = True]; |
Matteo Scandolo | d8ed60e | 2018-06-18 17:00:57 -0700 | [diff] [blame] | 96 | } |
| 97 | |
Matteo Scandolo | 2360fd9 | 2018-05-29 17:27:51 -0700 | [diff] [blame] | 98 | message VOLTServiceInstance (ServiceInstance){ |
| 99 | option kind = "vOLT"; |
| 100 | option owner_class_name = "VOLTService"; |
| 101 | option verbose_name = "vOLT Service Instance"; |
Scott Baker | 2108e75 | 2019-01-17 07:00:32 -0800 | [diff] [blame] | 102 | option description = "Represents subscriber tenancy in the VOLT Service"; |
Matteo Scandolo | 2360fd9 | 2018-05-29 17:27:51 -0700 | [diff] [blame] | 103 | |
Scott Baker | 2108e75 | 2019-01-17 07:00:32 -0800 | [diff] [blame] | 104 | optional string description = 1 [help_text = "Human-readable description", max_length = 254, db_index = False]; |
| 105 | optional manytoone onu_device->ONUDevice:volt_service_instances = 2:1003 [help_text = "ONUDevice that belongs to this Subscriber chain", db_index = True]; |
Scott Baker | 6ff7a4a | 2018-10-01 12:19:49 -0700 | [diff] [blame] | 106 | } |