blob: 603e0592c6605290e0ba9c8e55377766afc2133f [file] [log] [blame]
Matteo Scandoload0c1752018-08-09 15:47:16 -07001option name = "att-workflow-driver";
2option app_label = "att-workflow-driver";
3
4message AttWorkflowDriverService (Service){
5 option verbose_name = "AttWorkflowDriver Service";
Matteo Scandoloea529092018-09-11 16:36:39 -07006 option kind = "control";
Scott Baker776120a2019-01-23 14:59:46 -08007 option description = "Service that manages the AT&T Subscriber workflow";
Matteo Scandoload0c1752018-08-09 15:47:16 -07008}
9
10message AttWorkflowDriverServiceInstance (ServiceInstance){
11 option owner_class_name = "AttWorkflowDriverService";
12 option verbose_name = "AttWorkflowDriver Service Instance";
Scott Baker776120a2019-01-23 14:59:46 -080013 option description = "Workflow settings for a particular ONU Device";
Matteo Scandoload0c1752018-08-09 15:47:16 -070014
Scott Baker776120a2019-01-23 14:59:46 -080015 required string serial_number = 2 [
16 help_text = "Serial number of ONU",
Scott Baker7fc09ed2019-04-09 14:25:00 -070017 max_length = 256,
Scott Baker776120a2019-01-23 14:59:46 -080018 tosca_key=True,
19 unique = True];
20 required string authentication_state = 3 [
21 help_text = "Subscriber authentication state",
22 choices = "(('AWAITING', 'Awaiting'), ('STARTED', 'Started'), ('REQUESTED', 'Requested'), ('APPROVED', 'Approved'), ('DENIED', 'Denied'), )",
23 default = "AWAITING",
Scott Baker776120a2019-01-23 14:59:46 -080024 feedback_state = True,
25 max_length = 50];
26 required string of_dpid = 4 [
27 help_text = "OLT Openflow ID",
Scott Baker7fc09ed2019-04-09 14:25:00 -070028 max_length = 256];
Scott Baker776120a2019-01-23 14:59:46 -080029 required int32 uni_port_id = 5 [
Scott Baker345de302019-03-12 15:35:01 -070030 help_text = "ONU UNI port ID"];
Scott Baker776120a2019-01-23 14:59:46 -080031 required string onu_state = 6 [
32 help_text = "ONU administrative state",
33 choices = "(('AWAITING', 'Awaiting'), ('ENABLED', 'Enabled'), ('DISABLED', 'Disabled'))",
Scott Baker776120a2019-01-23 14:59:46 -080034 default = "AWAITING",
35 feedback_state = True,
Scott Baker7fc09ed2019-04-09 14:25:00 -070036 max_length = 256];
Scott Baker776120a2019-01-23 14:59:46 -080037 optional string status_message = 7 [
38 help_text = "Status text of current state machine state",
Scott Baker776120a2019-01-23 14:59:46 -080039 default = "",
Scott Baker7fc09ed2019-04-09 14:25:00 -070040 max_length = 256];
Scott Baker776120a2019-01-23 14:59:46 -080041 required string dhcp_state = 8 [
Scott Baker7fc09ed2019-04-09 14:25:00 -070042 max_length = 256,
Scott Baker776120a2019-01-23 14:59:46 -080043 default = "AWAITING",
44 choices = "(('AWAITING', 'Awaiting'), ('DHCPDISCOVER', 'DHCPDISCOVER'), ('DHCPACK', 'DHCPACK'), ('DHCPREQUEST', 'DHCPREQUEST'))",
45 feedback_state = True];
46 optional string ip_address = 9 [
47 help_text = "Subcriber IP address, learned from DHCP",
Scott Baker776120a2019-01-23 14:59:46 -080048 feedback_state = True,
49 max_length = 20];
50 optional string mac_address = 10 [
51 help_text = "Subscriber MAC address, leanred from DHCP",
Scott Baker776120a2019-01-23 14:59:46 -080052 feedback_state = True,
53 max_length = 20];
Matteo Scandoload0c1752018-08-09 15:47:16 -070054}
55
56message AttWorkflowDriverWhiteListEntry (XOSBase) {
Matteo Scandolo53da44c2018-08-14 16:04:18 -070057 option verbose_name = "ONU Whitelist";
Matteo Scandoload0c1752018-08-09 15:47:16 -070058 option plural = "attworkflowdriverwhitelistentries";
Scott Baker776120a2019-01-23 14:59:46 -080059 option description = "White list entry that permits an ONU with a particular serial number on a particular OLT and PON";
Matteo Scandoload0c1752018-08-09 15:47:16 -070060
Scott Baker776120a2019-01-23 14:59:46 -080061 required manytoone owner->AttWorkflowDriverService:whitelist_entries = 1:1001 [
62 help_text = "AttWorkflowDriverService that owns this white list entry",
63 db_index = True,
64 tosca_key = True];
65 required string serial_number = 2 [
66 help_text = "ONU Serial Number",
Scott Baker7fc09ed2019-04-09 14:25:00 -070067 max_length = 256,
Scott Baker776120a2019-01-23 14:59:46 -080068 tosca_key = True,
69 unique_with = "owner"];
70 required int32 pon_port_id = 3 [
Scott Baker345de302019-03-12 15:35:01 -070071 help_text = "PON Port on which this ONU is expected to show up"];
Scott Baker776120a2019-01-23 14:59:46 -080072 required string device_id = 4 [
73 help_text = "OLT Device (logical device id) on which this ONU is expected to show up",
Scott Baker776120a2019-01-23 14:59:46 -080074 max_length = 54];
Matteo Scandoload0c1752018-08-09 15:47:16 -070075}