forked from RangeNetworks/NodeManager
-
Notifications
You must be signed in to change notification settings - Fork 2
/
JSON_Interface.txt
202 lines (182 loc) · 3.69 KB
/
JSON_Interface.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
= NodeManager JSON Interface =
The JSON interface operates over a ZeroMQ REQ<->REP socket pair.
== General Notes ==
- everything is a string except for response codes and the static field
- response codes are based on HTTP
- 200 : action ok with response data
- 204 : action ok with no response data
- 404 : unknown key or action
- 406 : request is invalid
- 409 : conflicting value
- 500 : storing new value failed
- 501 : unknown action
== Read All Configuration Values ==
=== Request ===
{{{
{
"target":"openbts",
"command":"config",
"action":"read"
}
}}}
=== Response ===
{{{
{
"code": 200,
"data": [
{
"defaultValue": "127.0.0.1",
"description": "Interface for use in communicating between CLI and OpenBTS, use \"any\" for all interfaces, otherwise, a comma separated list of interfaces",
"key": "CLI.Interface",
"scope": 0,
"static": false,
"type": "IP address",
"units": "",
"validValues": "",
"value": "127.0.0.1",
"visibility": "factory - set once at the factory, should never be changed"
},
...
{
"defaultValue": "0",
"description": "Location area code, 16 bits, values 0xFFxx are reserved. For multi-BTS networks, assign a unique LAC to each BTS unit. (That is not the normal procedure in conventional GSM networks, but is the correct procedure in OpenBTS networks.)",
"key": "UMTS.Identity.LAC",
"static": false,
"type": "value range",
"units": "",
"validValues": "0:65280",
"value": "0",
"visibility": "customer warn - a warning will be presented and confirmation required before changing this sensitive setting"
}
]
}
}}}
== Read Configuration Value - Valid Key ==
=== Request ===
{{{
{
"target":"openbts",
"command":"config",
"action":"read",
"key":"GSM.Radio.Band"
}
}}}
=== Response ===
{{{
{
"code": 200,
"data": {
"defaultValue": "900",
"description": "The GSM operating band. Valid values are 850 (GSM850), 900 (PGSM900), 1800 (DCS1800) and 1900 (PCS1900). For non-multiband units, this value is dictated by the hardware and should not be changed.",
"key": "GSM.Radio.Band",
"static": true,
"type": "multiple choice",
"units": "",
"validValues": "850|GSM850,900|PGSM900,1800|DCS1800,1900|PCS1900",
"value": "850",
"visibility": "factory - set once at the factory, should never be changed"
}
}
}}}
== Read Configuration Value - Invalid Key ==
=== Request ===
{{{
{
"target":"openbts",
"command":"config",
"action":"read",
"key":"THISKEYISINVALID"
}
}}}
=== Response ===
{{{
{
"code":404
}
}}}
== Update Configuration Value - Valid Key and Valid Value ==
=== Request ===
{{{
{
"target":"openbts",
"command":"config",
"action":"update",
"key":"GSM.Radio.C0",
"value":"151"
}
}}}
=== Response ===
{{{
{
"code":204
}
}}}
== Update Configuration Value - Invalid Key and Valid Value ==
=== Request ===
{{{
{
"target":"openbts",
"command":"config",
"action":"update",
"key":"THISKEYISINVALID",
"value":"151"
}
}}}
=== Response ===
{{{
{
"code":404
}
}}}
== Update Configuration Value - Valid Key and Invalid Value ==
=== Request ===
{{{
{
"target":"openbts",
"command":"config",
"action":"update",
"key":"GSM.Radio.C0",
"value":"999"
}
}}}
=== Response ===
{{{
{
"code":406
}
}}}
== Read Version ==
=== Request ===
{{{
{
"target":"openbts",
"command":"version"
}
}}}
=== Response ===
{{{
{
"code":200,
"data":"release 4.0.0.8025+GPRS C built Mar 19 2014 rev8026 CommonLibs:rev8010 "
}
}}}
== Start a Timed PCAP Trace ==
Note: this command is in development as of R4.0
=== Request ===
{{{
{
"target":"openbts",
"command":"trace",
"action":"start",
"filename":"/tmp/mytrace.pcap",
"interface":"any",
"filter":"udp port 5060",
"seconds":"10"
}
}}}
=== Response ===
{{{
{
"code":204
}
}}}