dashboard-api 0.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/.gitignore +4 -0
- data/Gemfile +5 -0
- data/Gemfile.lock +31 -0
- data/README.md +103 -0
- data/Rakefile +6 -0
- data/dashboard-api.gemspec +28 -0
- data/doc/Clients.html +250 -0
- data/doc/DashboardAPI.html +532 -0
- data/doc/DashboardAPIVersion.html +122 -0
- data/doc/Devices.html +853 -0
- data/doc/Networks.html +1049 -0
- data/doc/Organizations.html +672 -0
- data/doc/SSIDs.html +497 -0
- data/doc/_index.html +171 -0
- data/doc/class_list.html +51 -0
- data/doc/css/common.css +1 -0
- data/doc/css/full_list.css +58 -0
- data/doc/css/style.css +481 -0
- data/doc/file.README.html +210 -0
- data/doc/file_list.html +56 -0
- data/doc/frames.html +17 -0
- data/doc/index.html +210 -0
- data/doc/js/app.js +243 -0
- data/doc/js/full_list.js +216 -0
- data/doc/js/jquery.js +4 -0
- data/doc/method_list.html +259 -0
- data/doc/top-level-namespace.html +114 -0
- data/lib/clients.rb +10 -0
- data/lib/dashboard-api.rb +67 -0
- data/lib/dashboard-api/version.rb +3 -0
- data/lib/devices.rb +55 -0
- data/lib/networks.rb +80 -0
- data/lib/organizations.rb +39 -0
- data/lib/ssids.rb +31 -0
- metadata +162 -0
data/doc/SSIDs.html
ADDED
@@ -0,0 +1,497 @@
|
|
1
|
+
<!DOCTYPE html>
|
2
|
+
<html>
|
3
|
+
<head>
|
4
|
+
<meta charset="utf-8">
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
6
|
+
<title>
|
7
|
+
Module: SSIDs
|
8
|
+
|
9
|
+
— Documentation by YARD 0.9.5
|
10
|
+
|
11
|
+
</title>
|
12
|
+
|
13
|
+
<link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
|
14
|
+
|
15
|
+
<link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
|
16
|
+
|
17
|
+
<script type="text/javascript" charset="utf-8">
|
18
|
+
pathId = "SSIDs";
|
19
|
+
relpath = '';
|
20
|
+
</script>
|
21
|
+
|
22
|
+
|
23
|
+
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
|
24
|
+
|
25
|
+
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
|
26
|
+
|
27
|
+
|
28
|
+
</head>
|
29
|
+
<body>
|
30
|
+
<div class="nav_wrap">
|
31
|
+
<iframe id="nav" src="class_list.html"></iframe>
|
32
|
+
<div id="resizer"></div>
|
33
|
+
</div>
|
34
|
+
|
35
|
+
<div id="main" tabindex="-1">
|
36
|
+
<div id="header">
|
37
|
+
<div id="menu">
|
38
|
+
|
39
|
+
<a href="_index.html">Index (S)</a> »
|
40
|
+
|
41
|
+
|
42
|
+
<span class="title">SSIDs</span>
|
43
|
+
|
44
|
+
</div>
|
45
|
+
|
46
|
+
<div id="search">
|
47
|
+
|
48
|
+
<a class="full_list_link" id="class_list_link"
|
49
|
+
href="class_list.html">
|
50
|
+
|
51
|
+
<svg width="24" height="24">
|
52
|
+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
53
|
+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
54
|
+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
55
|
+
</svg>
|
56
|
+
</a>
|
57
|
+
|
58
|
+
</div>
|
59
|
+
<div class="clear"></div>
|
60
|
+
</div>
|
61
|
+
|
62
|
+
<iframe id="search_frame" src="class_list.html"></iframe>
|
63
|
+
|
64
|
+
<div id="content"><h1>Module: SSIDs
|
65
|
+
|
66
|
+
|
67
|
+
|
68
|
+
</h1>
|
69
|
+
<div class="box_info">
|
70
|
+
|
71
|
+
|
72
|
+
|
73
|
+
|
74
|
+
|
75
|
+
|
76
|
+
|
77
|
+
|
78
|
+
|
79
|
+
<dl>
|
80
|
+
<dt>Included in:</dt>
|
81
|
+
<dd><span class='object_link'><a href="DashboardAPI.html" title="DashboardAPI (class)">DashboardAPI</a></span></dd>
|
82
|
+
</dl>
|
83
|
+
|
84
|
+
|
85
|
+
|
86
|
+
<dl>
|
87
|
+
<dt>Defined in:</dt>
|
88
|
+
<dd>lib/ssids.rb</dd>
|
89
|
+
</dl>
|
90
|
+
|
91
|
+
</div>
|
92
|
+
|
93
|
+
|
94
|
+
|
95
|
+
|
96
|
+
|
97
|
+
|
98
|
+
|
99
|
+
|
100
|
+
|
101
|
+
<h2>
|
102
|
+
Instance Method Summary
|
103
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
104
|
+
</h2>
|
105
|
+
|
106
|
+
<ul class="summary">
|
107
|
+
|
108
|
+
<li class="public ">
|
109
|
+
<span class="summary_signature">
|
110
|
+
|
111
|
+
<a href="#get_single_ssid-instance_method" title="#get_single_ssid (instance method)">#<strong>get_single_ssid</strong>(network_id, ssid_number) ⇒ Hash </a>
|
112
|
+
|
113
|
+
|
114
|
+
|
115
|
+
</span>
|
116
|
+
|
117
|
+
|
118
|
+
|
119
|
+
|
120
|
+
|
121
|
+
|
122
|
+
|
123
|
+
|
124
|
+
|
125
|
+
<span class="summary_desc"><div class='inline'>
|
126
|
+
<p>Get the attributes for a single SSID.</p>
|
127
|
+
</div></span>
|
128
|
+
|
129
|
+
</li>
|
130
|
+
|
131
|
+
|
132
|
+
<li class="public ">
|
133
|
+
<span class="summary_signature">
|
134
|
+
|
135
|
+
<a href="#list_ssids_in_network-instance_method" title="#list_ssids_in_network (instance method)">#<strong>list_ssids_in_network</strong>(network_id) ⇒ Array </a>
|
136
|
+
|
137
|
+
|
138
|
+
|
139
|
+
</span>
|
140
|
+
|
141
|
+
|
142
|
+
|
143
|
+
|
144
|
+
|
145
|
+
|
146
|
+
|
147
|
+
|
148
|
+
|
149
|
+
<span class="summary_desc"><div class='inline'>
|
150
|
+
<p>Get a list of the SSIDs and their attributes for a network.</p>
|
151
|
+
</div></span>
|
152
|
+
|
153
|
+
</li>
|
154
|
+
|
155
|
+
|
156
|
+
<li class="public ">
|
157
|
+
<span class="summary_signature">
|
158
|
+
|
159
|
+
<a href="#update_single_ssid-instance_method" title="#update_single_ssid (instance method)">#<strong>update_single_ssid</strong>(network_id, ssid_number, options) ⇒ Hash </a>
|
160
|
+
|
161
|
+
|
162
|
+
|
163
|
+
</span>
|
164
|
+
|
165
|
+
|
166
|
+
|
167
|
+
|
168
|
+
|
169
|
+
|
170
|
+
|
171
|
+
|
172
|
+
|
173
|
+
<span class="summary_desc"><div class='inline'>
|
174
|
+
<p>Update the attributes for a single SSID.</p>
|
175
|
+
</div></span>
|
176
|
+
|
177
|
+
</li>
|
178
|
+
|
179
|
+
|
180
|
+
</ul>
|
181
|
+
|
182
|
+
|
183
|
+
|
184
|
+
|
185
|
+
<div id="instance_method_details" class="method_details_list">
|
186
|
+
<h2>Instance Method Details</h2>
|
187
|
+
|
188
|
+
|
189
|
+
<div class="method_details first">
|
190
|
+
<h3 class="signature first" id="get_single_ssid-instance_method">
|
191
|
+
|
192
|
+
#<strong>get_single_ssid</strong>(network_id, ssid_number) ⇒ <tt>Hash</tt>
|
193
|
+
|
194
|
+
|
195
|
+
|
196
|
+
|
197
|
+
|
198
|
+
</h3><div class="docstring">
|
199
|
+
<div class="discussion">
|
200
|
+
|
201
|
+
<p>Get the attributes for a single SSID</p>
|
202
|
+
|
203
|
+
|
204
|
+
</div>
|
205
|
+
</div>
|
206
|
+
<div class="tags">
|
207
|
+
<p class="tag_title">Parameters:</p>
|
208
|
+
<ul class="param">
|
209
|
+
|
210
|
+
<li>
|
211
|
+
|
212
|
+
<span class='name'>network_id</span>
|
213
|
+
|
214
|
+
|
215
|
+
<span class='type'>(<tt>String</tt>)</span>
|
216
|
+
|
217
|
+
|
218
|
+
|
219
|
+
—
|
220
|
+
<div class='inline'>
|
221
|
+
<p>network id where the SSID you want to list is</p>
|
222
|
+
</div>
|
223
|
+
|
224
|
+
</li>
|
225
|
+
|
226
|
+
<li>
|
227
|
+
|
228
|
+
<span class='name'>ssid_number</span>
|
229
|
+
|
230
|
+
|
231
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
232
|
+
|
233
|
+
|
234
|
+
|
235
|
+
—
|
236
|
+
<div class='inline'>
|
237
|
+
<p>the SSID number you want to change. Range is from 0-14</p>
|
238
|
+
</div>
|
239
|
+
|
240
|
+
</li>
|
241
|
+
|
242
|
+
</ul>
|
243
|
+
|
244
|
+
<p class="tag_title">Returns:</p>
|
245
|
+
<ul class="return">
|
246
|
+
|
247
|
+
<li>
|
248
|
+
|
249
|
+
|
250
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
251
|
+
|
252
|
+
|
253
|
+
|
254
|
+
—
|
255
|
+
<div class='inline'>
|
256
|
+
<p>the attributes for the requested SSID</p>
|
257
|
+
</div>
|
258
|
+
|
259
|
+
</li>
|
260
|
+
|
261
|
+
</ul>
|
262
|
+
|
263
|
+
</div><table class="source_code">
|
264
|
+
<tr>
|
265
|
+
<td>
|
266
|
+
<pre class="lines">
|
267
|
+
|
268
|
+
|
269
|
+
13
|
270
|
+
14
|
271
|
+
15
|
272
|
+
16</pre>
|
273
|
+
</td>
|
274
|
+
<td>
|
275
|
+
<pre class="code"><span class="info file"># File 'lib/ssids.rb', line 13</span>
|
276
|
+
|
277
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_get_single_ssid'>get_single_ssid</span><span class='lparen'>(</span><span class='id identifier rubyid_network_id'>network_id</span><span class='comma'>,</span> <span class='id identifier rubyid_ssid_number'>ssid_number</span><span class='rparen'>)</span>
|
278
|
+
<span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Please provide a valid SSID number</span><span class='tstring_end'>"</span></span> <span class='kw'>unless</span> <span class='lparen'>(</span><span class='id identifier rubyid_ssid_number'>ssid_number</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Integer</span><span class='rparen'>)</span> <span class='op'>&&</span> <span class='id identifier rubyid_ssid_number'>ssid_number</span> <span class='op'><=</span> <span class='int'>14</span><span class='rparen'>)</span>
|
279
|
+
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_make_api_call'>make_api_call</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/networks/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_network_id'>network_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/ssids/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_ssid_number'>ssid_number</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>GET</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
280
|
+
<span class='kw'>end</span></pre>
|
281
|
+
</td>
|
282
|
+
</tr>
|
283
|
+
</table>
|
284
|
+
</div>
|
285
|
+
|
286
|
+
<div class="method_details ">
|
287
|
+
<h3 class="signature " id="list_ssids_in_network-instance_method">
|
288
|
+
|
289
|
+
#<strong>list_ssids_in_network</strong>(network_id) ⇒ <tt>Array</tt>
|
290
|
+
|
291
|
+
|
292
|
+
|
293
|
+
|
294
|
+
|
295
|
+
</h3><div class="docstring">
|
296
|
+
<div class="discussion">
|
297
|
+
|
298
|
+
<p>Get a list of the SSIDs and their attributes for a network</p>
|
299
|
+
|
300
|
+
|
301
|
+
</div>
|
302
|
+
</div>
|
303
|
+
<div class="tags">
|
304
|
+
<p class="tag_title">Parameters:</p>
|
305
|
+
<ul class="param">
|
306
|
+
|
307
|
+
<li>
|
308
|
+
|
309
|
+
<span class='name'>network_id</span>
|
310
|
+
|
311
|
+
|
312
|
+
<span class='type'>(<tt>String</tt>)</span>
|
313
|
+
|
314
|
+
|
315
|
+
|
316
|
+
—
|
317
|
+
<div class='inline'>
|
318
|
+
<p>network id where the SSIDs you exists are</p>
|
319
|
+
</div>
|
320
|
+
|
321
|
+
</li>
|
322
|
+
|
323
|
+
</ul>
|
324
|
+
|
325
|
+
<p class="tag_title">Returns:</p>
|
326
|
+
<ul class="return">
|
327
|
+
|
328
|
+
<li>
|
329
|
+
|
330
|
+
|
331
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
332
|
+
|
333
|
+
|
334
|
+
|
335
|
+
—
|
336
|
+
<div class='inline'>
|
337
|
+
<p>an array of Hashes containing the SSID attributes</p>
|
338
|
+
</div>
|
339
|
+
|
340
|
+
</li>
|
341
|
+
|
342
|
+
</ul>
|
343
|
+
|
344
|
+
</div><table class="source_code">
|
345
|
+
<tr>
|
346
|
+
<td>
|
347
|
+
<pre class="lines">
|
348
|
+
|
349
|
+
|
350
|
+
5
|
351
|
+
6
|
352
|
+
7</pre>
|
353
|
+
</td>
|
354
|
+
<td>
|
355
|
+
<pre class="code"><span class="info file"># File 'lib/ssids.rb', line 5</span>
|
356
|
+
|
357
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_list_ssids_in_network'>list_ssids_in_network</span><span class='lparen'>(</span><span class='id identifier rubyid_network_id'>network_id</span><span class='rparen'>)</span>
|
358
|
+
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_make_api_call'>make_api_call</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/networks/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_network_id'>network_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/ssids</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>GET</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
359
|
+
<span class='kw'>end</span></pre>
|
360
|
+
</td>
|
361
|
+
</tr>
|
362
|
+
</table>
|
363
|
+
</div>
|
364
|
+
|
365
|
+
<div class="method_details ">
|
366
|
+
<h3 class="signature " id="update_single_ssid-instance_method">
|
367
|
+
|
368
|
+
#<strong>update_single_ssid</strong>(network_id, ssid_number, options) ⇒ <tt>Hash</tt>
|
369
|
+
|
370
|
+
|
371
|
+
|
372
|
+
|
373
|
+
|
374
|
+
</h3><div class="docstring">
|
375
|
+
<div class="discussion">
|
376
|
+
|
377
|
+
<p>Update the attributes for a single SSID</p>
|
378
|
+
|
379
|
+
|
380
|
+
</div>
|
381
|
+
</div>
|
382
|
+
<div class="tags">
|
383
|
+
<p class="tag_title">Parameters:</p>
|
384
|
+
<ul class="param">
|
385
|
+
|
386
|
+
<li>
|
387
|
+
|
388
|
+
<span class='name'>network_id</span>
|
389
|
+
|
390
|
+
|
391
|
+
<span class='type'>(<tt>String</tt>)</span>
|
392
|
+
|
393
|
+
|
394
|
+
|
395
|
+
—
|
396
|
+
<div class='inline'>
|
397
|
+
<p>network id where the SSID you want to change is</p>
|
398
|
+
</div>
|
399
|
+
|
400
|
+
</li>
|
401
|
+
|
402
|
+
<li>
|
403
|
+
|
404
|
+
<span class='name'>ssid_number</span>
|
405
|
+
|
406
|
+
|
407
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
408
|
+
|
409
|
+
|
410
|
+
|
411
|
+
—
|
412
|
+
<div class='inline'>
|
413
|
+
<p>the SSID number you want to change. Range is from 0-14</p>
|
414
|
+
</div>
|
415
|
+
|
416
|
+
</li>
|
417
|
+
|
418
|
+
<li>
|
419
|
+
|
420
|
+
<span class='name'>options</span>
|
421
|
+
|
422
|
+
|
423
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
424
|
+
|
425
|
+
|
426
|
+
|
427
|
+
—
|
428
|
+
<div class='inline'>
|
429
|
+
<p>hash containing the attributes to update. Can include name, enabled,
|
430
|
+
authMode, encryptionMode and psk</p>
|
431
|
+
</div>
|
432
|
+
|
433
|
+
</li>
|
434
|
+
|
435
|
+
</ul>
|
436
|
+
|
437
|
+
<p class="tag_title">Returns:</p>
|
438
|
+
<ul class="return">
|
439
|
+
|
440
|
+
<li>
|
441
|
+
|
442
|
+
|
443
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
444
|
+
|
445
|
+
|
446
|
+
|
447
|
+
—
|
448
|
+
<div class='inline'>
|
449
|
+
<p>the updated attributes for the SSID</p>
|
450
|
+
</div>
|
451
|
+
|
452
|
+
</li>
|
453
|
+
|
454
|
+
</ul>
|
455
|
+
|
456
|
+
</div><table class="source_code">
|
457
|
+
<tr>
|
458
|
+
<td>
|
459
|
+
<pre class="lines">
|
460
|
+
|
461
|
+
|
462
|
+
23
|
463
|
+
24
|
464
|
+
25
|
465
|
+
26
|
466
|
+
27
|
467
|
+
28
|
468
|
+
29</pre>
|
469
|
+
</td>
|
470
|
+
<td>
|
471
|
+
<pre class="code"><span class="info file"># File 'lib/ssids.rb', line 23</span>
|
472
|
+
|
473
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_update_single_ssid'>update_single_ssid</span><span class='lparen'>(</span><span class='id identifier rubyid_network_id'>network_id</span><span class='comma'>,</span> <span class='id identifier rubyid_ssid_number'>ssid_number</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
474
|
+
<span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Options were not passed as a Hash</span><span class='tstring_end'>'</span></span> <span class='kw'>if</span> <span class='op'>!</span><span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Hash</span><span class='rparen'>)</span>
|
475
|
+
<span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Please provide a valid SSID number</span><span class='tstring_end'>"</span></span> <span class='kw'>unless</span> <span class='lparen'>(</span><span class='id identifier rubyid_ssid_number'>ssid_number</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Integer</span><span class='rparen'>)</span> <span class='op'>&&</span> <span class='id identifier rubyid_ssid_number'>ssid_number</span> <span class='op'><=</span> <span class='int'>14</span><span class='rparen'>)</span>
|
476
|
+
<span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='symbol'>:body</span> <span class='op'>=></span> <span class='id identifier rubyid_options'>options</span><span class='rbrace'>}</span>
|
477
|
+
|
478
|
+
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_make_api_call'>make_api_call</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/networks/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_network_id'>network_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/ssids/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_ssid_number'>ssid_number</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>PUT</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
479
|
+
<span class='kw'>end</span></pre>
|
480
|
+
</td>
|
481
|
+
</tr>
|
482
|
+
</table>
|
483
|
+
</div>
|
484
|
+
|
485
|
+
</div>
|
486
|
+
|
487
|
+
</div>
|
488
|
+
|
489
|
+
<div id="footer">
|
490
|
+
Generated on Tue Nov 15 21:16:06 2016 by
|
491
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
492
|
+
0.9.5 (ruby-2.3.0).
|
493
|
+
</div>
|
494
|
+
|
495
|
+
</div>
|
496
|
+
</body>
|
497
|
+
</html>
|