dashboard-api 0.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/.gitignore +4 -0
- data/Gemfile +5 -0
- data/Gemfile.lock +31 -0
- data/README.md +103 -0
- data/Rakefile +6 -0
- data/dashboard-api.gemspec +28 -0
- data/doc/Clients.html +250 -0
- data/doc/DashboardAPI.html +532 -0
- data/doc/DashboardAPIVersion.html +122 -0
- data/doc/Devices.html +853 -0
- data/doc/Networks.html +1049 -0
- data/doc/Organizations.html +672 -0
- data/doc/SSIDs.html +497 -0
- data/doc/_index.html +171 -0
- data/doc/class_list.html +51 -0
- data/doc/css/common.css +1 -0
- data/doc/css/full_list.css +58 -0
- data/doc/css/style.css +481 -0
- data/doc/file.README.html +210 -0
- data/doc/file_list.html +56 -0
- data/doc/frames.html +17 -0
- data/doc/index.html +210 -0
- data/doc/js/app.js +243 -0
- data/doc/js/full_list.js +216 -0
- data/doc/js/jquery.js +4 -0
- data/doc/method_list.html +259 -0
- data/doc/top-level-namespace.html +114 -0
- data/lib/clients.rb +10 -0
- data/lib/dashboard-api.rb +67 -0
- data/lib/dashboard-api/version.rb +3 -0
- data/lib/devices.rb +55 -0
- data/lib/networks.rb +80 -0
- data/lib/organizations.rb +39 -0
- data/lib/ssids.rb +31 -0
- metadata +162 -0
|
@@ -0,0 +1,672 @@
|
|
|
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: Organizations
|
|
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 = "Organizations";
|
|
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 (O)</a> »
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
<span class="title">Organizations</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: Organizations
|
|
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/organizations.rb</dd>
|
|
89
|
+
</dl>
|
|
90
|
+
|
|
91
|
+
</div>
|
|
92
|
+
|
|
93
|
+
<h2>Overview</h2><div class="docstring">
|
|
94
|
+
<div class="discussion">
|
|
95
|
+
|
|
96
|
+
<p>Organization 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="#get_inventory-instance_method" title="#get_inventory (instance method)">#<strong>get_inventory</strong>(org_id) ⇒ Array </a>
|
|
139
|
+
|
|
140
|
+
|
|
141
|
+
|
|
142
|
+
</span>
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
|
|
147
|
+
|
|
148
|
+
|
|
149
|
+
|
|
150
|
+
|
|
151
|
+
|
|
152
|
+
<span class="summary_desc"><div class='inline'>
|
|
153
|
+
<p>Returns the current inventory for an organization.</p>
|
|
154
|
+
</div></span>
|
|
155
|
+
|
|
156
|
+
</li>
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
<li class="public ">
|
|
160
|
+
<span class="summary_signature">
|
|
161
|
+
|
|
162
|
+
<a href="#get_license_state-instance_method" title="#get_license_state (instance method)">#<strong>get_license_state</strong>(org_id) ⇒ 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>Returns the current license state for a given organization.</p>
|
|
178
|
+
</div></span>
|
|
179
|
+
|
|
180
|
+
</li>
|
|
181
|
+
|
|
182
|
+
|
|
183
|
+
<li class="public ">
|
|
184
|
+
<span class="summary_signature">
|
|
185
|
+
|
|
186
|
+
<a href="#get_organization-instance_method" title="#get_organization (instance method)">#<strong>get_organization</strong>(org_id) ⇒ Hash </a>
|
|
187
|
+
|
|
188
|
+
|
|
189
|
+
|
|
190
|
+
</span>
|
|
191
|
+
|
|
192
|
+
|
|
193
|
+
|
|
194
|
+
|
|
195
|
+
|
|
196
|
+
|
|
197
|
+
|
|
198
|
+
|
|
199
|
+
|
|
200
|
+
<span class="summary_desc"><div class='inline'>
|
|
201
|
+
<p>Returns information about an organization.</p>
|
|
202
|
+
</div></span>
|
|
203
|
+
|
|
204
|
+
</li>
|
|
205
|
+
|
|
206
|
+
|
|
207
|
+
<li class="public ">
|
|
208
|
+
<span class="summary_signature">
|
|
209
|
+
|
|
210
|
+
<a href="#get_snmp_status-instance_method" title="#get_snmp_status (instance method)">#<strong>get_snmp_status</strong>(org_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>Returns the current SNMP status for an organization.</p>
|
|
226
|
+
</div></span>
|
|
227
|
+
|
|
228
|
+
</li>
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
<li class="public ">
|
|
232
|
+
<span class="summary_signature">
|
|
233
|
+
|
|
234
|
+
<a href="#get_third_party_peers-instance_method" title="#get_third_party_peers (instance method)">#<strong>get_third_party_peers</strong>(org_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>Returns the configurations for an organizations 3rd party VPN peers.</p>
|
|
250
|
+
</div></span>
|
|
251
|
+
|
|
252
|
+
</li>
|
|
253
|
+
|
|
254
|
+
|
|
255
|
+
</ul>
|
|
256
|
+
|
|
257
|
+
|
|
258
|
+
|
|
259
|
+
|
|
260
|
+
<div id="instance_method_details" class="method_details_list">
|
|
261
|
+
<h2>Instance Method Details</h2>
|
|
262
|
+
|
|
263
|
+
|
|
264
|
+
<div class="method_details first">
|
|
265
|
+
<h3 class="signature first" id="get_inventory-instance_method">
|
|
266
|
+
|
|
267
|
+
#<strong>get_inventory</strong>(org_id) ⇒ <tt>Array</tt>
|
|
268
|
+
|
|
269
|
+
|
|
270
|
+
|
|
271
|
+
|
|
272
|
+
|
|
273
|
+
</h3><div class="docstring">
|
|
274
|
+
<div class="discussion">
|
|
275
|
+
|
|
276
|
+
<p>Returns the current inventory for an organization</p>
|
|
277
|
+
|
|
278
|
+
|
|
279
|
+
</div>
|
|
280
|
+
</div>
|
|
281
|
+
<div class="tags">
|
|
282
|
+
<p class="tag_title">Parameters:</p>
|
|
283
|
+
<ul class="param">
|
|
284
|
+
|
|
285
|
+
<li>
|
|
286
|
+
|
|
287
|
+
<span class='name'>org_id</span>
|
|
288
|
+
|
|
289
|
+
|
|
290
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
291
|
+
|
|
292
|
+
|
|
293
|
+
|
|
294
|
+
—
|
|
295
|
+
<div class='inline'>
|
|
296
|
+
<p>dashboard organization ID</p>
|
|
297
|
+
</div>
|
|
298
|
+
|
|
299
|
+
</li>
|
|
300
|
+
|
|
301
|
+
</ul>
|
|
302
|
+
|
|
303
|
+
<p class="tag_title">Returns:</p>
|
|
304
|
+
<ul class="return">
|
|
305
|
+
|
|
306
|
+
<li>
|
|
307
|
+
|
|
308
|
+
|
|
309
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
|
310
|
+
|
|
311
|
+
|
|
312
|
+
|
|
313
|
+
—
|
|
314
|
+
<div class='inline'>
|
|
315
|
+
<p>an array of hashes containg information on each individual device</p>
|
|
316
|
+
</div>
|
|
317
|
+
|
|
318
|
+
</li>
|
|
319
|
+
|
|
320
|
+
</ul>
|
|
321
|
+
|
|
322
|
+
</div><table class="source_code">
|
|
323
|
+
<tr>
|
|
324
|
+
<td>
|
|
325
|
+
<pre class="lines">
|
|
326
|
+
|
|
327
|
+
|
|
328
|
+
21
|
|
329
|
+
22
|
|
330
|
+
23</pre>
|
|
331
|
+
</td>
|
|
332
|
+
<td>
|
|
333
|
+
<pre class="code"><span class="info file"># File 'lib/organizations.rb', line 21</span>
|
|
334
|
+
|
|
335
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_get_inventory'>get_inventory</span><span class='lparen'>(</span><span class='id identifier rubyid_org_id'>org_id</span><span class='rparen'>)</span>
|
|
336
|
+
<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'>/inventory</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>
|
|
337
|
+
<span class='kw'>end</span></pre>
|
|
338
|
+
</td>
|
|
339
|
+
</tr>
|
|
340
|
+
</table>
|
|
341
|
+
</div>
|
|
342
|
+
|
|
343
|
+
<div class="method_details ">
|
|
344
|
+
<h3 class="signature " id="get_license_state-instance_method">
|
|
345
|
+
|
|
346
|
+
#<strong>get_license_state</strong>(org_id) ⇒ <tt>Hash</tt>
|
|
347
|
+
|
|
348
|
+
|
|
349
|
+
|
|
350
|
+
|
|
351
|
+
|
|
352
|
+
</h3><div class="docstring">
|
|
353
|
+
<div class="discussion">
|
|
354
|
+
|
|
355
|
+
<p>Returns the current license state for a given organization</p>
|
|
356
|
+
|
|
357
|
+
|
|
358
|
+
</div>
|
|
359
|
+
</div>
|
|
360
|
+
<div class="tags">
|
|
361
|
+
<p class="tag_title">Parameters:</p>
|
|
362
|
+
<ul class="param">
|
|
363
|
+
|
|
364
|
+
<li>
|
|
365
|
+
|
|
366
|
+
<span class='name'>org_id</span>
|
|
367
|
+
|
|
368
|
+
|
|
369
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
370
|
+
|
|
371
|
+
|
|
372
|
+
|
|
373
|
+
—
|
|
374
|
+
<div class='inline'>
|
|
375
|
+
<p>dashboard organization ID</p>
|
|
376
|
+
</div>
|
|
377
|
+
|
|
378
|
+
</li>
|
|
379
|
+
|
|
380
|
+
</ul>
|
|
381
|
+
|
|
382
|
+
<p class="tag_title">Returns:</p>
|
|
383
|
+
<ul class="return">
|
|
384
|
+
|
|
385
|
+
<li>
|
|
386
|
+
|
|
387
|
+
|
|
388
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
389
|
+
|
|
390
|
+
|
|
391
|
+
|
|
392
|
+
—
|
|
393
|
+
<div class='inline'>
|
|
394
|
+
<p>results contains the current license state information</p>
|
|
395
|
+
</div>
|
|
396
|
+
|
|
397
|
+
</li>
|
|
398
|
+
|
|
399
|
+
</ul>
|
|
400
|
+
|
|
401
|
+
</div><table class="source_code">
|
|
402
|
+
<tr>
|
|
403
|
+
<td>
|
|
404
|
+
<pre class="lines">
|
|
405
|
+
|
|
406
|
+
|
|
407
|
+
14
|
|
408
|
+
15
|
|
409
|
+
16</pre>
|
|
410
|
+
</td>
|
|
411
|
+
<td>
|
|
412
|
+
<pre class="code"><span class="info file"># File 'lib/organizations.rb', line 14</span>
|
|
413
|
+
|
|
414
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_get_license_state'>get_license_state</span><span class='lparen'>(</span><span class='id identifier rubyid_org_id'>org_id</span><span class='rparen'>)</span>
|
|
415
|
+
<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'>/licenseState</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>
|
|
416
|
+
<span class='kw'>end</span></pre>
|
|
417
|
+
</td>
|
|
418
|
+
</tr>
|
|
419
|
+
</table>
|
|
420
|
+
</div>
|
|
421
|
+
|
|
422
|
+
<div class="method_details ">
|
|
423
|
+
<h3 class="signature " id="get_organization-instance_method">
|
|
424
|
+
|
|
425
|
+
#<strong>get_organization</strong>(org_id) ⇒ <tt>Hash</tt>
|
|
426
|
+
|
|
427
|
+
|
|
428
|
+
|
|
429
|
+
|
|
430
|
+
|
|
431
|
+
</h3><div class="docstring">
|
|
432
|
+
<div class="discussion">
|
|
433
|
+
|
|
434
|
+
<p>Returns information about an organization</p>
|
|
435
|
+
|
|
436
|
+
|
|
437
|
+
</div>
|
|
438
|
+
</div>
|
|
439
|
+
<div class="tags">
|
|
440
|
+
<p class="tag_title">Parameters:</p>
|
|
441
|
+
<ul class="param">
|
|
442
|
+
|
|
443
|
+
<li>
|
|
444
|
+
|
|
445
|
+
<span class='name'>org_id</span>
|
|
446
|
+
|
|
447
|
+
|
|
448
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
449
|
+
|
|
450
|
+
|
|
451
|
+
|
|
452
|
+
—
|
|
453
|
+
<div class='inline'>
|
|
454
|
+
<p>dashboard organization ID</p>
|
|
455
|
+
</div>
|
|
456
|
+
|
|
457
|
+
</li>
|
|
458
|
+
|
|
459
|
+
</ul>
|
|
460
|
+
|
|
461
|
+
<p class="tag_title">Returns:</p>
|
|
462
|
+
<ul class="return">
|
|
463
|
+
|
|
464
|
+
<li>
|
|
465
|
+
|
|
466
|
+
|
|
467
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
468
|
+
|
|
469
|
+
|
|
470
|
+
|
|
471
|
+
—
|
|
472
|
+
<div class='inline'>
|
|
473
|
+
<p>results contains the org id and name of the given organization</p>
|
|
474
|
+
</div>
|
|
475
|
+
|
|
476
|
+
</li>
|
|
477
|
+
|
|
478
|
+
</ul>
|
|
479
|
+
|
|
480
|
+
</div><table class="source_code">
|
|
481
|
+
<tr>
|
|
482
|
+
<td>
|
|
483
|
+
<pre class="lines">
|
|
484
|
+
|
|
485
|
+
|
|
486
|
+
7
|
|
487
|
+
8
|
|
488
|
+
9</pre>
|
|
489
|
+
</td>
|
|
490
|
+
<td>
|
|
491
|
+
<pre class="code"><span class="info file"># File 'lib/organizations.rb', line 7</span>
|
|
492
|
+
|
|
493
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_get_organization'>get_organization</span><span class='lparen'>(</span><span class='id identifier rubyid_org_id'>org_id</span><span class='rparen'>)</span>
|
|
494
|
+
<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_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>
|
|
495
|
+
<span class='kw'>end</span></pre>
|
|
496
|
+
</td>
|
|
497
|
+
</tr>
|
|
498
|
+
</table>
|
|
499
|
+
</div>
|
|
500
|
+
|
|
501
|
+
<div class="method_details ">
|
|
502
|
+
<h3 class="signature " id="get_snmp_status-instance_method">
|
|
503
|
+
|
|
504
|
+
#<strong>get_snmp_status</strong>(org_id) ⇒ <tt>Hash</tt>
|
|
505
|
+
|
|
506
|
+
|
|
507
|
+
|
|
508
|
+
|
|
509
|
+
|
|
510
|
+
</h3><div class="docstring">
|
|
511
|
+
<div class="discussion">
|
|
512
|
+
|
|
513
|
+
<p>Returns the current SNMP status for an organization</p>
|
|
514
|
+
|
|
515
|
+
|
|
516
|
+
</div>
|
|
517
|
+
</div>
|
|
518
|
+
<div class="tags">
|
|
519
|
+
<p class="tag_title">Parameters:</p>
|
|
520
|
+
<ul class="param">
|
|
521
|
+
|
|
522
|
+
<li>
|
|
523
|
+
|
|
524
|
+
<span class='name'>org_id</span>
|
|
525
|
+
|
|
526
|
+
|
|
527
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
528
|
+
|
|
529
|
+
|
|
530
|
+
|
|
531
|
+
—
|
|
532
|
+
<div class='inline'>
|
|
533
|
+
<p>dashboard organization ID</p>
|
|
534
|
+
</div>
|
|
535
|
+
|
|
536
|
+
</li>
|
|
537
|
+
|
|
538
|
+
</ul>
|
|
539
|
+
|
|
540
|
+
<p class="tag_title">Returns:</p>
|
|
541
|
+
<ul class="return">
|
|
542
|
+
|
|
543
|
+
<li>
|
|
544
|
+
|
|
545
|
+
|
|
546
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
547
|
+
|
|
548
|
+
|
|
549
|
+
|
|
550
|
+
—
|
|
551
|
+
<div class='inline'>
|
|
552
|
+
<p>a hash containing all SNMP configuration information for an organization</p>
|
|
553
|
+
</div>
|
|
554
|
+
|
|
555
|
+
</li>
|
|
556
|
+
|
|
557
|
+
</ul>
|
|
558
|
+
|
|
559
|
+
</div><table class="source_code">
|
|
560
|
+
<tr>
|
|
561
|
+
<td>
|
|
562
|
+
<pre class="lines">
|
|
563
|
+
|
|
564
|
+
|
|
565
|
+
28
|
|
566
|
+
29
|
|
567
|
+
30</pre>
|
|
568
|
+
</td>
|
|
569
|
+
<td>
|
|
570
|
+
<pre class="code"><span class="info file"># File 'lib/organizations.rb', line 28</span>
|
|
571
|
+
|
|
572
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_get_snmp_status'>get_snmp_status</span><span class='lparen'>(</span><span class='id identifier rubyid_org_id'>org_id</span><span class='rparen'>)</span>
|
|
573
|
+
<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'>/snmp</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>
|
|
574
|
+
<span class='kw'>end</span></pre>
|
|
575
|
+
</td>
|
|
576
|
+
</tr>
|
|
577
|
+
</table>
|
|
578
|
+
</div>
|
|
579
|
+
|
|
580
|
+
<div class="method_details ">
|
|
581
|
+
<h3 class="signature " id="get_third_party_peers-instance_method">
|
|
582
|
+
|
|
583
|
+
#<strong>get_third_party_peers</strong>(org_id) ⇒ <tt>Array</tt>
|
|
584
|
+
|
|
585
|
+
|
|
586
|
+
|
|
587
|
+
|
|
588
|
+
|
|
589
|
+
</h3><div class="docstring">
|
|
590
|
+
<div class="discussion">
|
|
591
|
+
|
|
592
|
+
<p>Returns the configurations for an organizations 3rd party VPN peers</p>
|
|
593
|
+
|
|
594
|
+
|
|
595
|
+
</div>
|
|
596
|
+
</div>
|
|
597
|
+
<div class="tags">
|
|
598
|
+
<p class="tag_title">Parameters:</p>
|
|
599
|
+
<ul class="param">
|
|
600
|
+
|
|
601
|
+
<li>
|
|
602
|
+
|
|
603
|
+
<span class='name'>org_id</span>
|
|
604
|
+
|
|
605
|
+
|
|
606
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
607
|
+
|
|
608
|
+
|
|
609
|
+
|
|
610
|
+
—
|
|
611
|
+
<div class='inline'>
|
|
612
|
+
<p>dashboard organization ID</p>
|
|
613
|
+
</div>
|
|
614
|
+
|
|
615
|
+
</li>
|
|
616
|
+
|
|
617
|
+
</ul>
|
|
618
|
+
|
|
619
|
+
<p class="tag_title">Returns:</p>
|
|
620
|
+
<ul class="return">
|
|
621
|
+
|
|
622
|
+
<li>
|
|
623
|
+
|
|
624
|
+
|
|
625
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
|
626
|
+
|
|
627
|
+
|
|
628
|
+
|
|
629
|
+
—
|
|
630
|
+
<div class='inline'>
|
|
631
|
+
<p>an arrry of hashes containing the configuration information for each 3rd
|
|
632
|
+
party VPN peer</p>
|
|
633
|
+
</div>
|
|
634
|
+
|
|
635
|
+
</li>
|
|
636
|
+
|
|
637
|
+
</ul>
|
|
638
|
+
|
|
639
|
+
</div><table class="source_code">
|
|
640
|
+
<tr>
|
|
641
|
+
<td>
|
|
642
|
+
<pre class="lines">
|
|
643
|
+
|
|
644
|
+
|
|
645
|
+
36
|
|
646
|
+
37
|
|
647
|
+
38</pre>
|
|
648
|
+
</td>
|
|
649
|
+
<td>
|
|
650
|
+
<pre class="code"><span class="info file"># File 'lib/organizations.rb', line 36</span>
|
|
651
|
+
|
|
652
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_get_third_party_peers'>get_third_party_peers</span><span class='lparen'>(</span><span class='id identifier rubyid_org_id'>org_id</span><span class='rparen'>)</span>
|
|
653
|
+
<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'>/thirdPartyVPNPeers</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>
|
|
654
|
+
<span class='kw'>end</span></pre>
|
|
655
|
+
</td>
|
|
656
|
+
</tr>
|
|
657
|
+
</table>
|
|
658
|
+
</div>
|
|
659
|
+
|
|
660
|
+
</div>
|
|
661
|
+
|
|
662
|
+
</div>
|
|
663
|
+
|
|
664
|
+
<div id="footer">
|
|
665
|
+
Generated on Tue Nov 15 21:16:07 2016 by
|
|
666
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
667
|
+
0.9.5 (ruby-2.3.0).
|
|
668
|
+
</div>
|
|
669
|
+
|
|
670
|
+
</div>
|
|
671
|
+
</body>
|
|
672
|
+
</html>
|