dashboard-api 0.4.0 → 0.9.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (30) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +3 -2
  3. data/doc/Admins.html +604 -0
  4. data/doc/Clients.html +1 -1
  5. data/doc/DashboardAPI.html +80 -23
  6. data/doc/DashboardAPIVersion.html +2 -2
  7. data/doc/Devices.html +1 -1
  8. data/doc/Networks.html +338 -2
  9. data/doc/Organizations.html +1 -1
  10. data/doc/Phones.html +642 -0
  11. data/doc/SAML.html +759 -0
  12. data/doc/SSIDs.html +1 -1
  13. data/doc/Switchports.html +1 -1
  14. data/doc/Templates.html +379 -0
  15. data/doc/VLANs.html +763 -0
  16. data/doc/_index.html +61 -1
  17. data/doc/class_list.html +1 -1
  18. data/doc/file.README.html +11 -6
  19. data/doc/index.html +11 -6
  20. data/doc/method_list.html +200 -16
  21. data/doc/top-level-namespace.html +2 -2
  22. data/lib/admins.rb +37 -0
  23. data/lib/dashboard-api.rb +11 -0
  24. data/lib/dashboard-api/version.rb +1 -1
  25. data/lib/networks.rb +29 -0
  26. data/lib/phones.rb +40 -0
  27. data/lib/saml.rb +47 -0
  28. data/lib/templates.rb +18 -0
  29. data/lib/vlans.rb +49 -0
  30. metadata +12 -2
data/doc/SSIDs.html CHANGED
@@ -514,7 +514,7 @@ authMode, encryptionMode and psk</p>
514
514
  </div>
515
515
 
516
516
  <div id="footer">
517
- Generated on Tue Nov 15 22:02:45 2016 by
517
+ Generated on Wed Nov 16 21:55:08 2016 by
518
518
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
519
519
  0.9.5 (ruby-2.3.0).
520
520
  </div>
data/doc/Switchports.html CHANGED
@@ -517,7 +517,7 @@ official Meraki Dashboard API documentation.</p>
517
517
  </div>
518
518
 
519
519
  <div id="footer">
520
- Generated on Tue Nov 15 22:02:45 2016 by
520
+ Generated on Wed Nov 16 21:55:08 2016 by
521
521
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
522
522
  0.9.5 (ruby-2.3.0).
523
523
  </div>
data/doc/Templates.html ADDED
@@ -0,0 +1,379 @@
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: Templates
8
+
9
+ &mdash; 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 = "Templates";
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 (T)</a> &raquo;
40
+
41
+
42
+ <span class="title">Templates</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: Templates
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/templates.rb</dd>
89
+ </dl>
90
+
91
+ </div>
92
+
93
+ <h2>Overview</h2><div class="docstring">
94
+ <div class="discussion">
95
+
96
+ <p>Templates section of the Meraki Dashboard API</p>
97
+
98
+
99
+ </div>
100
+ </div>
101
+ <div class="tags">
102
+
103
+ <p class="tag_title">Author:</p>
104
+ <ul class="author">
105
+
106
+ <li>
107
+
108
+
109
+
110
+
111
+
112
+ <div class='inline'>
113
+ <p>Joe Letizia</p>
114
+ </div>
115
+
116
+ </li>
117
+
118
+ </ul>
119
+
120
+ </div>
121
+
122
+
123
+
124
+
125
+
126
+
127
+
128
+ <h2>
129
+ Instance Method Summary
130
+ <small><a href="#" class="summary_toggle">collapse</a></small>
131
+ </h2>
132
+
133
+ <ul class="summary">
134
+
135
+ <li class="public ">
136
+ <span class="summary_signature">
137
+
138
+ <a href="#list_templates-instance_method" title="#list_templates (instance method)">#<strong>list_templates</strong>(org_id) &#x21d2; Array </a>
139
+
140
+
141
+
142
+ </span>
143
+
144
+
145
+
146
+
147
+
148
+
149
+
150
+
151
+
152
+ <span class="summary_desc"><div class='inline'>
153
+ <p>Return a list of all templates for a specific organization.</p>
154
+ </div></span>
155
+
156
+ </li>
157
+
158
+
159
+ <li class="public ">
160
+ <span class="summary_signature">
161
+
162
+ <a href="#remove_template-instance_method" title="#remove_template (instance method)">#<strong>remove_template</strong>(org_id, template_id) &#x21d2; Integer </a>
163
+
164
+
165
+
166
+ </span>
167
+
168
+
169
+
170
+
171
+
172
+
173
+
174
+
175
+
176
+ <span class="summary_desc"><div class='inline'>
177
+ <p>Remove a single configuration template.</p>
178
+ </div></span>
179
+
180
+ </li>
181
+
182
+
183
+ </ul>
184
+
185
+
186
+
187
+
188
+ <div id="instance_method_details" class="method_details_list">
189
+ <h2>Instance Method Details</h2>
190
+
191
+
192
+ <div class="method_details first">
193
+ <h3 class="signature first" id="list_templates-instance_method">
194
+
195
+ #<strong>list_templates</strong>(org_id) &#x21d2; <tt>Array</tt>
196
+
197
+
198
+
199
+
200
+
201
+ </h3><div class="docstring">
202
+ <div class="discussion">
203
+
204
+ <p>Return a list of all templates for a specific organization</p>
205
+
206
+
207
+ </div>
208
+ </div>
209
+ <div class="tags">
210
+ <p class="tag_title">Parameters:</p>
211
+ <ul class="param">
212
+
213
+ <li>
214
+
215
+ <span class='name'>org_id</span>
216
+
217
+
218
+ <span class='type'>(<tt>String</tt>)</span>
219
+
220
+
221
+
222
+ &mdash;
223
+ <div class='inline'>
224
+ <p>organization ID where that we want to list all of the templates from</p>
225
+ </div>
226
+
227
+ </li>
228
+
229
+ </ul>
230
+
231
+ <p class="tag_title">Returns:</p>
232
+ <ul class="return">
233
+
234
+ <li>
235
+
236
+
237
+ <span class='type'>(<tt>Array</tt>)</span>
238
+
239
+
240
+
241
+ &mdash;
242
+ <div class='inline'>
243
+ <p>an array of hashes containing the attributes for all configuration
244
+ templates</p>
245
+ </div>
246
+
247
+ </li>
248
+
249
+ </ul>
250
+
251
+ </div><table class="source_code">
252
+ <tr>
253
+ <td>
254
+ <pre class="lines">
255
+
256
+
257
+ 7
258
+ 8
259
+ 9</pre>
260
+ </td>
261
+ <td>
262
+ <pre class="code"><span class="info file"># File 'lib/templates.rb', line 7</span>
263
+
264
+ <span class='kw'>def</span> <span class='id identifier rubyid_list_templates'>list_templates</span><span class='lparen'>(</span><span class='id identifier rubyid_org_id'>org_id</span><span class='rparen'>)</span>
265
+ <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'>&quot;</span><span class='tstring_content'>/organizations/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_org_id'>org_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/configTemplates</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>GET</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
266
+ <span class='kw'>end</span></pre>
267
+ </td>
268
+ </tr>
269
+ </table>
270
+ </div>
271
+
272
+ <div class="method_details ">
273
+ <h3 class="signature " id="remove_template-instance_method">
274
+
275
+ #<strong>remove_template</strong>(org_id, template_id) &#x21d2; <tt>Integer</tt>
276
+
277
+
278
+
279
+
280
+
281
+ </h3><div class="docstring">
282
+ <div class="discussion">
283
+
284
+ <p>Remove a single configuration template</p>
285
+
286
+
287
+ </div>
288
+ </div>
289
+ <div class="tags">
290
+ <p class="tag_title">Parameters:</p>
291
+ <ul class="param">
292
+
293
+ <li>
294
+
295
+ <span class='name'>org_id</span>
296
+
297
+
298
+ <span class='type'>(<tt>String</tt>)</span>
299
+
300
+
301
+
302
+ &mdash;
303
+ <div class='inline'>
304
+ <p>organization ID where that we want to remove the templates from</p>
305
+ </div>
306
+
307
+ </li>
308
+
309
+ <li>
310
+
311
+ <span class='name'>template_id</span>
312
+
313
+
314
+ <span class='type'>(<tt>String</tt>)</span>
315
+
316
+
317
+
318
+ &mdash;
319
+ <div class='inline'>
320
+ <p>the template ID we want to delete</p>
321
+ </div>
322
+
323
+ </li>
324
+
325
+ </ul>
326
+
327
+ <p class="tag_title">Returns:</p>
328
+ <ul class="return">
329
+
330
+ <li>
331
+
332
+
333
+ <span class='type'>(<tt>Integer</tt>)</span>
334
+
335
+
336
+
337
+ &mdash;
338
+ <div class='inline'>
339
+ <p>HTTP code</p>
340
+ </div>
341
+
342
+ </li>
343
+
344
+ </ul>
345
+
346
+ </div><table class="source_code">
347
+ <tr>
348
+ <td>
349
+ <pre class="lines">
350
+
351
+
352
+ 15
353
+ 16
354
+ 17</pre>
355
+ </td>
356
+ <td>
357
+ <pre class="code"><span class="info file"># File 'lib/templates.rb', line 15</span>
358
+
359
+ <span class='kw'>def</span> <span class='id identifier rubyid_remove_template'>remove_template</span><span class='lparen'>(</span><span class='id identifier rubyid_org_id'>org_id</span><span class='comma'>,</span> <span class='id identifier rubyid_template_id'>template_id</span><span class='rparen'>)</span>
360
+ <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'>&quot;</span><span class='tstring_content'>/organizations/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_org_id'>org_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/configTemplates/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_template_id'>template_id</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>DELETE</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
361
+ <span class='kw'>end</span></pre>
362
+ </td>
363
+ </tr>
364
+ </table>
365
+ </div>
366
+
367
+ </div>
368
+
369
+ </div>
370
+
371
+ <div id="footer">
372
+ Generated on Wed Nov 16 21:55:08 2016 by
373
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
374
+ 0.9.5 (ruby-2.3.0).
375
+ </div>
376
+
377
+ </div>
378
+ </body>
379
+ </html>
data/doc/VLANs.html ADDED
@@ -0,0 +1,763 @@
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: VLANs
8
+
9
+ &mdash; 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 = "VLANs";
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 (V)</a> &raquo;
40
+
41
+
42
+ <span class="title">VLANs</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: VLANs
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/vlans.rb</dd>
89
+ </dl>
90
+
91
+ </div>
92
+
93
+ <h2>Overview</h2><div class="docstring">
94
+ <div class="discussion">
95
+
96
+ <p>VLANs section of the Meraki Dashboard API</p>
97
+
98
+
99
+ </div>
100
+ </div>
101
+ <div class="tags">
102
+
103
+ <p class="tag_title">Author:</p>
104
+ <ul class="author">
105
+
106
+ <li>
107
+
108
+
109
+
110
+
111
+
112
+ <div class='inline'>
113
+ <p>Joe Letizia</p>
114
+ </div>
115
+
116
+ </li>
117
+
118
+ </ul>
119
+
120
+ </div>
121
+
122
+
123
+
124
+
125
+
126
+
127
+
128
+ <h2>
129
+ Instance Method Summary
130
+ <small><a href="#" class="summary_toggle">collapse</a></small>
131
+ </h2>
132
+
133
+ <ul class="summary">
134
+
135
+ <li class="public ">
136
+ <span class="summary_signature">
137
+
138
+ <a href="#add_vlan-instance_method" title="#add_vlan (instance method)">#<strong>add_vlan</strong>(network_id, options) &#x21d2; Hash </a>
139
+
140
+
141
+
142
+ </span>
143
+
144
+
145
+
146
+
147
+
148
+
149
+
150
+
151
+
152
+ <span class="summary_desc"><div class='inline'>
153
+ <p>Add a single VLAN to a network.</p>
154
+ </div></span>
155
+
156
+ </li>
157
+
158
+
159
+ <li class="public ">
160
+ <span class="summary_signature">
161
+
162
+ <a href="#delete_vlan-instance_method" title="#delete_vlan (instance method)">#<strong>delete_vlan</strong>(network_id, vlan_id) &#x21d2; Integer </a>
163
+
164
+
165
+
166
+ </span>
167
+
168
+
169
+
170
+
171
+
172
+
173
+
174
+
175
+
176
+ <span class="summary_desc"><div class='inline'>
177
+ <p>Delete a single vlan.</p>
178
+ </div></span>
179
+
180
+ </li>
181
+
182
+
183
+ <li class="public ">
184
+ <span class="summary_signature">
185
+
186
+ <a href="#list_vlans-instance_method" title="#list_vlans (instance method)">#<strong>list_vlans</strong>(network_id) &#x21d2; Array </a>
187
+
188
+
189
+
190
+ </span>
191
+
192
+
193
+
194
+
195
+
196
+
197
+
198
+
199
+
200
+ <span class="summary_desc"><div class='inline'>
201
+ <p>Returns a list of the configured VLANs in a Dashboard network.</p>
202
+ </div></span>
203
+
204
+ </li>
205
+
206
+
207
+ <li class="public ">
208
+ <span class="summary_signature">
209
+
210
+ <a href="#return_vlan-instance_method" title="#return_vlan (instance method)">#<strong>return_vlan</strong>(network_id, vlan_id) &#x21d2; Hash </a>
211
+
212
+
213
+
214
+ </span>
215
+
216
+
217
+
218
+
219
+
220
+
221
+
222
+
223
+
224
+ <span class="summary_desc"><div class='inline'>
225
+ <p>Return a single configured VLAN for a network.</p>
226
+ </div></span>
227
+
228
+ </li>
229
+
230
+
231
+ <li class="public ">
232
+ <span class="summary_signature">
233
+
234
+ <a href="#update_vlan-instance_method" title="#update_vlan (instance method)">#<strong>update_vlan</strong>(network_id, vlan_id, options) &#x21d2; Hash </a>
235
+
236
+
237
+
238
+ </span>
239
+
240
+
241
+
242
+
243
+
244
+
245
+
246
+
247
+
248
+ <span class="summary_desc"><div class='inline'>
249
+ <p>Update the attributes for a single VLAN.</p>
250
+ </div></span>
251
+
252
+ </li>
253
+
254
+
255
+ </ul>
256
+
257
+
258
+
259
+
260
+ <div id="instance_method_details" class="method_details_list">
261
+ <h2>Instance Method Details</h2>
262
+
263
+
264
+ <div class="method_details first">
265
+ <h3 class="signature first" id="add_vlan-instance_method">
266
+
267
+ #<strong>add_vlan</strong>(network_id, options) &#x21d2; <tt>Hash</tt>
268
+
269
+
270
+
271
+
272
+
273
+ </h3><div class="docstring">
274
+ <div class="discussion">
275
+
276
+ <p>Add a single VLAN to a network</p>
277
+
278
+
279
+ </div>
280
+ </div>
281
+ <div class="tags">
282
+ <p class="tag_title">Parameters:</p>
283
+ <ul class="param">
284
+
285
+ <li>
286
+
287
+ <span class='name'>network_id</span>
288
+
289
+
290
+ <span class='type'>(<tt>String</tt>)</span>
291
+
292
+
293
+
294
+ &mdash;
295
+ <div class='inline'>
296
+ <p>the network you want to add a VLAN to</p>
297
+ </div>
298
+
299
+ </li>
300
+
301
+ <li>
302
+
303
+ <span class='name'>options</span>
304
+
305
+
306
+ <span class='type'>(<tt>Hash</tt>)</span>
307
+
308
+
309
+
310
+ &mdash;
311
+ <div class='inline'>
312
+ <p>a hash containing the attributes of id, name, subnet and applianceIp
313
+ additional details on these can be found in the official Meraki API
314
+ Documentation</p>
315
+ </div>
316
+
317
+ </li>
318
+
319
+ </ul>
320
+
321
+ <p class="tag_title">Returns:</p>
322
+ <ul class="return">
323
+
324
+ <li>
325
+
326
+
327
+ <span class='type'>(<tt>Hash</tt>)</span>
328
+
329
+
330
+
331
+ &mdash;
332
+ <div class='inline'>
333
+ <p>the attributes of the newly created vlan</p>
334
+ </div>
335
+
336
+ </li>
337
+
338
+ </ul>
339
+
340
+ </div><table class="source_code">
341
+ <tr>
342
+ <td>
343
+ <pre class="lines">
344
+
345
+
346
+ 24
347
+ 25
348
+ 26
349
+ 27
350
+ 28</pre>
351
+ </td>
352
+ <td>
353
+ <pre class="code"><span class="info file"># File 'lib/vlans.rb', line 24</span>
354
+
355
+ <span class='kw'>def</span> <span class='id identifier rubyid_add_vlan'>add_vlan</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>
356
+ <span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Options were not passed as a Hash</span><span class='tstring_end'>&#39;</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>
357
+ <span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='symbol'>:body</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_options'>options</span><span class='rbrace'>}</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'>&quot;</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'>/vlans</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>POST</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</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="delete_vlan-instance_method">
367
+
368
+ #<strong>delete_vlan</strong>(network_id, vlan_id) &#x21d2; <tt>Integer</tt>
369
+
370
+
371
+
372
+
373
+
374
+ </h3><div class="docstring">
375
+ <div class="discussion">
376
+
377
+ <p>Delete a single vlan</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
+ &mdash;
396
+ <div class='inline'>
397
+ <p>the Network ID for the VLAN you want to delete</p>
398
+ </div>
399
+
400
+ </li>
401
+
402
+ <li>
403
+
404
+ <span class='name'>vlan_id</span>
405
+
406
+
407
+ <span class='type'>(<tt>Integer</tt>)</span>
408
+
409
+
410
+
411
+ &mdash;
412
+ <div class='inline'>
413
+ <p>the VLAN ID you want to delete</p>
414
+ </div>
415
+
416
+ </li>
417
+
418
+ </ul>
419
+
420
+ <p class="tag_title">Returns:</p>
421
+ <ul class="return">
422
+
423
+ <li>
424
+
425
+
426
+ <span class='type'>(<tt>Integer</tt>)</span>
427
+
428
+
429
+
430
+ &mdash;
431
+ <div class='inline'>
432
+ <p>code HTTP return code</p>
433
+ </div>
434
+
435
+ </li>
436
+
437
+ </ul>
438
+
439
+ </div><table class="source_code">
440
+ <tr>
441
+ <td>
442
+ <pre class="lines">
443
+
444
+
445
+ 46
446
+ 47
447
+ 48</pre>
448
+ </td>
449
+ <td>
450
+ <pre class="code"><span class="info file"># File 'lib/vlans.rb', line 46</span>
451
+
452
+ <span class='kw'>def</span> <span class='id identifier rubyid_delete_vlan'>delete_vlan</span><span class='lparen'>(</span><span class='id identifier rubyid_network_id'>network_id</span><span class='comma'>,</span> <span class='id identifier rubyid_vlan_id'>vlan_id</span><span class='rparen'>)</span>
453
+ <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'>&quot;</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'>/vlans/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_vlan_id'>vlan_id</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>DELETE</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
454
+ <span class='kw'>end</span></pre>
455
+ </td>
456
+ </tr>
457
+ </table>
458
+ </div>
459
+
460
+ <div class="method_details ">
461
+ <h3 class="signature " id="list_vlans-instance_method">
462
+
463
+ #<strong>list_vlans</strong>(network_id) &#x21d2; <tt>Array</tt>
464
+
465
+
466
+
467
+
468
+
469
+ </h3><div class="docstring">
470
+ <div class="discussion">
471
+
472
+ <p>Returns a list of the configured VLANs in a Dashboard network</p>
473
+
474
+
475
+ </div>
476
+ </div>
477
+ <div class="tags">
478
+ <p class="tag_title">Parameters:</p>
479
+ <ul class="param">
480
+
481
+ <li>
482
+
483
+ <span class='name'>network_id</span>
484
+
485
+
486
+ <span class='type'>(<tt>String</tt>)</span>
487
+
488
+
489
+
490
+ &mdash;
491
+ <div class='inline'>
492
+ <p>the network ID you want the VLANs for</p>
493
+ </div>
494
+
495
+ </li>
496
+
497
+ </ul>
498
+
499
+ <p class="tag_title">Returns:</p>
500
+ <ul class="return">
501
+
502
+ <li>
503
+
504
+
505
+ <span class='type'>(<tt>Array</tt>)</span>
506
+
507
+
508
+
509
+ &mdash;
510
+ <div class='inline'>
511
+ <p>an array of hashes containing each VLAN and it&#39;s attributes</p>
512
+ </div>
513
+
514
+ </li>
515
+
516
+ </ul>
517
+
518
+ </div><table class="source_code">
519
+ <tr>
520
+ <td>
521
+ <pre class="lines">
522
+
523
+
524
+ 7
525
+ 8
526
+ 9</pre>
527
+ </td>
528
+ <td>
529
+ <pre class="code"><span class="info file"># File 'lib/vlans.rb', line 7</span>
530
+
531
+ <span class='kw'>def</span> <span class='id identifier rubyid_list_vlans'>list_vlans</span><span class='lparen'>(</span><span class='id identifier rubyid_network_id'>network_id</span><span class='rparen'>)</span>
532
+ <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'>&quot;</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'>/vlans</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>GET</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
533
+ <span class='kw'>end</span></pre>
534
+ </td>
535
+ </tr>
536
+ </table>
537
+ </div>
538
+
539
+ <div class="method_details ">
540
+ <h3 class="signature " id="return_vlan-instance_method">
541
+
542
+ #<strong>return_vlan</strong>(network_id, vlan_id) &#x21d2; <tt>Hash</tt>
543
+
544
+
545
+
546
+
547
+
548
+ </h3><div class="docstring">
549
+ <div class="discussion">
550
+
551
+ <p>Return a single configured VLAN for a network</p>
552
+
553
+
554
+ </div>
555
+ </div>
556
+ <div class="tags">
557
+ <p class="tag_title">Parameters:</p>
558
+ <ul class="param">
559
+
560
+ <li>
561
+
562
+ <span class='name'>network_id</span>
563
+
564
+
565
+ <span class='type'>(<tt>String</tt>)</span>
566
+
567
+
568
+
569
+ &mdash;
570
+ <div class='inline'>
571
+ <p>the network ID the VLAN exists in</p>
572
+ </div>
573
+
574
+ </li>
575
+
576
+ <li>
577
+
578
+ <span class='name'>vlan_id</span>
579
+
580
+
581
+ <span class='type'>(<tt>Integer</tt>)</span>
582
+
583
+
584
+
585
+ &mdash;
586
+ <div class='inline'>
587
+ <p>the VLAN ID you want the attributes for</p>
588
+ </div>
589
+
590
+ </li>
591
+
592
+ </ul>
593
+
594
+ <p class="tag_title">Returns:</p>
595
+ <ul class="return">
596
+
597
+ <li>
598
+
599
+
600
+ <span class='type'>(<tt>Hash</tt>)</span>
601
+
602
+
603
+
604
+ &mdash;
605
+ <div class='inline'>
606
+ <p>a hash of the VLAN&#39;s attributes</p>
607
+ </div>
608
+
609
+ </li>
610
+
611
+ </ul>
612
+
613
+ </div><table class="source_code">
614
+ <tr>
615
+ <td>
616
+ <pre class="lines">
617
+
618
+
619
+ 15
620
+ 16
621
+ 17</pre>
622
+ </td>
623
+ <td>
624
+ <pre class="code"><span class="info file"># File 'lib/vlans.rb', line 15</span>
625
+
626
+ <span class='kw'>def</span> <span class='id identifier rubyid_return_vlan'>return_vlan</span><span class='lparen'>(</span><span class='id identifier rubyid_network_id'>network_id</span><span class='comma'>,</span> <span class='id identifier rubyid_vlan_id'>vlan_id</span><span class='rparen'>)</span>
627
+ <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'>&quot;</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'>/vlans/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_vlan_id'>vlan_id</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>GET</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
628
+ <span class='kw'>end</span></pre>
629
+ </td>
630
+ </tr>
631
+ </table>
632
+ </div>
633
+
634
+ <div class="method_details ">
635
+ <h3 class="signature " id="update_vlan-instance_method">
636
+
637
+ #<strong>update_vlan</strong>(network_id, vlan_id, options) &#x21d2; <tt>Hash</tt>
638
+
639
+
640
+
641
+
642
+
643
+ </h3><div class="docstring">
644
+ <div class="discussion">
645
+
646
+ <p>Update the attributes for a single VLAN</p>
647
+
648
+
649
+ </div>
650
+ </div>
651
+ <div class="tags">
652
+ <p class="tag_title">Parameters:</p>
653
+ <ul class="param">
654
+
655
+ <li>
656
+
657
+ <span class='name'>network_id</span>
658
+
659
+
660
+ <span class='type'>(<tt>String</tt>)</span>
661
+
662
+
663
+
664
+ &mdash;
665
+ <div class='inline'>
666
+ <p>the network ID for the VLAN you want to update</p>
667
+ </div>
668
+
669
+ </li>
670
+
671
+ <li>
672
+
673
+ <span class='name'>vlan_id</span>
674
+
675
+
676
+ <span class='type'>(<tt>Integer</tt>)</span>
677
+
678
+
679
+
680
+ &mdash;
681
+ <div class='inline'>
682
+ <p>the VLAN ID you want to update</p>
683
+ </div>
684
+
685
+ </li>
686
+
687
+ <li>
688
+
689
+ <span class='name'>options</span>
690
+
691
+
692
+ <span class='type'>(<tt>Hash</tt>)</span>
693
+
694
+
695
+
696
+ &mdash;
697
+ <div class='inline'>
698
+ <p>a hash containing the attributes of name, subnet and applianceIp.
699
+ additional details on these can be found in the official Meraki API
700
+ Documentation</p>
701
+ </div>
702
+
703
+ </li>
704
+
705
+ </ul>
706
+
707
+ <p class="tag_title">Returns:</p>
708
+ <ul class="return">
709
+
710
+ <li>
711
+
712
+
713
+ <span class='type'>(<tt>Hash</tt>)</span>
714
+
715
+
716
+
717
+ &mdash;
718
+ <div class='inline'>
719
+ <p>the updated attributes for the VLAN</p>
720
+ </div>
721
+
722
+ </li>
723
+
724
+ </ul>
725
+
726
+ </div><table class="source_code">
727
+ <tr>
728
+ <td>
729
+ <pre class="lines">
730
+
731
+
732
+ 36
733
+ 37
734
+ 38
735
+ 39
736
+ 40</pre>
737
+ </td>
738
+ <td>
739
+ <pre class="code"><span class="info file"># File 'lib/vlans.rb', line 36</span>
740
+
741
+ <span class='kw'>def</span> <span class='id identifier rubyid_update_vlan'>update_vlan</span><span class='lparen'>(</span><span class='id identifier rubyid_network_id'>network_id</span><span class='comma'>,</span> <span class='id identifier rubyid_vlan_id'>vlan_id</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
742
+ <span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Options were not passed as a Hash</span><span class='tstring_end'>&#39;</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>
743
+ <span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='symbol'>:body</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_options'>options</span><span class='rbrace'>}</span>
744
+ <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'>&quot;</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'>/vlans/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_vlan_id'>vlan_id</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>PUT</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
745
+ <span class='kw'>end</span></pre>
746
+ </td>
747
+ </tr>
748
+ </table>
749
+ </div>
750
+
751
+ </div>
752
+
753
+ </div>
754
+
755
+ <div id="footer">
756
+ Generated on Wed Nov 16 21:55:08 2016 by
757
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
758
+ 0.9.5 (ruby-2.3.0).
759
+ </div>
760
+
761
+ </div>
762
+ </body>
763
+ </html>