blob: a96125ab3ce00e660ab5e5fe59786b753ff58e28 [file] [log] [blame]
Jian Lia7f86ce2015-12-20 13:42:10 -08001{
2 "type": "object",
3 "title": "group",
4 "required": [
5 "id",
6 "state",
7 "life",
8 "packets",
9 "bytes",
10 "referenceCount",
11 "type",
12 "deviceId",
13 "appId",
14 "appCookie",
15 "buckets"
16 ],
17 "properties": {
18 "id": {
19 "type": "string",
20 "description": "group id",
21 "example": "1"
22 },
23 "state": {
24 "type": "string",
25 "description": "state of the group object",
26 "example": "PENDING_ADD"
27 },
28 "life": {
29 "type": "integer",
30 "format": "int64",
31 "description": "number of milliseconds this group has been alive",
32 "example": 69889
33 },
34 "packets": {
35 "type": "integer",
36 "format": "int64",
37 "description": "number of packets processed by this group",
38 "example": 22546
39 },
40 "bytes": {
41 "type": "integer",
42 "format": "int64",
43 "description": "number of bytes processed by this group",
44 "example": 1826226
45 },
46 "referenceCount": {
47 "type": "integer",
48 "format": "int64",
49 "description": "number of flow rules or other groups reference this group",
50 "example": 1826226
51 },
52 "type": {
53 "type": "string",
54 "description": "types of the group",
55 "example": "ALL"
56 },
57 "deviceId": {
58 "type": "string",
59 "description": "device identifier",
60 "example": "of:0000000000000003"
61 },
62 "appId": {
63 "type": "string",
64 "description": "application identifier",
varunsha34b30602016-08-18 10:31:18 -070065 "example": "org.onosproject.rest"
Jian Lia7f86ce2015-12-20 13:42:10 -080066 },
67 "appCookie": {
68 "type": "string",
69 "description": "application cookie",
Charles Chanb3ef1fd2016-05-12 20:49:39 -070070 "example": "0x1234abcd"
Jian Lia7f86ce2015-12-20 13:42:10 -080071 },
72 "buckets": {
73 "type": "array",
74 "xml": {
75 "name": "buckets",
76 "wrapped": true
77 },
78 "items": {
79 "type": "object",
80 "title": "buckets",
81 "required": [
82 "treatment",
83 "weight",
84 "watchPort",
85 "watchGroup"
86 ],
87 "properties": {
88 "treatment": {
89 "type": "object",
90 "title": "treatment",
91 "required": [
92 "instructions",
93 "deferred"
94 ],
95 "properties": {
96 "instructions": {
97 "type": "array",
98 "title": "treatment",
99 "required": [
100 "properties",
101 "port"
102 ],
103 "items": {
104 "type": "object",
105 "title": "instructions",
106 "required": [
107 "type",
108 "port"
109 ],
110 "properties": {
111 "type": {
112 "type": "string",
113 "description": "instruction type",
114 "example": "OUTPUT"
115 },
116 "port": {
117 "type": "string",
118 "description": "port number",
119 "example": "2"
120 }
121 }
122 }
123 }
124 }
125 },
126 "weight": {
127 "type": "integer",
128 "format": "int16",
129 "description": "weight of select group bucket",
130 "example": "1.0"
131 },
132 "watchPort": {
133 "type": "string",
134 "description": "port number used for liveness detection for a failover bucket",
135 "example": "2"
136 },
137 "watchGroup": {
138 "type": "string",
139 "description": "group identifier used for liveness detection for a failover bucket",
140 "example": "1"
141 }
142 }
143 }
144 }
145 }
146}