blob: 205258860b6815075fd8db56cbd8ddbf77937f0b [file] [log] [blame]
Andy Bavier561f3e52019-03-15 10:46:05 -07001option name = "tt-workflow-driver";
2option app_label = "tt-workflow-driver";
3
4message TtWorkflowDriverService (Service){
5 option verbose_name = "TtWorkflowDriver Service";
6 option kind = "control";
7 option description = "Service that manages the Turk Telekom Subscriber workflow";
8}
9
10message TtWorkflowDriverServiceInstance (ServiceInstance){
11 option owner_class_name = "TtWorkflowDriverService";
12 option verbose_name = "TtWorkflowDriver Service Instance";
13 option description = "Workflow settings for a particular ONU Device";
14
15 required string serial_number = 2 [
16 help_text = "Serial number of ONU",
Scott Baker3ff47002019-04-10 10:29:37 -070017 max_length = 256,
Andy Bavier561f3e52019-03-15 10:46:05 -070018 tosca_key=True,
19 unique = True];
20 required string of_dpid = 4 [
21 help_text = "OLT Openflow ID",
Scott Baker3ff47002019-04-10 10:29:37 -070022 max_length = 256];
Andy Bavier561f3e52019-03-15 10:46:05 -070023 required int32 uni_port_id = 5 [
24 help_text = "ONU UNI port ID"];
Andy Bavier0ce0dae2019-05-10 17:46:02 -070025 required string admin_onu_state = 6 [
Andy Bavier561f3e52019-03-15 10:46:05 -070026 help_text = "ONU administrative state",
27 choices = "(('AWAITING', 'Awaiting'), ('ENABLED', 'Enabled'), ('DISABLED', 'Disabled'))",
28 default = "AWAITING",
29 feedback_state = True,
Scott Baker3ff47002019-04-10 10:29:37 -070030 max_length = 256];
Andy Bavier561f3e52019-03-15 10:46:05 -070031 optional string status_message = 7 [
32 help_text = "Status text of current state machine state",
33 default = "",
Scott Baker3ff47002019-04-10 10:29:37 -070034 max_length = 256];
Andy Bavier561f3e52019-03-15 10:46:05 -070035 required string dhcp_state = 8 [
Scott Baker3ff47002019-04-10 10:29:37 -070036 max_length = 256,
Andy Bavier561f3e52019-03-15 10:46:05 -070037 default = "AWAITING",
38 choices = "(('AWAITING', 'Awaiting'), ('DHCPDISCOVER', 'DHCPDISCOVER'), ('DHCPACK', 'DHCPACK'), ('DHCPREQUEST', 'DHCPREQUEST'))",
39 feedback_state = True];
40 optional string ip_address = 9 [
41 help_text = "Management IP address, learned from DHCP",
42 feedback_state = True,
43 max_length = 20];
44 optional string mac_address = 10 [
45 help_text = "Management MAC address, leanred from DHCP",
46 feedback_state = True,
47 max_length = 20];
Andy Bavier0ce0dae2019-05-10 17:46:02 -070048 required string oper_onu_status = 11 [
49 help_text = "ONU operational state",
50 choices = "(('AWAITING', 'Awaiting'), ('ENABLED', 'Enabled'), ('DISABLED', 'Disabled'))",
51 default = "AWAITING",
52 feedback_state = True,
53 max_length = 256];
Andy Bavier561f3e52019-03-15 10:46:05 -070054}
55
56message TtWorkflowDriverWhiteListEntry (XOSBase) {
57 option verbose_name = "ONU Whitelist";
58 option plural = "ttworkflowdriverwhitelistentries";
59 option description = "White list entry that permits an ONU with a particular serial number on a particular OLT and PON";
60
61 required manytoone owner->TtWorkflowDriverService:whitelist_entries = 1:1001 [
62 help_text = "TtWorkflowDriverService 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 Baker3ff47002019-04-10 10:29:37 -070067 max_length = 256,
Andy Bavier561f3e52019-03-15 10:46:05 -070068 tosca_key = True,
69 unique_with = "owner"];
70 required int32 pon_port_id = 3 [
71 help_text = "PON Port on which this ONU is expected to show up"];
72 required string device_id = 4 [
73 help_text = "OLT Device (logical device id) on which this ONU is expected to show up",
74 max_length = 54];
75}