blob: cf00c14c221f34b8cd3c88bda6b71ca93abdf215 [file] [log] [blame]
Takahiro Suzuki2b66b942020-12-17 11:58:14 +09001option name = "ntt-workflow-driver";
2option app_label = "ntt-workflow-driver";
3
4message NttWorkflowDriverService (Service){
5 option verbose_name = "NttWorkflowDriver Service";
6 option kind = "control";
7 option description = "Service that manages the EPON subscriber workflow";
8}
9
10message NttWorkflowDriverServiceInstance (ServiceInstance){
11 option owner_class_name = "NttWorkflowDriverService";
12 option verbose_name = "NttWorkflowDriver Service Instance";
13 option description = "Workflow settings for a particular ONU Device";
14 option policy_implemented = "True";
15
16 required string serial_number = 2 [
17 help_text = "Serial number of ONU",
18 max_length = 256,
19 tosca_key=True,
20 unique = True];
21 required string authentication_state = 3 [
22 help_text = "Subscriber authentication state",
23 choices = "(('AWAITING', 'Awaiting'), ('STARTED', 'Started'), ('REQUESTED', 'Requested'), ('APPROVED', 'Approved'), ('DENIED', 'Denied'), )",
24 default = "AWAITING",
25 feedback_state = True,
26 max_length = 50];
27 required string of_dpid = 4 [
28 help_text = "OLT MAC address",
29 max_length = 256];
30 required int32 uni_port_id = 5 [
31 help_text = "ONU UNI port ID"];
32 required string admin_onu_state = 6 [
33 help_text = "ONU administrative state",
34 choices = "(('AWAITING', 'Awaiting'), ('ENABLED', 'Enabled'), ('DISABLED', 'Disabled'))",
35 default = "AWAITING",
36 feedback_state = True,
37 max_length = 256];
38 optional string status_message = 7 [
39 help_text = "Status text of current state machine state",
40 default = "",
41 max_length = 256];
42
43 optional string mac_address = 10 [
44 help_text = "Subscriber MAC address",
45 feedback_state = True,
46 max_length = 20];
47 required string oper_onu_status = 11 [
48 help_text = "ONU operational state",
49 choices = "(('AWAITING', 'Awaiting'), ('ENABLED', 'Enabled'), ('DISABLED', 'Disabled'))",
50 default = "AWAITING",
51 feedback_state = True,
52 max_length = 256];
53}
54
55message NttWorkflowDriverWhiteListEntry (XOSBase) {
56 option verbose_name = "ONU Whitelist";
57 option plural = "nttworkflowdriverwhitelistentries";
58 option description = "White list entry";
59 option policy_implemented = "True";
60
61 required manytoone owner->NttWorkflowDriverService:whitelist_entries = 1:1001 [
62 help_text = "NttWorkflowDriverService that owns this white list entry",
63 db_index = True,
64 tosca_key = True];
65 optional string mac_address = 2 [
66 help_text = "ONU MAC Address for package A authentication",
67 max_length = 256,
68 tosca_key = True];
69 required int32 pon_port_from = 3 [
70 help_text = "Start ID of approved PON Port"];
71 required int32 pon_port_to = 4 [
72 help_text = "End ID of approved PON Port"];
73}
74
75message NttWorkflowDriverOltInformation (ServiceInstance){
76 option owner_class_name = "NttWorkflowDriverService";
77 option verbose_name = "NttWorkflowDriver Olt Information";
78 option description = "OLT information";
79 option policy_implemented = "True";
80
81 required string of_dpid = 2 [
82 help_text = "OLT MAC address",
83 max_length = 256];
84 optional string olt_location = 3 [
85 help_text = "OLT location",
86 max_length = 256];
87 optional string olt_package = 4 [
88 help_text = "Package",
89 max_length = 256];
90 optional uint32 port_no = 5 [
91 help_text = "Port number",
92 max_length = 256];
93}