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/Organizations.html
CHANGED
|
@@ -1,1478 +1,1478 @@
|
|
|
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="#claim-instance_method" title="#claim (instance method)">#<strong>claim</strong>(org_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>Claim something.</p>
|
|
154
|
-
</div></span>
|
|
155
|
-
|
|
156
|
-
</li>
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
<li class="public ">
|
|
160
|
-
<span class="summary_signature">
|
|
161
|
-
|
|
162
|
-
<a href="#clone_organization-instance_method" title="#clone_organization (instance method)">#<strong>clone_organization</strong>(source_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>Clone an organization.</p>
|
|
178
|
-
</div></span>
|
|
179
|
-
|
|
180
|
-
</li>
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
<li class="public ">
|
|
184
|
-
<span class="summary_signature">
|
|
185
|
-
|
|
186
|
-
<a href="#create_organization-instance_method" title="#create_organization (instance method)">#<strong>create_organization</strong>(options) ⇒ 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>Create a new organization.</p>
|
|
202
|
-
</div></span>
|
|
203
|
-
|
|
204
|
-
</li>
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
<li class="public ">
|
|
208
|
-
<span class="summary_signature">
|
|
209
|
-
|
|
210
|
-
<a href="#get_inventory-instance_method" title="#get_inventory (instance method)">#<strong>get_inventory</strong>(org_id) ⇒ Array </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 inventory 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_license_state-instance_method" title="#get_license_state (instance method)">#<strong>get_license_state</strong>(org_id) ⇒ Hash </a>
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
</span>
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
<span class="summary_desc"><div class='inline'>
|
|
249
|
-
<p>Returns the current license state for a given organization.</p>
|
|
250
|
-
</div></span>
|
|
251
|
-
|
|
252
|
-
</li>
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
<li class="public ">
|
|
256
|
-
<span class="summary_signature">
|
|
257
|
-
|
|
258
|
-
<a href="#get_organization-instance_method" title="#get_organization (instance method)">#<strong>get_organization</strong>(org_id) ⇒ Hash </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 information about an organization.</p>
|
|
274
|
-
</div></span>
|
|
275
|
-
|
|
276
|
-
</li>
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
<li class="public ">
|
|
280
|
-
<span class="summary_signature">
|
|
281
|
-
|
|
282
|
-
<a href="#get_snmp_settings-instance_method" title="#get_snmp_settings (instance method)">#<strong>get_snmp_settings</strong>(org_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 current SNMP status for an organization.</p>
|
|
298
|
-
</div></span>
|
|
299
|
-
|
|
300
|
-
</li>
|
|
301
|
-
|
|
302
|
-
|
|
303
|
-
<li class="public ">
|
|
304
|
-
<span class="summary_signature">
|
|
305
|
-
|
|
306
|
-
<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>
|
|
307
|
-
|
|
308
|
-
|
|
309
|
-
|
|
310
|
-
</span>
|
|
311
|
-
|
|
312
|
-
|
|
313
|
-
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
|
|
317
|
-
|
|
318
|
-
|
|
319
|
-
|
|
320
|
-
<span class="summary_desc"><div class='inline'>
|
|
321
|
-
<p>Returns the configurations for an organizations 3rd party VPN peers.</p>
|
|
322
|
-
</div></span>
|
|
323
|
-
|
|
324
|
-
</li>
|
|
325
|
-
|
|
326
|
-
|
|
327
|
-
<li class="public ">
|
|
328
|
-
<span class="summary_signature">
|
|
329
|
-
|
|
330
|
-
<a href="#list_all_organizations-instance_method" title="#list_all_organizations (instance method)">#<strong>list_all_organizations</strong> ⇒ Array </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>Returns all organizations a user is an administrator on.</p>
|
|
346
|
-
</div></span>
|
|
347
|
-
|
|
348
|
-
</li>
|
|
349
|
-
|
|
350
|
-
|
|
351
|
-
<li class="public ">
|
|
352
|
-
<span class="summary_signature">
|
|
353
|
-
|
|
354
|
-
<a href="#update_organization-instance_method" title="#update_organization (instance method)">#<strong>update_organization</strong>(org_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 an organization.</p>
|
|
370
|
-
</div></span>
|
|
371
|
-
|
|
372
|
-
</li>
|
|
373
|
-
|
|
374
|
-
|
|
375
|
-
<li class="public ">
|
|
376
|
-
<span class="summary_signature">
|
|
377
|
-
|
|
378
|
-
<a href="#update_snmp_settings-instance_method" title="#update_snmp_settings (instance method)">#<strong>update_snmp_settings</strong>(org_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 the current SNMP status for an organization.</p>
|
|
394
|
-
</div></span>
|
|
395
|
-
|
|
396
|
-
</li>
|
|
397
|
-
|
|
398
|
-
|
|
399
|
-
<li class="public ">
|
|
400
|
-
<span class="summary_signature">
|
|
401
|
-
|
|
402
|
-
<a href="#update_third_party_peers-instance_method" title="#update_third_party_peers (instance method)">#<strong>update_third_party_peers</strong>(org_id, options) ⇒ Array </a>
|
|
403
|
-
|
|
404
|
-
|
|
405
|
-
|
|
406
|
-
</span>
|
|
407
|
-
|
|
408
|
-
|
|
409
|
-
|
|
410
|
-
|
|
411
|
-
|
|
412
|
-
|
|
413
|
-
|
|
414
|
-
|
|
415
|
-
|
|
416
|
-
<span class="summary_desc"><div class='inline'>
|
|
417
|
-
<p>Updates your third party peers.</p>
|
|
418
|
-
</div></span>
|
|
419
|
-
|
|
420
|
-
</li>
|
|
421
|
-
|
|
422
|
-
|
|
423
|
-
</ul>
|
|
424
|
-
|
|
425
|
-
|
|
426
|
-
|
|
427
|
-
|
|
428
|
-
<div id="instance_method_details" class="method_details_list">
|
|
429
|
-
<h2>Instance Method Details</h2>
|
|
430
|
-
|
|
431
|
-
|
|
432
|
-
<div class="method_details first">
|
|
433
|
-
<h3 class="signature first" id="claim-instance_method">
|
|
434
|
-
|
|
435
|
-
#<strong>claim</strong>(org_id, options) ⇒ <tt>Integer</tt>
|
|
436
|
-
|
|
437
|
-
|
|
438
|
-
|
|
439
|
-
|
|
440
|
-
|
|
441
|
-
</h3><div class="docstring">
|
|
442
|
-
<div class="discussion">
|
|
443
|
-
|
|
444
|
-
<p>Claim something</p>
|
|
445
|
-
|
|
446
|
-
|
|
447
|
-
</div>
|
|
448
|
-
</div>
|
|
449
|
-
<div class="tags">
|
|
450
|
-
<p class="tag_title">Parameters:</p>
|
|
451
|
-
<ul class="param">
|
|
452
|
-
|
|
453
|
-
<li>
|
|
454
|
-
|
|
455
|
-
<span class='name'>org_id</span>
|
|
456
|
-
|
|
457
|
-
|
|
458
|
-
<span class='type'>(<tt>String</tt>)</span>
|
|
459
|
-
|
|
460
|
-
|
|
461
|
-
|
|
462
|
-
—
|
|
463
|
-
<div class='inline'>
|
|
464
|
-
<p>the organization that you want to claim to</p>
|
|
465
|
-
</div>
|
|
466
|
-
|
|
467
|
-
</li>
|
|
468
|
-
|
|
469
|
-
<li>
|
|
470
|
-
|
|
471
|
-
<span class='name'>options</span>
|
|
472
|
-
|
|
473
|
-
|
|
474
|
-
<span class='type'>(<tt>Hash</tt>)</span>
|
|
475
|
-
|
|
476
|
-
|
|
477
|
-
|
|
478
|
-
—
|
|
479
|
-
<div class='inline'>
|
|
480
|
-
<p>a hash containing information about what you want to claim. This can be
|
|
481
|
-
order, serial, licenseKey and licenseMode. Refer to the official Dashboard
|
|
482
|
-
API documentation for more information about these</p>
|
|
483
|
-
</div>
|
|
484
|
-
|
|
485
|
-
</li>
|
|
486
|
-
|
|
487
|
-
</ul>
|
|
488
|
-
|
|
489
|
-
<p class="tag_title">Returns:</p>
|
|
490
|
-
<ul class="return">
|
|
491
|
-
|
|
492
|
-
<li>
|
|
493
|
-
|
|
494
|
-
|
|
495
|
-
<span class='type'>(<tt>Integer</tt>)</span>
|
|
496
|
-
|
|
497
|
-
|
|
498
|
-
|
|
499
|
-
—
|
|
500
|
-
<div class='inline'>
|
|
501
|
-
<p>HTTP Code</p>
|
|
502
|
-
</div>
|
|
503
|
-
|
|
504
|
-
</li>
|
|
505
|
-
|
|
506
|
-
</ul>
|
|
507
|
-
|
|
508
|
-
</div><table class="source_code">
|
|
509
|
-
<tr>
|
|
510
|
-
<td>
|
|
511
|
-
<pre class="lines">
|
|
512
|
-
|
|
513
|
-
|
|
514
|
-
109
|
|
515
|
-
110
|
|
516
|
-
111
|
|
517
|
-
112
|
|
518
|
-
113
|
|
519
|
-
114</pre>
|
|
520
|
-
</td>
|
|
521
|
-
<td>
|
|
522
|
-
<pre class="code"><span class="info file"># File 'lib/organizations.rb', line 109</span>
|
|
523
|
-
|
|
524
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_claim'>claim</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>
|
|
525
|
-
<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>
|
|
526
|
-
|
|
527
|
-
<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>
|
|
528
|
-
<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'>/claim</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>POST</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
|
529
|
-
<span class='kw'>end</span></pre>
|
|
530
|
-
</td>
|
|
531
|
-
</tr>
|
|
532
|
-
</table>
|
|
533
|
-
</div>
|
|
534
|
-
|
|
535
|
-
<div class="method_details ">
|
|
536
|
-
<h3 class="signature " id="clone_organization-instance_method">
|
|
537
|
-
|
|
538
|
-
#<strong>clone_organization</strong>(source_org_id, options) ⇒ <tt>Hash</tt>
|
|
539
|
-
|
|
540
|
-
|
|
541
|
-
|
|
542
|
-
|
|
543
|
-
|
|
544
|
-
</h3><div class="docstring">
|
|
545
|
-
<div class="discussion">
|
|
546
|
-
|
|
547
|
-
<p>Clone an organization</p>
|
|
548
|
-
|
|
549
|
-
|
|
550
|
-
</div>
|
|
551
|
-
</div>
|
|
552
|
-
<div class="tags">
|
|
553
|
-
<p class="tag_title">Parameters:</p>
|
|
554
|
-
<ul class="param">
|
|
555
|
-
|
|
556
|
-
<li>
|
|
557
|
-
|
|
558
|
-
<span class='name'>source_org_id</span>
|
|
559
|
-
|
|
560
|
-
|
|
561
|
-
<span class='type'>(<tt>String</tt>)</span>
|
|
562
|
-
|
|
563
|
-
|
|
564
|
-
|
|
565
|
-
—
|
|
566
|
-
<div class='inline'>
|
|
567
|
-
<p>the source organization that we want to clone from</p>
|
|
568
|
-
</div>
|
|
569
|
-
|
|
570
|
-
</li>
|
|
571
|
-
|
|
572
|
-
<li>
|
|
573
|
-
|
|
574
|
-
<span class='name'>options</span>
|
|
575
|
-
|
|
576
|
-
|
|
577
|
-
<span class='type'>(<tt>Hash</tt>)</span>
|
|
578
|
-
|
|
579
|
-
|
|
580
|
-
|
|
581
|
-
—
|
|
582
|
-
<div class='inline'>
|
|
583
|
-
<p>options hash containing the attributes for the new organization</p>
|
|
584
|
-
</div>
|
|
585
|
-
|
|
586
|
-
</li>
|
|
587
|
-
|
|
588
|
-
</ul>
|
|
589
|
-
|
|
590
|
-
<p class="tag_title">Returns:</p>
|
|
591
|
-
<ul class="return">
|
|
592
|
-
|
|
593
|
-
<li>
|
|
594
|
-
|
|
595
|
-
|
|
596
|
-
<span class='type'>(<tt>Hash</tt>)</span>
|
|
597
|
-
|
|
598
|
-
|
|
599
|
-
|
|
600
|
-
—
|
|
601
|
-
<div class='inline'>
|
|
602
|
-
<p>the attributes of the newly cloned organization</p>
|
|
603
|
-
</div>
|
|
604
|
-
|
|
605
|
-
</li>
|
|
606
|
-
|
|
607
|
-
</ul>
|
|
608
|
-
|
|
609
|
-
</div><table class="source_code">
|
|
610
|
-
<tr>
|
|
611
|
-
<td>
|
|
612
|
-
<pre class="lines">
|
|
613
|
-
|
|
614
|
-
|
|
615
|
-
96
|
|
616
|
-
97
|
|
617
|
-
98
|
|
618
|
-
99
|
|
619
|
-
100
|
|
620
|
-
101</pre>
|
|
621
|
-
</td>
|
|
622
|
-
<td>
|
|
623
|
-
<pre class="code"><span class="info file"># File 'lib/organizations.rb', line 96</span>
|
|
624
|
-
|
|
625
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_clone_organization'>clone_organization</span><span class='lparen'>(</span><span class='id identifier rubyid_source_org_id'>source_org_id</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
|
626
|
-
<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>
|
|
627
|
-
|
|
628
|
-
<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>
|
|
629
|
-
<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_source_org_id'>source_org_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/clone</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>
|
|
630
|
-
<span class='kw'>end</span></pre>
|
|
631
|
-
</td>
|
|
632
|
-
</tr>
|
|
633
|
-
</table>
|
|
634
|
-
</div>
|
|
635
|
-
|
|
636
|
-
<div class="method_details ">
|
|
637
|
-
<h3 class="signature " id="create_organization-instance_method">
|
|
638
|
-
|
|
639
|
-
#<strong>create_organization</strong>(options) ⇒ <tt>Hash</tt>
|
|
640
|
-
|
|
641
|
-
|
|
642
|
-
|
|
643
|
-
|
|
644
|
-
|
|
645
|
-
</h3><div class="docstring">
|
|
646
|
-
<div class="discussion">
|
|
647
|
-
|
|
648
|
-
<p>Create a new organization</p>
|
|
649
|
-
|
|
650
|
-
|
|
651
|
-
</div>
|
|
652
|
-
</div>
|
|
653
|
-
<div class="tags">
|
|
654
|
-
<p class="tag_title">Parameters:</p>
|
|
655
|
-
<ul class="param">
|
|
656
|
-
|
|
657
|
-
<li>
|
|
658
|
-
|
|
659
|
-
<span class='name'>options</span>
|
|
660
|
-
|
|
661
|
-
|
|
662
|
-
<span class='type'>(<tt>Hash</tt>)</span>
|
|
663
|
-
|
|
664
|
-
|
|
665
|
-
|
|
666
|
-
—
|
|
667
|
-
<div class='inline'>
|
|
668
|
-
<p>an options hash containing the name of the new organization</p>
|
|
669
|
-
</div>
|
|
670
|
-
|
|
671
|
-
</li>
|
|
672
|
-
|
|
673
|
-
</ul>
|
|
674
|
-
|
|
675
|
-
<p class="tag_title">Returns:</p>
|
|
676
|
-
<ul class="return">
|
|
677
|
-
|
|
678
|
-
<li>
|
|
679
|
-
|
|
680
|
-
|
|
681
|
-
<span class='type'>(<tt>Hash</tt>)</span>
|
|
682
|
-
|
|
683
|
-
|
|
684
|
-
|
|
685
|
-
—
|
|
686
|
-
<div class='inline'>
|
|
687
|
-
<p>the attributes of the newly created organization</p>
|
|
688
|
-
</div>
|
|
689
|
-
|
|
690
|
-
</li>
|
|
691
|
-
|
|
692
|
-
</ul>
|
|
693
|
-
|
|
694
|
-
</div><table class="source_code">
|
|
695
|
-
<tr>
|
|
696
|
-
<td>
|
|
697
|
-
<pre class="lines">
|
|
698
|
-
|
|
699
|
-
|
|
700
|
-
85
|
|
701
|
-
86
|
|
702
|
-
87
|
|
703
|
-
88
|
|
704
|
-
89
|
|
705
|
-
90</pre>
|
|
706
|
-
</td>
|
|
707
|
-
<td>
|
|
708
|
-
<pre class="code"><span class="info file"># File 'lib/organizations.rb', line 85</span>
|
|
709
|
-
|
|
710
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_create_organization'>create_organization</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
|
711
|
-
<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>
|
|
712
|
-
|
|
713
|
-
<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>
|
|
714
|
-
<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='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>
|
|
715
|
-
<span class='kw'>end</span></pre>
|
|
716
|
-
</td>
|
|
717
|
-
</tr>
|
|
718
|
-
</table>
|
|
719
|
-
</div>
|
|
720
|
-
|
|
721
|
-
<div class="method_details ">
|
|
722
|
-
<h3 class="signature " id="get_inventory-instance_method">
|
|
723
|
-
|
|
724
|
-
#<strong>get_inventory</strong>(org_id) ⇒ <tt>Array</tt>
|
|
725
|
-
|
|
726
|
-
|
|
727
|
-
|
|
728
|
-
|
|
729
|
-
|
|
730
|
-
</h3><div class="docstring">
|
|
731
|
-
<div class="discussion">
|
|
732
|
-
|
|
733
|
-
<p>Returns the current inventory for an organization</p>
|
|
734
|
-
|
|
735
|
-
|
|
736
|
-
</div>
|
|
737
|
-
</div>
|
|
738
|
-
<div class="tags">
|
|
739
|
-
<p class="tag_title">Parameters:</p>
|
|
740
|
-
<ul class="param">
|
|
741
|
-
|
|
742
|
-
<li>
|
|
743
|
-
|
|
744
|
-
<span class='name'>org_id</span>
|
|
745
|
-
|
|
746
|
-
|
|
747
|
-
<span class='type'>(<tt>String</tt>)</span>
|
|
748
|
-
|
|
749
|
-
|
|
750
|
-
|
|
751
|
-
—
|
|
752
|
-
<div class='inline'>
|
|
753
|
-
<p>dashboard organization ID</p>
|
|
754
|
-
</div>
|
|
755
|
-
|
|
756
|
-
</li>
|
|
757
|
-
|
|
758
|
-
</ul>
|
|
759
|
-
|
|
760
|
-
<p class="tag_title">Returns:</p>
|
|
761
|
-
<ul class="return">
|
|
762
|
-
|
|
763
|
-
<li>
|
|
764
|
-
|
|
765
|
-
|
|
766
|
-
<span class='type'>(<tt>Array</tt>)</span>
|
|
767
|
-
|
|
768
|
-
|
|
769
|
-
|
|
770
|
-
—
|
|
771
|
-
<div class='inline'>
|
|
772
|
-
<p>an array of hashes containg information on each individual device</p>
|
|
773
|
-
</div>
|
|
774
|
-
|
|
775
|
-
</li>
|
|
776
|
-
|
|
777
|
-
</ul>
|
|
778
|
-
|
|
779
|
-
</div><table class="source_code">
|
|
780
|
-
<tr>
|
|
781
|
-
<td>
|
|
782
|
-
<pre class="lines">
|
|
783
|
-
|
|
784
|
-
|
|
785
|
-
21
|
|
786
|
-
22
|
|
787
|
-
23</pre>
|
|
788
|
-
</td>
|
|
789
|
-
<td>
|
|
790
|
-
<pre class="code"><span class="info file"># File 'lib/organizations.rb', line 21</span>
|
|
791
|
-
|
|
792
|
-
<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>
|
|
793
|
-
<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>
|
|
794
|
-
<span class='kw'>end</span></pre>
|
|
795
|
-
</td>
|
|
796
|
-
</tr>
|
|
797
|
-
</table>
|
|
798
|
-
</div>
|
|
799
|
-
|
|
800
|
-
<div class="method_details ">
|
|
801
|
-
<h3 class="signature " id="get_license_state-instance_method">
|
|
802
|
-
|
|
803
|
-
#<strong>get_license_state</strong>(org_id) ⇒ <tt>Hash</tt>
|
|
804
|
-
|
|
805
|
-
|
|
806
|
-
|
|
807
|
-
|
|
808
|
-
|
|
809
|
-
</h3><div class="docstring">
|
|
810
|
-
<div class="discussion">
|
|
811
|
-
|
|
812
|
-
<p>Returns the current license state for a given organization</p>
|
|
813
|
-
|
|
814
|
-
|
|
815
|
-
</div>
|
|
816
|
-
</div>
|
|
817
|
-
<div class="tags">
|
|
818
|
-
<p class="tag_title">Parameters:</p>
|
|
819
|
-
<ul class="param">
|
|
820
|
-
|
|
821
|
-
<li>
|
|
822
|
-
|
|
823
|
-
<span class='name'>org_id</span>
|
|
824
|
-
|
|
825
|
-
|
|
826
|
-
<span class='type'>(<tt>String</tt>)</span>
|
|
827
|
-
|
|
828
|
-
|
|
829
|
-
|
|
830
|
-
—
|
|
831
|
-
<div class='inline'>
|
|
832
|
-
<p>dashboard organization ID</p>
|
|
833
|
-
</div>
|
|
834
|
-
|
|
835
|
-
</li>
|
|
836
|
-
|
|
837
|
-
</ul>
|
|
838
|
-
|
|
839
|
-
<p class="tag_title">Returns:</p>
|
|
840
|
-
<ul class="return">
|
|
841
|
-
|
|
842
|
-
<li>
|
|
843
|
-
|
|
844
|
-
|
|
845
|
-
<span class='type'>(<tt>Hash</tt>)</span>
|
|
846
|
-
|
|
847
|
-
|
|
848
|
-
|
|
849
|
-
—
|
|
850
|
-
<div class='inline'>
|
|
851
|
-
<p>results contains the current license state information</p>
|
|
852
|
-
</div>
|
|
853
|
-
|
|
854
|
-
</li>
|
|
855
|
-
|
|
856
|
-
</ul>
|
|
857
|
-
|
|
858
|
-
</div><table class="source_code">
|
|
859
|
-
<tr>
|
|
860
|
-
<td>
|
|
861
|
-
<pre class="lines">
|
|
862
|
-
|
|
863
|
-
|
|
864
|
-
14
|
|
865
|
-
15
|
|
866
|
-
16</pre>
|
|
867
|
-
</td>
|
|
868
|
-
<td>
|
|
869
|
-
<pre class="code"><span class="info file"># File 'lib/organizations.rb', line 14</span>
|
|
870
|
-
|
|
871
|
-
<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>
|
|
872
|
-
<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>
|
|
873
|
-
<span class='kw'>end</span></pre>
|
|
874
|
-
</td>
|
|
875
|
-
</tr>
|
|
876
|
-
</table>
|
|
877
|
-
</div>
|
|
878
|
-
|
|
879
|
-
<div class="method_details ">
|
|
880
|
-
<h3 class="signature " id="get_organization-instance_method">
|
|
881
|
-
|
|
882
|
-
#<strong>get_organization</strong>(org_id) ⇒ <tt>Hash</tt>
|
|
883
|
-
|
|
884
|
-
|
|
885
|
-
|
|
886
|
-
|
|
887
|
-
|
|
888
|
-
</h3><div class="docstring">
|
|
889
|
-
<div class="discussion">
|
|
890
|
-
|
|
891
|
-
<p>Returns information about an organization</p>
|
|
892
|
-
|
|
893
|
-
|
|
894
|
-
</div>
|
|
895
|
-
</div>
|
|
896
|
-
<div class="tags">
|
|
897
|
-
<p class="tag_title">Parameters:</p>
|
|
898
|
-
<ul class="param">
|
|
899
|
-
|
|
900
|
-
<li>
|
|
901
|
-
|
|
902
|
-
<span class='name'>org_id</span>
|
|
903
|
-
|
|
904
|
-
|
|
905
|
-
<span class='type'>(<tt>String</tt>)</span>
|
|
906
|
-
|
|
907
|
-
|
|
908
|
-
|
|
909
|
-
—
|
|
910
|
-
<div class='inline'>
|
|
911
|
-
<p>dashboard organization ID</p>
|
|
912
|
-
</div>
|
|
913
|
-
|
|
914
|
-
</li>
|
|
915
|
-
|
|
916
|
-
</ul>
|
|
917
|
-
|
|
918
|
-
<p class="tag_title">Returns:</p>
|
|
919
|
-
<ul class="return">
|
|
920
|
-
|
|
921
|
-
<li>
|
|
922
|
-
|
|
923
|
-
|
|
924
|
-
<span class='type'>(<tt>Hash</tt>)</span>
|
|
925
|
-
|
|
926
|
-
|
|
927
|
-
|
|
928
|
-
—
|
|
929
|
-
<div class='inline'>
|
|
930
|
-
<p>results contains the org id and name of the given organization</p>
|
|
931
|
-
</div>
|
|
932
|
-
|
|
933
|
-
</li>
|
|
934
|
-
|
|
935
|
-
</ul>
|
|
936
|
-
|
|
937
|
-
</div><table class="source_code">
|
|
938
|
-
<tr>
|
|
939
|
-
<td>
|
|
940
|
-
<pre class="lines">
|
|
941
|
-
|
|
942
|
-
|
|
943
|
-
7
|
|
944
|
-
8
|
|
945
|
-
9</pre>
|
|
946
|
-
</td>
|
|
947
|
-
<td>
|
|
948
|
-
<pre class="code"><span class="info file"># File 'lib/organizations.rb', line 7</span>
|
|
949
|
-
|
|
950
|
-
<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>
|
|
951
|
-
<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>
|
|
952
|
-
<span class='kw'>end</span></pre>
|
|
953
|
-
</td>
|
|
954
|
-
</tr>
|
|
955
|
-
</table>
|
|
956
|
-
</div>
|
|
957
|
-
|
|
958
|
-
<div class="method_details ">
|
|
959
|
-
<h3 class="signature " id="get_snmp_settings-instance_method">
|
|
960
|
-
|
|
961
|
-
#<strong>get_snmp_settings</strong>(org_id) ⇒ <tt>Hash</tt>
|
|
962
|
-
|
|
963
|
-
|
|
964
|
-
|
|
965
|
-
|
|
966
|
-
|
|
967
|
-
</h3><div class="docstring">
|
|
968
|
-
<div class="discussion">
|
|
969
|
-
|
|
970
|
-
<p>Returns the current SNMP status for an organization</p>
|
|
971
|
-
|
|
972
|
-
|
|
973
|
-
</div>
|
|
974
|
-
</div>
|
|
975
|
-
<div class="tags">
|
|
976
|
-
<p class="tag_title">Parameters:</p>
|
|
977
|
-
<ul class="param">
|
|
978
|
-
|
|
979
|
-
<li>
|
|
980
|
-
|
|
981
|
-
<span class='name'>org_id</span>
|
|
982
|
-
|
|
983
|
-
|
|
984
|
-
<span class='type'>(<tt>String</tt>)</span>
|
|
985
|
-
|
|
986
|
-
|
|
987
|
-
|
|
988
|
-
—
|
|
989
|
-
<div class='inline'>
|
|
990
|
-
<p>dashboard organization ID</p>
|
|
991
|
-
</div>
|
|
992
|
-
|
|
993
|
-
</li>
|
|
994
|
-
|
|
995
|
-
</ul>
|
|
996
|
-
|
|
997
|
-
<p class="tag_title">Returns:</p>
|
|
998
|
-
<ul class="return">
|
|
999
|
-
|
|
1000
|
-
<li>
|
|
1001
|
-
|
|
1002
|
-
|
|
1003
|
-
<span class='type'>(<tt>Hash</tt>)</span>
|
|
1004
|
-
|
|
1005
|
-
|
|
1006
|
-
|
|
1007
|
-
—
|
|
1008
|
-
<div class='inline'>
|
|
1009
|
-
<p>a hash containing all SNMP configuration information for an organization</p>
|
|
1010
|
-
</div>
|
|
1011
|
-
|
|
1012
|
-
</li>
|
|
1013
|
-
|
|
1014
|
-
</ul>
|
|
1015
|
-
|
|
1016
|
-
</div><table class="source_code">
|
|
1017
|
-
<tr>
|
|
1018
|
-
<td>
|
|
1019
|
-
<pre class="lines">
|
|
1020
|
-
|
|
1021
|
-
|
|
1022
|
-
28
|
|
1023
|
-
29
|
|
1024
|
-
30</pre>
|
|
1025
|
-
</td>
|
|
1026
|
-
<td>
|
|
1027
|
-
<pre class="code"><span class="info file"># File 'lib/organizations.rb', line 28</span>
|
|
1028
|
-
|
|
1029
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_get_snmp_settings'>get_snmp_settings</span><span class='lparen'>(</span><span class='id identifier rubyid_org_id'>org_id</span><span class='rparen'>)</span>
|
|
1030
|
-
<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>
|
|
1031
|
-
<span class='kw'>end</span></pre>
|
|
1032
|
-
</td>
|
|
1033
|
-
</tr>
|
|
1034
|
-
</table>
|
|
1035
|
-
</div>
|
|
1036
|
-
|
|
1037
|
-
<div class="method_details ">
|
|
1038
|
-
<h3 class="signature " id="get_third_party_peers-instance_method">
|
|
1039
|
-
|
|
1040
|
-
#<strong>get_third_party_peers</strong>(org_id) ⇒ <tt>Array</tt>
|
|
1041
|
-
|
|
1042
|
-
|
|
1043
|
-
|
|
1044
|
-
|
|
1045
|
-
|
|
1046
|
-
</h3><div class="docstring">
|
|
1047
|
-
<div class="discussion">
|
|
1048
|
-
|
|
1049
|
-
<p>Returns the configurations for an organizations 3rd party VPN peers</p>
|
|
1050
|
-
|
|
1051
|
-
|
|
1052
|
-
</div>
|
|
1053
|
-
</div>
|
|
1054
|
-
<div class="tags">
|
|
1055
|
-
<p class="tag_title">Parameters:</p>
|
|
1056
|
-
<ul class="param">
|
|
1057
|
-
|
|
1058
|
-
<li>
|
|
1059
|
-
|
|
1060
|
-
<span class='name'>org_id</span>
|
|
1061
|
-
|
|
1062
|
-
|
|
1063
|
-
<span class='type'>(<tt>String</tt>)</span>
|
|
1064
|
-
|
|
1065
|
-
|
|
1066
|
-
|
|
1067
|
-
—
|
|
1068
|
-
<div class='inline'>
|
|
1069
|
-
<p>dashboard organization ID</p>
|
|
1070
|
-
</div>
|
|
1071
|
-
|
|
1072
|
-
</li>
|
|
1073
|
-
|
|
1074
|
-
</ul>
|
|
1075
|
-
|
|
1076
|
-
<p class="tag_title">Returns:</p>
|
|
1077
|
-
<ul class="return">
|
|
1078
|
-
|
|
1079
|
-
<li>
|
|
1080
|
-
|
|
1081
|
-
|
|
1082
|
-
<span class='type'>(<tt>Array</tt>)</span>
|
|
1083
|
-
|
|
1084
|
-
|
|
1085
|
-
|
|
1086
|
-
—
|
|
1087
|
-
<div class='inline'>
|
|
1088
|
-
<p>an arrry of hashes containing the configuration information for each 3rd
|
|
1089
|
-
party VPN peer</p>
|
|
1090
|
-
</div>
|
|
1091
|
-
|
|
1092
|
-
</li>
|
|
1093
|
-
|
|
1094
|
-
</ul>
|
|
1095
|
-
|
|
1096
|
-
</div><table class="source_code">
|
|
1097
|
-
<tr>
|
|
1098
|
-
<td>
|
|
1099
|
-
<pre class="lines">
|
|
1100
|
-
|
|
1101
|
-
|
|
1102
|
-
49
|
|
1103
|
-
50
|
|
1104
|
-
51</pre>
|
|
1105
|
-
</td>
|
|
1106
|
-
<td>
|
|
1107
|
-
<pre class="code"><span class="info file"># File 'lib/organizations.rb', line 49</span>
|
|
1108
|
-
|
|
1109
|
-
<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>
|
|
1110
|
-
<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>
|
|
1111
|
-
<span class='kw'>end</span></pre>
|
|
1112
|
-
</td>
|
|
1113
|
-
</tr>
|
|
1114
|
-
</table>
|
|
1115
|
-
</div>
|
|
1116
|
-
|
|
1117
|
-
<div class="method_details ">
|
|
1118
|
-
<h3 class="signature " id="list_all_organizations-instance_method">
|
|
1119
|
-
|
|
1120
|
-
#<strong>list_all_organizations</strong> ⇒ <tt>Array</tt>
|
|
1121
|
-
|
|
1122
|
-
|
|
1123
|
-
|
|
1124
|
-
|
|
1125
|
-
|
|
1126
|
-
</h3><div class="docstring">
|
|
1127
|
-
<div class="discussion">
|
|
1128
|
-
|
|
1129
|
-
<p>Returns all organizations a user is an administrator on</p>
|
|
1130
|
-
|
|
1131
|
-
|
|
1132
|
-
</div>
|
|
1133
|
-
</div>
|
|
1134
|
-
<div class="tags">
|
|
1135
|
-
|
|
1136
|
-
<p class="tag_title">Returns:</p>
|
|
1137
|
-
<ul class="return">
|
|
1138
|
-
|
|
1139
|
-
<li>
|
|
1140
|
-
|
|
1141
|
-
|
|
1142
|
-
<span class='type'>(<tt>Array</tt>)</span>
|
|
1143
|
-
|
|
1144
|
-
|
|
1145
|
-
|
|
1146
|
-
—
|
|
1147
|
-
<div class='inline'>
|
|
1148
|
-
<p>an array of hashes containing the organizations and their attributes</p>
|
|
1149
|
-
</div>
|
|
1150
|
-
|
|
1151
|
-
</li>
|
|
1152
|
-
|
|
1153
|
-
</ul>
|
|
1154
|
-
|
|
1155
|
-
</div><table class="source_code">
|
|
1156
|
-
<tr>
|
|
1157
|
-
<td>
|
|
1158
|
-
<pre class="lines">
|
|
1159
|
-
|
|
1160
|
-
|
|
1161
|
-
67
|
|
1162
|
-
68
|
|
1163
|
-
69</pre>
|
|
1164
|
-
</td>
|
|
1165
|
-
<td>
|
|
1166
|
-
<pre class="code"><span class="info file"># File 'lib/organizations.rb', line 67</span>
|
|
1167
|
-
|
|
1168
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_list_all_organizations'>list_all_organizations</span>
|
|
1169
|
-
<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='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>
|
|
1170
|
-
<span class='kw'>end</span></pre>
|
|
1171
|
-
</td>
|
|
1172
|
-
</tr>
|
|
1173
|
-
</table>
|
|
1174
|
-
</div>
|
|
1175
|
-
|
|
1176
|
-
<div class="method_details ">
|
|
1177
|
-
<h3 class="signature " id="update_organization-instance_method">
|
|
1178
|
-
|
|
1179
|
-
#<strong>update_organization</strong>(org_id, options) ⇒ <tt>Hash</tt>
|
|
1180
|
-
|
|
1181
|
-
|
|
1182
|
-
|
|
1183
|
-
|
|
1184
|
-
|
|
1185
|
-
</h3><div class="docstring">
|
|
1186
|
-
<div class="discussion">
|
|
1187
|
-
|
|
1188
|
-
<p>Update an organization</p>
|
|
1189
|
-
|
|
1190
|
-
|
|
1191
|
-
</div>
|
|
1192
|
-
</div>
|
|
1193
|
-
<div class="tags">
|
|
1194
|
-
<p class="tag_title">Parameters:</p>
|
|
1195
|
-
<ul class="param">
|
|
1196
|
-
|
|
1197
|
-
<li>
|
|
1198
|
-
|
|
1199
|
-
<span class='name'>org_id</span>
|
|
1200
|
-
|
|
1201
|
-
|
|
1202
|
-
<span class='type'>(<tt>String</tt>)</span>
|
|
1203
|
-
|
|
1204
|
-
|
|
1205
|
-
|
|
1206
|
-
—
|
|
1207
|
-
<div class='inline'>
|
|
1208
|
-
<p>the organization ID that you want to update</p>
|
|
1209
|
-
</div>
|
|
1210
|
-
|
|
1211
|
-
</li>
|
|
1212
|
-
|
|
1213
|
-
<li>
|
|
1214
|
-
|
|
1215
|
-
<span class='name'>options</span>
|
|
1216
|
-
|
|
1217
|
-
|
|
1218
|
-
<span class='type'>(<tt>Hash</tt>)</span>
|
|
1219
|
-
|
|
1220
|
-
|
|
1221
|
-
|
|
1222
|
-
—
|
|
1223
|
-
<div class='inline'>
|
|
1224
|
-
<p>an options hash containing the org ID and new name of the org</p>
|
|
1225
|
-
</div>
|
|
1226
|
-
|
|
1227
|
-
</li>
|
|
1228
|
-
|
|
1229
|
-
</ul>
|
|
1230
|
-
|
|
1231
|
-
<p class="tag_title">Returns:</p>
|
|
1232
|
-
<ul class="return">
|
|
1233
|
-
|
|
1234
|
-
<li>
|
|
1235
|
-
|
|
1236
|
-
|
|
1237
|
-
<span class='type'>(<tt>Hash</tt>)</span>
|
|
1238
|
-
|
|
1239
|
-
|
|
1240
|
-
|
|
1241
|
-
—
|
|
1242
|
-
<div class='inline'>
|
|
1243
|
-
<p>the updated attributes of the organization</p>
|
|
1244
|
-
</div>
|
|
1245
|
-
|
|
1246
|
-
</li>
|
|
1247
|
-
|
|
1248
|
-
</ul>
|
|
1249
|
-
|
|
1250
|
-
</div><table class="source_code">
|
|
1251
|
-
<tr>
|
|
1252
|
-
<td>
|
|
1253
|
-
<pre class="lines">
|
|
1254
|
-
|
|
1255
|
-
|
|
1256
|
-
75
|
|
1257
|
-
76
|
|
1258
|
-
77
|
|
1259
|
-
78
|
|
1260
|
-
79
|
|
1261
|
-
80</pre>
|
|
1262
|
-
</td>
|
|
1263
|
-
<td>
|
|
1264
|
-
<pre class="code"><span class="info file"># File 'lib/organizations.rb', line 75</span>
|
|
1265
|
-
|
|
1266
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_update_organization'>update_organization</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>
|
|
1267
|
-
<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>
|
|
1268
|
-
|
|
1269
|
-
<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>
|
|
1270
|
-
<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'>PUT</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
|
1271
|
-
<span class='kw'>end</span></pre>
|
|
1272
|
-
</td>
|
|
1273
|
-
</tr>
|
|
1274
|
-
</table>
|
|
1275
|
-
</div>
|
|
1276
|
-
|
|
1277
|
-
<div class="method_details ">
|
|
1278
|
-
<h3 class="signature " id="update_snmp_settings-instance_method">
|
|
1279
|
-
|
|
1280
|
-
#<strong>update_snmp_settings</strong>(org_id, options) ⇒ <tt>Hash</tt>
|
|
1281
|
-
|
|
1282
|
-
|
|
1283
|
-
|
|
1284
|
-
|
|
1285
|
-
|
|
1286
|
-
</h3><div class="docstring">
|
|
1287
|
-
<div class="discussion">
|
|
1288
|
-
|
|
1289
|
-
<p>Updates the current SNMP status for an organization</p>
|
|
1290
|
-
|
|
1291
|
-
|
|
1292
|
-
</div>
|
|
1293
|
-
</div>
|
|
1294
|
-
<div class="tags">
|
|
1295
|
-
<p class="tag_title">Parameters:</p>
|
|
1296
|
-
<ul class="param">
|
|
1297
|
-
|
|
1298
|
-
<li>
|
|
1299
|
-
|
|
1300
|
-
<span class='name'>org_id</span>
|
|
1301
|
-
|
|
1302
|
-
|
|
1303
|
-
<span class='type'>(<tt>String</tt>)</span>
|
|
1304
|
-
|
|
1305
|
-
|
|
1306
|
-
|
|
1307
|
-
—
|
|
1308
|
-
<div class='inline'>
|
|
1309
|
-
<p>dashboard organization ID</p>
|
|
1310
|
-
</div>
|
|
1311
|
-
|
|
1312
|
-
</li>
|
|
1313
|
-
|
|
1314
|
-
<li>
|
|
1315
|
-
|
|
1316
|
-
<span class='name'>options</span>
|
|
1317
|
-
|
|
1318
|
-
|
|
1319
|
-
<span class='type'>(<tt>Hash</tt>)</span>
|
|
1320
|
-
|
|
1321
|
-
|
|
1322
|
-
|
|
1323
|
-
—
|
|
1324
|
-
<div class='inline'>
|
|
1325
|
-
<p>a hash containing all updated SNMP configuration information for an
|
|
1326
|
-
organization. Please refer to official Dashboard API documentation for more
|
|
1327
|
-
information on these options: v2cEnabled, v3Enabled, v3AuthMode,
|
|
1328
|
-
v3AuthPass, v3PrivMode, v3PrivPass, peerIps</p>
|
|
1329
|
-
</div>
|
|
1330
|
-
|
|
1331
|
-
</li>
|
|
1332
|
-
|
|
1333
|
-
</ul>
|
|
1334
|
-
|
|
1335
|
-
<p class="tag_title">Returns:</p>
|
|
1336
|
-
<ul class="return">
|
|
1337
|
-
|
|
1338
|
-
<li>
|
|
1339
|
-
|
|
1340
|
-
|
|
1341
|
-
<span class='type'>(<tt>Hash</tt>)</span>
|
|
1342
|
-
|
|
1343
|
-
|
|
1344
|
-
|
|
1345
|
-
—
|
|
1346
|
-
<div class='inline'>
|
|
1347
|
-
<p>a hash containing all SNMP configuration information for an organization</p>
|
|
1348
|
-
</div>
|
|
1349
|
-
|
|
1350
|
-
</li>
|
|
1351
|
-
|
|
1352
|
-
</ul>
|
|
1353
|
-
|
|
1354
|
-
</div><table class="source_code">
|
|
1355
|
-
<tr>
|
|
1356
|
-
<td>
|
|
1357
|
-
<pre class="lines">
|
|
1358
|
-
|
|
1359
|
-
|
|
1360
|
-
38
|
|
1361
|
-
39
|
|
1362
|
-
40
|
|
1363
|
-
41
|
|
1364
|
-
42
|
|
1365
|
-
43</pre>
|
|
1366
|
-
</td>
|
|
1367
|
-
<td>
|
|
1368
|
-
<pre class="code"><span class="info file"># File 'lib/organizations.rb', line 38</span>
|
|
1369
|
-
|
|
1370
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_update_snmp_settings'>update_snmp_settings</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>
|
|
1371
|
-
<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>
|
|
1372
|
-
|
|
1373
|
-
<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>
|
|
1374
|
-
<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'>PUT</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
|
1375
|
-
<span class='kw'>end</span></pre>
|
|
1376
|
-
</td>
|
|
1377
|
-
</tr>
|
|
1378
|
-
</table>
|
|
1379
|
-
</div>
|
|
1380
|
-
|
|
1381
|
-
<div class="method_details ">
|
|
1382
|
-
<h3 class="signature " id="update_third_party_peers-instance_method">
|
|
1383
|
-
|
|
1384
|
-
#<strong>update_third_party_peers</strong>(org_id, options) ⇒ <tt>Array</tt>
|
|
1385
|
-
|
|
1386
|
-
|
|
1387
|
-
|
|
1388
|
-
|
|
1389
|
-
|
|
1390
|
-
</h3><div class="docstring">
|
|
1391
|
-
<div class="discussion">
|
|
1392
|
-
|
|
1393
|
-
<p>Updates your third party peers</p>
|
|
1394
|
-
|
|
1395
|
-
|
|
1396
|
-
</div>
|
|
1397
|
-
</div>
|
|
1398
|
-
<div class="tags">
|
|
1399
|
-
<p class="tag_title">Parameters:</p>
|
|
1400
|
-
<ul class="param">
|
|
1401
|
-
|
|
1402
|
-
<li>
|
|
1403
|
-
|
|
1404
|
-
<span class='name'>org_id</span>
|
|
1405
|
-
|
|
1406
|
-
|
|
1407
|
-
<span class='type'>(<tt>String</tt>)</span>
|
|
1408
|
-
|
|
1409
|
-
|
|
1410
|
-
|
|
1411
|
-
—
|
|
1412
|
-
<div class='inline'>
|
|
1413
|
-
<p>dashboard organization ID</p>
|
|
1414
|
-
</div>
|
|
1415
|
-
|
|
1416
|
-
</li>
|
|
1417
|
-
|
|
1418
|
-
</ul>
|
|
1419
|
-
|
|
1420
|
-
<p class="tag_title">Returns:</p>
|
|
1421
|
-
<ul class="return">
|
|
1422
|
-
|
|
1423
|
-
<li>
|
|
1424
|
-
|
|
1425
|
-
|
|
1426
|
-
<span class='type'>(<tt>Array</tt>)</span>
|
|
1427
|
-
|
|
1428
|
-
|
|
1429
|
-
|
|
1430
|
-
—
|
|
1431
|
-
<div class='inline'>
|
|
1432
|
-
<p>returns the array of hashes for all currently configured 3rd party peers</p>
|
|
1433
|
-
</div>
|
|
1434
|
-
|
|
1435
|
-
</li>
|
|
1436
|
-
|
|
1437
|
-
</ul>
|
|
1438
|
-
|
|
1439
|
-
</div><table class="source_code">
|
|
1440
|
-
<tr>
|
|
1441
|
-
<td>
|
|
1442
|
-
<pre class="lines">
|
|
1443
|
-
|
|
1444
|
-
|
|
1445
|
-
58
|
|
1446
|
-
59
|
|
1447
|
-
60
|
|
1448
|
-
61
|
|
1449
|
-
62
|
|
1450
|
-
63</pre>
|
|
1451
|
-
</td>
|
|
1452
|
-
<td>
|
|
1453
|
-
<pre class="code"><span class="info file"># File 'lib/organizations.rb', line 58</span>
|
|
1454
|
-
|
|
1455
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_update_third_party_peers'>update_third_party_peers</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>
|
|
1456
|
-
<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>
|
|
1457
|
-
|
|
1458
|
-
<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>
|
|
1459
|
-
<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'>PUT</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
|
1460
|
-
<span class='kw'>end</span></pre>
|
|
1461
|
-
</td>
|
|
1462
|
-
</tr>
|
|
1463
|
-
</table>
|
|
1464
|
-
</div>
|
|
1465
|
-
|
|
1466
|
-
</div>
|
|
1467
|
-
|
|
1468
|
-
</div>
|
|
1469
|
-
|
|
1470
|
-
<div id="footer">
|
|
1471
|
-
Generated on Thu Nov 17 22:15:39 2016 by
|
|
1472
|
-
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
1473
|
-
0.9.5 (ruby-2.3.0).
|
|
1474
|
-
</div>
|
|
1475
|
-
|
|
1476
|
-
</div>
|
|
1477
|
-
</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: 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="#claim-instance_method" title="#claim (instance method)">#<strong>claim</strong>(org_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>Claim something.</p>
|
|
154
|
+
</div></span>
|
|
155
|
+
|
|
156
|
+
</li>
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
<li class="public ">
|
|
160
|
+
<span class="summary_signature">
|
|
161
|
+
|
|
162
|
+
<a href="#clone_organization-instance_method" title="#clone_organization (instance method)">#<strong>clone_organization</strong>(source_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>Clone an organization.</p>
|
|
178
|
+
</div></span>
|
|
179
|
+
|
|
180
|
+
</li>
|
|
181
|
+
|
|
182
|
+
|
|
183
|
+
<li class="public ">
|
|
184
|
+
<span class="summary_signature">
|
|
185
|
+
|
|
186
|
+
<a href="#create_organization-instance_method" title="#create_organization (instance method)">#<strong>create_organization</strong>(options) ⇒ 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>Create a new organization.</p>
|
|
202
|
+
</div></span>
|
|
203
|
+
|
|
204
|
+
</li>
|
|
205
|
+
|
|
206
|
+
|
|
207
|
+
<li class="public ">
|
|
208
|
+
<span class="summary_signature">
|
|
209
|
+
|
|
210
|
+
<a href="#get_inventory-instance_method" title="#get_inventory (instance method)">#<strong>get_inventory</strong>(org_id) ⇒ Array </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 inventory 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_license_state-instance_method" title="#get_license_state (instance method)">#<strong>get_license_state</strong>(org_id) ⇒ Hash </a>
|
|
235
|
+
|
|
236
|
+
|
|
237
|
+
|
|
238
|
+
</span>
|
|
239
|
+
|
|
240
|
+
|
|
241
|
+
|
|
242
|
+
|
|
243
|
+
|
|
244
|
+
|
|
245
|
+
|
|
246
|
+
|
|
247
|
+
|
|
248
|
+
<span class="summary_desc"><div class='inline'>
|
|
249
|
+
<p>Returns the current license state for a given organization.</p>
|
|
250
|
+
</div></span>
|
|
251
|
+
|
|
252
|
+
</li>
|
|
253
|
+
|
|
254
|
+
|
|
255
|
+
<li class="public ">
|
|
256
|
+
<span class="summary_signature">
|
|
257
|
+
|
|
258
|
+
<a href="#get_organization-instance_method" title="#get_organization (instance method)">#<strong>get_organization</strong>(org_id) ⇒ Hash </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 information about an organization.</p>
|
|
274
|
+
</div></span>
|
|
275
|
+
|
|
276
|
+
</li>
|
|
277
|
+
|
|
278
|
+
|
|
279
|
+
<li class="public ">
|
|
280
|
+
<span class="summary_signature">
|
|
281
|
+
|
|
282
|
+
<a href="#get_snmp_settings-instance_method" title="#get_snmp_settings (instance method)">#<strong>get_snmp_settings</strong>(org_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 current SNMP status for an organization.</p>
|
|
298
|
+
</div></span>
|
|
299
|
+
|
|
300
|
+
</li>
|
|
301
|
+
|
|
302
|
+
|
|
303
|
+
<li class="public ">
|
|
304
|
+
<span class="summary_signature">
|
|
305
|
+
|
|
306
|
+
<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>
|
|
307
|
+
|
|
308
|
+
|
|
309
|
+
|
|
310
|
+
</span>
|
|
311
|
+
|
|
312
|
+
|
|
313
|
+
|
|
314
|
+
|
|
315
|
+
|
|
316
|
+
|
|
317
|
+
|
|
318
|
+
|
|
319
|
+
|
|
320
|
+
<span class="summary_desc"><div class='inline'>
|
|
321
|
+
<p>Returns the configurations for an organizations 3rd party VPN peers.</p>
|
|
322
|
+
</div></span>
|
|
323
|
+
|
|
324
|
+
</li>
|
|
325
|
+
|
|
326
|
+
|
|
327
|
+
<li class="public ">
|
|
328
|
+
<span class="summary_signature">
|
|
329
|
+
|
|
330
|
+
<a href="#list_all_organizations-instance_method" title="#list_all_organizations (instance method)">#<strong>list_all_organizations</strong> ⇒ Array </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>Returns all organizations a user is an administrator on.</p>
|
|
346
|
+
</div></span>
|
|
347
|
+
|
|
348
|
+
</li>
|
|
349
|
+
|
|
350
|
+
|
|
351
|
+
<li class="public ">
|
|
352
|
+
<span class="summary_signature">
|
|
353
|
+
|
|
354
|
+
<a href="#update_organization-instance_method" title="#update_organization (instance method)">#<strong>update_organization</strong>(org_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 an organization.</p>
|
|
370
|
+
</div></span>
|
|
371
|
+
|
|
372
|
+
</li>
|
|
373
|
+
|
|
374
|
+
|
|
375
|
+
<li class="public ">
|
|
376
|
+
<span class="summary_signature">
|
|
377
|
+
|
|
378
|
+
<a href="#update_snmp_settings-instance_method" title="#update_snmp_settings (instance method)">#<strong>update_snmp_settings</strong>(org_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 the current SNMP status for an organization.</p>
|
|
394
|
+
</div></span>
|
|
395
|
+
|
|
396
|
+
</li>
|
|
397
|
+
|
|
398
|
+
|
|
399
|
+
<li class="public ">
|
|
400
|
+
<span class="summary_signature">
|
|
401
|
+
|
|
402
|
+
<a href="#update_third_party_peers-instance_method" title="#update_third_party_peers (instance method)">#<strong>update_third_party_peers</strong>(org_id, options) ⇒ Array </a>
|
|
403
|
+
|
|
404
|
+
|
|
405
|
+
|
|
406
|
+
</span>
|
|
407
|
+
|
|
408
|
+
|
|
409
|
+
|
|
410
|
+
|
|
411
|
+
|
|
412
|
+
|
|
413
|
+
|
|
414
|
+
|
|
415
|
+
|
|
416
|
+
<span class="summary_desc"><div class='inline'>
|
|
417
|
+
<p>Updates your third party peers.</p>
|
|
418
|
+
</div></span>
|
|
419
|
+
|
|
420
|
+
</li>
|
|
421
|
+
|
|
422
|
+
|
|
423
|
+
</ul>
|
|
424
|
+
|
|
425
|
+
|
|
426
|
+
|
|
427
|
+
|
|
428
|
+
<div id="instance_method_details" class="method_details_list">
|
|
429
|
+
<h2>Instance Method Details</h2>
|
|
430
|
+
|
|
431
|
+
|
|
432
|
+
<div class="method_details first">
|
|
433
|
+
<h3 class="signature first" id="claim-instance_method">
|
|
434
|
+
|
|
435
|
+
#<strong>claim</strong>(org_id, options) ⇒ <tt>Integer</tt>
|
|
436
|
+
|
|
437
|
+
|
|
438
|
+
|
|
439
|
+
|
|
440
|
+
|
|
441
|
+
</h3><div class="docstring">
|
|
442
|
+
<div class="discussion">
|
|
443
|
+
|
|
444
|
+
<p>Claim something</p>
|
|
445
|
+
|
|
446
|
+
|
|
447
|
+
</div>
|
|
448
|
+
</div>
|
|
449
|
+
<div class="tags">
|
|
450
|
+
<p class="tag_title">Parameters:</p>
|
|
451
|
+
<ul class="param">
|
|
452
|
+
|
|
453
|
+
<li>
|
|
454
|
+
|
|
455
|
+
<span class='name'>org_id</span>
|
|
456
|
+
|
|
457
|
+
|
|
458
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
459
|
+
|
|
460
|
+
|
|
461
|
+
|
|
462
|
+
—
|
|
463
|
+
<div class='inline'>
|
|
464
|
+
<p>the organization that you want to claim to</p>
|
|
465
|
+
</div>
|
|
466
|
+
|
|
467
|
+
</li>
|
|
468
|
+
|
|
469
|
+
<li>
|
|
470
|
+
|
|
471
|
+
<span class='name'>options</span>
|
|
472
|
+
|
|
473
|
+
|
|
474
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
475
|
+
|
|
476
|
+
|
|
477
|
+
|
|
478
|
+
—
|
|
479
|
+
<div class='inline'>
|
|
480
|
+
<p>a hash containing information about what you want to claim. This can be
|
|
481
|
+
order, serial, licenseKey and licenseMode. Refer to the official Dashboard
|
|
482
|
+
API documentation for more information about these</p>
|
|
483
|
+
</div>
|
|
484
|
+
|
|
485
|
+
</li>
|
|
486
|
+
|
|
487
|
+
</ul>
|
|
488
|
+
|
|
489
|
+
<p class="tag_title">Returns:</p>
|
|
490
|
+
<ul class="return">
|
|
491
|
+
|
|
492
|
+
<li>
|
|
493
|
+
|
|
494
|
+
|
|
495
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
|
496
|
+
|
|
497
|
+
|
|
498
|
+
|
|
499
|
+
—
|
|
500
|
+
<div class='inline'>
|
|
501
|
+
<p>HTTP Code</p>
|
|
502
|
+
</div>
|
|
503
|
+
|
|
504
|
+
</li>
|
|
505
|
+
|
|
506
|
+
</ul>
|
|
507
|
+
|
|
508
|
+
</div><table class="source_code">
|
|
509
|
+
<tr>
|
|
510
|
+
<td>
|
|
511
|
+
<pre class="lines">
|
|
512
|
+
|
|
513
|
+
|
|
514
|
+
109
|
|
515
|
+
110
|
|
516
|
+
111
|
|
517
|
+
112
|
|
518
|
+
113
|
|
519
|
+
114</pre>
|
|
520
|
+
</td>
|
|
521
|
+
<td>
|
|
522
|
+
<pre class="code"><span class="info file"># File 'lib/organizations.rb', line 109</span>
|
|
523
|
+
|
|
524
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_claim'>claim</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>
|
|
525
|
+
<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>
|
|
526
|
+
|
|
527
|
+
<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>
|
|
528
|
+
<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'>/claim</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>POST</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
|
529
|
+
<span class='kw'>end</span></pre>
|
|
530
|
+
</td>
|
|
531
|
+
</tr>
|
|
532
|
+
</table>
|
|
533
|
+
</div>
|
|
534
|
+
|
|
535
|
+
<div class="method_details ">
|
|
536
|
+
<h3 class="signature " id="clone_organization-instance_method">
|
|
537
|
+
|
|
538
|
+
#<strong>clone_organization</strong>(source_org_id, options) ⇒ <tt>Hash</tt>
|
|
539
|
+
|
|
540
|
+
|
|
541
|
+
|
|
542
|
+
|
|
543
|
+
|
|
544
|
+
</h3><div class="docstring">
|
|
545
|
+
<div class="discussion">
|
|
546
|
+
|
|
547
|
+
<p>Clone an organization</p>
|
|
548
|
+
|
|
549
|
+
|
|
550
|
+
</div>
|
|
551
|
+
</div>
|
|
552
|
+
<div class="tags">
|
|
553
|
+
<p class="tag_title">Parameters:</p>
|
|
554
|
+
<ul class="param">
|
|
555
|
+
|
|
556
|
+
<li>
|
|
557
|
+
|
|
558
|
+
<span class='name'>source_org_id</span>
|
|
559
|
+
|
|
560
|
+
|
|
561
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
562
|
+
|
|
563
|
+
|
|
564
|
+
|
|
565
|
+
—
|
|
566
|
+
<div class='inline'>
|
|
567
|
+
<p>the source organization that we want to clone from</p>
|
|
568
|
+
</div>
|
|
569
|
+
|
|
570
|
+
</li>
|
|
571
|
+
|
|
572
|
+
<li>
|
|
573
|
+
|
|
574
|
+
<span class='name'>options</span>
|
|
575
|
+
|
|
576
|
+
|
|
577
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
578
|
+
|
|
579
|
+
|
|
580
|
+
|
|
581
|
+
—
|
|
582
|
+
<div class='inline'>
|
|
583
|
+
<p>options hash containing the attributes for the new organization</p>
|
|
584
|
+
</div>
|
|
585
|
+
|
|
586
|
+
</li>
|
|
587
|
+
|
|
588
|
+
</ul>
|
|
589
|
+
|
|
590
|
+
<p class="tag_title">Returns:</p>
|
|
591
|
+
<ul class="return">
|
|
592
|
+
|
|
593
|
+
<li>
|
|
594
|
+
|
|
595
|
+
|
|
596
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
597
|
+
|
|
598
|
+
|
|
599
|
+
|
|
600
|
+
—
|
|
601
|
+
<div class='inline'>
|
|
602
|
+
<p>the attributes of the newly cloned organization</p>
|
|
603
|
+
</div>
|
|
604
|
+
|
|
605
|
+
</li>
|
|
606
|
+
|
|
607
|
+
</ul>
|
|
608
|
+
|
|
609
|
+
</div><table class="source_code">
|
|
610
|
+
<tr>
|
|
611
|
+
<td>
|
|
612
|
+
<pre class="lines">
|
|
613
|
+
|
|
614
|
+
|
|
615
|
+
96
|
|
616
|
+
97
|
|
617
|
+
98
|
|
618
|
+
99
|
|
619
|
+
100
|
|
620
|
+
101</pre>
|
|
621
|
+
</td>
|
|
622
|
+
<td>
|
|
623
|
+
<pre class="code"><span class="info file"># File 'lib/organizations.rb', line 96</span>
|
|
624
|
+
|
|
625
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_clone_organization'>clone_organization</span><span class='lparen'>(</span><span class='id identifier rubyid_source_org_id'>source_org_id</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
|
626
|
+
<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>
|
|
627
|
+
|
|
628
|
+
<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>
|
|
629
|
+
<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_source_org_id'>source_org_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/clone</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>
|
|
630
|
+
<span class='kw'>end</span></pre>
|
|
631
|
+
</td>
|
|
632
|
+
</tr>
|
|
633
|
+
</table>
|
|
634
|
+
</div>
|
|
635
|
+
|
|
636
|
+
<div class="method_details ">
|
|
637
|
+
<h3 class="signature " id="create_organization-instance_method">
|
|
638
|
+
|
|
639
|
+
#<strong>create_organization</strong>(options) ⇒ <tt>Hash</tt>
|
|
640
|
+
|
|
641
|
+
|
|
642
|
+
|
|
643
|
+
|
|
644
|
+
|
|
645
|
+
</h3><div class="docstring">
|
|
646
|
+
<div class="discussion">
|
|
647
|
+
|
|
648
|
+
<p>Create a new organization</p>
|
|
649
|
+
|
|
650
|
+
|
|
651
|
+
</div>
|
|
652
|
+
</div>
|
|
653
|
+
<div class="tags">
|
|
654
|
+
<p class="tag_title">Parameters:</p>
|
|
655
|
+
<ul class="param">
|
|
656
|
+
|
|
657
|
+
<li>
|
|
658
|
+
|
|
659
|
+
<span class='name'>options</span>
|
|
660
|
+
|
|
661
|
+
|
|
662
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
663
|
+
|
|
664
|
+
|
|
665
|
+
|
|
666
|
+
—
|
|
667
|
+
<div class='inline'>
|
|
668
|
+
<p>an options hash containing the name of the new organization</p>
|
|
669
|
+
</div>
|
|
670
|
+
|
|
671
|
+
</li>
|
|
672
|
+
|
|
673
|
+
</ul>
|
|
674
|
+
|
|
675
|
+
<p class="tag_title">Returns:</p>
|
|
676
|
+
<ul class="return">
|
|
677
|
+
|
|
678
|
+
<li>
|
|
679
|
+
|
|
680
|
+
|
|
681
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
682
|
+
|
|
683
|
+
|
|
684
|
+
|
|
685
|
+
—
|
|
686
|
+
<div class='inline'>
|
|
687
|
+
<p>the attributes of the newly created organization</p>
|
|
688
|
+
</div>
|
|
689
|
+
|
|
690
|
+
</li>
|
|
691
|
+
|
|
692
|
+
</ul>
|
|
693
|
+
|
|
694
|
+
</div><table class="source_code">
|
|
695
|
+
<tr>
|
|
696
|
+
<td>
|
|
697
|
+
<pre class="lines">
|
|
698
|
+
|
|
699
|
+
|
|
700
|
+
85
|
|
701
|
+
86
|
|
702
|
+
87
|
|
703
|
+
88
|
|
704
|
+
89
|
|
705
|
+
90</pre>
|
|
706
|
+
</td>
|
|
707
|
+
<td>
|
|
708
|
+
<pre class="code"><span class="info file"># File 'lib/organizations.rb', line 85</span>
|
|
709
|
+
|
|
710
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_create_organization'>create_organization</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
|
711
|
+
<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>
|
|
712
|
+
|
|
713
|
+
<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>
|
|
714
|
+
<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='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>
|
|
715
|
+
<span class='kw'>end</span></pre>
|
|
716
|
+
</td>
|
|
717
|
+
</tr>
|
|
718
|
+
</table>
|
|
719
|
+
</div>
|
|
720
|
+
|
|
721
|
+
<div class="method_details ">
|
|
722
|
+
<h3 class="signature " id="get_inventory-instance_method">
|
|
723
|
+
|
|
724
|
+
#<strong>get_inventory</strong>(org_id) ⇒ <tt>Array</tt>
|
|
725
|
+
|
|
726
|
+
|
|
727
|
+
|
|
728
|
+
|
|
729
|
+
|
|
730
|
+
</h3><div class="docstring">
|
|
731
|
+
<div class="discussion">
|
|
732
|
+
|
|
733
|
+
<p>Returns the current inventory for an organization</p>
|
|
734
|
+
|
|
735
|
+
|
|
736
|
+
</div>
|
|
737
|
+
</div>
|
|
738
|
+
<div class="tags">
|
|
739
|
+
<p class="tag_title">Parameters:</p>
|
|
740
|
+
<ul class="param">
|
|
741
|
+
|
|
742
|
+
<li>
|
|
743
|
+
|
|
744
|
+
<span class='name'>org_id</span>
|
|
745
|
+
|
|
746
|
+
|
|
747
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
748
|
+
|
|
749
|
+
|
|
750
|
+
|
|
751
|
+
—
|
|
752
|
+
<div class='inline'>
|
|
753
|
+
<p>dashboard organization ID</p>
|
|
754
|
+
</div>
|
|
755
|
+
|
|
756
|
+
</li>
|
|
757
|
+
|
|
758
|
+
</ul>
|
|
759
|
+
|
|
760
|
+
<p class="tag_title">Returns:</p>
|
|
761
|
+
<ul class="return">
|
|
762
|
+
|
|
763
|
+
<li>
|
|
764
|
+
|
|
765
|
+
|
|
766
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
|
767
|
+
|
|
768
|
+
|
|
769
|
+
|
|
770
|
+
—
|
|
771
|
+
<div class='inline'>
|
|
772
|
+
<p>an array of hashes containg information on each individual device</p>
|
|
773
|
+
</div>
|
|
774
|
+
|
|
775
|
+
</li>
|
|
776
|
+
|
|
777
|
+
</ul>
|
|
778
|
+
|
|
779
|
+
</div><table class="source_code">
|
|
780
|
+
<tr>
|
|
781
|
+
<td>
|
|
782
|
+
<pre class="lines">
|
|
783
|
+
|
|
784
|
+
|
|
785
|
+
21
|
|
786
|
+
22
|
|
787
|
+
23</pre>
|
|
788
|
+
</td>
|
|
789
|
+
<td>
|
|
790
|
+
<pre class="code"><span class="info file"># File 'lib/organizations.rb', line 21</span>
|
|
791
|
+
|
|
792
|
+
<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>
|
|
793
|
+
<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>
|
|
794
|
+
<span class='kw'>end</span></pre>
|
|
795
|
+
</td>
|
|
796
|
+
</tr>
|
|
797
|
+
</table>
|
|
798
|
+
</div>
|
|
799
|
+
|
|
800
|
+
<div class="method_details ">
|
|
801
|
+
<h3 class="signature " id="get_license_state-instance_method">
|
|
802
|
+
|
|
803
|
+
#<strong>get_license_state</strong>(org_id) ⇒ <tt>Hash</tt>
|
|
804
|
+
|
|
805
|
+
|
|
806
|
+
|
|
807
|
+
|
|
808
|
+
|
|
809
|
+
</h3><div class="docstring">
|
|
810
|
+
<div class="discussion">
|
|
811
|
+
|
|
812
|
+
<p>Returns the current license state for a given organization</p>
|
|
813
|
+
|
|
814
|
+
|
|
815
|
+
</div>
|
|
816
|
+
</div>
|
|
817
|
+
<div class="tags">
|
|
818
|
+
<p class="tag_title">Parameters:</p>
|
|
819
|
+
<ul class="param">
|
|
820
|
+
|
|
821
|
+
<li>
|
|
822
|
+
|
|
823
|
+
<span class='name'>org_id</span>
|
|
824
|
+
|
|
825
|
+
|
|
826
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
827
|
+
|
|
828
|
+
|
|
829
|
+
|
|
830
|
+
—
|
|
831
|
+
<div class='inline'>
|
|
832
|
+
<p>dashboard organization ID</p>
|
|
833
|
+
</div>
|
|
834
|
+
|
|
835
|
+
</li>
|
|
836
|
+
|
|
837
|
+
</ul>
|
|
838
|
+
|
|
839
|
+
<p class="tag_title">Returns:</p>
|
|
840
|
+
<ul class="return">
|
|
841
|
+
|
|
842
|
+
<li>
|
|
843
|
+
|
|
844
|
+
|
|
845
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
846
|
+
|
|
847
|
+
|
|
848
|
+
|
|
849
|
+
—
|
|
850
|
+
<div class='inline'>
|
|
851
|
+
<p>results contains the current license state information</p>
|
|
852
|
+
</div>
|
|
853
|
+
|
|
854
|
+
</li>
|
|
855
|
+
|
|
856
|
+
</ul>
|
|
857
|
+
|
|
858
|
+
</div><table class="source_code">
|
|
859
|
+
<tr>
|
|
860
|
+
<td>
|
|
861
|
+
<pre class="lines">
|
|
862
|
+
|
|
863
|
+
|
|
864
|
+
14
|
|
865
|
+
15
|
|
866
|
+
16</pre>
|
|
867
|
+
</td>
|
|
868
|
+
<td>
|
|
869
|
+
<pre class="code"><span class="info file"># File 'lib/organizations.rb', line 14</span>
|
|
870
|
+
|
|
871
|
+
<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>
|
|
872
|
+
<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>
|
|
873
|
+
<span class='kw'>end</span></pre>
|
|
874
|
+
</td>
|
|
875
|
+
</tr>
|
|
876
|
+
</table>
|
|
877
|
+
</div>
|
|
878
|
+
|
|
879
|
+
<div class="method_details ">
|
|
880
|
+
<h3 class="signature " id="get_organization-instance_method">
|
|
881
|
+
|
|
882
|
+
#<strong>get_organization</strong>(org_id) ⇒ <tt>Hash</tt>
|
|
883
|
+
|
|
884
|
+
|
|
885
|
+
|
|
886
|
+
|
|
887
|
+
|
|
888
|
+
</h3><div class="docstring">
|
|
889
|
+
<div class="discussion">
|
|
890
|
+
|
|
891
|
+
<p>Returns information about an organization</p>
|
|
892
|
+
|
|
893
|
+
|
|
894
|
+
</div>
|
|
895
|
+
</div>
|
|
896
|
+
<div class="tags">
|
|
897
|
+
<p class="tag_title">Parameters:</p>
|
|
898
|
+
<ul class="param">
|
|
899
|
+
|
|
900
|
+
<li>
|
|
901
|
+
|
|
902
|
+
<span class='name'>org_id</span>
|
|
903
|
+
|
|
904
|
+
|
|
905
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
906
|
+
|
|
907
|
+
|
|
908
|
+
|
|
909
|
+
—
|
|
910
|
+
<div class='inline'>
|
|
911
|
+
<p>dashboard organization ID</p>
|
|
912
|
+
</div>
|
|
913
|
+
|
|
914
|
+
</li>
|
|
915
|
+
|
|
916
|
+
</ul>
|
|
917
|
+
|
|
918
|
+
<p class="tag_title">Returns:</p>
|
|
919
|
+
<ul class="return">
|
|
920
|
+
|
|
921
|
+
<li>
|
|
922
|
+
|
|
923
|
+
|
|
924
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
925
|
+
|
|
926
|
+
|
|
927
|
+
|
|
928
|
+
—
|
|
929
|
+
<div class='inline'>
|
|
930
|
+
<p>results contains the org id and name of the given organization</p>
|
|
931
|
+
</div>
|
|
932
|
+
|
|
933
|
+
</li>
|
|
934
|
+
|
|
935
|
+
</ul>
|
|
936
|
+
|
|
937
|
+
</div><table class="source_code">
|
|
938
|
+
<tr>
|
|
939
|
+
<td>
|
|
940
|
+
<pre class="lines">
|
|
941
|
+
|
|
942
|
+
|
|
943
|
+
7
|
|
944
|
+
8
|
|
945
|
+
9</pre>
|
|
946
|
+
</td>
|
|
947
|
+
<td>
|
|
948
|
+
<pre class="code"><span class="info file"># File 'lib/organizations.rb', line 7</span>
|
|
949
|
+
|
|
950
|
+
<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>
|
|
951
|
+
<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>
|
|
952
|
+
<span class='kw'>end</span></pre>
|
|
953
|
+
</td>
|
|
954
|
+
</tr>
|
|
955
|
+
</table>
|
|
956
|
+
</div>
|
|
957
|
+
|
|
958
|
+
<div class="method_details ">
|
|
959
|
+
<h3 class="signature " id="get_snmp_settings-instance_method">
|
|
960
|
+
|
|
961
|
+
#<strong>get_snmp_settings</strong>(org_id) ⇒ <tt>Hash</tt>
|
|
962
|
+
|
|
963
|
+
|
|
964
|
+
|
|
965
|
+
|
|
966
|
+
|
|
967
|
+
</h3><div class="docstring">
|
|
968
|
+
<div class="discussion">
|
|
969
|
+
|
|
970
|
+
<p>Returns the current SNMP status for an organization</p>
|
|
971
|
+
|
|
972
|
+
|
|
973
|
+
</div>
|
|
974
|
+
</div>
|
|
975
|
+
<div class="tags">
|
|
976
|
+
<p class="tag_title">Parameters:</p>
|
|
977
|
+
<ul class="param">
|
|
978
|
+
|
|
979
|
+
<li>
|
|
980
|
+
|
|
981
|
+
<span class='name'>org_id</span>
|
|
982
|
+
|
|
983
|
+
|
|
984
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
985
|
+
|
|
986
|
+
|
|
987
|
+
|
|
988
|
+
—
|
|
989
|
+
<div class='inline'>
|
|
990
|
+
<p>dashboard organization ID</p>
|
|
991
|
+
</div>
|
|
992
|
+
|
|
993
|
+
</li>
|
|
994
|
+
|
|
995
|
+
</ul>
|
|
996
|
+
|
|
997
|
+
<p class="tag_title">Returns:</p>
|
|
998
|
+
<ul class="return">
|
|
999
|
+
|
|
1000
|
+
<li>
|
|
1001
|
+
|
|
1002
|
+
|
|
1003
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
1004
|
+
|
|
1005
|
+
|
|
1006
|
+
|
|
1007
|
+
—
|
|
1008
|
+
<div class='inline'>
|
|
1009
|
+
<p>a hash containing all SNMP configuration information for an organization</p>
|
|
1010
|
+
</div>
|
|
1011
|
+
|
|
1012
|
+
</li>
|
|
1013
|
+
|
|
1014
|
+
</ul>
|
|
1015
|
+
|
|
1016
|
+
</div><table class="source_code">
|
|
1017
|
+
<tr>
|
|
1018
|
+
<td>
|
|
1019
|
+
<pre class="lines">
|
|
1020
|
+
|
|
1021
|
+
|
|
1022
|
+
28
|
|
1023
|
+
29
|
|
1024
|
+
30</pre>
|
|
1025
|
+
</td>
|
|
1026
|
+
<td>
|
|
1027
|
+
<pre class="code"><span class="info file"># File 'lib/organizations.rb', line 28</span>
|
|
1028
|
+
|
|
1029
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_get_snmp_settings'>get_snmp_settings</span><span class='lparen'>(</span><span class='id identifier rubyid_org_id'>org_id</span><span class='rparen'>)</span>
|
|
1030
|
+
<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>
|
|
1031
|
+
<span class='kw'>end</span></pre>
|
|
1032
|
+
</td>
|
|
1033
|
+
</tr>
|
|
1034
|
+
</table>
|
|
1035
|
+
</div>
|
|
1036
|
+
|
|
1037
|
+
<div class="method_details ">
|
|
1038
|
+
<h3 class="signature " id="get_third_party_peers-instance_method">
|
|
1039
|
+
|
|
1040
|
+
#<strong>get_third_party_peers</strong>(org_id) ⇒ <tt>Array</tt>
|
|
1041
|
+
|
|
1042
|
+
|
|
1043
|
+
|
|
1044
|
+
|
|
1045
|
+
|
|
1046
|
+
</h3><div class="docstring">
|
|
1047
|
+
<div class="discussion">
|
|
1048
|
+
|
|
1049
|
+
<p>Returns the configurations for an organizations 3rd party VPN peers</p>
|
|
1050
|
+
|
|
1051
|
+
|
|
1052
|
+
</div>
|
|
1053
|
+
</div>
|
|
1054
|
+
<div class="tags">
|
|
1055
|
+
<p class="tag_title">Parameters:</p>
|
|
1056
|
+
<ul class="param">
|
|
1057
|
+
|
|
1058
|
+
<li>
|
|
1059
|
+
|
|
1060
|
+
<span class='name'>org_id</span>
|
|
1061
|
+
|
|
1062
|
+
|
|
1063
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
1064
|
+
|
|
1065
|
+
|
|
1066
|
+
|
|
1067
|
+
—
|
|
1068
|
+
<div class='inline'>
|
|
1069
|
+
<p>dashboard organization ID</p>
|
|
1070
|
+
</div>
|
|
1071
|
+
|
|
1072
|
+
</li>
|
|
1073
|
+
|
|
1074
|
+
</ul>
|
|
1075
|
+
|
|
1076
|
+
<p class="tag_title">Returns:</p>
|
|
1077
|
+
<ul class="return">
|
|
1078
|
+
|
|
1079
|
+
<li>
|
|
1080
|
+
|
|
1081
|
+
|
|
1082
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
|
1083
|
+
|
|
1084
|
+
|
|
1085
|
+
|
|
1086
|
+
—
|
|
1087
|
+
<div class='inline'>
|
|
1088
|
+
<p>an arrry of hashes containing the configuration information for each 3rd
|
|
1089
|
+
party VPN peer</p>
|
|
1090
|
+
</div>
|
|
1091
|
+
|
|
1092
|
+
</li>
|
|
1093
|
+
|
|
1094
|
+
</ul>
|
|
1095
|
+
|
|
1096
|
+
</div><table class="source_code">
|
|
1097
|
+
<tr>
|
|
1098
|
+
<td>
|
|
1099
|
+
<pre class="lines">
|
|
1100
|
+
|
|
1101
|
+
|
|
1102
|
+
49
|
|
1103
|
+
50
|
|
1104
|
+
51</pre>
|
|
1105
|
+
</td>
|
|
1106
|
+
<td>
|
|
1107
|
+
<pre class="code"><span class="info file"># File 'lib/organizations.rb', line 49</span>
|
|
1108
|
+
|
|
1109
|
+
<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>
|
|
1110
|
+
<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>
|
|
1111
|
+
<span class='kw'>end</span></pre>
|
|
1112
|
+
</td>
|
|
1113
|
+
</tr>
|
|
1114
|
+
</table>
|
|
1115
|
+
</div>
|
|
1116
|
+
|
|
1117
|
+
<div class="method_details ">
|
|
1118
|
+
<h3 class="signature " id="list_all_organizations-instance_method">
|
|
1119
|
+
|
|
1120
|
+
#<strong>list_all_organizations</strong> ⇒ <tt>Array</tt>
|
|
1121
|
+
|
|
1122
|
+
|
|
1123
|
+
|
|
1124
|
+
|
|
1125
|
+
|
|
1126
|
+
</h3><div class="docstring">
|
|
1127
|
+
<div class="discussion">
|
|
1128
|
+
|
|
1129
|
+
<p>Returns all organizations a user is an administrator on</p>
|
|
1130
|
+
|
|
1131
|
+
|
|
1132
|
+
</div>
|
|
1133
|
+
</div>
|
|
1134
|
+
<div class="tags">
|
|
1135
|
+
|
|
1136
|
+
<p class="tag_title">Returns:</p>
|
|
1137
|
+
<ul class="return">
|
|
1138
|
+
|
|
1139
|
+
<li>
|
|
1140
|
+
|
|
1141
|
+
|
|
1142
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
|
1143
|
+
|
|
1144
|
+
|
|
1145
|
+
|
|
1146
|
+
—
|
|
1147
|
+
<div class='inline'>
|
|
1148
|
+
<p>an array of hashes containing the organizations and their attributes</p>
|
|
1149
|
+
</div>
|
|
1150
|
+
|
|
1151
|
+
</li>
|
|
1152
|
+
|
|
1153
|
+
</ul>
|
|
1154
|
+
|
|
1155
|
+
</div><table class="source_code">
|
|
1156
|
+
<tr>
|
|
1157
|
+
<td>
|
|
1158
|
+
<pre class="lines">
|
|
1159
|
+
|
|
1160
|
+
|
|
1161
|
+
67
|
|
1162
|
+
68
|
|
1163
|
+
69</pre>
|
|
1164
|
+
</td>
|
|
1165
|
+
<td>
|
|
1166
|
+
<pre class="code"><span class="info file"># File 'lib/organizations.rb', line 67</span>
|
|
1167
|
+
|
|
1168
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_list_all_organizations'>list_all_organizations</span>
|
|
1169
|
+
<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='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>
|
|
1170
|
+
<span class='kw'>end</span></pre>
|
|
1171
|
+
</td>
|
|
1172
|
+
</tr>
|
|
1173
|
+
</table>
|
|
1174
|
+
</div>
|
|
1175
|
+
|
|
1176
|
+
<div class="method_details ">
|
|
1177
|
+
<h3 class="signature " id="update_organization-instance_method">
|
|
1178
|
+
|
|
1179
|
+
#<strong>update_organization</strong>(org_id, options) ⇒ <tt>Hash</tt>
|
|
1180
|
+
|
|
1181
|
+
|
|
1182
|
+
|
|
1183
|
+
|
|
1184
|
+
|
|
1185
|
+
</h3><div class="docstring">
|
|
1186
|
+
<div class="discussion">
|
|
1187
|
+
|
|
1188
|
+
<p>Update an organization</p>
|
|
1189
|
+
|
|
1190
|
+
|
|
1191
|
+
</div>
|
|
1192
|
+
</div>
|
|
1193
|
+
<div class="tags">
|
|
1194
|
+
<p class="tag_title">Parameters:</p>
|
|
1195
|
+
<ul class="param">
|
|
1196
|
+
|
|
1197
|
+
<li>
|
|
1198
|
+
|
|
1199
|
+
<span class='name'>org_id</span>
|
|
1200
|
+
|
|
1201
|
+
|
|
1202
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
1203
|
+
|
|
1204
|
+
|
|
1205
|
+
|
|
1206
|
+
—
|
|
1207
|
+
<div class='inline'>
|
|
1208
|
+
<p>the organization ID that you want to update</p>
|
|
1209
|
+
</div>
|
|
1210
|
+
|
|
1211
|
+
</li>
|
|
1212
|
+
|
|
1213
|
+
<li>
|
|
1214
|
+
|
|
1215
|
+
<span class='name'>options</span>
|
|
1216
|
+
|
|
1217
|
+
|
|
1218
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
1219
|
+
|
|
1220
|
+
|
|
1221
|
+
|
|
1222
|
+
—
|
|
1223
|
+
<div class='inline'>
|
|
1224
|
+
<p>an options hash containing the org ID and new name of the org</p>
|
|
1225
|
+
</div>
|
|
1226
|
+
|
|
1227
|
+
</li>
|
|
1228
|
+
|
|
1229
|
+
</ul>
|
|
1230
|
+
|
|
1231
|
+
<p class="tag_title">Returns:</p>
|
|
1232
|
+
<ul class="return">
|
|
1233
|
+
|
|
1234
|
+
<li>
|
|
1235
|
+
|
|
1236
|
+
|
|
1237
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
1238
|
+
|
|
1239
|
+
|
|
1240
|
+
|
|
1241
|
+
—
|
|
1242
|
+
<div class='inline'>
|
|
1243
|
+
<p>the updated attributes of the organization</p>
|
|
1244
|
+
</div>
|
|
1245
|
+
|
|
1246
|
+
</li>
|
|
1247
|
+
|
|
1248
|
+
</ul>
|
|
1249
|
+
|
|
1250
|
+
</div><table class="source_code">
|
|
1251
|
+
<tr>
|
|
1252
|
+
<td>
|
|
1253
|
+
<pre class="lines">
|
|
1254
|
+
|
|
1255
|
+
|
|
1256
|
+
75
|
|
1257
|
+
76
|
|
1258
|
+
77
|
|
1259
|
+
78
|
|
1260
|
+
79
|
|
1261
|
+
80</pre>
|
|
1262
|
+
</td>
|
|
1263
|
+
<td>
|
|
1264
|
+
<pre class="code"><span class="info file"># File 'lib/organizations.rb', line 75</span>
|
|
1265
|
+
|
|
1266
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_update_organization'>update_organization</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>
|
|
1267
|
+
<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>
|
|
1268
|
+
|
|
1269
|
+
<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>
|
|
1270
|
+
<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'>PUT</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
|
1271
|
+
<span class='kw'>end</span></pre>
|
|
1272
|
+
</td>
|
|
1273
|
+
</tr>
|
|
1274
|
+
</table>
|
|
1275
|
+
</div>
|
|
1276
|
+
|
|
1277
|
+
<div class="method_details ">
|
|
1278
|
+
<h3 class="signature " id="update_snmp_settings-instance_method">
|
|
1279
|
+
|
|
1280
|
+
#<strong>update_snmp_settings</strong>(org_id, options) ⇒ <tt>Hash</tt>
|
|
1281
|
+
|
|
1282
|
+
|
|
1283
|
+
|
|
1284
|
+
|
|
1285
|
+
|
|
1286
|
+
</h3><div class="docstring">
|
|
1287
|
+
<div class="discussion">
|
|
1288
|
+
|
|
1289
|
+
<p>Updates the current SNMP status for an organization</p>
|
|
1290
|
+
|
|
1291
|
+
|
|
1292
|
+
</div>
|
|
1293
|
+
</div>
|
|
1294
|
+
<div class="tags">
|
|
1295
|
+
<p class="tag_title">Parameters:</p>
|
|
1296
|
+
<ul class="param">
|
|
1297
|
+
|
|
1298
|
+
<li>
|
|
1299
|
+
|
|
1300
|
+
<span class='name'>org_id</span>
|
|
1301
|
+
|
|
1302
|
+
|
|
1303
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
1304
|
+
|
|
1305
|
+
|
|
1306
|
+
|
|
1307
|
+
—
|
|
1308
|
+
<div class='inline'>
|
|
1309
|
+
<p>dashboard organization ID</p>
|
|
1310
|
+
</div>
|
|
1311
|
+
|
|
1312
|
+
</li>
|
|
1313
|
+
|
|
1314
|
+
<li>
|
|
1315
|
+
|
|
1316
|
+
<span class='name'>options</span>
|
|
1317
|
+
|
|
1318
|
+
|
|
1319
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
1320
|
+
|
|
1321
|
+
|
|
1322
|
+
|
|
1323
|
+
—
|
|
1324
|
+
<div class='inline'>
|
|
1325
|
+
<p>a hash containing all updated SNMP configuration information for an
|
|
1326
|
+
organization. Please refer to official Dashboard API documentation for more
|
|
1327
|
+
information on these options: v2cEnabled, v3Enabled, v3AuthMode,
|
|
1328
|
+
v3AuthPass, v3PrivMode, v3PrivPass, peerIps</p>
|
|
1329
|
+
</div>
|
|
1330
|
+
|
|
1331
|
+
</li>
|
|
1332
|
+
|
|
1333
|
+
</ul>
|
|
1334
|
+
|
|
1335
|
+
<p class="tag_title">Returns:</p>
|
|
1336
|
+
<ul class="return">
|
|
1337
|
+
|
|
1338
|
+
<li>
|
|
1339
|
+
|
|
1340
|
+
|
|
1341
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
1342
|
+
|
|
1343
|
+
|
|
1344
|
+
|
|
1345
|
+
—
|
|
1346
|
+
<div class='inline'>
|
|
1347
|
+
<p>a hash containing all SNMP configuration information for an organization</p>
|
|
1348
|
+
</div>
|
|
1349
|
+
|
|
1350
|
+
</li>
|
|
1351
|
+
|
|
1352
|
+
</ul>
|
|
1353
|
+
|
|
1354
|
+
</div><table class="source_code">
|
|
1355
|
+
<tr>
|
|
1356
|
+
<td>
|
|
1357
|
+
<pre class="lines">
|
|
1358
|
+
|
|
1359
|
+
|
|
1360
|
+
38
|
|
1361
|
+
39
|
|
1362
|
+
40
|
|
1363
|
+
41
|
|
1364
|
+
42
|
|
1365
|
+
43</pre>
|
|
1366
|
+
</td>
|
|
1367
|
+
<td>
|
|
1368
|
+
<pre class="code"><span class="info file"># File 'lib/organizations.rb', line 38</span>
|
|
1369
|
+
|
|
1370
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_update_snmp_settings'>update_snmp_settings</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>
|
|
1371
|
+
<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>
|
|
1372
|
+
|
|
1373
|
+
<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>
|
|
1374
|
+
<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'>PUT</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
|
1375
|
+
<span class='kw'>end</span></pre>
|
|
1376
|
+
</td>
|
|
1377
|
+
</tr>
|
|
1378
|
+
</table>
|
|
1379
|
+
</div>
|
|
1380
|
+
|
|
1381
|
+
<div class="method_details ">
|
|
1382
|
+
<h3 class="signature " id="update_third_party_peers-instance_method">
|
|
1383
|
+
|
|
1384
|
+
#<strong>update_third_party_peers</strong>(org_id, options) ⇒ <tt>Array</tt>
|
|
1385
|
+
|
|
1386
|
+
|
|
1387
|
+
|
|
1388
|
+
|
|
1389
|
+
|
|
1390
|
+
</h3><div class="docstring">
|
|
1391
|
+
<div class="discussion">
|
|
1392
|
+
|
|
1393
|
+
<p>Updates your third party peers</p>
|
|
1394
|
+
|
|
1395
|
+
|
|
1396
|
+
</div>
|
|
1397
|
+
</div>
|
|
1398
|
+
<div class="tags">
|
|
1399
|
+
<p class="tag_title">Parameters:</p>
|
|
1400
|
+
<ul class="param">
|
|
1401
|
+
|
|
1402
|
+
<li>
|
|
1403
|
+
|
|
1404
|
+
<span class='name'>org_id</span>
|
|
1405
|
+
|
|
1406
|
+
|
|
1407
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
1408
|
+
|
|
1409
|
+
|
|
1410
|
+
|
|
1411
|
+
—
|
|
1412
|
+
<div class='inline'>
|
|
1413
|
+
<p>dashboard organization ID</p>
|
|
1414
|
+
</div>
|
|
1415
|
+
|
|
1416
|
+
</li>
|
|
1417
|
+
|
|
1418
|
+
</ul>
|
|
1419
|
+
|
|
1420
|
+
<p class="tag_title">Returns:</p>
|
|
1421
|
+
<ul class="return">
|
|
1422
|
+
|
|
1423
|
+
<li>
|
|
1424
|
+
|
|
1425
|
+
|
|
1426
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
|
1427
|
+
|
|
1428
|
+
|
|
1429
|
+
|
|
1430
|
+
—
|
|
1431
|
+
<div class='inline'>
|
|
1432
|
+
<p>returns the array of hashes for all currently configured 3rd party peers</p>
|
|
1433
|
+
</div>
|
|
1434
|
+
|
|
1435
|
+
</li>
|
|
1436
|
+
|
|
1437
|
+
</ul>
|
|
1438
|
+
|
|
1439
|
+
</div><table class="source_code">
|
|
1440
|
+
<tr>
|
|
1441
|
+
<td>
|
|
1442
|
+
<pre class="lines">
|
|
1443
|
+
|
|
1444
|
+
|
|
1445
|
+
58
|
|
1446
|
+
59
|
|
1447
|
+
60
|
|
1448
|
+
61
|
|
1449
|
+
62
|
|
1450
|
+
63</pre>
|
|
1451
|
+
</td>
|
|
1452
|
+
<td>
|
|
1453
|
+
<pre class="code"><span class="info file"># File 'lib/organizations.rb', line 58</span>
|
|
1454
|
+
|
|
1455
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_update_third_party_peers'>update_third_party_peers</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>
|
|
1456
|
+
<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>
|
|
1457
|
+
|
|
1458
|
+
<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>
|
|
1459
|
+
<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'>PUT</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
|
1460
|
+
<span class='kw'>end</span></pre>
|
|
1461
|
+
</td>
|
|
1462
|
+
</tr>
|
|
1463
|
+
</table>
|
|
1464
|
+
</div>
|
|
1465
|
+
|
|
1466
|
+
</div>
|
|
1467
|
+
|
|
1468
|
+
</div>
|
|
1469
|
+
|
|
1470
|
+
<div id="footer">
|
|
1471
|
+
Generated on Thu Nov 17 22:15:39 2016 by
|
|
1472
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
1473
|
+
0.9.5 (ruby-2.3.0).
|
|
1474
|
+
</div>
|
|
1475
|
+
|
|
1476
|
+
</div>
|
|
1477
|
+
</body>
|
|
1478
1478
|
</html>
|