blob: 7ff322986ad01de074ed5e58d1433d0ccbc727b7 [file] [log] [blame]
Zack Williams52209662019-02-07 10:15:31 -07001syntax = "proto3";
2
khenaidoo5fc5cea2021-08-11 17:39:16 -04003option go_package = "github.com/opencord/voltha-protos/v5/go/common";
Zack Williams52209662019-02-07 10:15:31 -07004
William Kurkian12fc0af2019-04-18 14:27:45 -04005package common;
Zack Williams52209662019-02-07 10:15:31 -07006
Serkant Uluderyacbcfaa42019-10-18 13:25:08 +03007option java_package = "org.opencord.voltha";
Zack Williams52209662019-02-07 10:15:31 -07008
9// Convey a resource identifier
10message ID {
11 string id = 1;
12}
13
14// Represents a list of IDs
15message IDs {
16 repeated ID items = 1;
17}
18
19enum TestModeKeys {
20 api_test=0;
21}
22
khenaidoo5cb0d402021-12-08 14:09:16 -050023message Connection {
24 // endpoint is the endpoint sending the request
25 string endpoint = 1;
26
27 // contextInfo represents additional contextual information
28 string contextInfo = 2;
29
30 // keep_alive_interval is used to indicate to the remote endpoint how often it
31 // will get a keep alive notification
32 int64 keep_alive_interval = 3;
33}
34
Zack Williams52209662019-02-07 10:15:31 -070035message AdminState {
Zack Williams52209662019-02-07 10:15:31 -070036 // Administrative State
Serkant Uluderyacbcfaa42019-10-18 13:25:08 +030037 enum Types {
Zack Williams52209662019-02-07 10:15:31 -070038
39 // The administrative state of the device is unknown
40 UNKNOWN = 0;
41
42 // The device is pre-provisioned into Voltha, but not contacted by it
43 PREPROVISIONED = 1;
44
45 // The device is enabled for activation and operation
46 ENABLED = 2;
47
48 // The device is disabled and shall not perform its intended forwarding
49 // functions other than being available for re-activation.
50 DISABLED = 3;
51
52 // The device is in the state of image download
53 DOWNLOADING_IMAGE = 4;
Zack Williams52209662019-02-07 10:15:31 -070054 }
55}
56
57message OperStatus {
Zack Williams52209662019-02-07 10:15:31 -070058 // Operational Status
Serkant Uluderyacbcfaa42019-10-18 13:25:08 +030059 enum Types {
Zack Williams52209662019-02-07 10:15:31 -070060
61 // The status of the device is unknown at this point
62 UNKNOWN = 0;
63
64 // The device has been discovered, but not yet activated
65 DISCOVERED = 1;
66
67 // The device is being activated (booted, rebooted, upgraded, etc.)
68 ACTIVATING = 2;
69
70 // Service impacting tests are being conducted
71 TESTING = 3;
72
73 // The device is up and active
74 ACTIVE = 4;
75
76 // The device has failed and cannot fulfill its intended role
77 FAILED = 5;
Maninder4ed97f52021-03-15 10:14:55 +053078
79 // The device is reconciling
80 RECONCILING = 6;
Manindera4b9e552021-06-16 17:33:04 +053081
82 // The device is in reconciling failed
83 RECONCILING_FAILED = 7;
Abhilash Laxmeshwar540a0b92022-06-13 11:24:06 +053084
85 // The device has rebooted
86 REBOOTED = 8;
Zack Williams52209662019-02-07 10:15:31 -070087 }
88}
89
90message ConnectStatus {
Zack Williams52209662019-02-07 10:15:31 -070091 // Connectivity Status
Serkant Uluderyacbcfaa42019-10-18 13:25:08 +030092 enum Types {
Zack Williams52209662019-02-07 10:15:31 -070093
94 // The device connectivity status is unknown
95 UNKNOWN = 0;
96
97 // The device cannot be reached by Voltha
98 UNREACHABLE = 1;
99
100 // There is live communication between device and Voltha
101 REACHABLE = 2;
102 }
103}
104
105message OperationResp {
Zack Williams52209662019-02-07 10:15:31 -0700106 enum OperationReturnCode {
107 OPERATION_SUCCESS = 0;
108 OPERATION_FAILURE = 1;
109 OPERATION_UNSUPPORTED = 2;
Maninder2f9d63e2021-02-08 11:42:19 +0530110 OPERATION_IN_PROGRESS = 3;
Zack Williams52209662019-02-07 10:15:31 -0700111 }
112 // Return code
113 OperationReturnCode code = 1;
114
115 // Additional Info
116 string additional_info = 2;
divyadesaid11cf312020-02-26 12:23:31 +0000117}
Dinesh Belwalkared6da5e2020-02-25 11:23:57 -0800118