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
|
@@ -0,0 +1,122 @@
|
|
|
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: DashboardAPIVersion
|
|
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 = "DashboardAPIVersion";
|
|
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 (D)</a> »
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
<span class="title">DashboardAPIVersion</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: DashboardAPIVersion
|
|
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/dashboard-api/version.rb</dd>
|
|
89
|
+
</dl>
|
|
90
|
+
|
|
91
|
+
</div>
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
<h2>Constant Summary</h2>
|
|
95
|
+
<dl class="constants">
|
|
96
|
+
|
|
97
|
+
<dt id="VERSION-constant" class="">VERSION =
|
|
98
|
+
|
|
99
|
+
</dt>
|
|
100
|
+
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>0.1.0</span><span class='tstring_end'>"</span></span></pre></dd>
|
|
101
|
+
|
|
102
|
+
</dl>
|
|
103
|
+
|
|
104
|
+
|
|
105
|
+
|
|
106
|
+
|
|
107
|
+
|
|
108
|
+
|
|
109
|
+
|
|
110
|
+
|
|
111
|
+
|
|
112
|
+
</div>
|
|
113
|
+
|
|
114
|
+
<div id="footer">
|
|
115
|
+
Generated on Tue Nov 15 21:16:07 2016 by
|
|
116
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
117
|
+
0.9.5 (ruby-2.3.0).
|
|
118
|
+
</div>
|
|
119
|
+
|
|
120
|
+
</div>
|
|
121
|
+
</body>
|
|
122
|
+
</html>
|
data/doc/Devices.html
ADDED
|
@@ -0,0 +1,853 @@
|
|
|
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: Devices
|
|
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 = "Devices";
|
|
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 (D)</a> »
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
<span class="title">Devices</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: Devices
|
|
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/devices.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="#claim_device_into_network-instance_method" title="#claim_device_into_network (instance method)">#<strong>claim_device_into_network</strong>(network_id, options) ⇒ Integer </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>Claim a single device into a network.</p>
|
|
127
|
+
</div></span>
|
|
128
|
+
|
|
129
|
+
</li>
|
|
130
|
+
|
|
131
|
+
|
|
132
|
+
<li class="public ">
|
|
133
|
+
<span class="summary_signature">
|
|
134
|
+
|
|
135
|
+
<a href="#get_device_uplink_stats-instance_method" title="#get_device_uplink_stats (instance method)">#<strong>get_device_uplink_stats</strong>(network_id, device_serial) ⇒ 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>Uplink information for a specified device.</p>
|
|
151
|
+
</div></span>
|
|
152
|
+
|
|
153
|
+
</li>
|
|
154
|
+
|
|
155
|
+
|
|
156
|
+
<li class="public ">
|
|
157
|
+
<span class="summary_signature">
|
|
158
|
+
|
|
159
|
+
<a href="#get_single_device-instance_method" title="#get_single_device (instance method)">#<strong>get_single_device</strong>(network_id, device_serial) ⇒ 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>Device information for a specified device.</p>
|
|
175
|
+
</div></span>
|
|
176
|
+
|
|
177
|
+
</li>
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
<li class="public ">
|
|
181
|
+
<span class="summary_signature">
|
|
182
|
+
|
|
183
|
+
<a href="#list_devices_in_network-instance_method" title="#list_devices_in_network (instance method)">#<strong>list_devices_in_network</strong>(network_id) ⇒ Array </a>
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
|
|
187
|
+
</span>
|
|
188
|
+
|
|
189
|
+
|
|
190
|
+
|
|
191
|
+
|
|
192
|
+
|
|
193
|
+
|
|
194
|
+
|
|
195
|
+
|
|
196
|
+
|
|
197
|
+
<span class="summary_desc"><div class='inline'>
|
|
198
|
+
<p>List all devices in a given network.</p>
|
|
199
|
+
</div></span>
|
|
200
|
+
|
|
201
|
+
</li>
|
|
202
|
+
|
|
203
|
+
|
|
204
|
+
<li class="public ">
|
|
205
|
+
<span class="summary_signature">
|
|
206
|
+
|
|
207
|
+
<a href="#remove_device_from_network-instance_method" title="#remove_device_from_network (instance method)">#<strong>remove_device_from_network</strong>(network_id, device_serial) ⇒ Integer </a>
|
|
208
|
+
|
|
209
|
+
|
|
210
|
+
|
|
211
|
+
</span>
|
|
212
|
+
|
|
213
|
+
|
|
214
|
+
|
|
215
|
+
|
|
216
|
+
|
|
217
|
+
|
|
218
|
+
|
|
219
|
+
|
|
220
|
+
|
|
221
|
+
<span class="summary_desc"><div class='inline'>
|
|
222
|
+
<p>Remove a single device from a network.</p>
|
|
223
|
+
</div></span>
|
|
224
|
+
|
|
225
|
+
</li>
|
|
226
|
+
|
|
227
|
+
|
|
228
|
+
<li class="public ">
|
|
229
|
+
<span class="summary_signature">
|
|
230
|
+
|
|
231
|
+
<a href="#update_device_attributes-instance_method" title="#update_device_attributes (instance method)">#<strong>update_device_attributes</strong>(network_id, device_serial, options) ⇒ Hash </a>
|
|
232
|
+
|
|
233
|
+
|
|
234
|
+
|
|
235
|
+
</span>
|
|
236
|
+
|
|
237
|
+
|
|
238
|
+
|
|
239
|
+
|
|
240
|
+
|
|
241
|
+
|
|
242
|
+
|
|
243
|
+
|
|
244
|
+
|
|
245
|
+
<span class="summary_desc"><div class='inline'>
|
|
246
|
+
<p>Update a single devices attributes.</p>
|
|
247
|
+
</div></span>
|
|
248
|
+
|
|
249
|
+
</li>
|
|
250
|
+
|
|
251
|
+
|
|
252
|
+
</ul>
|
|
253
|
+
|
|
254
|
+
|
|
255
|
+
|
|
256
|
+
|
|
257
|
+
<div id="instance_method_details" class="method_details_list">
|
|
258
|
+
<h2>Instance Method Details</h2>
|
|
259
|
+
|
|
260
|
+
|
|
261
|
+
<div class="method_details first">
|
|
262
|
+
<h3 class="signature first" id="claim_device_into_network-instance_method">
|
|
263
|
+
|
|
264
|
+
#<strong>claim_device_into_network</strong>(network_id, options) ⇒ <tt>Integer</tt>
|
|
265
|
+
|
|
266
|
+
|
|
267
|
+
|
|
268
|
+
|
|
269
|
+
|
|
270
|
+
</h3><div class="docstring">
|
|
271
|
+
<div class="discussion">
|
|
272
|
+
|
|
273
|
+
<p>Claim a single device into a network</p>
|
|
274
|
+
|
|
275
|
+
|
|
276
|
+
</div>
|
|
277
|
+
</div>
|
|
278
|
+
<div class="tags">
|
|
279
|
+
<p class="tag_title">Parameters:</p>
|
|
280
|
+
<ul class="param">
|
|
281
|
+
|
|
282
|
+
<li>
|
|
283
|
+
|
|
284
|
+
<span class='name'>network_id</span>
|
|
285
|
+
|
|
286
|
+
|
|
287
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
288
|
+
|
|
289
|
+
|
|
290
|
+
|
|
291
|
+
—
|
|
292
|
+
<div class='inline'>
|
|
293
|
+
<p>dashboard network id to claim device into</p>
|
|
294
|
+
</div>
|
|
295
|
+
|
|
296
|
+
</li>
|
|
297
|
+
|
|
298
|
+
<li>
|
|
299
|
+
|
|
300
|
+
<span class='name'>options</span>
|
|
301
|
+
|
|
302
|
+
|
|
303
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
304
|
+
|
|
305
|
+
|
|
306
|
+
|
|
307
|
+
—
|
|
308
|
+
<div class='inline'>
|
|
309
|
+
<p>hash containing :serial => 'meraki device SN' you want to claim</p>
|
|
310
|
+
</div>
|
|
311
|
+
|
|
312
|
+
</li>
|
|
313
|
+
|
|
314
|
+
</ul>
|
|
315
|
+
|
|
316
|
+
<p class="tag_title">Returns:</p>
|
|
317
|
+
<ul class="return">
|
|
318
|
+
|
|
319
|
+
<li>
|
|
320
|
+
|
|
321
|
+
|
|
322
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
|
323
|
+
|
|
324
|
+
|
|
325
|
+
|
|
326
|
+
—
|
|
327
|
+
<div class='inline'>
|
|
328
|
+
<p>code returns the HTTP code of the API call</p>
|
|
329
|
+
</div>
|
|
330
|
+
|
|
331
|
+
</li>
|
|
332
|
+
|
|
333
|
+
</ul>
|
|
334
|
+
|
|
335
|
+
</div><table class="source_code">
|
|
336
|
+
<tr>
|
|
337
|
+
<td>
|
|
338
|
+
<pre class="lines">
|
|
339
|
+
|
|
340
|
+
|
|
341
|
+
42
|
|
342
|
+
43
|
|
343
|
+
44
|
|
344
|
+
45
|
|
345
|
+
46</pre>
|
|
346
|
+
</td>
|
|
347
|
+
<td>
|
|
348
|
+
<pre class="code"><span class="info file"># File 'lib/devices.rb', line 42</span>
|
|
349
|
+
|
|
350
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_claim_device_into_network'>claim_device_into_network</span><span class='lparen'>(</span><span class='id identifier rubyid_network_id'>network_id</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
|
351
|
+
<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>
|
|
352
|
+
<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>
|
|
353
|
+
<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'>/devices/claim</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>POST</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
|
354
|
+
<span class='kw'>end</span></pre>
|
|
355
|
+
</td>
|
|
356
|
+
</tr>
|
|
357
|
+
</table>
|
|
358
|
+
</div>
|
|
359
|
+
|
|
360
|
+
<div class="method_details ">
|
|
361
|
+
<h3 class="signature " id="get_device_uplink_stats-instance_method">
|
|
362
|
+
|
|
363
|
+
#<strong>get_device_uplink_stats</strong>(network_id, device_serial) ⇒ <tt>Array</tt>
|
|
364
|
+
|
|
365
|
+
|
|
366
|
+
|
|
367
|
+
|
|
368
|
+
|
|
369
|
+
</h3><div class="docstring">
|
|
370
|
+
<div class="discussion">
|
|
371
|
+
|
|
372
|
+
<p>Uplink information for a specified device</p>
|
|
373
|
+
|
|
374
|
+
|
|
375
|
+
</div>
|
|
376
|
+
</div>
|
|
377
|
+
<div class="tags">
|
|
378
|
+
<p class="tag_title">Parameters:</p>
|
|
379
|
+
<ul class="param">
|
|
380
|
+
|
|
381
|
+
<li>
|
|
382
|
+
|
|
383
|
+
<span class='name'>network_id</span>
|
|
384
|
+
|
|
385
|
+
|
|
386
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
387
|
+
|
|
388
|
+
|
|
389
|
+
|
|
390
|
+
—
|
|
391
|
+
<div class='inline'>
|
|
392
|
+
<p>network id where the device exists</p>
|
|
393
|
+
</div>
|
|
394
|
+
|
|
395
|
+
</li>
|
|
396
|
+
|
|
397
|
+
<li>
|
|
398
|
+
|
|
399
|
+
<span class='name'>device_serial</span>
|
|
400
|
+
|
|
401
|
+
|
|
402
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
403
|
+
|
|
404
|
+
|
|
405
|
+
|
|
406
|
+
—
|
|
407
|
+
<div class='inline'>
|
|
408
|
+
<p>meraki serial number of the device you want to check</p>
|
|
409
|
+
</div>
|
|
410
|
+
|
|
411
|
+
</li>
|
|
412
|
+
|
|
413
|
+
</ul>
|
|
414
|
+
|
|
415
|
+
<p class="tag_title">Returns:</p>
|
|
416
|
+
<ul class="return">
|
|
417
|
+
|
|
418
|
+
<li>
|
|
419
|
+
|
|
420
|
+
|
|
421
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
|
422
|
+
|
|
423
|
+
|
|
424
|
+
|
|
425
|
+
—
|
|
426
|
+
<div class='inline'>
|
|
427
|
+
<p>an array of hashes for each uplink and it's attributes</p>
|
|
428
|
+
</div>
|
|
429
|
+
|
|
430
|
+
</li>
|
|
431
|
+
|
|
432
|
+
</ul>
|
|
433
|
+
|
|
434
|
+
</div><table class="source_code">
|
|
435
|
+
<tr>
|
|
436
|
+
<td>
|
|
437
|
+
<pre class="lines">
|
|
438
|
+
|
|
439
|
+
|
|
440
|
+
22
|
|
441
|
+
23
|
|
442
|
+
24</pre>
|
|
443
|
+
</td>
|
|
444
|
+
<td>
|
|
445
|
+
<pre class="code"><span class="info file"># File 'lib/devices.rb', line 22</span>
|
|
446
|
+
|
|
447
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_get_device_uplink_stats'>get_device_uplink_stats</span><span class='lparen'>(</span><span class='id identifier rubyid_network_id'>network_id</span><span class='comma'>,</span> <span class='id identifier rubyid_device_serial'>device_serial</span><span class='rparen'>)</span>
|
|
448
|
+
<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'>/devices/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_device_serial'>device_serial</span><span class='embexpr_end'>}</span><span class='tstring_content'>/uplink</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>
|
|
449
|
+
<span class='kw'>end</span></pre>
|
|
450
|
+
</td>
|
|
451
|
+
</tr>
|
|
452
|
+
</table>
|
|
453
|
+
</div>
|
|
454
|
+
|
|
455
|
+
<div class="method_details ">
|
|
456
|
+
<h3 class="signature " id="get_single_device-instance_method">
|
|
457
|
+
|
|
458
|
+
#<strong>get_single_device</strong>(network_id, device_serial) ⇒ <tt>Hash</tt>
|
|
459
|
+
|
|
460
|
+
|
|
461
|
+
|
|
462
|
+
|
|
463
|
+
|
|
464
|
+
</h3><div class="docstring">
|
|
465
|
+
<div class="discussion">
|
|
466
|
+
|
|
467
|
+
<p>Device information for a specified device</p>
|
|
468
|
+
|
|
469
|
+
|
|
470
|
+
</div>
|
|
471
|
+
</div>
|
|
472
|
+
<div class="tags">
|
|
473
|
+
<p class="tag_title">Parameters:</p>
|
|
474
|
+
<ul class="param">
|
|
475
|
+
|
|
476
|
+
<li>
|
|
477
|
+
|
|
478
|
+
<span class='name'>network_id</span>
|
|
479
|
+
|
|
480
|
+
|
|
481
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
482
|
+
|
|
483
|
+
|
|
484
|
+
|
|
485
|
+
—
|
|
486
|
+
<div class='inline'>
|
|
487
|
+
<p>the network id where the device exists</p>
|
|
488
|
+
</div>
|
|
489
|
+
|
|
490
|
+
</li>
|
|
491
|
+
|
|
492
|
+
<li>
|
|
493
|
+
|
|
494
|
+
<span class='name'>device_serial</span>
|
|
495
|
+
|
|
496
|
+
|
|
497
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
498
|
+
|
|
499
|
+
|
|
500
|
+
|
|
501
|
+
—
|
|
502
|
+
<div class='inline'>
|
|
503
|
+
<p>the meraki serial number of the device you want to get information for</p>
|
|
504
|
+
</div>
|
|
505
|
+
|
|
506
|
+
</li>
|
|
507
|
+
|
|
508
|
+
</ul>
|
|
509
|
+
|
|
510
|
+
<p class="tag_title">Returns:</p>
|
|
511
|
+
<ul class="return">
|
|
512
|
+
|
|
513
|
+
<li>
|
|
514
|
+
|
|
515
|
+
|
|
516
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
517
|
+
|
|
518
|
+
|
|
519
|
+
|
|
520
|
+
—
|
|
521
|
+
<div class='inline'>
|
|
522
|
+
<p>a hash containing all of the devices attributes</p>
|
|
523
|
+
</div>
|
|
524
|
+
|
|
525
|
+
</li>
|
|
526
|
+
|
|
527
|
+
</ul>
|
|
528
|
+
|
|
529
|
+
</div><table class="source_code">
|
|
530
|
+
<tr>
|
|
531
|
+
<td>
|
|
532
|
+
<pre class="lines">
|
|
533
|
+
|
|
534
|
+
|
|
535
|
+
14
|
|
536
|
+
15
|
|
537
|
+
16</pre>
|
|
538
|
+
</td>
|
|
539
|
+
<td>
|
|
540
|
+
<pre class="code"><span class="info file"># File 'lib/devices.rb', line 14</span>
|
|
541
|
+
|
|
542
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_get_single_device'>get_single_device</span><span class='lparen'>(</span><span class='id identifier rubyid_network_id'>network_id</span><span class='comma'>,</span> <span class='id identifier rubyid_device_serial'>device_serial</span><span class='rparen'>)</span>
|
|
543
|
+
<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'>/devices/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_device_serial'>device_serial</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>
|
|
544
|
+
<span class='kw'>end</span></pre>
|
|
545
|
+
</td>
|
|
546
|
+
</tr>
|
|
547
|
+
</table>
|
|
548
|
+
</div>
|
|
549
|
+
|
|
550
|
+
<div class="method_details ">
|
|
551
|
+
<h3 class="signature " id="list_devices_in_network-instance_method">
|
|
552
|
+
|
|
553
|
+
#<strong>list_devices_in_network</strong>(network_id) ⇒ <tt>Array</tt>
|
|
554
|
+
|
|
555
|
+
|
|
556
|
+
|
|
557
|
+
|
|
558
|
+
|
|
559
|
+
</h3><div class="docstring">
|
|
560
|
+
<div class="discussion">
|
|
561
|
+
|
|
562
|
+
<p>List all devices in a given network</p>
|
|
563
|
+
|
|
564
|
+
|
|
565
|
+
</div>
|
|
566
|
+
</div>
|
|
567
|
+
<div class="tags">
|
|
568
|
+
<p class="tag_title">Parameters:</p>
|
|
569
|
+
<ul class="param">
|
|
570
|
+
|
|
571
|
+
<li>
|
|
572
|
+
|
|
573
|
+
<span class='name'>network_id</span>
|
|
574
|
+
|
|
575
|
+
|
|
576
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
577
|
+
|
|
578
|
+
|
|
579
|
+
|
|
580
|
+
—
|
|
581
|
+
<div class='inline'>
|
|
582
|
+
<p>network that you want to get devices for</p>
|
|
583
|
+
</div>
|
|
584
|
+
|
|
585
|
+
</li>
|
|
586
|
+
|
|
587
|
+
</ul>
|
|
588
|
+
|
|
589
|
+
<p class="tag_title">Returns:</p>
|
|
590
|
+
<ul class="return">
|
|
591
|
+
|
|
592
|
+
<li>
|
|
593
|
+
|
|
594
|
+
|
|
595
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
|
596
|
+
|
|
597
|
+
|
|
598
|
+
|
|
599
|
+
—
|
|
600
|
+
<div class='inline'>
|
|
601
|
+
<p>array of hashes containing device information for all devices in the
|
|
602
|
+
network</p>
|
|
603
|
+
</div>
|
|
604
|
+
|
|
605
|
+
</li>
|
|
606
|
+
|
|
607
|
+
</ul>
|
|
608
|
+
|
|
609
|
+
</div><table class="source_code">
|
|
610
|
+
<tr>
|
|
611
|
+
<td>
|
|
612
|
+
<pre class="lines">
|
|
613
|
+
|
|
614
|
+
|
|
615
|
+
5
|
|
616
|
+
6
|
|
617
|
+
7</pre>
|
|
618
|
+
</td>
|
|
619
|
+
<td>
|
|
620
|
+
<pre class="code"><span class="info file"># File 'lib/devices.rb', line 5</span>
|
|
621
|
+
|
|
622
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_list_devices_in_network'>list_devices_in_network</span><span class='lparen'>(</span><span class='id identifier rubyid_network_id'>network_id</span><span class='rparen'>)</span>
|
|
623
|
+
<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'>/devices</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>
|
|
624
|
+
<span class='kw'>end</span></pre>
|
|
625
|
+
</td>
|
|
626
|
+
</tr>
|
|
627
|
+
</table>
|
|
628
|
+
</div>
|
|
629
|
+
|
|
630
|
+
<div class="method_details ">
|
|
631
|
+
<h3 class="signature " id="remove_device_from_network-instance_method">
|
|
632
|
+
|
|
633
|
+
#<strong>remove_device_from_network</strong>(network_id, device_serial) ⇒ <tt>Integer</tt>
|
|
634
|
+
|
|
635
|
+
|
|
636
|
+
|
|
637
|
+
|
|
638
|
+
|
|
639
|
+
</h3><div class="docstring">
|
|
640
|
+
<div class="discussion">
|
|
641
|
+
|
|
642
|
+
<p>Remove a single device from a network</p>
|
|
643
|
+
|
|
644
|
+
|
|
645
|
+
</div>
|
|
646
|
+
</div>
|
|
647
|
+
<div class="tags">
|
|
648
|
+
<p class="tag_title">Parameters:</p>
|
|
649
|
+
<ul class="param">
|
|
650
|
+
|
|
651
|
+
<li>
|
|
652
|
+
|
|
653
|
+
<span class='name'>network_id</span>
|
|
654
|
+
|
|
655
|
+
|
|
656
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
657
|
+
|
|
658
|
+
|
|
659
|
+
|
|
660
|
+
—
|
|
661
|
+
<div class='inline'>
|
|
662
|
+
<p>dashboard network id to remove device from</p>
|
|
663
|
+
</div>
|
|
664
|
+
|
|
665
|
+
</li>
|
|
666
|
+
|
|
667
|
+
<li>
|
|
668
|
+
|
|
669
|
+
<span class='name'>serial</span>
|
|
670
|
+
|
|
671
|
+
|
|
672
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
673
|
+
|
|
674
|
+
|
|
675
|
+
|
|
676
|
+
—
|
|
677
|
+
<div class='inline'>
|
|
678
|
+
<p>meraki serial number for device to remove</p>
|
|
679
|
+
</div>
|
|
680
|
+
|
|
681
|
+
</li>
|
|
682
|
+
|
|
683
|
+
</ul>
|
|
684
|
+
|
|
685
|
+
<p class="tag_title">Returns:</p>
|
|
686
|
+
<ul class="return">
|
|
687
|
+
|
|
688
|
+
<li>
|
|
689
|
+
|
|
690
|
+
|
|
691
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
|
692
|
+
|
|
693
|
+
|
|
694
|
+
|
|
695
|
+
—
|
|
696
|
+
<div class='inline'>
|
|
697
|
+
<p>http_code HTTP code for API call</p>
|
|
698
|
+
</div>
|
|
699
|
+
|
|
700
|
+
</li>
|
|
701
|
+
|
|
702
|
+
</ul>
|
|
703
|
+
|
|
704
|
+
</div><table class="source_code">
|
|
705
|
+
<tr>
|
|
706
|
+
<td>
|
|
707
|
+
<pre class="lines">
|
|
708
|
+
|
|
709
|
+
|
|
710
|
+
52
|
|
711
|
+
53
|
|
712
|
+
54</pre>
|
|
713
|
+
</td>
|
|
714
|
+
<td>
|
|
715
|
+
<pre class="code"><span class="info file"># File 'lib/devices.rb', line 52</span>
|
|
716
|
+
|
|
717
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_remove_device_from_network'>remove_device_from_network</span><span class='lparen'>(</span><span class='id identifier rubyid_network_id'>network_id</span><span class='comma'>,</span> <span class='id identifier rubyid_device_serial'>device_serial</span><span class='rparen'>)</span>
|
|
718
|
+
<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'>/devices/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_device_serial'>device_serial</span><span class='embexpr_end'>}</span><span class='tstring_content'>/remove</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>POST</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
|
719
|
+
<span class='kw'>end</span></pre>
|
|
720
|
+
</td>
|
|
721
|
+
</tr>
|
|
722
|
+
</table>
|
|
723
|
+
</div>
|
|
724
|
+
|
|
725
|
+
<div class="method_details ">
|
|
726
|
+
<h3 class="signature " id="update_device_attributes-instance_method">
|
|
727
|
+
|
|
728
|
+
#<strong>update_device_attributes</strong>(network_id, device_serial, options) ⇒ <tt>Hash</tt>
|
|
729
|
+
|
|
730
|
+
|
|
731
|
+
|
|
732
|
+
|
|
733
|
+
|
|
734
|
+
</h3><div class="docstring">
|
|
735
|
+
<div class="discussion">
|
|
736
|
+
|
|
737
|
+
<p>Update a single devices attributes</p>
|
|
738
|
+
|
|
739
|
+
|
|
740
|
+
</div>
|
|
741
|
+
</div>
|
|
742
|
+
<div class="tags">
|
|
743
|
+
<p class="tag_title">Parameters:</p>
|
|
744
|
+
<ul class="param">
|
|
745
|
+
|
|
746
|
+
<li>
|
|
747
|
+
|
|
748
|
+
<span class='name'>network_id</span>
|
|
749
|
+
|
|
750
|
+
|
|
751
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
752
|
+
|
|
753
|
+
|
|
754
|
+
|
|
755
|
+
—
|
|
756
|
+
<div class='inline'>
|
|
757
|
+
<p>dashboard network id where the device exists</p>
|
|
758
|
+
</div>
|
|
759
|
+
|
|
760
|
+
</li>
|
|
761
|
+
|
|
762
|
+
<li>
|
|
763
|
+
|
|
764
|
+
<span class='name'>device_serial</span>
|
|
765
|
+
|
|
766
|
+
|
|
767
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
768
|
+
|
|
769
|
+
|
|
770
|
+
|
|
771
|
+
—
|
|
772
|
+
<div class='inline'>
|
|
773
|
+
<p>meraki serial number of the device you want to modify</p>
|
|
774
|
+
</div>
|
|
775
|
+
|
|
776
|
+
</li>
|
|
777
|
+
|
|
778
|
+
<li>
|
|
779
|
+
|
|
780
|
+
<span class='name'>options</span>
|
|
781
|
+
|
|
782
|
+
|
|
783
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
784
|
+
|
|
785
|
+
|
|
786
|
+
|
|
787
|
+
—
|
|
788
|
+
<div class='inline'>
|
|
789
|
+
<p>hash containing the attributes you want to modify. such as name, tags,
|
|
790
|
+
longitude, latitude. A full list is found on the official Meraki API Docs</p>
|
|
791
|
+
</div>
|
|
792
|
+
|
|
793
|
+
</li>
|
|
794
|
+
|
|
795
|
+
</ul>
|
|
796
|
+
|
|
797
|
+
<p class="tag_title">Returns:</p>
|
|
798
|
+
<ul class="return">
|
|
799
|
+
|
|
800
|
+
<li>
|
|
801
|
+
|
|
802
|
+
|
|
803
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
804
|
+
|
|
805
|
+
|
|
806
|
+
|
|
807
|
+
—
|
|
808
|
+
<div class='inline'>
|
|
809
|
+
<p>a hash containing the devices new attribute set</p>
|
|
810
|
+
</div>
|
|
811
|
+
|
|
812
|
+
</li>
|
|
813
|
+
|
|
814
|
+
</ul>
|
|
815
|
+
|
|
816
|
+
</div><table class="source_code">
|
|
817
|
+
<tr>
|
|
818
|
+
<td>
|
|
819
|
+
<pre class="lines">
|
|
820
|
+
|
|
821
|
+
|
|
822
|
+
32
|
|
823
|
+
33
|
|
824
|
+
34
|
|
825
|
+
35
|
|
826
|
+
36</pre>
|
|
827
|
+
</td>
|
|
828
|
+
<td>
|
|
829
|
+
<pre class="code"><span class="info file"># File 'lib/devices.rb', line 32</span>
|
|
830
|
+
|
|
831
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_update_device_attributes'>update_device_attributes</span><span class='lparen'>(</span><span class='id identifier rubyid_network_id'>network_id</span><span class='comma'>,</span> <span class='id identifier rubyid_device_serial'>device_serial</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
|
832
|
+
<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>
|
|
833
|
+
<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>
|
|
834
|
+
<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'>/devices/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_device_serial'>device_serial</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>
|
|
835
|
+
<span class='kw'>end</span></pre>
|
|
836
|
+
</td>
|
|
837
|
+
</tr>
|
|
838
|
+
</table>
|
|
839
|
+
</div>
|
|
840
|
+
|
|
841
|
+
</div>
|
|
842
|
+
|
|
843
|
+
</div>
|
|
844
|
+
|
|
845
|
+
<div id="footer">
|
|
846
|
+
Generated on Tue Nov 15 21:16:06 2016 by
|
|
847
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
848
|
+
0.9.5 (ruby-2.3.0).
|
|
849
|
+
</div>
|
|
850
|
+
|
|
851
|
+
</div>
|
|
852
|
+
</body>
|
|
853
|
+
</html>
|