blob: 25fbaf1ffb3ce50dc98b89a460584cc825ad6a17 [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";
Scott Baker2108e752019-01-17 07:00:32 -08008 option description = "OLT Access Service";
Matteo Scandolo4a8b4d62018-03-06 17:18:46 -08009
Scott Baker1e043272019-01-24 08:33:15 -080010 required string voltha_url = 1 [
11 help_text = "The Voltha API address. By default voltha.voltha.svc.cluster.local",
Scott Baker1e043272019-01-24 08:33:15 -080012 default = "voltha.voltha.svc.cluster.local",
Scott Bakera108b9c2019-04-09 14:13:44 -070013 max_length = 256];
Scott Baker1e043272019-01-24 08:33:15 -080014 required int32 voltha_port = 2 [
15 help_text = "The Voltha API port. By default 8882",
Scott Baker1e043272019-01-24 08:33:15 -080016 default = 8882];
17 required string voltha_user = 3 [
18 help_text = "The Voltha username. By default voltha",
Scott Baker1e043272019-01-24 08:33:15 -080019 default = "voltha",
Scott Bakera108b9c2019-04-09 14:13:44 -070020 max_length = 256];
Scott Baker1e043272019-01-24 08:33:15 -080021 required string voltha_pass = 4 [
22 help_text = "The Voltha password. By default admin",
Scott Baker1e043272019-01-24 08:33:15 -080023 default = "admin",
Scott Bakera108b9c2019-04-09 14:13:44 -070024 max_length = 256];
Scott Baker1e043272019-01-24 08:33:15 -080025 required string onos_voltha_url = 5 [
26 help_text = "The ONOS Voltha address. By default onos-voltha-ui.voltha.svc.cluster.local",
Scott Baker1e043272019-01-24 08:33:15 -080027 default = "onos-voltha-ui.voltha.svc.cluster.local",
Scott Bakera108b9c2019-04-09 14:13:44 -070028 max_length = 256];
Scott Baker1e043272019-01-24 08:33:15 -080029 required int32 onos_voltha_port = 6 [
30 help_text = "The Voltha API port. By default 8181",
Scott Baker1e043272019-01-24 08:33:15 -080031 default = 8181];
32 required string onos_voltha_user = 7 [
33 help_text = "The ONOS Voltha username. By default sdn",
Scott Bakera108b9c2019-04-09 14:13:44 -070034 max_length = 256,
Scott Baker1e043272019-01-24 08:33:15 -080035 default = "onos"];
36 required string onos_voltha_pass = 8 [
37 help_text = "The ONOS Voltha password. By default rocks",
Scott Bakera108b9c2019-04-09 14:13:44 -070038 max_length = 256,
Scott Baker1e043272019-01-24 08:33:15 -080039 default = "rocks"];
Andy Bavier03df22b2017-08-30 14:46:02 -070040}
41
Matteo Scandolo4a8b4d62018-03-06 17:18:46 -080042message OLTDevice (XOSBase){
43 option verbose_name = "OLT Device";
44 option description="Represents a physical OLT device";
Andy Bavier03df22b2017-08-30 14:46:02 -070045
Scott Baker1e043272019-01-24 08:33:15 -080046 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 Bakera108b9c2019-04-09 14:13:44 -070051 max_length = 256,
Scott Baker1e043272019-01-24 08:33:15 -080052 unique = True];
53 required string device_type = 3 [
54 help_text = "Phyiscal Device Type",
Scott Baker1e043272019-01-24 08:33:15 -080055 default = "openolt",
Scott Bakera108b9c2019-04-09 14:13:44 -070056 max_length = 256];
Scott Baker1e043272019-01-24 08:33:15 -080057 optional string host = 4 [
58 help_text = "IP Address of physical OLT Device",
Scott Bakera108b9c2019-04-09 14:13:44 -070059 max_length = 256];
Scott Baker1e043272019-01-24 08:33:15 -080060 optional int32 port = 5 [
61 help_text = "Port Number of physical OLT Device",
Scott Baker1e043272019-01-24 08:33:15 -080062 unique_with = "host"];
63 optional string mac_address = 6 [
Scott Bakera108b9c2019-04-09 14:13:44 -070064 help_text = "MAC address of physical OLT Device",
65 max_length = 17];
Matteo Scandolo4a8b4d62018-03-06 17:18:46 -080066
Scott Baker1e043272019-01-24 08:33:15 -080067 optional string serial_number = 9 [
Scott Bakera108b9c2019-04-09 14:13:44 -070068 help_text = "Serial Number",
69 max_length = 256];
Scott Baker1e043272019-01-24 08:33:15 -080070 optional string device_id = 10 [
71 help_text = "Voltha Device ID",
Scott Bakera108b9c2019-04-09 14:13:44 -070072 feedback_state = True,
73 max_length = 256];
Scott Baker1e043272019-01-24 08:33:15 -080074 optional string admin_state = 11 [
75 help_text = "admin state, whether OLT should be enabled",
76 choices = "(('DISABLED', 'DISABLED'), ('ENABLED', 'ENABLED'))",
Scott Bakera108b9c2019-04-09 14:13:44 -070077 default = "ENABLED",
78 max_length = 32];
Scott Baker1e043272019-01-24 08:33:15 -080079 optional string oper_status = 12 [
80 help_text = "operational status, whether OLT is active",
Scott Bakera108b9c2019-04-09 14:13:44 -070081 feedback_state = True,
82 max_length = 256];
Scott Baker12687732019-03-19 15:40:57 -070083 optional string link_status = 21 [
84 help_text = "connectivity status, whether OLT has connectivity to agg switch",
85 choices = "(('up', 'up'), ('down', 'down'))",
Scott Bakera108b9c2019-04-09 14:13:44 -070086 feedback_state = True,
87 max_length = 32];
Scott Baker1e043272019-01-24 08:33:15 -080088 optional string of_id = 13 [
89 help_text = "Logical device openflow id",
Scott Bakera108b9c2019-04-09 14:13:44 -070090 feedback_state = True,
91 max_length = 256];
Scott Baker1e043272019-01-24 08:33:15 -080092 optional string dp_id = 14 [
Scott Bakera108b9c2019-04-09 14:13:44 -070093 help_text = "Logical device datapath id",
94 max_length = 256];
Matteo Scandolo4a8b4d62018-03-06 17:18:46 -080095
Scott Baker1e043272019-01-24 08:33:15 -080096 required string uplink = 15 [
Scott Bakera108b9c2019-04-09 14:13:44 -070097 help_text = "uplink port, exposed via sadis",
98 max_length = 256];
Scott Baker1e043272019-01-24 08:33:15 -080099 required string driver = 16 [
100 help_text = "DEPRECATED",
Scott Bakera108b9c2019-04-09 14:13:44 -0700101 default = "voltha",
102 max_length = 32]; // Used to be sent to ONOS, now unused.
Matteo Scandolod3c768d2018-04-11 13:38:49 -0700103
Scott Baker1e043272019-01-24 08:33:15 -0800104 optional string switch_datapath_id = 17 [
Scott Bakera108b9c2019-04-09 14:13:44 -0700105 help_text = "Fabric switch to which the OLT is connected",
106 max_length = 256];
Scott Baker1e043272019-01-24 08:33:15 -0800107 optional string switch_port = 18 [
Scott Bakera108b9c2019-04-09 14:13:44 -0700108 help_text = "Fabric port to which the OLT is connected",
109 max_length = 256];
Scott Baker1e043272019-01-24 08:33:15 -0800110 optional string outer_tpid = 19 [
Scott Bakera108b9c2019-04-09 14:13:44 -0700111 help_text = "Outer VLAN id field EtherType",
112 max_length = 256];
Matteo Scandolo610c11d2018-08-31 07:33:43 -0700113
Scott Baker1e043272019-01-24 08:33:15 -0800114 optional string nas_id = 20 [
Scott Bakera108b9c2019-04-09 14:13:44 -0700115 help_text = "Authentication ID (propagated to the free-radius server via sadis)",
116 max_length = 256];
Andy Bavier03df22b2017-08-30 14:46:02 -0700117}
118
Matteo Scandolo6be6ee92018-05-24 15:07:51 -0700119message PortBase (XOSBase){
120 option gui_hidden = True;
Scott Baker1e043272019-01-24 08:33:15 -0800121 option description = "Base class for Port objects";
Matteo Scandolo6be6ee92018-05-24 15:07:51 -0700122
Scott Baker1e043272019-01-24 08:33:15 -0800123 required string name = 1 [
124 help_text = "Human-readable name of port",
Scott Bakera108b9c2019-04-09 14:13:44 -0700125 db_index = True,
126 max_length = 256];
Scott Baker1e043272019-01-24 08:33:15 -0800127 required int32 port_no = 3 [
Scott Baker3f4816f2019-03-12 15:06:01 -0700128 help_text = "Port Number"];
Matteo Scandolo6be6ee92018-05-24 15:07:51 -0700129
Scott Baker1e043272019-01-24 08:33:15 -0800130 optional string admin_state = 4 [
131 help_text = "admin state, whether port should be enabled",
Scott Bakera108b9c2019-04-09 14:13:44 -0700132 // TODO: Should specify "choices"
133 feedback_state = True,
134 max_length = 32];
Scott Baker1e043272019-01-24 08:33:15 -0800135 optional string oper_status = 5 [
136 help_text = "operational status, whether port is active",
Scott Bakera108b9c2019-04-09 14:13:44 -0700137 // TODO: Should specify "choices"
138 feedback_state = True,
139 max_length = 32];
Matteo Scandolo6be6ee92018-05-24 15:07:51 -0700140}
141
142message PONPort (PortBase){
Matteo Scandolo80912942018-07-25 20:51:30 -0700143 option verbose_name = "PON Port";
Scott Baker1e043272019-01-24 08:33:15 -0800144 option description = "PON Port";
Matteo Scandolo4a8b4d62018-03-06 17:18:46 -0800145
Scott Baker1e043272019-01-24 08:33:15 -0800146 required manytoone olt_device->OLTDevice:pon_ports = 1:1001 [
147 help_text = "OLTDevice that owns this PONPort",
148 db_index = True];
Matteo Scandolo6be6ee92018-05-24 15:07:51 -0700149}
150
151message NNIPort (PortBase) {
152 option verbose_name = "NNI Port";
Scott Baker1e043272019-01-24 08:33:15 -0800153 option description = "NNI Port";
154
155 required manytoone olt_device->OLTDevice:nni_ports = 1:1002 [
156 help_text = "OLTDevice that owns this NNIPort",
157 db_index = True];
Andy Bavier03df22b2017-08-30 14:46:02 -0700158}
Matteo Scandoloe2cb8a42018-05-18 16:30:06 -0700159
160message ONUDevice (XOSBase){
161 option verbose_name = "ONU Device";
162 option description = "Represents a physical ONU device";
163
Scott Baker1e043272019-01-24 08:33:15 -0800164 required manytoone pon_port->PONPort:onu_devices = 1:1001 [
165 help_text = "PONPort that connects this ONUDevice to an OLTDevice",
166 db_index = True];
167 required string serial_number = 2 [
168 help_text = "Serial number of ONU Device",
Scott Bakera108b9c2019-04-09 14:13:44 -0700169 max_length = 256,
Scott Baker1e043272019-01-24 08:33:15 -0800170 tosca_key=True,
171 unique = True];
172 required string vendor = 3 [
173 help_text = "Vendor of ONU Device",
Scott Bakera108b9c2019-04-09 14:13:44 -0700174 max_length = 256];
Scott Baker1e043272019-01-24 08:33:15 -0800175 required string device_type = 4 [
176 help_text = "Device Type",
Scott Baker1e043272019-01-24 08:33:15 -0800177 default = "asfvolt16_olt",
Scott Bakera108b9c2019-04-09 14:13:44 -0700178 max_length = 256];
Matteo Scandoloe2cb8a42018-05-18 16:30:06 -0700179
Scott Baker1e043272019-01-24 08:33:15 -0800180 optional string device_id = 5 [
181 help_text = "Voltha Device ID",
Scott Baker1e043272019-01-24 08:33:15 -0800182 feedback_state = True,
Scott Bakera108b9c2019-04-09 14:13:44 -0700183 max_length = 256];
Scott Baker1e043272019-01-24 08:33:15 -0800184 optional string admin_state = 6 [
185 help_text = "admin state, whether port should be enabled",
Andy Baviercd940192019-05-15 12:59:35 -0700186 choices = "(('DISABLED', 'DISABLED'), ('ENABLED', 'ENABLED'), ('ADMIN_DISABLED', 'ADMIN_DISABLED'))",
Scott Bakera108b9c2019-04-09 14:13:44 -0700187 default = "ENABLED",
188 max_length = 32];
Scott Baker1e043272019-01-24 08:33:15 -0800189 optional string oper_status = 7 [
190 help_text = "oper_status",
Scott Bakera108b9c2019-04-09 14:13:44 -0700191 // TODO: Should add "choices"
192 feedback_state = True,
193 max_length = 32];
Scott Baker1e043272019-01-24 08:33:15 -0800194 optional string connect_status = 8 [
195 help_text = "operational status, whether port is active",
Scott Bakera108b9c2019-04-09 14:13:44 -0700196 feedback_state = True,
197 max_length = 32];
Scott Baker1e043272019-01-24 08:33:15 -0800198 optional string reason = 9 [
199 help_text = "ONU device configuration state machine status message",
Scott Bakera108b9c2019-04-09 14:13:44 -0700200 feedback_state = True,
201 text = True];
Matteo Scandolo2360fd92018-05-29 17:27:51 -0700202}
203
Matteo Scandolod8ed60e2018-06-18 17:00:57 -0700204message PONONUPort (PortBase) {
Matteo Scandolo80912942018-07-25 20:51:30 -0700205 option verbose_name = "ANI Port";
Scott Baker2108e752019-01-17 07:00:32 -0800206 option description="Access Node Interface Port";
Scott Baker1e043272019-01-24 08:33:15 -0800207 required manytoone onu_device->ONUDevice:pononu_ports = 1:1001 [
208 help_text = "ONUDevice that owns this PONONUPort",
209 db_index = True];
Matteo Scandolod8ed60e2018-06-18 17:00:57 -0700210}
211
212message UNIPort (PortBase) {
213 option verbose_name = "UNI Port";
Scott Baker2108e752019-01-17 07:00:32 -0800214 option description = "User Network Interface Port";
Scott Baker1e043272019-01-24 08:33:15 -0800215 required manytoone onu_device->ONUDevice:uni_ports = 1:1002 [
216 help_text = "ONUDevice that owns this UNIPort",
217 db_index = True];
Matteo Scandolod8ed60e2018-06-18 17:00:57 -0700218}
219
Matteo Scandolo2360fd92018-05-29 17:27:51 -0700220message VOLTServiceInstance (ServiceInstance){
221 option kind = "vOLT";
222 option owner_class_name = "VOLTService";
223 option verbose_name = "vOLT Service Instance";
Scott Baker2108e752019-01-17 07:00:32 -0800224 option description = "Represents subscriber tenancy in the VOLT Service";
Matteo Scandolo2360fd92018-05-29 17:27:51 -0700225
Scott Baker1e043272019-01-24 08:33:15 -0800226 optional string description = 1 [
227 help_text = "Human-readable description",
Scott Bakera108b9c2019-04-09 14:13:44 -0700228 text = True];
Scott Baker1e043272019-01-24 08:33:15 -0800229 optional manytoone onu_device->ONUDevice:volt_service_instances = 2:1003 [
230 help_text = "ONUDevice that belongs to this Subscriber chain",
231 db_index = True];
Scott Baker6ff7a4a2018-10-01 12:19:49 -0700232}
Hardik Windlassda0d6c42019-05-13 16:00:01 +0000233
234message TechnologyProfile (XOSBase) {
235 option verbose_name = "Technology Profile";
236 option description = "The Technology Profile that is utilized by VOLTHA";
237
238 required string technology = 1 [
239 help_text = "The technology being utilized by the adaptor",
240 db_index = True,
241 max_length = 16];
242 required int32 profile_id = 2 [
243 help_text = "The numeric id of the profile",
244 db_index = True,
245 min_value = 64,
246 max_value = 255];
247 required string profile_value = 3 [
248 help_text = "The technology profile value in JSON format",
249 max_length = 4096];
250}