blob: 2b6c88972b4427d57fee4068330e2d38c42a4631 [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",
17 max_length = 254,
18 tosca_key=True,
19 unique = True];
20 required string of_dpid = 4 [
21 help_text = "OLT Openflow ID",
22 max_length = 254];
23 required int32 uni_port_id = 5 [
24 help_text = "ONU UNI port ID"];
25 required string onu_state = 6 [
26 help_text = "ONU administrative state",
27 choices = "(('AWAITING', 'Awaiting'), ('ENABLED', 'Enabled'), ('DISABLED', 'Disabled'))",
28 default = "AWAITING",
29 feedback_state = True,
30 max_length = 254];
31 optional string status_message = 7 [
32 help_text = "Status text of current state machine state",
33 default = "",
34 max_length = 254];
35 required string dhcp_state = 8 [
36 max_length = 254,
37 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];
48}
49
50message TtWorkflowDriverWhiteListEntry (XOSBase) {
51 option verbose_name = "ONU Whitelist";
52 option plural = "ttworkflowdriverwhitelistentries";
53 option description = "White list entry that permits an ONU with a particular serial number on a particular OLT and PON";
54
55 required manytoone owner->TtWorkflowDriverService:whitelist_entries = 1:1001 [
56 help_text = "TtWorkflowDriverService that owns this white list entry",
57 db_index = True,
58 tosca_key = True];
59 required string serial_number = 2 [
60 help_text = "ONU Serial Number",
61 max_length = 254,
62 tosca_key = True,
63 unique_with = "owner"];
64 required int32 pon_port_id = 3 [
65 help_text = "PON Port on which this ONU is expected to show up"];
66 required string device_id = 4 [
67 help_text = "OLT Device (logical device id) on which this ONU is expected to show up",
68 max_length = 54];
69}