dashboard-api 1.0.0 → 1.0.1
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 +4 -4
- data/.codeclimate.yml +34 -0
- data/.gitignore +5 -4
- data/.travis.yml +20 -0
- data/Gemfile +9 -5
- data/Gemfile.lock +63 -31
- data/README.md +134 -138
- data/Rakefile +9 -7
- data/dashboard-api.gemspec +28 -28
- data/doc/Admins.html +603 -603
- data/doc/Clients.html +276 -276
- data/doc/DashboardAPI.html +603 -603
- data/doc/DashboardAPIVersion.html +159 -159
- data/doc/Devices.html +879 -879
- data/doc/Networks.html +1382 -1382
- data/doc/Organizations.html +1477 -1477
- data/doc/Phones.html +641 -641
- data/doc/SAML.html +758 -758
- data/doc/SSIDs.html +523 -523
- data/doc/Switchports.html +526 -526
- data/doc/Templates.html +378 -378
- data/doc/VLANs.html +762 -762
- data/doc/_index.html +235 -235
- data/doc/class_list.html +51 -51
- data/doc/css/full_list.css +58 -58
- data/doc/css/style.css +481 -481
- data/doc/file.README.html +248 -248
- data/doc/file_list.html +56 -56
- data/doc/frames.html +17 -17
- data/doc/index.html +248 -248
- data/doc/js/app.js +243 -243
- data/doc/js/full_list.js +216 -216
- data/doc/js/jquery.js +3 -3
- data/doc/method_list.html +523 -523
- data/doc/top-level-namespace.html +113 -113
- data/lib/admins.rb +37 -37
- data/lib/clients.rb +12 -12
- data/lib/dashboard-api.rb +82 -83
- data/lib/dashboard-api/version.rb +6 -6
- data/lib/devices.rb +57 -57
- data/lib/networks.rb +108 -108
- data/lib/organizations.rb +110 -115
- data/lib/phones.rb +40 -40
- data/lib/saml.rb +47 -47
- data/lib/ssids.rb +33 -33
- data/lib/switchports.rb +33 -33
- data/lib/templates.rb +18 -18
- data/lib/vlans.rb +49 -49
- metadata +7 -5
data/doc/Networks.html
CHANGED
|
@@ -1,1383 +1,1383 @@
|
|
|
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: Networks
|
|
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 = "Networks";
|
|
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 (N)</a> »
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
<span class="title">Networks</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: Networks
|
|
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/networks.rb</dd>
|
|
89
|
-
</dl>
|
|
90
|
-
|
|
91
|
-
</div>
|
|
92
|
-
|
|
93
|
-
<h2>Overview</h2><div class="docstring">
|
|
94
|
-
<div class="discussion">
|
|
95
|
-
|
|
96
|
-
<p>Networks 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="#bind_network_to_template-instance_method" title="#bind_network_to_template (instance method)">#<strong>bind_network_to_template</strong>(network_id, options) ⇒ Integer </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>Bind a single network to a configuration template.</p>
|
|
154
|
-
</div></span>
|
|
155
|
-
|
|
156
|
-
</li>
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
<li class="public ">
|
|
160
|
-
<span class="summary_signature">
|
|
161
|
-
|
|
162
|
-
<a href="#create_network-instance_method" title="#create_network (instance method)">#<strong>create_network</strong>(org_id, options) ⇒ Hash </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>Create a new Dashboard network.</p>
|
|
178
|
-
</div></span>
|
|
179
|
-
|
|
180
|
-
</li>
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
<li class="public ">
|
|
184
|
-
<span class="summary_signature">
|
|
185
|
-
|
|
186
|
-
<a href="#delete_network-instance_method" title="#delete_network (instance method)">#<strong>delete_network</strong>(network_id) ⇒ Bool </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>Delete an existing Dashboard network.</p>
|
|
202
|
-
</div></span>
|
|
203
|
-
|
|
204
|
-
</li>
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
<li class="public ">
|
|
208
|
-
<span class="summary_signature">
|
|
209
|
-
|
|
210
|
-
<a href="#get_auto_vpn_settings-instance_method" title="#get_auto_vpn_settings (instance method)">#<strong>get_auto_vpn_settings</strong>(network_id) ⇒ 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>Get AutoVPN settings for a specific network.</p>
|
|
226
|
-
</div></span>
|
|
227
|
-
|
|
228
|
-
</li>
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
<li class="public ">
|
|
232
|
-
<span class="summary_signature">
|
|
233
|
-
|
|
234
|
-
<a href="#get_ms_access_policies-instance_method" title="#get_ms_access_policies (instance method)">#<strong>get_ms_access_policies</strong>(network_id) ⇒ Array </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>Get all MS access policies configured for a specific Dashboard network.</p>
|
|
250
|
-
</div></span>
|
|
251
|
-
|
|
252
|
-
</li>
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
<li class="public ">
|
|
256
|
-
<span class="summary_signature">
|
|
257
|
-
|
|
258
|
-
<a href="#get_networks-instance_method" title="#get_networks (instance method)">#<strong>get_networks</strong>(org_id) ⇒ Array </a>
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
</span>
|
|
263
|
-
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
<span class="summary_desc"><div class='inline'>
|
|
273
|
-
<p>Returns the list of networks for a given organization.</p>
|
|
274
|
-
</div></span>
|
|
275
|
-
|
|
276
|
-
</li>
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
<li class="public ">
|
|
280
|
-
<span class="summary_signature">
|
|
281
|
-
|
|
282
|
-
<a href="#get_single_network-instance_method" title="#get_single_network (instance method)">#<strong>get_single_network</strong>(network_id) ⇒ Hash </a>
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
</span>
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
<span class="summary_desc"><div class='inline'>
|
|
297
|
-
<p>Returns the network details for a single network.</p>
|
|
298
|
-
</div></span>
|
|
299
|
-
|
|
300
|
-
</li>
|
|
301
|
-
|
|
302
|
-
|
|
303
|
-
<li class="public ">
|
|
304
|
-
<span class="summary_signature">
|
|
305
|
-
|
|
306
|
-
<a href="#traffic_analysis-instance_method" title="#traffic_analysis (instance method)">#<strong>traffic_analysis</strong>(network_id, options) ⇒ Object </a>
|
|
307
|
-
|
|
308
|
-
|
|
309
|
-
|
|
310
|
-
</span>
|
|
311
|
-
|
|
312
|
-
|
|
313
|
-
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
|
|
317
|
-
|
|
318
|
-
|
|
319
|
-
|
|
320
|
-
<span class="summary_desc"><div class='inline'>
|
|
321
|
-
<p>Return traffic analysis data for a network.</p>
|
|
322
|
-
</div></span>
|
|
323
|
-
|
|
324
|
-
</li>
|
|
325
|
-
|
|
326
|
-
|
|
327
|
-
<li class="public ">
|
|
328
|
-
<span class="summary_signature">
|
|
329
|
-
|
|
330
|
-
<a href="#unbind_network_to_template-instance_method" title="#unbind_network_to_template (instance method)">#<strong>unbind_network_to_template</strong>(network_id) ⇒ Integer </a>
|
|
331
|
-
|
|
332
|
-
|
|
333
|
-
|
|
334
|
-
</span>
|
|
335
|
-
|
|
336
|
-
|
|
337
|
-
|
|
338
|
-
|
|
339
|
-
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
|
|
343
|
-
|
|
344
|
-
<span class="summary_desc"><div class='inline'>
|
|
345
|
-
<p>Unbind a single network from a configuration template.</p>
|
|
346
|
-
</div></span>
|
|
347
|
-
|
|
348
|
-
</li>
|
|
349
|
-
|
|
350
|
-
|
|
351
|
-
<li class="public ">
|
|
352
|
-
<span class="summary_signature">
|
|
353
|
-
|
|
354
|
-
<a href="#update_auto_vpn_settings-instance_method" title="#update_auto_vpn_settings (instance method)">#<strong>update_auto_vpn_settings</strong>(network_id, options) ⇒ Hash </a>
|
|
355
|
-
|
|
356
|
-
|
|
357
|
-
|
|
358
|
-
</span>
|
|
359
|
-
|
|
360
|
-
|
|
361
|
-
|
|
362
|
-
|
|
363
|
-
|
|
364
|
-
|
|
365
|
-
|
|
366
|
-
|
|
367
|
-
|
|
368
|
-
<span class="summary_desc"><div class='inline'>
|
|
369
|
-
<p>Update AutoVPN for a specific network.</p>
|
|
370
|
-
</div></span>
|
|
371
|
-
|
|
372
|
-
</li>
|
|
373
|
-
|
|
374
|
-
|
|
375
|
-
<li class="public ">
|
|
376
|
-
<span class="summary_signature">
|
|
377
|
-
|
|
378
|
-
<a href="#update_network-instance_method" title="#update_network (instance method)">#<strong>update_network</strong>(network_id, options) ⇒ Hash </a>
|
|
379
|
-
|
|
380
|
-
|
|
381
|
-
|
|
382
|
-
</span>
|
|
383
|
-
|
|
384
|
-
|
|
385
|
-
|
|
386
|
-
|
|
387
|
-
|
|
388
|
-
|
|
389
|
-
|
|
390
|
-
|
|
391
|
-
|
|
392
|
-
<span class="summary_desc"><div class='inline'>
|
|
393
|
-
<p>Updates a network's details.</p>
|
|
394
|
-
</div></span>
|
|
395
|
-
|
|
396
|
-
</li>
|
|
397
|
-
|
|
398
|
-
|
|
399
|
-
</ul>
|
|
400
|
-
|
|
401
|
-
|
|
402
|
-
|
|
403
|
-
|
|
404
|
-
<div id="instance_method_details" class="method_details_list">
|
|
405
|
-
<h2>Instance Method Details</h2>
|
|
406
|
-
|
|
407
|
-
|
|
408
|
-
<div class="method_details first">
|
|
409
|
-
<h3 class="signature first" id="bind_network_to_template-instance_method">
|
|
410
|
-
|
|
411
|
-
#<strong>bind_network_to_template</strong>(network_id, options) ⇒ <tt>Integer</tt>
|
|
412
|
-
|
|
413
|
-
|
|
414
|
-
|
|
415
|
-
|
|
416
|
-
|
|
417
|
-
</h3><div class="docstring">
|
|
418
|
-
<div class="discussion">
|
|
419
|
-
|
|
420
|
-
<p>Bind a single network to a configuration template</p>
|
|
421
|
-
|
|
422
|
-
|
|
423
|
-
</div>
|
|
424
|
-
</div>
|
|
425
|
-
<div class="tags">
|
|
426
|
-
<p class="tag_title">Parameters:</p>
|
|
427
|
-
<ul class="param">
|
|
428
|
-
|
|
429
|
-
<li>
|
|
430
|
-
|
|
431
|
-
<span class='name'>network_id</span>
|
|
432
|
-
|
|
433
|
-
|
|
434
|
-
<span class='type'>(<tt>String</tt>)</span>
|
|
435
|
-
|
|
436
|
-
|
|
437
|
-
|
|
438
|
-
—
|
|
439
|
-
<div class='inline'>
|
|
440
|
-
<p>the source network that you want to bind to a tempalte</p>
|
|
441
|
-
</div>
|
|
442
|
-
|
|
443
|
-
</li>
|
|
444
|
-
|
|
445
|
-
<li>
|
|
446
|
-
|
|
447
|
-
<span class='name'>options</span>
|
|
448
|
-
|
|
449
|
-
|
|
450
|
-
<span class='type'>(<tt>Hash</tt>)</span>
|
|
451
|
-
|
|
452
|
-
|
|
453
|
-
|
|
454
|
-
—
|
|
455
|
-
<div class='inline'>
|
|
456
|
-
<p>options hash that contains configTemplateId and autoBind values. Refer to
|
|
457
|
-
the official Meraki Dashboard API documentation for more information on
|
|
458
|
-
these.</p>
|
|
459
|
-
</div>
|
|
460
|
-
|
|
461
|
-
</li>
|
|
462
|
-
|
|
463
|
-
</ul>
|
|
464
|
-
|
|
465
|
-
<p class="tag_title">Returns:</p>
|
|
466
|
-
<ul class="return">
|
|
467
|
-
|
|
468
|
-
<li>
|
|
469
|
-
|
|
470
|
-
|
|
471
|
-
<span class='type'>(<tt>Integer</tt>)</span>
|
|
472
|
-
|
|
473
|
-
|
|
474
|
-
|
|
475
|
-
—
|
|
476
|
-
<div class='inline'>
|
|
477
|
-
<p>HTTP Code</p>
|
|
478
|
-
</div>
|
|
479
|
-
|
|
480
|
-
</li>
|
|
481
|
-
|
|
482
|
-
</ul>
|
|
483
|
-
|
|
484
|
-
</div><table class="source_code">
|
|
485
|
-
<tr>
|
|
486
|
-
<td>
|
|
487
|
-
<pre class="lines">
|
|
488
|
-
|
|
489
|
-
|
|
490
|
-
85
|
|
491
|
-
86
|
|
492
|
-
87
|
|
493
|
-
88
|
|
494
|
-
89
|
|
495
|
-
90</pre>
|
|
496
|
-
</td>
|
|
497
|
-
<td>
|
|
498
|
-
<pre class="code"><span class="info file"># File 'lib/networks.rb', line 85</span>
|
|
499
|
-
|
|
500
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_bind_network_to_template'>bind_network_to_template</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>
|
|
501
|
-
<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>
|
|
502
|
-
<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>
|
|
503
|
-
|
|
504
|
-
<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'>/bind</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>
|
|
505
|
-
<span class='kw'>end</span></pre>
|
|
506
|
-
</td>
|
|
507
|
-
</tr>
|
|
508
|
-
</table>
|
|
509
|
-
</div>
|
|
510
|
-
|
|
511
|
-
<div class="method_details ">
|
|
512
|
-
<h3 class="signature " id="create_network-instance_method">
|
|
513
|
-
|
|
514
|
-
#<strong>create_network</strong>(org_id, options) ⇒ <tt>Hash</tt>
|
|
515
|
-
|
|
516
|
-
|
|
517
|
-
|
|
518
|
-
|
|
519
|
-
|
|
520
|
-
</h3><div class="docstring">
|
|
521
|
-
<div class="discussion">
|
|
522
|
-
|
|
523
|
-
<p>Create a new Dashboard network</p>
|
|
524
|
-
|
|
525
|
-
|
|
526
|
-
</div>
|
|
527
|
-
</div>
|
|
528
|
-
<div class="tags">
|
|
529
|
-
<p class="tag_title">Parameters:</p>
|
|
530
|
-
<ul class="param">
|
|
531
|
-
|
|
532
|
-
<li>
|
|
533
|
-
|
|
534
|
-
<span class='name'>org_id</span>
|
|
535
|
-
|
|
536
|
-
|
|
537
|
-
<span class='type'>(<tt>String</tt>)</span>
|
|
538
|
-
|
|
539
|
-
|
|
540
|
-
|
|
541
|
-
—
|
|
542
|
-
<div class='inline'>
|
|
543
|
-
<p>dashboard organization ID</p>
|
|
544
|
-
</div>
|
|
545
|
-
|
|
546
|
-
</li>
|
|
547
|
-
|
|
548
|
-
<li>
|
|
549
|
-
|
|
550
|
-
<span class='name'>options</span>
|
|
551
|
-
|
|
552
|
-
|
|
553
|
-
<span class='type'>(<tt>Hash</tt>)</span>
|
|
554
|
-
|
|
555
|
-
|
|
556
|
-
|
|
557
|
-
—
|
|
558
|
-
<div class='inline'>
|
|
559
|
-
<p>a hash containing the following options: name: the network name (REQUIRED)
|
|
560
|
-
type: the type of network (wireless, switch, appliance, or phone)
|
|
561
|
-
(REQUIRED) tags: tags for the network (NOT REQUIRED)</p>
|
|
562
|
-
</div>
|
|
563
|
-
|
|
564
|
-
</li>
|
|
565
|
-
|
|
566
|
-
</ul>
|
|
567
|
-
|
|
568
|
-
<p class="tag_title">Returns:</p>
|
|
569
|
-
<ul class="return">
|
|
570
|
-
|
|
571
|
-
<li>
|
|
572
|
-
|
|
573
|
-
|
|
574
|
-
<span class='type'>(<tt>Hash</tt>)</span>
|
|
575
|
-
|
|
576
|
-
|
|
577
|
-
|
|
578
|
-
—
|
|
579
|
-
<div class='inline'>
|
|
580
|
-
<p>a hash containing the new networks details</p>
|
|
581
|
-
</div>
|
|
582
|
-
|
|
583
|
-
</li>
|
|
584
|
-
|
|
585
|
-
</ul>
|
|
586
|
-
|
|
587
|
-
</div><table class="source_code">
|
|
588
|
-
<tr>
|
|
589
|
-
<td>
|
|
590
|
-
<pre class="lines">
|
|
591
|
-
|
|
592
|
-
|
|
593
|
-
37
|
|
594
|
-
38
|
|
595
|
-
39
|
|
596
|
-
40
|
|
597
|
-
41</pre>
|
|
598
|
-
</td>
|
|
599
|
-
<td>
|
|
600
|
-
<pre class="code"><span class="info file"># File 'lib/networks.rb', line 37</span>
|
|
601
|
-
|
|
602
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_create_network'>create_network</span><span class='lparen'>(</span><span class='id identifier rubyid_org_id'>org_id</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
|
603
|
-
<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>
|
|
604
|
-
<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>
|
|
605
|
-
<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'>/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'>/networks</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>
|
|
606
|
-
<span class='kw'>end</span></pre>
|
|
607
|
-
</td>
|
|
608
|
-
</tr>
|
|
609
|
-
</table>
|
|
610
|
-
</div>
|
|
611
|
-
|
|
612
|
-
<div class="method_details ">
|
|
613
|
-
<h3 class="signature " id="delete_network-instance_method">
|
|
614
|
-
|
|
615
|
-
#<strong>delete_network</strong>(network_id) ⇒ <tt>Bool</tt>
|
|
616
|
-
|
|
617
|
-
|
|
618
|
-
|
|
619
|
-
|
|
620
|
-
|
|
621
|
-
</h3><div class="docstring">
|
|
622
|
-
<div class="discussion">
|
|
623
|
-
|
|
624
|
-
<p>Delete an existing Dashboard network</p>
|
|
625
|
-
|
|
626
|
-
|
|
627
|
-
</div>
|
|
628
|
-
</div>
|
|
629
|
-
<div class="tags">
|
|
630
|
-
<p class="tag_title">Parameters:</p>
|
|
631
|
-
<ul class="param">
|
|
632
|
-
|
|
633
|
-
<li>
|
|
634
|
-
|
|
635
|
-
<span class='name'>network_id</span>
|
|
636
|
-
|
|
637
|
-
|
|
638
|
-
<span class='type'>(<tt>String</tt>)</span>
|
|
639
|
-
|
|
640
|
-
|
|
641
|
-
|
|
642
|
-
—
|
|
643
|
-
<div class='inline'>
|
|
644
|
-
<p>dashboard netwok ID to delete</p>
|
|
645
|
-
</div>
|
|
646
|
-
|
|
647
|
-
</li>
|
|
648
|
-
|
|
649
|
-
</ul>
|
|
650
|
-
|
|
651
|
-
<p class="tag_title">Returns:</p>
|
|
652
|
-
<ul class="return">
|
|
653
|
-
|
|
654
|
-
<li>
|
|
655
|
-
|
|
656
|
-
|
|
657
|
-
<span class='type'>(<tt>Bool</tt>)</span>
|
|
658
|
-
|
|
659
|
-
|
|
660
|
-
|
|
661
|
-
—
|
|
662
|
-
<div class='inline'>
|
|
663
|
-
<p>status true if the network was deleted, false if not</p>
|
|
664
|
-
</div>
|
|
665
|
-
|
|
666
|
-
</li>
|
|
667
|
-
|
|
668
|
-
</ul>
|
|
669
|
-
|
|
670
|
-
</div><table class="source_code">
|
|
671
|
-
<tr>
|
|
672
|
-
<td>
|
|
673
|
-
<pre class="lines">
|
|
674
|
-
|
|
675
|
-
|
|
676
|
-
46
|
|
677
|
-
47
|
|
678
|
-
48
|
|
679
|
-
49</pre>
|
|
680
|
-
</td>
|
|
681
|
-
<td>
|
|
682
|
-
<pre class="code"><span class="info file"># File 'lib/networks.rb', line 46</span>
|
|
683
|
-
|
|
684
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_delete_network'>delete_network</span><span class='lparen'>(</span><span class='id identifier rubyid_network_id'>network_id</span><span class='rparen'>)</span>
|
|
685
|
-
<span class='id identifier rubyid_res'>res</span> <span class='op'>=</span> <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_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>DELETE</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
|
686
|
-
<span class='kw'>return</span> <span class='id identifier rubyid_res'>res</span><span class='period'>.</span><span class='id identifier rubyid_code'>code</span> <span class='op'>==</span> <span class='int'>204</span> <span class='op'>?</span> <span class='kw'>true</span> <span class='op'>:</span> <span class='kw'>false</span>
|
|
687
|
-
<span class='kw'>end</span></pre>
|
|
688
|
-
</td>
|
|
689
|
-
</tr>
|
|
690
|
-
</table>
|
|
691
|
-
</div>
|
|
692
|
-
|
|
693
|
-
<div class="method_details ">
|
|
694
|
-
<h3 class="signature " id="get_auto_vpn_settings-instance_method">
|
|
695
|
-
|
|
696
|
-
#<strong>get_auto_vpn_settings</strong>(network_id) ⇒ <tt>Hash</tt>
|
|
697
|
-
|
|
698
|
-
|
|
699
|
-
|
|
700
|
-
|
|
701
|
-
|
|
702
|
-
</h3><div class="docstring">
|
|
703
|
-
<div class="discussion">
|
|
704
|
-
|
|
705
|
-
<p>Get AutoVPN settings for a specific network</p>
|
|
706
|
-
|
|
707
|
-
|
|
708
|
-
</div>
|
|
709
|
-
</div>
|
|
710
|
-
<div class="tags">
|
|
711
|
-
<p class="tag_title">Parameters:</p>
|
|
712
|
-
<ul class="param">
|
|
713
|
-
|
|
714
|
-
<li>
|
|
715
|
-
|
|
716
|
-
<span class='name'>network_id</span>
|
|
717
|
-
|
|
718
|
-
|
|
719
|
-
<span class='type'>(<tt>String</tt>)</span>
|
|
720
|
-
|
|
721
|
-
|
|
722
|
-
|
|
723
|
-
—
|
|
724
|
-
<div class='inline'>
|
|
725
|
-
<p>dashboard network ID to get AutoVPN settings for</p>
|
|
726
|
-
</div>
|
|
727
|
-
|
|
728
|
-
</li>
|
|
729
|
-
|
|
730
|
-
</ul>
|
|
731
|
-
|
|
732
|
-
<p class="tag_title">Returns:</p>
|
|
733
|
-
<ul class="return">
|
|
734
|
-
|
|
735
|
-
<li>
|
|
736
|
-
|
|
737
|
-
|
|
738
|
-
<span class='type'>(<tt>Hash</tt>)</span>
|
|
739
|
-
|
|
740
|
-
|
|
741
|
-
|
|
742
|
-
—
|
|
743
|
-
<div class='inline'>
|
|
744
|
-
<p>a hash containing the AutoVPN details for the network</p>
|
|
745
|
-
</div>
|
|
746
|
-
|
|
747
|
-
</li>
|
|
748
|
-
|
|
749
|
-
</ul>
|
|
750
|
-
|
|
751
|
-
</div><table class="source_code">
|
|
752
|
-
<tr>
|
|
753
|
-
<td>
|
|
754
|
-
<pre class="lines">
|
|
755
|
-
|
|
756
|
-
|
|
757
|
-
54
|
|
758
|
-
55
|
|
759
|
-
56</pre>
|
|
760
|
-
</td>
|
|
761
|
-
<td>
|
|
762
|
-
<pre class="code"><span class="info file"># File 'lib/networks.rb', line 54</span>
|
|
763
|
-
|
|
764
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_get_auto_vpn_settings'>get_auto_vpn_settings</span><span class='lparen'>(</span><span class='id identifier rubyid_network_id'>network_id</span><span class='rparen'>)</span>
|
|
765
|
-
<span class='id identifier rubyid_res'>res</span> <span class='op'>=</span> <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'>/siteToSiteVpn</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>
|
|
766
|
-
<span class='kw'>end</span></pre>
|
|
767
|
-
</td>
|
|
768
|
-
</tr>
|
|
769
|
-
</table>
|
|
770
|
-
</div>
|
|
771
|
-
|
|
772
|
-
<div class="method_details ">
|
|
773
|
-
<h3 class="signature " id="get_ms_access_policies-instance_method">
|
|
774
|
-
|
|
775
|
-
#<strong>get_ms_access_policies</strong>(network_id) ⇒ <tt>Array</tt>
|
|
776
|
-
|
|
777
|
-
|
|
778
|
-
|
|
779
|
-
|
|
780
|
-
|
|
781
|
-
</h3><div class="docstring">
|
|
782
|
-
<div class="discussion">
|
|
783
|
-
|
|
784
|
-
<p>Get all MS access policies configured for a specific Dashboard network</p>
|
|
785
|
-
|
|
786
|
-
|
|
787
|
-
</div>
|
|
788
|
-
</div>
|
|
789
|
-
<div class="tags">
|
|
790
|
-
<p class="tag_title">Parameters:</p>
|
|
791
|
-
<ul class="param">
|
|
792
|
-
|
|
793
|
-
<li>
|
|
794
|
-
|
|
795
|
-
<span class='name'>network_id</span>
|
|
796
|
-
|
|
797
|
-
|
|
798
|
-
<span class='type'>(<tt>String</tt>)</span>
|
|
799
|
-
|
|
800
|
-
|
|
801
|
-
|
|
802
|
-
—
|
|
803
|
-
<div class='inline'>
|
|
804
|
-
<p>dashboard network ID to get MS policies for</p>
|
|
805
|
-
</div>
|
|
806
|
-
|
|
807
|
-
</li>
|
|
808
|
-
|
|
809
|
-
</ul>
|
|
810
|
-
|
|
811
|
-
<p class="tag_title">Returns:</p>
|
|
812
|
-
<ul class="return">
|
|
813
|
-
|
|
814
|
-
<li>
|
|
815
|
-
|
|
816
|
-
|
|
817
|
-
<span class='type'>(<tt>Array</tt>)</span>
|
|
818
|
-
|
|
819
|
-
|
|
820
|
-
|
|
821
|
-
—
|
|
822
|
-
<div class='inline'>
|
|
823
|
-
<p>an array of hashes for containing the policy information</p>
|
|
824
|
-
</div>
|
|
825
|
-
|
|
826
|
-
</li>
|
|
827
|
-
|
|
828
|
-
</ul>
|
|
829
|
-
|
|
830
|
-
</div><table class="source_code">
|
|
831
|
-
<tr>
|
|
832
|
-
<td>
|
|
833
|
-
<pre class="lines">
|
|
834
|
-
|
|
835
|
-
|
|
836
|
-
75
|
|
837
|
-
76
|
|
838
|
-
77
|
|
839
|
-
78</pre>
|
|
840
|
-
</td>
|
|
841
|
-
<td>
|
|
842
|
-
<pre class="code"><span class="info file"># File 'lib/networks.rb', line 75</span>
|
|
843
|
-
|
|
844
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_get_ms_access_policies'>get_ms_access_policies</span><span class='lparen'>(</span><span class='id identifier rubyid_network_id'>network_id</span><span class='rparen'>)</span>
|
|
845
|
-
<span class='id identifier rubyid_res'>res</span> <span class='op'>=</span> <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'>/accessPolicies</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>
|
|
846
|
-
<span class='kw'>return</span> <span class='id identifier rubyid_res'>res</span>
|
|
847
|
-
<span class='kw'>end</span></pre>
|
|
848
|
-
</td>
|
|
849
|
-
</tr>
|
|
850
|
-
</table>
|
|
851
|
-
</div>
|
|
852
|
-
|
|
853
|
-
<div class="method_details ">
|
|
854
|
-
<h3 class="signature " id="get_networks-instance_method">
|
|
855
|
-
|
|
856
|
-
#<strong>get_networks</strong>(org_id) ⇒ <tt>Array</tt>
|
|
857
|
-
|
|
858
|
-
|
|
859
|
-
|
|
860
|
-
|
|
861
|
-
|
|
862
|
-
</h3><div class="docstring">
|
|
863
|
-
<div class="discussion">
|
|
864
|
-
|
|
865
|
-
<p>Returns the list of networks for a given organization</p>
|
|
866
|
-
|
|
867
|
-
|
|
868
|
-
</div>
|
|
869
|
-
</div>
|
|
870
|
-
<div class="tags">
|
|
871
|
-
<p class="tag_title">Parameters:</p>
|
|
872
|
-
<ul class="param">
|
|
873
|
-
|
|
874
|
-
<li>
|
|
875
|
-
|
|
876
|
-
<span class='name'>org_id</span>
|
|
877
|
-
|
|
878
|
-
|
|
879
|
-
<span class='type'>(<tt>String</tt>)</span>
|
|
880
|
-
|
|
881
|
-
|
|
882
|
-
|
|
883
|
-
—
|
|
884
|
-
<div class='inline'>
|
|
885
|
-
<p>dashboard organization ID</p>
|
|
886
|
-
</div>
|
|
887
|
-
|
|
888
|
-
</li>
|
|
889
|
-
|
|
890
|
-
</ul>
|
|
891
|
-
|
|
892
|
-
<p class="tag_title">Returns:</p>
|
|
893
|
-
<ul class="return">
|
|
894
|
-
|
|
895
|
-
<li>
|
|
896
|
-
|
|
897
|
-
|
|
898
|
-
<span class='type'>(<tt>Array</tt>)</span>
|
|
899
|
-
|
|
900
|
-
|
|
901
|
-
|
|
902
|
-
—
|
|
903
|
-
<div class='inline'>
|
|
904
|
-
<p>an array of hashes containing the network details</p>
|
|
905
|
-
</div>
|
|
906
|
-
|
|
907
|
-
</li>
|
|
908
|
-
|
|
909
|
-
</ul>
|
|
910
|
-
|
|
911
|
-
</div><table class="source_code">
|
|
912
|
-
<tr>
|
|
913
|
-
<td>
|
|
914
|
-
<pre class="lines">
|
|
915
|
-
|
|
916
|
-
|
|
917
|
-
7
|
|
918
|
-
8
|
|
919
|
-
9</pre>
|
|
920
|
-
</td>
|
|
921
|
-
<td>
|
|
922
|
-
<pre class="code"><span class="info file"># File 'lib/networks.rb', line 7</span>
|
|
923
|
-
|
|
924
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_get_networks'>get_networks</span><span class='lparen'>(</span><span class='id identifier rubyid_org_id'>org_id</span><span class='rparen'>)</span>
|
|
925
|
-
<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'>/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'>/networks</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>
|
|
926
|
-
<span class='kw'>end</span></pre>
|
|
927
|
-
</td>
|
|
928
|
-
</tr>
|
|
929
|
-
</table>
|
|
930
|
-
</div>
|
|
931
|
-
|
|
932
|
-
<div class="method_details ">
|
|
933
|
-
<h3 class="signature " id="get_single_network-instance_method">
|
|
934
|
-
|
|
935
|
-
#<strong>get_single_network</strong>(network_id) ⇒ <tt>Hash</tt>
|
|
936
|
-
|
|
937
|
-
|
|
938
|
-
|
|
939
|
-
|
|
940
|
-
|
|
941
|
-
</h3><div class="docstring">
|
|
942
|
-
<div class="discussion">
|
|
943
|
-
|
|
944
|
-
<p>Returns the network details for a single network</p>
|
|
945
|
-
|
|
946
|
-
|
|
947
|
-
</div>
|
|
948
|
-
</div>
|
|
949
|
-
<div class="tags">
|
|
950
|
-
<p class="tag_title">Parameters:</p>
|
|
951
|
-
<ul class="param">
|
|
952
|
-
|
|
953
|
-
<li>
|
|
954
|
-
|
|
955
|
-
<span class='name'>network_id</span>
|
|
956
|
-
|
|
957
|
-
|
|
958
|
-
<span class='type'>(<tt>String</tt>)</span>
|
|
959
|
-
|
|
960
|
-
|
|
961
|
-
|
|
962
|
-
—
|
|
963
|
-
<div class='inline'>
|
|
964
|
-
<p>dashboard network ID</p>
|
|
965
|
-
</div>
|
|
966
|
-
|
|
967
|
-
</li>
|
|
968
|
-
|
|
969
|
-
</ul>
|
|
970
|
-
|
|
971
|
-
<p class="tag_title">Returns:</p>
|
|
972
|
-
<ul class="return">
|
|
973
|
-
|
|
974
|
-
<li>
|
|
975
|
-
|
|
976
|
-
|
|
977
|
-
<span class='type'>(<tt>Hash</tt>)</span>
|
|
978
|
-
|
|
979
|
-
|
|
980
|
-
|
|
981
|
-
—
|
|
982
|
-
<div class='inline'>
|
|
983
|
-
<p>a hash containing the network details of the specific network</p>
|
|
984
|
-
</div>
|
|
985
|
-
|
|
986
|
-
</li>
|
|
987
|
-
|
|
988
|
-
</ul>
|
|
989
|
-
|
|
990
|
-
</div><table class="source_code">
|
|
991
|
-
<tr>
|
|
992
|
-
<td>
|
|
993
|
-
<pre class="lines">
|
|
994
|
-
|
|
995
|
-
|
|
996
|
-
14
|
|
997
|
-
15
|
|
998
|
-
16</pre>
|
|
999
|
-
</td>
|
|
1000
|
-
<td>
|
|
1001
|
-
<pre class="code"><span class="info file"># File 'lib/networks.rb', line 14</span>
|
|
1002
|
-
|
|
1003
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_get_single_network'>get_single_network</span><span class='lparen'>(</span><span class='id identifier rubyid_network_id'>network_id</span><span class='rparen'>)</span>
|
|
1004
|
-
<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_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>
|
|
1005
|
-
<span class='kw'>end</span></pre>
|
|
1006
|
-
</td>
|
|
1007
|
-
</tr>
|
|
1008
|
-
</table>
|
|
1009
|
-
</div>
|
|
1010
|
-
|
|
1011
|
-
<div class="method_details ">
|
|
1012
|
-
<h3 class="signature " id="traffic_analysis-instance_method">
|
|
1013
|
-
|
|
1014
|
-
#<strong>traffic_analysis</strong>(network_id, options) ⇒ <tt>Object</tt>
|
|
1015
|
-
|
|
1016
|
-
|
|
1017
|
-
|
|
1018
|
-
|
|
1019
|
-
|
|
1020
|
-
</h3><div class="docstring">
|
|
1021
|
-
<div class="discussion">
|
|
1022
|
-
|
|
1023
|
-
<p>Return traffic analysis data for a network</p>
|
|
1024
|
-
|
|
1025
|
-
|
|
1026
|
-
</div>
|
|
1027
|
-
</div>
|
|
1028
|
-
<div class="tags">
|
|
1029
|
-
<p class="tag_title">Parameters:</p>
|
|
1030
|
-
<ul class="param">
|
|
1031
|
-
|
|
1032
|
-
<li>
|
|
1033
|
-
|
|
1034
|
-
<span class='name'>network_id</span>
|
|
1035
|
-
|
|
1036
|
-
|
|
1037
|
-
<span class='type'>(<tt>String</tt>)</span>
|
|
1038
|
-
|
|
1039
|
-
|
|
1040
|
-
|
|
1041
|
-
—
|
|
1042
|
-
<div class='inline'>
|
|
1043
|
-
<p>network that you want data for</p>
|
|
1044
|
-
</div>
|
|
1045
|
-
|
|
1046
|
-
</li>
|
|
1047
|
-
|
|
1048
|
-
<li>
|
|
1049
|
-
|
|
1050
|
-
<span class='name'>options</span>
|
|
1051
|
-
|
|
1052
|
-
|
|
1053
|
-
<span class='type'>(<tt>Hash</tt>)</span>
|
|
1054
|
-
|
|
1055
|
-
|
|
1056
|
-
|
|
1057
|
-
—
|
|
1058
|
-
<div class='inline'>
|
|
1059
|
-
<p>options hash containing a timespan and deviceType. Refer to the official
|
|
1060
|
-
Meraki Dashboard API documentation for more information on these.</p>
|
|
1061
|
-
</div>
|
|
1062
|
-
|
|
1063
|
-
</li>
|
|
1064
|
-
|
|
1065
|
-
</ul>
|
|
1066
|
-
|
|
1067
|
-
|
|
1068
|
-
</div><table class="source_code">
|
|
1069
|
-
<tr>
|
|
1070
|
-
<td>
|
|
1071
|
-
<pre class="lines">
|
|
1072
|
-
|
|
1073
|
-
|
|
1074
|
-
103
|
|
1075
|
-
104
|
|
1076
|
-
105
|
|
1077
|
-
106
|
|
1078
|
-
107</pre>
|
|
1079
|
-
</td>
|
|
1080
|
-
<td>
|
|
1081
|
-
<pre class="code"><span class="info file"># File 'lib/networks.rb', line 103</span>
|
|
1082
|
-
|
|
1083
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_traffic_analysis'>traffic_analysis</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>
|
|
1084
|
-
<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>
|
|
1085
|
-
<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>
|
|
1086
|
-
<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'>/traffic</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='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
|
1087
|
-
<span class='kw'>end</span></pre>
|
|
1088
|
-
</td>
|
|
1089
|
-
</tr>
|
|
1090
|
-
</table>
|
|
1091
|
-
</div>
|
|
1092
|
-
|
|
1093
|
-
<div class="method_details ">
|
|
1094
|
-
<h3 class="signature " id="unbind_network_to_template-instance_method">
|
|
1095
|
-
|
|
1096
|
-
#<strong>unbind_network_to_template</strong>(network_id) ⇒ <tt>Integer</tt>
|
|
1097
|
-
|
|
1098
|
-
|
|
1099
|
-
|
|
1100
|
-
|
|
1101
|
-
|
|
1102
|
-
</h3><div class="docstring">
|
|
1103
|
-
<div class="discussion">
|
|
1104
|
-
|
|
1105
|
-
<p>Unbind a single network from a configuration template</p>
|
|
1106
|
-
|
|
1107
|
-
|
|
1108
|
-
</div>
|
|
1109
|
-
</div>
|
|
1110
|
-
<div class="tags">
|
|
1111
|
-
<p class="tag_title">Parameters:</p>
|
|
1112
|
-
<ul class="param">
|
|
1113
|
-
|
|
1114
|
-
<li>
|
|
1115
|
-
|
|
1116
|
-
<span class='name'>network_id</span>
|
|
1117
|
-
|
|
1118
|
-
|
|
1119
|
-
<span class='type'>(<tt>String</tt>)</span>
|
|
1120
|
-
|
|
1121
|
-
|
|
1122
|
-
|
|
1123
|
-
—
|
|
1124
|
-
<div class='inline'>
|
|
1125
|
-
<p>the network that you want to unbind from it's template</p>
|
|
1126
|
-
</div>
|
|
1127
|
-
|
|
1128
|
-
</li>
|
|
1129
|
-
|
|
1130
|
-
</ul>
|
|
1131
|
-
|
|
1132
|
-
<p class="tag_title">Returns:</p>
|
|
1133
|
-
<ul class="return">
|
|
1134
|
-
|
|
1135
|
-
<li>
|
|
1136
|
-
|
|
1137
|
-
|
|
1138
|
-
<span class='type'>(<tt>Integer</tt>)</span>
|
|
1139
|
-
|
|
1140
|
-
|
|
1141
|
-
|
|
1142
|
-
—
|
|
1143
|
-
<div class='inline'>
|
|
1144
|
-
<p>HTTP Code</p>
|
|
1145
|
-
</div>
|
|
1146
|
-
|
|
1147
|
-
</li>
|
|
1148
|
-
|
|
1149
|
-
</ul>
|
|
1150
|
-
|
|
1151
|
-
</div><table class="source_code">
|
|
1152
|
-
<tr>
|
|
1153
|
-
<td>
|
|
1154
|
-
<pre class="lines">
|
|
1155
|
-
|
|
1156
|
-
|
|
1157
|
-
95
|
|
1158
|
-
96
|
|
1159
|
-
97</pre>
|
|
1160
|
-
</td>
|
|
1161
|
-
<td>
|
|
1162
|
-
<pre class="code"><span class="info file"># File 'lib/networks.rb', line 95</span>
|
|
1163
|
-
|
|
1164
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_unbind_network_to_template'>unbind_network_to_template</span><span class='lparen'>(</span><span class='id identifier rubyid_network_id'>network_id</span><span class='rparen'>)</span>
|
|
1165
|
-
<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'>/unbind</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>
|
|
1166
|
-
<span class='kw'>end</span></pre>
|
|
1167
|
-
</td>
|
|
1168
|
-
</tr>
|
|
1169
|
-
</table>
|
|
1170
|
-
</div>
|
|
1171
|
-
|
|
1172
|
-
<div class="method_details ">
|
|
1173
|
-
<h3 class="signature " id="update_auto_vpn_settings-instance_method">
|
|
1174
|
-
|
|
1175
|
-
#<strong>update_auto_vpn_settings</strong>(network_id, options) ⇒ <tt>Hash</tt>
|
|
1176
|
-
|
|
1177
|
-
|
|
1178
|
-
|
|
1179
|
-
|
|
1180
|
-
|
|
1181
|
-
</h3><div class="docstring">
|
|
1182
|
-
<div class="discussion">
|
|
1183
|
-
|
|
1184
|
-
<p>Update AutoVPN for a specific network</p>
|
|
1185
|
-
|
|
1186
|
-
|
|
1187
|
-
</div>
|
|
1188
|
-
</div>
|
|
1189
|
-
<div class="tags">
|
|
1190
|
-
<p class="tag_title">Parameters:</p>
|
|
1191
|
-
<ul class="param">
|
|
1192
|
-
|
|
1193
|
-
<li>
|
|
1194
|
-
|
|
1195
|
-
<span class='name'>network_id</span>
|
|
1196
|
-
|
|
1197
|
-
|
|
1198
|
-
<span class='type'>(<tt>String</tt>)</span>
|
|
1199
|
-
|
|
1200
|
-
|
|
1201
|
-
|
|
1202
|
-
—
|
|
1203
|
-
<div class='inline'>
|
|
1204
|
-
<p>dashboard network ID to update AutoVPN settings for</p>
|
|
1205
|
-
</div>
|
|
1206
|
-
|
|
1207
|
-
</li>
|
|
1208
|
-
|
|
1209
|
-
<li>
|
|
1210
|
-
|
|
1211
|
-
<span class='name'>options</span>
|
|
1212
|
-
|
|
1213
|
-
|
|
1214
|
-
<span class='type'>(<tt>Hash</tt>)</span>
|
|
1215
|
-
|
|
1216
|
-
|
|
1217
|
-
|
|
1218
|
-
—
|
|
1219
|
-
<div class='inline'>
|
|
1220
|
-
<p>options hash containing the following options: mode: hub, spoke or none
|
|
1221
|
-
hubs: an array of Hashes containing the hubId and a true or false for
|
|
1222
|
-
useDefaultRoute subnets: an array of Hashes containing localSubnet and
|
|
1223
|
-
useVPN</p>
|
|
1224
|
-
</div>
|
|
1225
|
-
|
|
1226
|
-
</li>
|
|
1227
|
-
|
|
1228
|
-
</ul>
|
|
1229
|
-
|
|
1230
|
-
<p class="tag_title">Returns:</p>
|
|
1231
|
-
<ul class="return">
|
|
1232
|
-
|
|
1233
|
-
<li>
|
|
1234
|
-
|
|
1235
|
-
|
|
1236
|
-
<span class='type'>(<tt>Hash</tt>)</span>
|
|
1237
|
-
|
|
1238
|
-
|
|
1239
|
-
|
|
1240
|
-
</li>
|
|
1241
|
-
|
|
1242
|
-
</ul>
|
|
1243
|
-
|
|
1244
|
-
</div><table class="source_code">
|
|
1245
|
-
<tr>
|
|
1246
|
-
<td>
|
|
1247
|
-
<pre class="lines">
|
|
1248
|
-
|
|
1249
|
-
|
|
1250
|
-
65
|
|
1251
|
-
66
|
|
1252
|
-
67
|
|
1253
|
-
68
|
|
1254
|
-
69
|
|
1255
|
-
70</pre>
|
|
1256
|
-
</td>
|
|
1257
|
-
<td>
|
|
1258
|
-
<pre class="code"><span class="info file"># File 'lib/networks.rb', line 65</span>
|
|
1259
|
-
|
|
1260
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_update_auto_vpn_settings'>update_auto_vpn_settings</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>
|
|
1261
|
-
<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>
|
|
1262
|
-
|
|
1263
|
-
<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>
|
|
1264
|
-
<span class='id identifier rubyid_res'>res</span> <span class='op'>=</span> <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'>/siteToSiteVpn</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>
|
|
1265
|
-
<span class='kw'>end</span></pre>
|
|
1266
|
-
</td>
|
|
1267
|
-
</tr>
|
|
1268
|
-
</table>
|
|
1269
|
-
</div>
|
|
1270
|
-
|
|
1271
|
-
<div class="method_details ">
|
|
1272
|
-
<h3 class="signature " id="update_network-instance_method">
|
|
1273
|
-
|
|
1274
|
-
#<strong>update_network</strong>(network_id, options) ⇒ <tt>Hash</tt>
|
|
1275
|
-
|
|
1276
|
-
|
|
1277
|
-
|
|
1278
|
-
|
|
1279
|
-
|
|
1280
|
-
</h3><div class="docstring">
|
|
1281
|
-
<div class="discussion">
|
|
1282
|
-
|
|
1283
|
-
<p>Updates a network's details</p>
|
|
1284
|
-
|
|
1285
|
-
|
|
1286
|
-
</div>
|
|
1287
|
-
</div>
|
|
1288
|
-
<div class="tags">
|
|
1289
|
-
<p class="tag_title">Parameters:</p>
|
|
1290
|
-
<ul class="param">
|
|
1291
|
-
|
|
1292
|
-
<li>
|
|
1293
|
-
|
|
1294
|
-
<span class='name'>network_id</span>
|
|
1295
|
-
|
|
1296
|
-
|
|
1297
|
-
<span class='type'>(<tt>String</tt>)</span>
|
|
1298
|
-
|
|
1299
|
-
|
|
1300
|
-
|
|
1301
|
-
—
|
|
1302
|
-
<div class='inline'>
|
|
1303
|
-
<p>dashboard network ID</p>
|
|
1304
|
-
</div>
|
|
1305
|
-
|
|
1306
|
-
</li>
|
|
1307
|
-
|
|
1308
|
-
<li>
|
|
1309
|
-
|
|
1310
|
-
<span class='name'>options</span>
|
|
1311
|
-
|
|
1312
|
-
|
|
1313
|
-
<span class='type'>(<tt>Hash</tt>)</span>
|
|
1314
|
-
|
|
1315
|
-
|
|
1316
|
-
|
|
1317
|
-
—
|
|
1318
|
-
<div class='inline'>
|
|
1319
|
-
<p>a hash containing any of the following keys: name: the network name tags:
|
|
1320
|
-
tags assigned to the network</p>
|
|
1321
|
-
</div>
|
|
1322
|
-
|
|
1323
|
-
</li>
|
|
1324
|
-
|
|
1325
|
-
</ul>
|
|
1326
|
-
|
|
1327
|
-
<p class="tag_title">Returns:</p>
|
|
1328
|
-
<ul class="return">
|
|
1329
|
-
|
|
1330
|
-
<li>
|
|
1331
|
-
|
|
1332
|
-
|
|
1333
|
-
<span class='type'>(<tt>Hash</tt>)</span>
|
|
1334
|
-
|
|
1335
|
-
|
|
1336
|
-
|
|
1337
|
-
—
|
|
1338
|
-
<div class='inline'>
|
|
1339
|
-
<p>a hash containing the updated network details</p>
|
|
1340
|
-
</div>
|
|
1341
|
-
|
|
1342
|
-
</li>
|
|
1343
|
-
|
|
1344
|
-
</ul>
|
|
1345
|
-
|
|
1346
|
-
</div><table class="source_code">
|
|
1347
|
-
<tr>
|
|
1348
|
-
<td>
|
|
1349
|
-
<pre class="lines">
|
|
1350
|
-
|
|
1351
|
-
|
|
1352
|
-
24
|
|
1353
|
-
25
|
|
1354
|
-
26
|
|
1355
|
-
27
|
|
1356
|
-
28</pre>
|
|
1357
|
-
</td>
|
|
1358
|
-
<td>
|
|
1359
|
-
<pre class="code"><span class="info file"># File 'lib/networks.rb', line 24</span>
|
|
1360
|
-
|
|
1361
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_update_network'>update_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>
|
|
1362
|
-
<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>
|
|
1363
|
-
<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>
|
|
1364
|
-
<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_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>
|
|
1365
|
-
<span class='kw'>end</span></pre>
|
|
1366
|
-
</td>
|
|
1367
|
-
</tr>
|
|
1368
|
-
</table>
|
|
1369
|
-
</div>
|
|
1370
|
-
|
|
1371
|
-
</div>
|
|
1372
|
-
|
|
1373
|
-
</div>
|
|
1374
|
-
|
|
1375
|
-
<div id="footer">
|
|
1376
|
-
Generated on Thu Nov 17 22:15:39 2016 by
|
|
1377
|
-
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
1378
|
-
0.9.5 (ruby-2.3.0).
|
|
1379
|
-
</div>
|
|
1380
|
-
|
|
1381
|
-
</div>
|
|
1382
|
-
</body>
|
|
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: Networks
|
|
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 = "Networks";
|
|
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 (N)</a> »
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
<span class="title">Networks</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: Networks
|
|
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/networks.rb</dd>
|
|
89
|
+
</dl>
|
|
90
|
+
|
|
91
|
+
</div>
|
|
92
|
+
|
|
93
|
+
<h2>Overview</h2><div class="docstring">
|
|
94
|
+
<div class="discussion">
|
|
95
|
+
|
|
96
|
+
<p>Networks 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="#bind_network_to_template-instance_method" title="#bind_network_to_template (instance method)">#<strong>bind_network_to_template</strong>(network_id, options) ⇒ Integer </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>Bind a single network to a configuration template.</p>
|
|
154
|
+
</div></span>
|
|
155
|
+
|
|
156
|
+
</li>
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
<li class="public ">
|
|
160
|
+
<span class="summary_signature">
|
|
161
|
+
|
|
162
|
+
<a href="#create_network-instance_method" title="#create_network (instance method)">#<strong>create_network</strong>(org_id, options) ⇒ Hash </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>Create a new Dashboard network.</p>
|
|
178
|
+
</div></span>
|
|
179
|
+
|
|
180
|
+
</li>
|
|
181
|
+
|
|
182
|
+
|
|
183
|
+
<li class="public ">
|
|
184
|
+
<span class="summary_signature">
|
|
185
|
+
|
|
186
|
+
<a href="#delete_network-instance_method" title="#delete_network (instance method)">#<strong>delete_network</strong>(network_id) ⇒ Bool </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>Delete an existing Dashboard network.</p>
|
|
202
|
+
</div></span>
|
|
203
|
+
|
|
204
|
+
</li>
|
|
205
|
+
|
|
206
|
+
|
|
207
|
+
<li class="public ">
|
|
208
|
+
<span class="summary_signature">
|
|
209
|
+
|
|
210
|
+
<a href="#get_auto_vpn_settings-instance_method" title="#get_auto_vpn_settings (instance method)">#<strong>get_auto_vpn_settings</strong>(network_id) ⇒ 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>Get AutoVPN settings for a specific network.</p>
|
|
226
|
+
</div></span>
|
|
227
|
+
|
|
228
|
+
</li>
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
<li class="public ">
|
|
232
|
+
<span class="summary_signature">
|
|
233
|
+
|
|
234
|
+
<a href="#get_ms_access_policies-instance_method" title="#get_ms_access_policies (instance method)">#<strong>get_ms_access_policies</strong>(network_id) ⇒ Array </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>Get all MS access policies configured for a specific Dashboard network.</p>
|
|
250
|
+
</div></span>
|
|
251
|
+
|
|
252
|
+
</li>
|
|
253
|
+
|
|
254
|
+
|
|
255
|
+
<li class="public ">
|
|
256
|
+
<span class="summary_signature">
|
|
257
|
+
|
|
258
|
+
<a href="#get_networks-instance_method" title="#get_networks (instance method)">#<strong>get_networks</strong>(org_id) ⇒ Array </a>
|
|
259
|
+
|
|
260
|
+
|
|
261
|
+
|
|
262
|
+
</span>
|
|
263
|
+
|
|
264
|
+
|
|
265
|
+
|
|
266
|
+
|
|
267
|
+
|
|
268
|
+
|
|
269
|
+
|
|
270
|
+
|
|
271
|
+
|
|
272
|
+
<span class="summary_desc"><div class='inline'>
|
|
273
|
+
<p>Returns the list of networks for a given organization.</p>
|
|
274
|
+
</div></span>
|
|
275
|
+
|
|
276
|
+
</li>
|
|
277
|
+
|
|
278
|
+
|
|
279
|
+
<li class="public ">
|
|
280
|
+
<span class="summary_signature">
|
|
281
|
+
|
|
282
|
+
<a href="#get_single_network-instance_method" title="#get_single_network (instance method)">#<strong>get_single_network</strong>(network_id) ⇒ Hash </a>
|
|
283
|
+
|
|
284
|
+
|
|
285
|
+
|
|
286
|
+
</span>
|
|
287
|
+
|
|
288
|
+
|
|
289
|
+
|
|
290
|
+
|
|
291
|
+
|
|
292
|
+
|
|
293
|
+
|
|
294
|
+
|
|
295
|
+
|
|
296
|
+
<span class="summary_desc"><div class='inline'>
|
|
297
|
+
<p>Returns the network details for a single network.</p>
|
|
298
|
+
</div></span>
|
|
299
|
+
|
|
300
|
+
</li>
|
|
301
|
+
|
|
302
|
+
|
|
303
|
+
<li class="public ">
|
|
304
|
+
<span class="summary_signature">
|
|
305
|
+
|
|
306
|
+
<a href="#traffic_analysis-instance_method" title="#traffic_analysis (instance method)">#<strong>traffic_analysis</strong>(network_id, options) ⇒ Object </a>
|
|
307
|
+
|
|
308
|
+
|
|
309
|
+
|
|
310
|
+
</span>
|
|
311
|
+
|
|
312
|
+
|
|
313
|
+
|
|
314
|
+
|
|
315
|
+
|
|
316
|
+
|
|
317
|
+
|
|
318
|
+
|
|
319
|
+
|
|
320
|
+
<span class="summary_desc"><div class='inline'>
|
|
321
|
+
<p>Return traffic analysis data for a network.</p>
|
|
322
|
+
</div></span>
|
|
323
|
+
|
|
324
|
+
</li>
|
|
325
|
+
|
|
326
|
+
|
|
327
|
+
<li class="public ">
|
|
328
|
+
<span class="summary_signature">
|
|
329
|
+
|
|
330
|
+
<a href="#unbind_network_to_template-instance_method" title="#unbind_network_to_template (instance method)">#<strong>unbind_network_to_template</strong>(network_id) ⇒ Integer </a>
|
|
331
|
+
|
|
332
|
+
|
|
333
|
+
|
|
334
|
+
</span>
|
|
335
|
+
|
|
336
|
+
|
|
337
|
+
|
|
338
|
+
|
|
339
|
+
|
|
340
|
+
|
|
341
|
+
|
|
342
|
+
|
|
343
|
+
|
|
344
|
+
<span class="summary_desc"><div class='inline'>
|
|
345
|
+
<p>Unbind a single network from a configuration template.</p>
|
|
346
|
+
</div></span>
|
|
347
|
+
|
|
348
|
+
</li>
|
|
349
|
+
|
|
350
|
+
|
|
351
|
+
<li class="public ">
|
|
352
|
+
<span class="summary_signature">
|
|
353
|
+
|
|
354
|
+
<a href="#update_auto_vpn_settings-instance_method" title="#update_auto_vpn_settings (instance method)">#<strong>update_auto_vpn_settings</strong>(network_id, options) ⇒ Hash </a>
|
|
355
|
+
|
|
356
|
+
|
|
357
|
+
|
|
358
|
+
</span>
|
|
359
|
+
|
|
360
|
+
|
|
361
|
+
|
|
362
|
+
|
|
363
|
+
|
|
364
|
+
|
|
365
|
+
|
|
366
|
+
|
|
367
|
+
|
|
368
|
+
<span class="summary_desc"><div class='inline'>
|
|
369
|
+
<p>Update AutoVPN for a specific network.</p>
|
|
370
|
+
</div></span>
|
|
371
|
+
|
|
372
|
+
</li>
|
|
373
|
+
|
|
374
|
+
|
|
375
|
+
<li class="public ">
|
|
376
|
+
<span class="summary_signature">
|
|
377
|
+
|
|
378
|
+
<a href="#update_network-instance_method" title="#update_network (instance method)">#<strong>update_network</strong>(network_id, options) ⇒ Hash </a>
|
|
379
|
+
|
|
380
|
+
|
|
381
|
+
|
|
382
|
+
</span>
|
|
383
|
+
|
|
384
|
+
|
|
385
|
+
|
|
386
|
+
|
|
387
|
+
|
|
388
|
+
|
|
389
|
+
|
|
390
|
+
|
|
391
|
+
|
|
392
|
+
<span class="summary_desc"><div class='inline'>
|
|
393
|
+
<p>Updates a network's details.</p>
|
|
394
|
+
</div></span>
|
|
395
|
+
|
|
396
|
+
</li>
|
|
397
|
+
|
|
398
|
+
|
|
399
|
+
</ul>
|
|
400
|
+
|
|
401
|
+
|
|
402
|
+
|
|
403
|
+
|
|
404
|
+
<div id="instance_method_details" class="method_details_list">
|
|
405
|
+
<h2>Instance Method Details</h2>
|
|
406
|
+
|
|
407
|
+
|
|
408
|
+
<div class="method_details first">
|
|
409
|
+
<h3 class="signature first" id="bind_network_to_template-instance_method">
|
|
410
|
+
|
|
411
|
+
#<strong>bind_network_to_template</strong>(network_id, options) ⇒ <tt>Integer</tt>
|
|
412
|
+
|
|
413
|
+
|
|
414
|
+
|
|
415
|
+
|
|
416
|
+
|
|
417
|
+
</h3><div class="docstring">
|
|
418
|
+
<div class="discussion">
|
|
419
|
+
|
|
420
|
+
<p>Bind a single network to a configuration template</p>
|
|
421
|
+
|
|
422
|
+
|
|
423
|
+
</div>
|
|
424
|
+
</div>
|
|
425
|
+
<div class="tags">
|
|
426
|
+
<p class="tag_title">Parameters:</p>
|
|
427
|
+
<ul class="param">
|
|
428
|
+
|
|
429
|
+
<li>
|
|
430
|
+
|
|
431
|
+
<span class='name'>network_id</span>
|
|
432
|
+
|
|
433
|
+
|
|
434
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
435
|
+
|
|
436
|
+
|
|
437
|
+
|
|
438
|
+
—
|
|
439
|
+
<div class='inline'>
|
|
440
|
+
<p>the source network that you want to bind to a tempalte</p>
|
|
441
|
+
</div>
|
|
442
|
+
|
|
443
|
+
</li>
|
|
444
|
+
|
|
445
|
+
<li>
|
|
446
|
+
|
|
447
|
+
<span class='name'>options</span>
|
|
448
|
+
|
|
449
|
+
|
|
450
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
451
|
+
|
|
452
|
+
|
|
453
|
+
|
|
454
|
+
—
|
|
455
|
+
<div class='inline'>
|
|
456
|
+
<p>options hash that contains configTemplateId and autoBind values. Refer to
|
|
457
|
+
the official Meraki Dashboard API documentation for more information on
|
|
458
|
+
these.</p>
|
|
459
|
+
</div>
|
|
460
|
+
|
|
461
|
+
</li>
|
|
462
|
+
|
|
463
|
+
</ul>
|
|
464
|
+
|
|
465
|
+
<p class="tag_title">Returns:</p>
|
|
466
|
+
<ul class="return">
|
|
467
|
+
|
|
468
|
+
<li>
|
|
469
|
+
|
|
470
|
+
|
|
471
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
|
472
|
+
|
|
473
|
+
|
|
474
|
+
|
|
475
|
+
—
|
|
476
|
+
<div class='inline'>
|
|
477
|
+
<p>HTTP Code</p>
|
|
478
|
+
</div>
|
|
479
|
+
|
|
480
|
+
</li>
|
|
481
|
+
|
|
482
|
+
</ul>
|
|
483
|
+
|
|
484
|
+
</div><table class="source_code">
|
|
485
|
+
<tr>
|
|
486
|
+
<td>
|
|
487
|
+
<pre class="lines">
|
|
488
|
+
|
|
489
|
+
|
|
490
|
+
85
|
|
491
|
+
86
|
|
492
|
+
87
|
|
493
|
+
88
|
|
494
|
+
89
|
|
495
|
+
90</pre>
|
|
496
|
+
</td>
|
|
497
|
+
<td>
|
|
498
|
+
<pre class="code"><span class="info file"># File 'lib/networks.rb', line 85</span>
|
|
499
|
+
|
|
500
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_bind_network_to_template'>bind_network_to_template</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>
|
|
501
|
+
<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>
|
|
502
|
+
<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>
|
|
503
|
+
|
|
504
|
+
<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'>/bind</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>
|
|
505
|
+
<span class='kw'>end</span></pre>
|
|
506
|
+
</td>
|
|
507
|
+
</tr>
|
|
508
|
+
</table>
|
|
509
|
+
</div>
|
|
510
|
+
|
|
511
|
+
<div class="method_details ">
|
|
512
|
+
<h3 class="signature " id="create_network-instance_method">
|
|
513
|
+
|
|
514
|
+
#<strong>create_network</strong>(org_id, options) ⇒ <tt>Hash</tt>
|
|
515
|
+
|
|
516
|
+
|
|
517
|
+
|
|
518
|
+
|
|
519
|
+
|
|
520
|
+
</h3><div class="docstring">
|
|
521
|
+
<div class="discussion">
|
|
522
|
+
|
|
523
|
+
<p>Create a new Dashboard network</p>
|
|
524
|
+
|
|
525
|
+
|
|
526
|
+
</div>
|
|
527
|
+
</div>
|
|
528
|
+
<div class="tags">
|
|
529
|
+
<p class="tag_title">Parameters:</p>
|
|
530
|
+
<ul class="param">
|
|
531
|
+
|
|
532
|
+
<li>
|
|
533
|
+
|
|
534
|
+
<span class='name'>org_id</span>
|
|
535
|
+
|
|
536
|
+
|
|
537
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
538
|
+
|
|
539
|
+
|
|
540
|
+
|
|
541
|
+
—
|
|
542
|
+
<div class='inline'>
|
|
543
|
+
<p>dashboard organization ID</p>
|
|
544
|
+
</div>
|
|
545
|
+
|
|
546
|
+
</li>
|
|
547
|
+
|
|
548
|
+
<li>
|
|
549
|
+
|
|
550
|
+
<span class='name'>options</span>
|
|
551
|
+
|
|
552
|
+
|
|
553
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
554
|
+
|
|
555
|
+
|
|
556
|
+
|
|
557
|
+
—
|
|
558
|
+
<div class='inline'>
|
|
559
|
+
<p>a hash containing the following options: name: the network name (REQUIRED)
|
|
560
|
+
type: the type of network (wireless, switch, appliance, or phone)
|
|
561
|
+
(REQUIRED) tags: tags for the network (NOT REQUIRED)</p>
|
|
562
|
+
</div>
|
|
563
|
+
|
|
564
|
+
</li>
|
|
565
|
+
|
|
566
|
+
</ul>
|
|
567
|
+
|
|
568
|
+
<p class="tag_title">Returns:</p>
|
|
569
|
+
<ul class="return">
|
|
570
|
+
|
|
571
|
+
<li>
|
|
572
|
+
|
|
573
|
+
|
|
574
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
575
|
+
|
|
576
|
+
|
|
577
|
+
|
|
578
|
+
—
|
|
579
|
+
<div class='inline'>
|
|
580
|
+
<p>a hash containing the new networks details</p>
|
|
581
|
+
</div>
|
|
582
|
+
|
|
583
|
+
</li>
|
|
584
|
+
|
|
585
|
+
</ul>
|
|
586
|
+
|
|
587
|
+
</div><table class="source_code">
|
|
588
|
+
<tr>
|
|
589
|
+
<td>
|
|
590
|
+
<pre class="lines">
|
|
591
|
+
|
|
592
|
+
|
|
593
|
+
37
|
|
594
|
+
38
|
|
595
|
+
39
|
|
596
|
+
40
|
|
597
|
+
41</pre>
|
|
598
|
+
</td>
|
|
599
|
+
<td>
|
|
600
|
+
<pre class="code"><span class="info file"># File 'lib/networks.rb', line 37</span>
|
|
601
|
+
|
|
602
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_create_network'>create_network</span><span class='lparen'>(</span><span class='id identifier rubyid_org_id'>org_id</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
|
603
|
+
<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>
|
|
604
|
+
<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>
|
|
605
|
+
<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'>/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'>/networks</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>
|
|
606
|
+
<span class='kw'>end</span></pre>
|
|
607
|
+
</td>
|
|
608
|
+
</tr>
|
|
609
|
+
</table>
|
|
610
|
+
</div>
|
|
611
|
+
|
|
612
|
+
<div class="method_details ">
|
|
613
|
+
<h3 class="signature " id="delete_network-instance_method">
|
|
614
|
+
|
|
615
|
+
#<strong>delete_network</strong>(network_id) ⇒ <tt>Bool</tt>
|
|
616
|
+
|
|
617
|
+
|
|
618
|
+
|
|
619
|
+
|
|
620
|
+
|
|
621
|
+
</h3><div class="docstring">
|
|
622
|
+
<div class="discussion">
|
|
623
|
+
|
|
624
|
+
<p>Delete an existing Dashboard network</p>
|
|
625
|
+
|
|
626
|
+
|
|
627
|
+
</div>
|
|
628
|
+
</div>
|
|
629
|
+
<div class="tags">
|
|
630
|
+
<p class="tag_title">Parameters:</p>
|
|
631
|
+
<ul class="param">
|
|
632
|
+
|
|
633
|
+
<li>
|
|
634
|
+
|
|
635
|
+
<span class='name'>network_id</span>
|
|
636
|
+
|
|
637
|
+
|
|
638
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
639
|
+
|
|
640
|
+
|
|
641
|
+
|
|
642
|
+
—
|
|
643
|
+
<div class='inline'>
|
|
644
|
+
<p>dashboard netwok ID to delete</p>
|
|
645
|
+
</div>
|
|
646
|
+
|
|
647
|
+
</li>
|
|
648
|
+
|
|
649
|
+
</ul>
|
|
650
|
+
|
|
651
|
+
<p class="tag_title">Returns:</p>
|
|
652
|
+
<ul class="return">
|
|
653
|
+
|
|
654
|
+
<li>
|
|
655
|
+
|
|
656
|
+
|
|
657
|
+
<span class='type'>(<tt>Bool</tt>)</span>
|
|
658
|
+
|
|
659
|
+
|
|
660
|
+
|
|
661
|
+
—
|
|
662
|
+
<div class='inline'>
|
|
663
|
+
<p>status true if the network was deleted, false if not</p>
|
|
664
|
+
</div>
|
|
665
|
+
|
|
666
|
+
</li>
|
|
667
|
+
|
|
668
|
+
</ul>
|
|
669
|
+
|
|
670
|
+
</div><table class="source_code">
|
|
671
|
+
<tr>
|
|
672
|
+
<td>
|
|
673
|
+
<pre class="lines">
|
|
674
|
+
|
|
675
|
+
|
|
676
|
+
46
|
|
677
|
+
47
|
|
678
|
+
48
|
|
679
|
+
49</pre>
|
|
680
|
+
</td>
|
|
681
|
+
<td>
|
|
682
|
+
<pre class="code"><span class="info file"># File 'lib/networks.rb', line 46</span>
|
|
683
|
+
|
|
684
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_delete_network'>delete_network</span><span class='lparen'>(</span><span class='id identifier rubyid_network_id'>network_id</span><span class='rparen'>)</span>
|
|
685
|
+
<span class='id identifier rubyid_res'>res</span> <span class='op'>=</span> <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_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>DELETE</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
|
686
|
+
<span class='kw'>return</span> <span class='id identifier rubyid_res'>res</span><span class='period'>.</span><span class='id identifier rubyid_code'>code</span> <span class='op'>==</span> <span class='int'>204</span> <span class='op'>?</span> <span class='kw'>true</span> <span class='op'>:</span> <span class='kw'>false</span>
|
|
687
|
+
<span class='kw'>end</span></pre>
|
|
688
|
+
</td>
|
|
689
|
+
</tr>
|
|
690
|
+
</table>
|
|
691
|
+
</div>
|
|
692
|
+
|
|
693
|
+
<div class="method_details ">
|
|
694
|
+
<h3 class="signature " id="get_auto_vpn_settings-instance_method">
|
|
695
|
+
|
|
696
|
+
#<strong>get_auto_vpn_settings</strong>(network_id) ⇒ <tt>Hash</tt>
|
|
697
|
+
|
|
698
|
+
|
|
699
|
+
|
|
700
|
+
|
|
701
|
+
|
|
702
|
+
</h3><div class="docstring">
|
|
703
|
+
<div class="discussion">
|
|
704
|
+
|
|
705
|
+
<p>Get AutoVPN settings for a specific network</p>
|
|
706
|
+
|
|
707
|
+
|
|
708
|
+
</div>
|
|
709
|
+
</div>
|
|
710
|
+
<div class="tags">
|
|
711
|
+
<p class="tag_title">Parameters:</p>
|
|
712
|
+
<ul class="param">
|
|
713
|
+
|
|
714
|
+
<li>
|
|
715
|
+
|
|
716
|
+
<span class='name'>network_id</span>
|
|
717
|
+
|
|
718
|
+
|
|
719
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
720
|
+
|
|
721
|
+
|
|
722
|
+
|
|
723
|
+
—
|
|
724
|
+
<div class='inline'>
|
|
725
|
+
<p>dashboard network ID to get AutoVPN settings for</p>
|
|
726
|
+
</div>
|
|
727
|
+
|
|
728
|
+
</li>
|
|
729
|
+
|
|
730
|
+
</ul>
|
|
731
|
+
|
|
732
|
+
<p class="tag_title">Returns:</p>
|
|
733
|
+
<ul class="return">
|
|
734
|
+
|
|
735
|
+
<li>
|
|
736
|
+
|
|
737
|
+
|
|
738
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
739
|
+
|
|
740
|
+
|
|
741
|
+
|
|
742
|
+
—
|
|
743
|
+
<div class='inline'>
|
|
744
|
+
<p>a hash containing the AutoVPN details for the network</p>
|
|
745
|
+
</div>
|
|
746
|
+
|
|
747
|
+
</li>
|
|
748
|
+
|
|
749
|
+
</ul>
|
|
750
|
+
|
|
751
|
+
</div><table class="source_code">
|
|
752
|
+
<tr>
|
|
753
|
+
<td>
|
|
754
|
+
<pre class="lines">
|
|
755
|
+
|
|
756
|
+
|
|
757
|
+
54
|
|
758
|
+
55
|
|
759
|
+
56</pre>
|
|
760
|
+
</td>
|
|
761
|
+
<td>
|
|
762
|
+
<pre class="code"><span class="info file"># File 'lib/networks.rb', line 54</span>
|
|
763
|
+
|
|
764
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_get_auto_vpn_settings'>get_auto_vpn_settings</span><span class='lparen'>(</span><span class='id identifier rubyid_network_id'>network_id</span><span class='rparen'>)</span>
|
|
765
|
+
<span class='id identifier rubyid_res'>res</span> <span class='op'>=</span> <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'>/siteToSiteVpn</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>
|
|
766
|
+
<span class='kw'>end</span></pre>
|
|
767
|
+
</td>
|
|
768
|
+
</tr>
|
|
769
|
+
</table>
|
|
770
|
+
</div>
|
|
771
|
+
|
|
772
|
+
<div class="method_details ">
|
|
773
|
+
<h3 class="signature " id="get_ms_access_policies-instance_method">
|
|
774
|
+
|
|
775
|
+
#<strong>get_ms_access_policies</strong>(network_id) ⇒ <tt>Array</tt>
|
|
776
|
+
|
|
777
|
+
|
|
778
|
+
|
|
779
|
+
|
|
780
|
+
|
|
781
|
+
</h3><div class="docstring">
|
|
782
|
+
<div class="discussion">
|
|
783
|
+
|
|
784
|
+
<p>Get all MS access policies configured for a specific Dashboard network</p>
|
|
785
|
+
|
|
786
|
+
|
|
787
|
+
</div>
|
|
788
|
+
</div>
|
|
789
|
+
<div class="tags">
|
|
790
|
+
<p class="tag_title">Parameters:</p>
|
|
791
|
+
<ul class="param">
|
|
792
|
+
|
|
793
|
+
<li>
|
|
794
|
+
|
|
795
|
+
<span class='name'>network_id</span>
|
|
796
|
+
|
|
797
|
+
|
|
798
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
799
|
+
|
|
800
|
+
|
|
801
|
+
|
|
802
|
+
—
|
|
803
|
+
<div class='inline'>
|
|
804
|
+
<p>dashboard network ID to get MS policies for</p>
|
|
805
|
+
</div>
|
|
806
|
+
|
|
807
|
+
</li>
|
|
808
|
+
|
|
809
|
+
</ul>
|
|
810
|
+
|
|
811
|
+
<p class="tag_title">Returns:</p>
|
|
812
|
+
<ul class="return">
|
|
813
|
+
|
|
814
|
+
<li>
|
|
815
|
+
|
|
816
|
+
|
|
817
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
|
818
|
+
|
|
819
|
+
|
|
820
|
+
|
|
821
|
+
—
|
|
822
|
+
<div class='inline'>
|
|
823
|
+
<p>an array of hashes for containing the policy information</p>
|
|
824
|
+
</div>
|
|
825
|
+
|
|
826
|
+
</li>
|
|
827
|
+
|
|
828
|
+
</ul>
|
|
829
|
+
|
|
830
|
+
</div><table class="source_code">
|
|
831
|
+
<tr>
|
|
832
|
+
<td>
|
|
833
|
+
<pre class="lines">
|
|
834
|
+
|
|
835
|
+
|
|
836
|
+
75
|
|
837
|
+
76
|
|
838
|
+
77
|
|
839
|
+
78</pre>
|
|
840
|
+
</td>
|
|
841
|
+
<td>
|
|
842
|
+
<pre class="code"><span class="info file"># File 'lib/networks.rb', line 75</span>
|
|
843
|
+
|
|
844
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_get_ms_access_policies'>get_ms_access_policies</span><span class='lparen'>(</span><span class='id identifier rubyid_network_id'>network_id</span><span class='rparen'>)</span>
|
|
845
|
+
<span class='id identifier rubyid_res'>res</span> <span class='op'>=</span> <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'>/accessPolicies</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>
|
|
846
|
+
<span class='kw'>return</span> <span class='id identifier rubyid_res'>res</span>
|
|
847
|
+
<span class='kw'>end</span></pre>
|
|
848
|
+
</td>
|
|
849
|
+
</tr>
|
|
850
|
+
</table>
|
|
851
|
+
</div>
|
|
852
|
+
|
|
853
|
+
<div class="method_details ">
|
|
854
|
+
<h3 class="signature " id="get_networks-instance_method">
|
|
855
|
+
|
|
856
|
+
#<strong>get_networks</strong>(org_id) ⇒ <tt>Array</tt>
|
|
857
|
+
|
|
858
|
+
|
|
859
|
+
|
|
860
|
+
|
|
861
|
+
|
|
862
|
+
</h3><div class="docstring">
|
|
863
|
+
<div class="discussion">
|
|
864
|
+
|
|
865
|
+
<p>Returns the list of networks for a given organization</p>
|
|
866
|
+
|
|
867
|
+
|
|
868
|
+
</div>
|
|
869
|
+
</div>
|
|
870
|
+
<div class="tags">
|
|
871
|
+
<p class="tag_title">Parameters:</p>
|
|
872
|
+
<ul class="param">
|
|
873
|
+
|
|
874
|
+
<li>
|
|
875
|
+
|
|
876
|
+
<span class='name'>org_id</span>
|
|
877
|
+
|
|
878
|
+
|
|
879
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
880
|
+
|
|
881
|
+
|
|
882
|
+
|
|
883
|
+
—
|
|
884
|
+
<div class='inline'>
|
|
885
|
+
<p>dashboard organization ID</p>
|
|
886
|
+
</div>
|
|
887
|
+
|
|
888
|
+
</li>
|
|
889
|
+
|
|
890
|
+
</ul>
|
|
891
|
+
|
|
892
|
+
<p class="tag_title">Returns:</p>
|
|
893
|
+
<ul class="return">
|
|
894
|
+
|
|
895
|
+
<li>
|
|
896
|
+
|
|
897
|
+
|
|
898
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
|
899
|
+
|
|
900
|
+
|
|
901
|
+
|
|
902
|
+
—
|
|
903
|
+
<div class='inline'>
|
|
904
|
+
<p>an array of hashes containing the network details</p>
|
|
905
|
+
</div>
|
|
906
|
+
|
|
907
|
+
</li>
|
|
908
|
+
|
|
909
|
+
</ul>
|
|
910
|
+
|
|
911
|
+
</div><table class="source_code">
|
|
912
|
+
<tr>
|
|
913
|
+
<td>
|
|
914
|
+
<pre class="lines">
|
|
915
|
+
|
|
916
|
+
|
|
917
|
+
7
|
|
918
|
+
8
|
|
919
|
+
9</pre>
|
|
920
|
+
</td>
|
|
921
|
+
<td>
|
|
922
|
+
<pre class="code"><span class="info file"># File 'lib/networks.rb', line 7</span>
|
|
923
|
+
|
|
924
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_get_networks'>get_networks</span><span class='lparen'>(</span><span class='id identifier rubyid_org_id'>org_id</span><span class='rparen'>)</span>
|
|
925
|
+
<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'>/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'>/networks</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>
|
|
926
|
+
<span class='kw'>end</span></pre>
|
|
927
|
+
</td>
|
|
928
|
+
</tr>
|
|
929
|
+
</table>
|
|
930
|
+
</div>
|
|
931
|
+
|
|
932
|
+
<div class="method_details ">
|
|
933
|
+
<h3 class="signature " id="get_single_network-instance_method">
|
|
934
|
+
|
|
935
|
+
#<strong>get_single_network</strong>(network_id) ⇒ <tt>Hash</tt>
|
|
936
|
+
|
|
937
|
+
|
|
938
|
+
|
|
939
|
+
|
|
940
|
+
|
|
941
|
+
</h3><div class="docstring">
|
|
942
|
+
<div class="discussion">
|
|
943
|
+
|
|
944
|
+
<p>Returns the network details for a single network</p>
|
|
945
|
+
|
|
946
|
+
|
|
947
|
+
</div>
|
|
948
|
+
</div>
|
|
949
|
+
<div class="tags">
|
|
950
|
+
<p class="tag_title">Parameters:</p>
|
|
951
|
+
<ul class="param">
|
|
952
|
+
|
|
953
|
+
<li>
|
|
954
|
+
|
|
955
|
+
<span class='name'>network_id</span>
|
|
956
|
+
|
|
957
|
+
|
|
958
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
959
|
+
|
|
960
|
+
|
|
961
|
+
|
|
962
|
+
—
|
|
963
|
+
<div class='inline'>
|
|
964
|
+
<p>dashboard network ID</p>
|
|
965
|
+
</div>
|
|
966
|
+
|
|
967
|
+
</li>
|
|
968
|
+
|
|
969
|
+
</ul>
|
|
970
|
+
|
|
971
|
+
<p class="tag_title">Returns:</p>
|
|
972
|
+
<ul class="return">
|
|
973
|
+
|
|
974
|
+
<li>
|
|
975
|
+
|
|
976
|
+
|
|
977
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
978
|
+
|
|
979
|
+
|
|
980
|
+
|
|
981
|
+
—
|
|
982
|
+
<div class='inline'>
|
|
983
|
+
<p>a hash containing the network details of the specific network</p>
|
|
984
|
+
</div>
|
|
985
|
+
|
|
986
|
+
</li>
|
|
987
|
+
|
|
988
|
+
</ul>
|
|
989
|
+
|
|
990
|
+
</div><table class="source_code">
|
|
991
|
+
<tr>
|
|
992
|
+
<td>
|
|
993
|
+
<pre class="lines">
|
|
994
|
+
|
|
995
|
+
|
|
996
|
+
14
|
|
997
|
+
15
|
|
998
|
+
16</pre>
|
|
999
|
+
</td>
|
|
1000
|
+
<td>
|
|
1001
|
+
<pre class="code"><span class="info file"># File 'lib/networks.rb', line 14</span>
|
|
1002
|
+
|
|
1003
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_get_single_network'>get_single_network</span><span class='lparen'>(</span><span class='id identifier rubyid_network_id'>network_id</span><span class='rparen'>)</span>
|
|
1004
|
+
<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_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>
|
|
1005
|
+
<span class='kw'>end</span></pre>
|
|
1006
|
+
</td>
|
|
1007
|
+
</tr>
|
|
1008
|
+
</table>
|
|
1009
|
+
</div>
|
|
1010
|
+
|
|
1011
|
+
<div class="method_details ">
|
|
1012
|
+
<h3 class="signature " id="traffic_analysis-instance_method">
|
|
1013
|
+
|
|
1014
|
+
#<strong>traffic_analysis</strong>(network_id, options) ⇒ <tt>Object</tt>
|
|
1015
|
+
|
|
1016
|
+
|
|
1017
|
+
|
|
1018
|
+
|
|
1019
|
+
|
|
1020
|
+
</h3><div class="docstring">
|
|
1021
|
+
<div class="discussion">
|
|
1022
|
+
|
|
1023
|
+
<p>Return traffic analysis data for a network</p>
|
|
1024
|
+
|
|
1025
|
+
|
|
1026
|
+
</div>
|
|
1027
|
+
</div>
|
|
1028
|
+
<div class="tags">
|
|
1029
|
+
<p class="tag_title">Parameters:</p>
|
|
1030
|
+
<ul class="param">
|
|
1031
|
+
|
|
1032
|
+
<li>
|
|
1033
|
+
|
|
1034
|
+
<span class='name'>network_id</span>
|
|
1035
|
+
|
|
1036
|
+
|
|
1037
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
1038
|
+
|
|
1039
|
+
|
|
1040
|
+
|
|
1041
|
+
—
|
|
1042
|
+
<div class='inline'>
|
|
1043
|
+
<p>network that you want data for</p>
|
|
1044
|
+
</div>
|
|
1045
|
+
|
|
1046
|
+
</li>
|
|
1047
|
+
|
|
1048
|
+
<li>
|
|
1049
|
+
|
|
1050
|
+
<span class='name'>options</span>
|
|
1051
|
+
|
|
1052
|
+
|
|
1053
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
1054
|
+
|
|
1055
|
+
|
|
1056
|
+
|
|
1057
|
+
—
|
|
1058
|
+
<div class='inline'>
|
|
1059
|
+
<p>options hash containing a timespan and deviceType. Refer to the official
|
|
1060
|
+
Meraki Dashboard API documentation for more information on these.</p>
|
|
1061
|
+
</div>
|
|
1062
|
+
|
|
1063
|
+
</li>
|
|
1064
|
+
|
|
1065
|
+
</ul>
|
|
1066
|
+
|
|
1067
|
+
|
|
1068
|
+
</div><table class="source_code">
|
|
1069
|
+
<tr>
|
|
1070
|
+
<td>
|
|
1071
|
+
<pre class="lines">
|
|
1072
|
+
|
|
1073
|
+
|
|
1074
|
+
103
|
|
1075
|
+
104
|
|
1076
|
+
105
|
|
1077
|
+
106
|
|
1078
|
+
107</pre>
|
|
1079
|
+
</td>
|
|
1080
|
+
<td>
|
|
1081
|
+
<pre class="code"><span class="info file"># File 'lib/networks.rb', line 103</span>
|
|
1082
|
+
|
|
1083
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_traffic_analysis'>traffic_analysis</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>
|
|
1084
|
+
<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>
|
|
1085
|
+
<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>
|
|
1086
|
+
<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'>/traffic</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='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
|
1087
|
+
<span class='kw'>end</span></pre>
|
|
1088
|
+
</td>
|
|
1089
|
+
</tr>
|
|
1090
|
+
</table>
|
|
1091
|
+
</div>
|
|
1092
|
+
|
|
1093
|
+
<div class="method_details ">
|
|
1094
|
+
<h3 class="signature " id="unbind_network_to_template-instance_method">
|
|
1095
|
+
|
|
1096
|
+
#<strong>unbind_network_to_template</strong>(network_id) ⇒ <tt>Integer</tt>
|
|
1097
|
+
|
|
1098
|
+
|
|
1099
|
+
|
|
1100
|
+
|
|
1101
|
+
|
|
1102
|
+
</h3><div class="docstring">
|
|
1103
|
+
<div class="discussion">
|
|
1104
|
+
|
|
1105
|
+
<p>Unbind a single network from a configuration template</p>
|
|
1106
|
+
|
|
1107
|
+
|
|
1108
|
+
</div>
|
|
1109
|
+
</div>
|
|
1110
|
+
<div class="tags">
|
|
1111
|
+
<p class="tag_title">Parameters:</p>
|
|
1112
|
+
<ul class="param">
|
|
1113
|
+
|
|
1114
|
+
<li>
|
|
1115
|
+
|
|
1116
|
+
<span class='name'>network_id</span>
|
|
1117
|
+
|
|
1118
|
+
|
|
1119
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
1120
|
+
|
|
1121
|
+
|
|
1122
|
+
|
|
1123
|
+
—
|
|
1124
|
+
<div class='inline'>
|
|
1125
|
+
<p>the network that you want to unbind from it's template</p>
|
|
1126
|
+
</div>
|
|
1127
|
+
|
|
1128
|
+
</li>
|
|
1129
|
+
|
|
1130
|
+
</ul>
|
|
1131
|
+
|
|
1132
|
+
<p class="tag_title">Returns:</p>
|
|
1133
|
+
<ul class="return">
|
|
1134
|
+
|
|
1135
|
+
<li>
|
|
1136
|
+
|
|
1137
|
+
|
|
1138
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
|
1139
|
+
|
|
1140
|
+
|
|
1141
|
+
|
|
1142
|
+
—
|
|
1143
|
+
<div class='inline'>
|
|
1144
|
+
<p>HTTP Code</p>
|
|
1145
|
+
</div>
|
|
1146
|
+
|
|
1147
|
+
</li>
|
|
1148
|
+
|
|
1149
|
+
</ul>
|
|
1150
|
+
|
|
1151
|
+
</div><table class="source_code">
|
|
1152
|
+
<tr>
|
|
1153
|
+
<td>
|
|
1154
|
+
<pre class="lines">
|
|
1155
|
+
|
|
1156
|
+
|
|
1157
|
+
95
|
|
1158
|
+
96
|
|
1159
|
+
97</pre>
|
|
1160
|
+
</td>
|
|
1161
|
+
<td>
|
|
1162
|
+
<pre class="code"><span class="info file"># File 'lib/networks.rb', line 95</span>
|
|
1163
|
+
|
|
1164
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_unbind_network_to_template'>unbind_network_to_template</span><span class='lparen'>(</span><span class='id identifier rubyid_network_id'>network_id</span><span class='rparen'>)</span>
|
|
1165
|
+
<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'>/unbind</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>
|
|
1166
|
+
<span class='kw'>end</span></pre>
|
|
1167
|
+
</td>
|
|
1168
|
+
</tr>
|
|
1169
|
+
</table>
|
|
1170
|
+
</div>
|
|
1171
|
+
|
|
1172
|
+
<div class="method_details ">
|
|
1173
|
+
<h3 class="signature " id="update_auto_vpn_settings-instance_method">
|
|
1174
|
+
|
|
1175
|
+
#<strong>update_auto_vpn_settings</strong>(network_id, options) ⇒ <tt>Hash</tt>
|
|
1176
|
+
|
|
1177
|
+
|
|
1178
|
+
|
|
1179
|
+
|
|
1180
|
+
|
|
1181
|
+
</h3><div class="docstring">
|
|
1182
|
+
<div class="discussion">
|
|
1183
|
+
|
|
1184
|
+
<p>Update AutoVPN for a specific network</p>
|
|
1185
|
+
|
|
1186
|
+
|
|
1187
|
+
</div>
|
|
1188
|
+
</div>
|
|
1189
|
+
<div class="tags">
|
|
1190
|
+
<p class="tag_title">Parameters:</p>
|
|
1191
|
+
<ul class="param">
|
|
1192
|
+
|
|
1193
|
+
<li>
|
|
1194
|
+
|
|
1195
|
+
<span class='name'>network_id</span>
|
|
1196
|
+
|
|
1197
|
+
|
|
1198
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
1199
|
+
|
|
1200
|
+
|
|
1201
|
+
|
|
1202
|
+
—
|
|
1203
|
+
<div class='inline'>
|
|
1204
|
+
<p>dashboard network ID to update AutoVPN settings for</p>
|
|
1205
|
+
</div>
|
|
1206
|
+
|
|
1207
|
+
</li>
|
|
1208
|
+
|
|
1209
|
+
<li>
|
|
1210
|
+
|
|
1211
|
+
<span class='name'>options</span>
|
|
1212
|
+
|
|
1213
|
+
|
|
1214
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
1215
|
+
|
|
1216
|
+
|
|
1217
|
+
|
|
1218
|
+
—
|
|
1219
|
+
<div class='inline'>
|
|
1220
|
+
<p>options hash containing the following options: mode: hub, spoke or none
|
|
1221
|
+
hubs: an array of Hashes containing the hubId and a true or false for
|
|
1222
|
+
useDefaultRoute subnets: an array of Hashes containing localSubnet and
|
|
1223
|
+
useVPN</p>
|
|
1224
|
+
</div>
|
|
1225
|
+
|
|
1226
|
+
</li>
|
|
1227
|
+
|
|
1228
|
+
</ul>
|
|
1229
|
+
|
|
1230
|
+
<p class="tag_title">Returns:</p>
|
|
1231
|
+
<ul class="return">
|
|
1232
|
+
|
|
1233
|
+
<li>
|
|
1234
|
+
|
|
1235
|
+
|
|
1236
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
1237
|
+
|
|
1238
|
+
|
|
1239
|
+
|
|
1240
|
+
</li>
|
|
1241
|
+
|
|
1242
|
+
</ul>
|
|
1243
|
+
|
|
1244
|
+
</div><table class="source_code">
|
|
1245
|
+
<tr>
|
|
1246
|
+
<td>
|
|
1247
|
+
<pre class="lines">
|
|
1248
|
+
|
|
1249
|
+
|
|
1250
|
+
65
|
|
1251
|
+
66
|
|
1252
|
+
67
|
|
1253
|
+
68
|
|
1254
|
+
69
|
|
1255
|
+
70</pre>
|
|
1256
|
+
</td>
|
|
1257
|
+
<td>
|
|
1258
|
+
<pre class="code"><span class="info file"># File 'lib/networks.rb', line 65</span>
|
|
1259
|
+
|
|
1260
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_update_auto_vpn_settings'>update_auto_vpn_settings</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>
|
|
1261
|
+
<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>
|
|
1262
|
+
|
|
1263
|
+
<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>
|
|
1264
|
+
<span class='id identifier rubyid_res'>res</span> <span class='op'>=</span> <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'>/siteToSiteVpn</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>
|
|
1265
|
+
<span class='kw'>end</span></pre>
|
|
1266
|
+
</td>
|
|
1267
|
+
</tr>
|
|
1268
|
+
</table>
|
|
1269
|
+
</div>
|
|
1270
|
+
|
|
1271
|
+
<div class="method_details ">
|
|
1272
|
+
<h3 class="signature " id="update_network-instance_method">
|
|
1273
|
+
|
|
1274
|
+
#<strong>update_network</strong>(network_id, options) ⇒ <tt>Hash</tt>
|
|
1275
|
+
|
|
1276
|
+
|
|
1277
|
+
|
|
1278
|
+
|
|
1279
|
+
|
|
1280
|
+
</h3><div class="docstring">
|
|
1281
|
+
<div class="discussion">
|
|
1282
|
+
|
|
1283
|
+
<p>Updates a network's details</p>
|
|
1284
|
+
|
|
1285
|
+
|
|
1286
|
+
</div>
|
|
1287
|
+
</div>
|
|
1288
|
+
<div class="tags">
|
|
1289
|
+
<p class="tag_title">Parameters:</p>
|
|
1290
|
+
<ul class="param">
|
|
1291
|
+
|
|
1292
|
+
<li>
|
|
1293
|
+
|
|
1294
|
+
<span class='name'>network_id</span>
|
|
1295
|
+
|
|
1296
|
+
|
|
1297
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
1298
|
+
|
|
1299
|
+
|
|
1300
|
+
|
|
1301
|
+
—
|
|
1302
|
+
<div class='inline'>
|
|
1303
|
+
<p>dashboard network ID</p>
|
|
1304
|
+
</div>
|
|
1305
|
+
|
|
1306
|
+
</li>
|
|
1307
|
+
|
|
1308
|
+
<li>
|
|
1309
|
+
|
|
1310
|
+
<span class='name'>options</span>
|
|
1311
|
+
|
|
1312
|
+
|
|
1313
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
1314
|
+
|
|
1315
|
+
|
|
1316
|
+
|
|
1317
|
+
—
|
|
1318
|
+
<div class='inline'>
|
|
1319
|
+
<p>a hash containing any of the following keys: name: the network name tags:
|
|
1320
|
+
tags assigned to the network</p>
|
|
1321
|
+
</div>
|
|
1322
|
+
|
|
1323
|
+
</li>
|
|
1324
|
+
|
|
1325
|
+
</ul>
|
|
1326
|
+
|
|
1327
|
+
<p class="tag_title">Returns:</p>
|
|
1328
|
+
<ul class="return">
|
|
1329
|
+
|
|
1330
|
+
<li>
|
|
1331
|
+
|
|
1332
|
+
|
|
1333
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
1334
|
+
|
|
1335
|
+
|
|
1336
|
+
|
|
1337
|
+
—
|
|
1338
|
+
<div class='inline'>
|
|
1339
|
+
<p>a hash containing the updated network details</p>
|
|
1340
|
+
</div>
|
|
1341
|
+
|
|
1342
|
+
</li>
|
|
1343
|
+
|
|
1344
|
+
</ul>
|
|
1345
|
+
|
|
1346
|
+
</div><table class="source_code">
|
|
1347
|
+
<tr>
|
|
1348
|
+
<td>
|
|
1349
|
+
<pre class="lines">
|
|
1350
|
+
|
|
1351
|
+
|
|
1352
|
+
24
|
|
1353
|
+
25
|
|
1354
|
+
26
|
|
1355
|
+
27
|
|
1356
|
+
28</pre>
|
|
1357
|
+
</td>
|
|
1358
|
+
<td>
|
|
1359
|
+
<pre class="code"><span class="info file"># File 'lib/networks.rb', line 24</span>
|
|
1360
|
+
|
|
1361
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_update_network'>update_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>
|
|
1362
|
+
<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>
|
|
1363
|
+
<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>
|
|
1364
|
+
<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_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>
|
|
1365
|
+
<span class='kw'>end</span></pre>
|
|
1366
|
+
</td>
|
|
1367
|
+
</tr>
|
|
1368
|
+
</table>
|
|
1369
|
+
</div>
|
|
1370
|
+
|
|
1371
|
+
</div>
|
|
1372
|
+
|
|
1373
|
+
</div>
|
|
1374
|
+
|
|
1375
|
+
<div id="footer">
|
|
1376
|
+
Generated on Thu Nov 17 22:15:39 2016 by
|
|
1377
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
1378
|
+
0.9.5 (ruby-2.3.0).
|
|
1379
|
+
</div>
|
|
1380
|
+
|
|
1381
|
+
</div>
|
|
1382
|
+
</body>
|
|
1383
1383
|
</html>
|