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 | |
Scott Baker | 1e04327 | 2019-01-24 08:33:15 -0800 | [diff] [blame] | 10 | required string voltha_url = 1 [ |
| 11 | help_text = "The Voltha API address. By default voltha.voltha.svc.cluster.local", |
Scott Baker | 1e04327 | 2019-01-24 08:33:15 -0800 | [diff] [blame] | 12 | default = "voltha.voltha.svc.cluster.local", |
| 13 | max_length = 254]; |
| 14 | required int32 voltha_port = 2 [ |
| 15 | help_text = "The Voltha API port. By default 8882", |
Scott Baker | 1e04327 | 2019-01-24 08:33:15 -0800 | [diff] [blame] | 16 | default = 8882]; |
| 17 | required string voltha_user = 3 [ |
| 18 | help_text = "The Voltha username. By default voltha", |
Scott Baker | 1e04327 | 2019-01-24 08:33:15 -0800 | [diff] [blame] | 19 | default = "voltha", |
| 20 | max_length = 254]; |
| 21 | required string voltha_pass = 4 [ |
| 22 | help_text = "The Voltha password. By default admin", |
Scott Baker | 1e04327 | 2019-01-24 08:33:15 -0800 | [diff] [blame] | 23 | default = "admin", |
| 24 | max_length = 254]; |
| 25 | required string onos_voltha_url = 5 [ |
| 26 | help_text = "The ONOS Voltha address. By default onos-voltha-ui.voltha.svc.cluster.local", |
Scott Baker | 1e04327 | 2019-01-24 08:33:15 -0800 | [diff] [blame] | 27 | default = "onos-voltha-ui.voltha.svc.cluster.local", |
| 28 | max_length = 254]; |
| 29 | required int32 onos_voltha_port = 6 [ |
| 30 | help_text = "The Voltha API port. By default 8181", |
Scott Baker | 1e04327 | 2019-01-24 08:33:15 -0800 | [diff] [blame] | 31 | default = 8181]; |
| 32 | required string onos_voltha_user = 7 [ |
| 33 | help_text = "The ONOS Voltha username. By default sdn", |
| 34 | max_length = 254, |
Scott Baker | 1e04327 | 2019-01-24 08:33:15 -0800 | [diff] [blame] | 35 | default = "onos"]; |
| 36 | required string onos_voltha_pass = 8 [ |
| 37 | help_text = "The ONOS Voltha password. By default rocks", |
| 38 | max_length = 254, |
Scott Baker | 1e04327 | 2019-01-24 08:33:15 -0800 | [diff] [blame] | 39 | default = "rocks"]; |
Andy Bavier | 03df22b | 2017-08-30 14:46:02 -0700 | [diff] [blame] | 40 | } |
| 41 | |
Matteo Scandolo | 4a8b4d6 | 2018-03-06 17:18:46 -0800 | [diff] [blame] | 42 | message OLTDevice (XOSBase){ |
| 43 | option verbose_name = "OLT Device"; |
| 44 | option description="Represents a physical OLT device"; |
Andy Bavier | 03df22b | 2017-08-30 14:46:02 -0700 | [diff] [blame] | 45 | |
Scott Baker | 1e04327 | 2019-01-24 08:33:15 -0800 | [diff] [blame] | 46 | required manytoone volt_service->VOLTService:volt_devices = 1:1001 [ |
| 47 | help_text = "VOLTService that owns this OLT", |
| 48 | db_index = True]; |
| 49 | optional string name = 2 [ |
| 50 | help_text = "Human-readable name of device", |
Scott Baker | 1e04327 | 2019-01-24 08:33:15 -0800 | [diff] [blame] | 51 | max_length = 254, |
| 52 | unique = True]; |
| 53 | required string device_type = 3 [ |
| 54 | help_text = "Phyiscal Device Type", |
Scott Baker | 1e04327 | 2019-01-24 08:33:15 -0800 | [diff] [blame] | 55 | default = "openolt", |
| 56 | max_length = 254]; |
| 57 | optional string host = 4 [ |
| 58 | help_text = "IP Address of physical OLT Device", |
Scott Baker | 1e04327 | 2019-01-24 08:33:15 -0800 | [diff] [blame] | 59 | max_length = 254]; |
| 60 | optional int32 port = 5 [ |
| 61 | help_text = "Port Number of physical OLT Device", |
Scott Baker | 1e04327 | 2019-01-24 08:33:15 -0800 | [diff] [blame] | 62 | unique_with = "host"]; |
| 63 | optional string mac_address = 6 [ |
Scott Baker | 3f4816f | 2019-03-12 15:06:01 -0700 | [diff] [blame] | 64 | help_text = "Mac address of physical OLT Device"]; |
Matteo Scandolo | 4a8b4d6 | 2018-03-06 17:18:46 -0800 | [diff] [blame] | 65 | |
Scott Baker | 1e04327 | 2019-01-24 08:33:15 -0800 | [diff] [blame] | 66 | optional string serial_number = 9 [ |
Scott Baker | 3f4816f | 2019-03-12 15:06:01 -0700 | [diff] [blame] | 67 | help_text = "Serial Number"]; |
Scott Baker | 1e04327 | 2019-01-24 08:33:15 -0800 | [diff] [blame] | 68 | optional string device_id = 10 [ |
| 69 | help_text = "Voltha Device ID", |
Scott Baker | 1e04327 | 2019-01-24 08:33:15 -0800 | [diff] [blame] | 70 | feedback_state = True]; |
| 71 | optional string admin_state = 11 [ |
| 72 | help_text = "admin state, whether OLT should be enabled", |
| 73 | choices = "(('DISABLED', 'DISABLED'), ('ENABLED', 'ENABLED'))", |
Scott Baker | 1e04327 | 2019-01-24 08:33:15 -0800 | [diff] [blame] | 74 | default = "ENABLED"]; |
| 75 | optional string oper_status = 12 [ |
| 76 | help_text = "operational status, whether OLT is active", |
Scott Baker | 1e04327 | 2019-01-24 08:33:15 -0800 | [diff] [blame] | 77 | feedback_state = True]; |
Scott Baker | 1268773 | 2019-03-19 15:40:57 -0700 | [diff] [blame^] | 78 | optional string link_status = 21 [ |
| 79 | help_text = "connectivity status, whether OLT has connectivity to agg switch", |
| 80 | choices = "(('up', 'up'), ('down', 'down'))", |
| 81 | feedback_state = True]; |
Scott Baker | 1e04327 | 2019-01-24 08:33:15 -0800 | [diff] [blame] | 82 | optional string of_id = 13 [ |
| 83 | help_text = "Logical device openflow id", |
Scott Baker | 1e04327 | 2019-01-24 08:33:15 -0800 | [diff] [blame] | 84 | feedback_state = True]; |
| 85 | optional string dp_id = 14 [ |
Scott Baker | 3f4816f | 2019-03-12 15:06:01 -0700 | [diff] [blame] | 86 | help_text = "Logical device datapath id"]; |
Matteo Scandolo | 4a8b4d6 | 2018-03-06 17:18:46 -0800 | [diff] [blame] | 87 | |
Scott Baker | 1e04327 | 2019-01-24 08:33:15 -0800 | [diff] [blame] | 88 | required string uplink = 15 [ |
Scott Baker | 3f4816f | 2019-03-12 15:06:01 -0700 | [diff] [blame] | 89 | help_text = "uplink port, exposed via sadis"]; |
Scott Baker | 1e04327 | 2019-01-24 08:33:15 -0800 | [diff] [blame] | 90 | required string driver = 16 [ |
| 91 | help_text = "DEPRECATED", |
Scott Baker | 1e04327 | 2019-01-24 08:33:15 -0800 | [diff] [blame] | 92 | default = "voltha"]; // Used to be sent to ONOS, now unused. |
Matteo Scandolo | d3c768d | 2018-04-11 13:38:49 -0700 | [diff] [blame] | 93 | |
Scott Baker | 1e04327 | 2019-01-24 08:33:15 -0800 | [diff] [blame] | 94 | optional string switch_datapath_id = 17 [ |
Scott Baker | 3f4816f | 2019-03-12 15:06:01 -0700 | [diff] [blame] | 95 | help_text = "Fabric switch to which the OLT is connected"]; |
Scott Baker | 1e04327 | 2019-01-24 08:33:15 -0800 | [diff] [blame] | 96 | optional string switch_port = 18 [ |
Scott Baker | 3f4816f | 2019-03-12 15:06:01 -0700 | [diff] [blame] | 97 | help_text = "Fabric port to which the OLT is connected"]; |
Scott Baker | 1e04327 | 2019-01-24 08:33:15 -0800 | [diff] [blame] | 98 | optional string outer_tpid = 19 [ |
Scott Baker | 3f4816f | 2019-03-12 15:06:01 -0700 | [diff] [blame] | 99 | help_text = "Outer VLAN id field EtherType"]; |
Matteo Scandolo | 610c11d | 2018-08-31 07:33:43 -0700 | [diff] [blame] | 100 | |
Scott Baker | 1e04327 | 2019-01-24 08:33:15 -0800 | [diff] [blame] | 101 | optional string nas_id = 20 [ |
Scott Baker | 3f4816f | 2019-03-12 15:06:01 -0700 | [diff] [blame] | 102 | help_text = "Authentication ID (propagated to the free-radius server via sadis)"]; |
Andy Bavier | 03df22b | 2017-08-30 14:46:02 -0700 | [diff] [blame] | 103 | } |
| 104 | |
Matteo Scandolo | 6be6ee9 | 2018-05-24 15:07:51 -0700 | [diff] [blame] | 105 | message PortBase (XOSBase){ |
| 106 | option gui_hidden = True; |
Scott Baker | 1e04327 | 2019-01-24 08:33:15 -0800 | [diff] [blame] | 107 | option description = "Base class for Port objects"; |
Matteo Scandolo | 6be6ee9 | 2018-05-24 15:07:51 -0700 | [diff] [blame] | 108 | |
Scott Baker | 1e04327 | 2019-01-24 08:33:15 -0800 | [diff] [blame] | 109 | required string name = 1 [ |
| 110 | help_text = "Human-readable name of port", |
| 111 | db_index = True]; |
| 112 | required int32 port_no = 3 [ |
Scott Baker | 3f4816f | 2019-03-12 15:06:01 -0700 | [diff] [blame] | 113 | help_text = "Port Number"]; |
Matteo Scandolo | 6be6ee9 | 2018-05-24 15:07:51 -0700 | [diff] [blame] | 114 | |
Scott Baker | 1e04327 | 2019-01-24 08:33:15 -0800 | [diff] [blame] | 115 | optional string admin_state = 4 [ |
| 116 | help_text = "admin state, whether port should be enabled", |
Scott Baker | 1e04327 | 2019-01-24 08:33:15 -0800 | [diff] [blame] | 117 | feedback_state = True]; |
| 118 | optional string oper_status = 5 [ |
| 119 | help_text = "operational status, whether port is active", |
Scott Baker | 1e04327 | 2019-01-24 08:33:15 -0800 | [diff] [blame] | 120 | feedback_state = True]; |
Matteo Scandolo | 6be6ee9 | 2018-05-24 15:07:51 -0700 | [diff] [blame] | 121 | } |
| 122 | |
| 123 | message PONPort (PortBase){ |
Matteo Scandolo | 8091294 | 2018-07-25 20:51:30 -0700 | [diff] [blame] | 124 | option verbose_name = "PON Port"; |
Scott Baker | 1e04327 | 2019-01-24 08:33:15 -0800 | [diff] [blame] | 125 | option description = "PON Port"; |
Matteo Scandolo | 4a8b4d6 | 2018-03-06 17:18:46 -0800 | [diff] [blame] | 126 | |
Scott Baker | 1e04327 | 2019-01-24 08:33:15 -0800 | [diff] [blame] | 127 | required manytoone olt_device->OLTDevice:pon_ports = 1:1001 [ |
| 128 | help_text = "OLTDevice that owns this PONPort", |
| 129 | db_index = True]; |
Matteo Scandolo | 6be6ee9 | 2018-05-24 15:07:51 -0700 | [diff] [blame] | 130 | } |
| 131 | |
| 132 | message NNIPort (PortBase) { |
| 133 | option verbose_name = "NNI Port"; |
Scott Baker | 1e04327 | 2019-01-24 08:33:15 -0800 | [diff] [blame] | 134 | option description = "NNI Port"; |
| 135 | |
| 136 | required manytoone olt_device->OLTDevice:nni_ports = 1:1002 [ |
| 137 | help_text = "OLTDevice that owns this NNIPort", |
| 138 | db_index = True]; |
Andy Bavier | 03df22b | 2017-08-30 14:46:02 -0700 | [diff] [blame] | 139 | } |
Matteo Scandolo | e2cb8a4 | 2018-05-18 16:30:06 -0700 | [diff] [blame] | 140 | |
| 141 | message ONUDevice (XOSBase){ |
| 142 | option verbose_name = "ONU Device"; |
| 143 | option description = "Represents a physical ONU device"; |
| 144 | |
Scott Baker | 1e04327 | 2019-01-24 08:33:15 -0800 | [diff] [blame] | 145 | required manytoone pon_port->PONPort:onu_devices = 1:1001 [ |
| 146 | help_text = "PONPort that connects this ONUDevice to an OLTDevice", |
| 147 | db_index = True]; |
| 148 | required string serial_number = 2 [ |
| 149 | help_text = "Serial number of ONU Device", |
Scott Baker | 1e04327 | 2019-01-24 08:33:15 -0800 | [diff] [blame] | 150 | max_length = 254, |
| 151 | tosca_key=True, |
| 152 | unique = True]; |
| 153 | required string vendor = 3 [ |
| 154 | help_text = "Vendor of ONU Device", |
Scott Baker | 1e04327 | 2019-01-24 08:33:15 -0800 | [diff] [blame] | 155 | max_length = 254]; |
| 156 | required string device_type = 4 [ |
| 157 | help_text = "Device Type", |
Scott Baker | 1e04327 | 2019-01-24 08:33:15 -0800 | [diff] [blame] | 158 | default = "asfvolt16_olt", |
| 159 | max_length = 254]; |
Matteo Scandolo | e2cb8a4 | 2018-05-18 16:30:06 -0700 | [diff] [blame] | 160 | |
Scott Baker | 1e04327 | 2019-01-24 08:33:15 -0800 | [diff] [blame] | 161 | optional string device_id = 5 [ |
| 162 | help_text = "Voltha Device ID", |
Scott Baker | 1e04327 | 2019-01-24 08:33:15 -0800 | [diff] [blame] | 163 | feedback_state = True, |
| 164 | max_length = 254]; |
| 165 | optional string admin_state = 6 [ |
| 166 | help_text = "admin state, whether port should be enabled", |
| 167 | choices = "(('DISABLED', 'DISABLED'), ('ENABLED', 'ENABLED'))", |
Scott Baker | 1e04327 | 2019-01-24 08:33:15 -0800 | [diff] [blame] | 168 | default = "ENABLED"]; |
| 169 | optional string oper_status = 7 [ |
| 170 | help_text = "oper_status", |
Scott Baker | 1e04327 | 2019-01-24 08:33:15 -0800 | [diff] [blame] | 171 | feedback_state = True]; |
| 172 | optional string connect_status = 8 [ |
| 173 | help_text = "operational status, whether port is active", |
Scott Baker | 1e04327 | 2019-01-24 08:33:15 -0800 | [diff] [blame] | 174 | feedback_state = True]; |
| 175 | optional string reason = 9 [ |
| 176 | help_text = "ONU device configuration state machine status message", |
Scott Baker | 1e04327 | 2019-01-24 08:33:15 -0800 | [diff] [blame] | 177 | feedback_state = True]; |
Matteo Scandolo | 2360fd9 | 2018-05-29 17:27:51 -0700 | [diff] [blame] | 178 | } |
| 179 | |
Matteo Scandolo | d8ed60e | 2018-06-18 17:00:57 -0700 | [diff] [blame] | 180 | message PONONUPort (PortBase) { |
Matteo Scandolo | 8091294 | 2018-07-25 20:51:30 -0700 | [diff] [blame] | 181 | option verbose_name = "ANI Port"; |
Scott Baker | 2108e75 | 2019-01-17 07:00:32 -0800 | [diff] [blame] | 182 | option description="Access Node Interface Port"; |
Scott Baker | 1e04327 | 2019-01-24 08:33:15 -0800 | [diff] [blame] | 183 | required manytoone onu_device->ONUDevice:pononu_ports = 1:1001 [ |
| 184 | help_text = "ONUDevice that owns this PONONUPort", |
| 185 | db_index = True]; |
Matteo Scandolo | d8ed60e | 2018-06-18 17:00:57 -0700 | [diff] [blame] | 186 | } |
| 187 | |
| 188 | message UNIPort (PortBase) { |
| 189 | option verbose_name = "UNI Port"; |
Scott Baker | 2108e75 | 2019-01-17 07:00:32 -0800 | [diff] [blame] | 190 | option description = "User Network Interface Port"; |
Scott Baker | 1e04327 | 2019-01-24 08:33:15 -0800 | [diff] [blame] | 191 | required manytoone onu_device->ONUDevice:uni_ports = 1:1002 [ |
| 192 | help_text = "ONUDevice that owns this UNIPort", |
| 193 | db_index = True]; |
Matteo Scandolo | d8ed60e | 2018-06-18 17:00:57 -0700 | [diff] [blame] | 194 | } |
| 195 | |
Matteo Scandolo | 2360fd9 | 2018-05-29 17:27:51 -0700 | [diff] [blame] | 196 | message VOLTServiceInstance (ServiceInstance){ |
| 197 | option kind = "vOLT"; |
| 198 | option owner_class_name = "VOLTService"; |
| 199 | option verbose_name = "vOLT Service Instance"; |
Scott Baker | 2108e75 | 2019-01-17 07:00:32 -0800 | [diff] [blame] | 200 | option description = "Represents subscriber tenancy in the VOLT Service"; |
Matteo Scandolo | 2360fd9 | 2018-05-29 17:27:51 -0700 | [diff] [blame] | 201 | |
Scott Baker | 1e04327 | 2019-01-24 08:33:15 -0800 | [diff] [blame] | 202 | optional string description = 1 [ |
| 203 | help_text = "Human-readable description", |
Scott Baker | 1e04327 | 2019-01-24 08:33:15 -0800 | [diff] [blame] | 204 | max_length = 254]; |
| 205 | optional manytoone onu_device->ONUDevice:volt_service_instances = 2:1003 [ |
| 206 | help_text = "ONUDevice that belongs to this Subscriber chain", |
| 207 | db_index = True]; |
Scott Baker | 6ff7a4a | 2018-10-01 12:19:49 -0700 | [diff] [blame] | 208 | } |