dashboard-api 0.4.0 → 0.9.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +3 -2
- data/doc/Admins.html +604 -0
- data/doc/Clients.html +1 -1
- data/doc/DashboardAPI.html +80 -23
- data/doc/DashboardAPIVersion.html +2 -2
- data/doc/Devices.html +1 -1
- data/doc/Networks.html +338 -2
- data/doc/Organizations.html +1 -1
- data/doc/Phones.html +642 -0
- data/doc/SAML.html +759 -0
- data/doc/SSIDs.html +1 -1
- data/doc/Switchports.html +1 -1
- data/doc/Templates.html +379 -0
- data/doc/VLANs.html +763 -0
- data/doc/_index.html +61 -1
- data/doc/class_list.html +1 -1
- data/doc/file.README.html +11 -6
- data/doc/index.html +11 -6
- data/doc/method_list.html +200 -16
- data/doc/top-level-namespace.html +2 -2
- data/lib/admins.rb +37 -0
- data/lib/dashboard-api.rb +11 -0
- data/lib/dashboard-api/version.rb +1 -1
- data/lib/networks.rb +29 -0
- data/lib/phones.rb +40 -0
- data/lib/saml.rb +47 -0
- data/lib/templates.rb +18 -0
- data/lib/vlans.rb +49 -0
- metadata +12 -2
data/doc/Clients.html
CHANGED
@@ -267,7 +267,7 @@
|
|
267
267
|
</div>
|
268
268
|
|
269
269
|
<div id="footer">
|
270
|
-
Generated on
|
270
|
+
Generated on Wed Nov 16 21:55:08 2016 by
|
271
271
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
272
272
|
0.9.5 (ruby-2.3.0).
|
273
273
|
</div>
|
data/doc/DashboardAPI.html
CHANGED
@@ -91,7 +91,7 @@
|
|
91
91
|
|
92
92
|
<dl>
|
93
93
|
<dt>Includes:</dt>
|
94
|
-
<dd><span class='object_link'><a href="Clients.html" title="Clients (module)">Clients</a></span>, <span class='object_link'><a href="DashboardAPIVersion.html" title="DashboardAPIVersion (module)">DashboardAPIVersion</a></span>, <span class='object_link'><a href="Devices.html" title="Devices (module)">Devices</a></span>, HTTParty, <span class='object_link'><a href="Networks.html" title="Networks (module)">Networks</a></span>, <span class='object_link'><a href="Organizations.html" title="Organizations (module)">Organizations</a></span>, <span class='object_link'><a href="SSIDs.html" title="SSIDs (module)">SSIDs</a></span>, <span class='object_link'><a href="Switchports.html" title="Switchports (module)">Switchports</a></span></dd>
|
94
|
+
<dd><span class='object_link'><a href="Admins.html" title="Admins (module)">Admins</a></span>, <span class='object_link'><a href="Clients.html" title="Clients (module)">Clients</a></span>, <span class='object_link'><a href="DashboardAPIVersion.html" title="DashboardAPIVersion (module)">DashboardAPIVersion</a></span>, <span class='object_link'><a href="Devices.html" title="Devices (module)">Devices</a></span>, HTTParty, <span class='object_link'><a href="Networks.html" title="Networks (module)">Networks</a></span>, <span class='object_link'><a href="Organizations.html" title="Organizations (module)">Organizations</a></span>, <span class='object_link'><a href="Phones.html" title="Phones (module)">Phones</a></span>, <span class='object_link'><a href="SAML.html" title="SAML (module)">SAML</a></span>, <span class='object_link'><a href="SSIDs.html" title="SSIDs (module)">SSIDs</a></span>, <span class='object_link'><a href="Switchports.html" title="Switchports (module)">Switchports</a></span>, <span class='object_link'><a href="Templates.html" title="Templates (module)">Templates</a></span>, <span class='object_link'><a href="VLANs.html" title="VLANs (module)">VLANs</a></span></dd>
|
95
95
|
</dl>
|
96
96
|
|
97
97
|
|
@@ -250,6 +250,50 @@
|
|
250
250
|
|
251
251
|
|
252
252
|
|
253
|
+
<h3 class="inherited">Methods included from <span class='object_link'><a href="SAML.html" title="SAML (module)">SAML</a></span></h3>
|
254
|
+
<p class="inherited"><span class='object_link'><a href="SAML.html#create_saml_role-instance_method" title="SAML#create_saml_role (method)">#create_saml_role</a></span>, <span class='object_link'><a href="SAML.html#list_saml_roles-instance_method" title="SAML#list_saml_roles (method)">#list_saml_roles</a></span>, <span class='object_link'><a href="SAML.html#remove_saml_role-instance_method" title="SAML#remove_saml_role (method)">#remove_saml_role</a></span>, <span class='object_link'><a href="SAML.html#return_saml_role-instance_method" title="SAML#return_saml_role (method)">#return_saml_role</a></span>, <span class='object_link'><a href="SAML.html#update_saml_role-instance_method" title="SAML#update_saml_role (method)">#update_saml_role</a></span></p>
|
255
|
+
|
256
|
+
|
257
|
+
|
258
|
+
|
259
|
+
|
260
|
+
|
261
|
+
|
262
|
+
|
263
|
+
|
264
|
+
<h3 class="inherited">Methods included from <span class='object_link'><a href="Templates.html" title="Templates (module)">Templates</a></span></h3>
|
265
|
+
<p class="inherited"><span class='object_link'><a href="Templates.html#list_templates-instance_method" title="Templates#list_templates (method)">#list_templates</a></span>, <span class='object_link'><a href="Templates.html#remove_template-instance_method" title="Templates#remove_template (method)">#remove_template</a></span></p>
|
266
|
+
|
267
|
+
|
268
|
+
|
269
|
+
|
270
|
+
|
271
|
+
|
272
|
+
|
273
|
+
|
274
|
+
|
275
|
+
<h3 class="inherited">Methods included from <span class='object_link'><a href="Phones.html" title="Phones (module)">Phones</a></span></h3>
|
276
|
+
<p class="inherited"><span class='object_link'><a href="Phones.html#add_phone_contact-instance_method" title="Phones#add_phone_contact (method)">#add_phone_contact</a></span>, <span class='object_link'><a href="Phones.html#delete_phone_contact-instance_method" title="Phones#delete_phone_contact (method)">#delete_phone_contact</a></span>, <span class='object_link'><a href="Phones.html#list_phone_contacts-instance_method" title="Phones#list_phone_contacts (method)">#list_phone_contacts</a></span>, <span class='object_link'><a href="Phones.html#update_phone_contact-instance_method" title="Phones#update_phone_contact (method)">#update_phone_contact</a></span></p>
|
277
|
+
|
278
|
+
|
279
|
+
|
280
|
+
|
281
|
+
|
282
|
+
|
283
|
+
|
284
|
+
|
285
|
+
|
286
|
+
<h3 class="inherited">Methods included from <span class='object_link'><a href="VLANs.html" title="VLANs (module)">VLANs</a></span></h3>
|
287
|
+
<p class="inherited"><span class='object_link'><a href="VLANs.html#add_vlan-instance_method" title="VLANs#add_vlan (method)">#add_vlan</a></span>, <span class='object_link'><a href="VLANs.html#delete_vlan-instance_method" title="VLANs#delete_vlan (method)">#delete_vlan</a></span>, <span class='object_link'><a href="VLANs.html#list_vlans-instance_method" title="VLANs#list_vlans (method)">#list_vlans</a></span>, <span class='object_link'><a href="VLANs.html#return_vlan-instance_method" title="VLANs#return_vlan (method)">#return_vlan</a></span>, <span class='object_link'><a href="VLANs.html#update_vlan-instance_method" title="VLANs#update_vlan (method)">#update_vlan</a></span></p>
|
288
|
+
|
289
|
+
|
290
|
+
|
291
|
+
|
292
|
+
|
293
|
+
|
294
|
+
|
295
|
+
|
296
|
+
|
253
297
|
<h3 class="inherited">Methods included from <span class='object_link'><a href="Switchports.html" title="Switchports (module)">Switchports</a></span></h3>
|
254
298
|
<p class="inherited"><span class='object_link'><a href="Switchports.html#get_single_switch_port-instance_method" title="Switchports#get_single_switch_port (method)">#get_single_switch_port</a></span>, <span class='object_link'><a href="Switchports.html#get_switch_ports-instance_method" title="Switchports#get_switch_ports (method)">#get_switch_ports</a></span>, <span class='object_link'><a href="Switchports.html#update_switchport-instance_method" title="Switchports#update_switchport (method)">#update_switchport</a></span></p>
|
255
299
|
|
@@ -261,6 +305,17 @@
|
|
261
305
|
|
262
306
|
|
263
307
|
|
308
|
+
<h3 class="inherited">Methods included from <span class='object_link'><a href="Admins.html" title="Admins (module)">Admins</a></span></h3>
|
309
|
+
<p class="inherited"><span class='object_link'><a href="Admins.html#add_admin-instance_method" title="Admins#add_admin (method)">#add_admin</a></span>, <span class='object_link'><a href="Admins.html#list_admins-instance_method" title="Admins#list_admins (method)">#list_admins</a></span>, <span class='object_link'><a href="Admins.html#revoke_admin-instance_method" title="Admins#revoke_admin (method)">#revoke_admin</a></span>, <span class='object_link'><a href="Admins.html#update_admin-instance_method" title="Admins#update_admin (method)">#update_admin</a></span></p>
|
310
|
+
|
311
|
+
|
312
|
+
|
313
|
+
|
314
|
+
|
315
|
+
|
316
|
+
|
317
|
+
|
318
|
+
|
264
319
|
<h3 class="inherited">Methods included from <span class='object_link'><a href="SSIDs.html" title="SSIDs (module)">SSIDs</a></span></h3>
|
265
320
|
<p class="inherited"><span class='object_link'><a href="SSIDs.html#get_single_ssid-instance_method" title="SSIDs#get_single_ssid (method)">#get_single_ssid</a></span>, <span class='object_link'><a href="SSIDs.html#list_ssids_in_network-instance_method" title="SSIDs#list_ssids_in_network (method)">#list_ssids_in_network</a></span>, <span class='object_link'><a href="SSIDs.html#update_single_ssid-instance_method" title="SSIDs#update_single_ssid (method)">#update_single_ssid</a></span></p>
|
266
321
|
|
@@ -295,7 +350,7 @@
|
|
295
350
|
|
296
351
|
|
297
352
|
<h3 class="inherited">Methods included from <span class='object_link'><a href="Networks.html" title="Networks (module)">Networks</a></span></h3>
|
298
|
-
<p class="inherited"><span class='object_link'><a href="Networks.html#create_network-instance_method" title="Networks#create_network (method)">#create_network</a></span>, <span class='object_link'><a href="Networks.html#delete_network-instance_method" title="Networks#delete_network (method)">#delete_network</a></span>, <span class='object_link'><a href="Networks.html#get_auto_vpn_settings-instance_method" title="Networks#get_auto_vpn_settings (method)">#get_auto_vpn_settings</a></span>, <span class='object_link'><a href="Networks.html#get_ms_access_policies-instance_method" title="Networks#get_ms_access_policies (method)">#get_ms_access_policies</a></span>, <span class='object_link'><a href="Networks.html#get_networks-instance_method" title="Networks#get_networks (method)">#get_networks</a></span>, <span class='object_link'><a href="Networks.html#get_single_network-instance_method" title="Networks#get_single_network (method)">#get_single_network</a></span>, <span class='object_link'><a href="Networks.html#update_auto_vpn_settings-instance_method" title="Networks#update_auto_vpn_settings (method)">#update_auto_vpn_settings</a></span>, <span class='object_link'><a href="Networks.html#update_network-instance_method" title="Networks#update_network (method)">#update_network</a></span></p>
|
353
|
+
<p class="inherited"><span class='object_link'><a href="Networks.html#bind_network_to_template-instance_method" title="Networks#bind_network_to_template (method)">#bind_network_to_template</a></span>, <span class='object_link'><a href="Networks.html#create_network-instance_method" title="Networks#create_network (method)">#create_network</a></span>, <span class='object_link'><a href="Networks.html#delete_network-instance_method" title="Networks#delete_network (method)">#delete_network</a></span>, <span class='object_link'><a href="Networks.html#get_auto_vpn_settings-instance_method" title="Networks#get_auto_vpn_settings (method)">#get_auto_vpn_settings</a></span>, <span class='object_link'><a href="Networks.html#get_ms_access_policies-instance_method" title="Networks#get_ms_access_policies (method)">#get_ms_access_policies</a></span>, <span class='object_link'><a href="Networks.html#get_networks-instance_method" title="Networks#get_networks (method)">#get_networks</a></span>, <span class='object_link'><a href="Networks.html#get_single_network-instance_method" title="Networks#get_single_network (method)">#get_single_network</a></span>, <span class='object_link'><a href="Networks.html#traffic_analysis-instance_method" title="Networks#traffic_analysis (method)">#traffic_analysis</a></span>, <span class='object_link'><a href="Networks.html#unbind_network_to_template-instance_method" title="Networks#unbind_network_to_template (method)">#unbind_network_to_template</a></span>, <span class='object_link'><a href="Networks.html#update_auto_vpn_settings-instance_method" title="Networks#update_auto_vpn_settings (method)">#update_auto_vpn_settings</a></span>, <span class='object_link'><a href="Networks.html#update_network-instance_method" title="Networks#update_network (method)">#update_network</a></span></p>
|
299
354
|
|
300
355
|
|
301
356
|
|
@@ -343,12 +398,12 @@
|
|
343
398
|
<pre class="lines">
|
344
399
|
|
345
400
|
|
346
|
-
|
347
|
-
|
348
|
-
|
401
|
+
36
|
402
|
+
37
|
403
|
+
38</pre>
|
349
404
|
</td>
|
350
405
|
<td>
|
351
|
-
<pre class="code"><span class="info file"># File 'lib/dashboard-api.rb', line
|
406
|
+
<pre class="code"><span class="info file"># File 'lib/dashboard-api.rb', line 36</span>
|
352
407
|
|
353
408
|
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='rparen'>)</span>
|
354
409
|
<span class='ivar'>@key</span> <span class='op'>=</span> <span class='id identifier rubyid_key'>key</span>
|
@@ -391,12 +446,12 @@
|
|
391
446
|
<pre class="lines">
|
392
447
|
|
393
448
|
|
394
|
-
|
395
|
-
|
396
|
-
|
449
|
+
34
|
450
|
+
35
|
451
|
+
36</pre>
|
397
452
|
</td>
|
398
453
|
<td>
|
399
|
-
<pre class="code"><span class="info file"># File 'lib/dashboard-api.rb', line
|
454
|
+
<pre class="code"><span class="info file"># File 'lib/dashboard-api.rb', line 34</span>
|
400
455
|
|
401
456
|
<span class='kw'>def</span> <span class='id identifier rubyid_key'>key</span>
|
402
457
|
<span class='ivar'>@key</span>
|
@@ -449,16 +504,6 @@ handling</p>
|
|
449
504
|
<pre class="lines">
|
450
505
|
|
451
506
|
|
452
|
-
35
|
453
|
-
36
|
454
|
-
37
|
455
|
-
38
|
456
|
-
39
|
457
|
-
40
|
458
|
-
41
|
459
|
-
42
|
460
|
-
43
|
461
|
-
44
|
462
507
|
45
|
463
508
|
46
|
464
509
|
47
|
@@ -483,10 +528,21 @@ handling</p>
|
|
483
528
|
66
|
484
529
|
67
|
485
530
|
68
|
486
|
-
69
|
531
|
+
69
|
532
|
+
70
|
533
|
+
71
|
534
|
+
72
|
535
|
+
73
|
536
|
+
74
|
537
|
+
75
|
538
|
+
76
|
539
|
+
77
|
540
|
+
78
|
541
|
+
79
|
542
|
+
80</pre>
|
487
543
|
</td>
|
488
544
|
<td>
|
489
|
-
<pre class="code"><span class="info file"># File 'lib/dashboard-api.rb', line
|
545
|
+
<pre class="code"><span class="info file"># File 'lib/dashboard-api.rb', line 45</span>
|
490
546
|
|
491
547
|
<span class='kw'>def</span> <span class='id identifier rubyid_make_api_call'>make_api_call</span><span class='lparen'>(</span><span class='id identifier rubyid_endpoint_url'>endpoint_url</span><span class='comma'>,</span> <span class='id identifier rubyid_http_method'>http_method</span><span class='comma'>,</span> <span class='id identifier rubyid_options_hash'>options_hash</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
492
548
|
<span class='id identifier rubyid_headers'>headers</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>X-Cisco-Meraki-API-Key</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='ivar'>@key</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Content-Type</span><span class='tstring_end'>'</span></span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>application/json</span><span class='tstring_end'>'</span></span><span class='rbrace'>}</span>
|
@@ -497,6 +553,7 @@ handling</p>
|
|
497
553
|
<span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>GET</span><span class='tstring_end'>'</span></span>
|
498
554
|
<span class='id identifier rubyid_res'>res</span> <span class='op'>=</span> <span class='const'>HTTParty</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_base_uri'>base_uri</span><span class='embexpr_end'>}</span><span class='tstring_content'>/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_endpoint_url'>endpoint_url</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
499
555
|
<span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>404 returned. Are you sure you are using the proper IDs?</span><span class='tstring_end'>"</span></span> <span class='kw'>if</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'>404</span>
|
556
|
+
<span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Bad request due to the following error(s): </span><span class='embexpr_beg'>#{</span><span class='const'>JSON</span><span class='period'>.</span><span class='id identifier rubyid_parse'>parse</span><span class='lparen'>(</span><span class='id identifier rubyid_res'>res</span><span class='period'>.</span><span class='id identifier rubyid_body'>body</span><span class='rparen'>)</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>errors</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_res'>res</span><span class='period'>.</span><span class='id identifier rubyid_body'>body</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>errors</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
500
557
|
<span class='kw'>return</span> <span class='const'>JSON</span><span class='period'>.</span><span class='id identifier rubyid_parse'>parse</span><span class='lparen'>(</span><span class='id identifier rubyid_res'>res</span><span class='period'>.</span><span class='id identifier rubyid_body'>body</span><span class='rparen'>)</span>
|
501
558
|
<span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>POST</span><span class='tstring_end'>'</span></span>
|
502
559
|
<span class='id identifier rubyid_res'>res</span> <span class='op'>=</span> <span class='const'>HTTParty</span><span class='period'>.</span><span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_base_uri'>base_uri</span><span class='embexpr_end'>}</span><span class='tstring_content'>/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_endpoint_url'>endpoint_url</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
@@ -533,7 +590,7 @@ handling</p>
|
|
533
590
|
</div>
|
534
591
|
|
535
592
|
<div id="footer">
|
536
|
-
Generated on
|
593
|
+
Generated on Wed Nov 16 21:55:08 2016 by
|
537
594
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
538
595
|
0.9.5 (ruby-2.3.0).
|
539
596
|
</div>
|
@@ -135,7 +135,7 @@
|
|
135
135
|
|
136
136
|
</div>
|
137
137
|
</dt>
|
138
|
-
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>0.
|
138
|
+
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>0.9.0</span><span class='tstring_end'>"</span></span></pre></dd>
|
139
139
|
|
140
140
|
</dl>
|
141
141
|
|
@@ -150,7 +150,7 @@
|
|
150
150
|
</div>
|
151
151
|
|
152
152
|
<div id="footer">
|
153
|
-
Generated on
|
153
|
+
Generated on Wed Nov 16 21:55:08 2016 by
|
154
154
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
155
155
|
0.9.5 (ruby-2.3.0).
|
156
156
|
</div>
|
data/doc/Devices.html
CHANGED
@@ -870,7 +870,7 @@ longitude, latitude. A full list is found on the official Meraki API Docs</p>
|
|
870
870
|
</div>
|
871
871
|
|
872
872
|
<div id="footer">
|
873
|
-
Generated on
|
873
|
+
Generated on Wed Nov 16 21:55:08 2016 by
|
874
874
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
875
875
|
0.9.5 (ruby-2.3.0).
|
876
876
|
</div>
|
data/doc/Networks.html
CHANGED
@@ -135,6 +135,30 @@
|
|
135
135
|
<li class="public ">
|
136
136
|
<span class="summary_signature">
|
137
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
|
+
|
138
162
|
<a href="#create_network-instance_method" title="#create_network (instance method)">#<strong>create_network</strong>(org_id, options) ⇒ Hash </a>
|
139
163
|
|
140
164
|
|
@@ -273,6 +297,54 @@
|
|
273
297
|
<p>Returns the network details for a single network.</p>
|
274
298
|
</div></span>
|
275
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
|
+
|
276
348
|
</li>
|
277
349
|
|
278
350
|
|
@@ -334,7 +406,110 @@
|
|
334
406
|
|
335
407
|
|
336
408
|
<div class="method_details first">
|
337
|
-
<h3 class="signature first" id="
|
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
|
+
86
|
491
|
+
87
|
492
|
+
88
|
493
|
+
89
|
494
|
+
90
|
495
|
+
91</pre>
|
496
|
+
</td>
|
497
|
+
<td>
|
498
|
+
<pre class="code"><span class="info file"># File 'lib/networks.rb', line 86</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">
|
338
513
|
|
339
514
|
#<strong>create_network</strong>(org_id, options) ⇒ <tt>Hash</tt>
|
340
515
|
|
@@ -833,6 +1008,167 @@ type: the type of network (wireless, switch, appliance, or phone)
|
|
833
1008
|
</td>
|
834
1009
|
</tr>
|
835
1010
|
</table>
|
1011
|
+
</div>
|
1012
|
+
|
1013
|
+
<div class="method_details ">
|
1014
|
+
<h3 class="signature " id="traffic_analysis-instance_method">
|
1015
|
+
|
1016
|
+
#<strong>traffic_analysis</strong>(network_id, options) ⇒ <tt>Object</tt>
|
1017
|
+
|
1018
|
+
|
1019
|
+
|
1020
|
+
|
1021
|
+
|
1022
|
+
</h3><div class="docstring">
|
1023
|
+
<div class="discussion">
|
1024
|
+
|
1025
|
+
<p>Return traffic analysis data for a network</p>
|
1026
|
+
|
1027
|
+
|
1028
|
+
</div>
|
1029
|
+
</div>
|
1030
|
+
<div class="tags">
|
1031
|
+
<p class="tag_title">Parameters:</p>
|
1032
|
+
<ul class="param">
|
1033
|
+
|
1034
|
+
<li>
|
1035
|
+
|
1036
|
+
<span class='name'>network_id</span>
|
1037
|
+
|
1038
|
+
|
1039
|
+
<span class='type'>(<tt>String</tt>)</span>
|
1040
|
+
|
1041
|
+
|
1042
|
+
|
1043
|
+
—
|
1044
|
+
<div class='inline'>
|
1045
|
+
<p>network that you want data for</p>
|
1046
|
+
</div>
|
1047
|
+
|
1048
|
+
</li>
|
1049
|
+
|
1050
|
+
<li>
|
1051
|
+
|
1052
|
+
<span class='name'>options</span>
|
1053
|
+
|
1054
|
+
|
1055
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
1056
|
+
|
1057
|
+
|
1058
|
+
|
1059
|
+
—
|
1060
|
+
<div class='inline'>
|
1061
|
+
<p>options hash containing a timespan and deviceType. Refer to the official
|
1062
|
+
Meraki Dashboard API documentation for more information on these.</p>
|
1063
|
+
</div>
|
1064
|
+
|
1065
|
+
</li>
|
1066
|
+
|
1067
|
+
</ul>
|
1068
|
+
|
1069
|
+
|
1070
|
+
</div><table class="source_code">
|
1071
|
+
<tr>
|
1072
|
+
<td>
|
1073
|
+
<pre class="lines">
|
1074
|
+
|
1075
|
+
|
1076
|
+
104
|
1077
|
+
105
|
1078
|
+
106
|
1079
|
+
107
|
1080
|
+
108</pre>
|
1081
|
+
</td>
|
1082
|
+
<td>
|
1083
|
+
<pre class="code"><span class="info file"># File 'lib/networks.rb', line 104</span>
|
1084
|
+
|
1085
|
+
<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>
|
1086
|
+
<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>
|
1087
|
+
<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>
|
1088
|
+
<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>
|
1089
|
+
<span class='kw'>end</span></pre>
|
1090
|
+
</td>
|
1091
|
+
</tr>
|
1092
|
+
</table>
|
1093
|
+
</div>
|
1094
|
+
|
1095
|
+
<div class="method_details ">
|
1096
|
+
<h3 class="signature " id="unbind_network_to_template-instance_method">
|
1097
|
+
|
1098
|
+
#<strong>unbind_network_to_template</strong>(network_id) ⇒ <tt>Integer</tt>
|
1099
|
+
|
1100
|
+
|
1101
|
+
|
1102
|
+
|
1103
|
+
|
1104
|
+
</h3><div class="docstring">
|
1105
|
+
<div class="discussion">
|
1106
|
+
|
1107
|
+
<p>Unbind a single network from a configuration template</p>
|
1108
|
+
|
1109
|
+
|
1110
|
+
</div>
|
1111
|
+
</div>
|
1112
|
+
<div class="tags">
|
1113
|
+
<p class="tag_title">Parameters:</p>
|
1114
|
+
<ul class="param">
|
1115
|
+
|
1116
|
+
<li>
|
1117
|
+
|
1118
|
+
<span class='name'>network_id</span>
|
1119
|
+
|
1120
|
+
|
1121
|
+
<span class='type'>(<tt>String</tt>)</span>
|
1122
|
+
|
1123
|
+
|
1124
|
+
|
1125
|
+
—
|
1126
|
+
<div class='inline'>
|
1127
|
+
<p>the network that you want to unbind from it's template</p>
|
1128
|
+
</div>
|
1129
|
+
|
1130
|
+
</li>
|
1131
|
+
|
1132
|
+
</ul>
|
1133
|
+
|
1134
|
+
<p class="tag_title">Returns:</p>
|
1135
|
+
<ul class="return">
|
1136
|
+
|
1137
|
+
<li>
|
1138
|
+
|
1139
|
+
|
1140
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
1141
|
+
|
1142
|
+
|
1143
|
+
|
1144
|
+
—
|
1145
|
+
<div class='inline'>
|
1146
|
+
<p>HTTP Code</p>
|
1147
|
+
</div>
|
1148
|
+
|
1149
|
+
</li>
|
1150
|
+
|
1151
|
+
</ul>
|
1152
|
+
|
1153
|
+
</div><table class="source_code">
|
1154
|
+
<tr>
|
1155
|
+
<td>
|
1156
|
+
<pre class="lines">
|
1157
|
+
|
1158
|
+
|
1159
|
+
96
|
1160
|
+
97
|
1161
|
+
98</pre>
|
1162
|
+
</td>
|
1163
|
+
<td>
|
1164
|
+
<pre class="code"><span class="info file"># File 'lib/networks.rb', line 96</span>
|
1165
|
+
|
1166
|
+
<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>
|
1167
|
+
<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>
|
1168
|
+
<span class='kw'>end</span></pre>
|
1169
|
+
</td>
|
1170
|
+
</tr>
|
1171
|
+
</table>
|
836
1172
|
</div>
|
837
1173
|
|
838
1174
|
<div class="method_details ">
|
@@ -1039,7 +1375,7 @@ tags assigned to the network</p>
|
|
1039
1375
|
</div>
|
1040
1376
|
|
1041
1377
|
<div id="footer">
|
1042
|
-
Generated on
|
1378
|
+
Generated on Wed Nov 16 21:55:08 2016 by
|
1043
1379
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
1044
1380
|
0.9.5 (ruby-2.3.0).
|
1045
1381
|
</div>
|