wazuh-ruby-client 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (86) hide show
  1. checksums.yaml +7 -0
  2. data/.gitignore +20 -0
  3. data/.rspec +3 -0
  4. data/.travis.yml +7 -0
  5. data/CHANGELOG.md +0 -0
  6. data/Gemfile +5 -0
  7. data/LICENSE +21 -0
  8. data/README.md +74 -0
  9. data/Rakefile +6 -0
  10. data/docs/.nojekyll +0 -0
  11. data/docs/Wazuh/Api/Endpoints/ActiveResponse.html +278 -0
  12. data/docs/Wazuh/Api/Endpoints/Agents.html +1877 -0
  13. data/docs/Wazuh/Api/Endpoints/Cache.html +415 -0
  14. data/docs/Wazuh/Api/Endpoints/Ciscat.html +418 -0
  15. data/docs/Wazuh/Api/Endpoints/Cluster.html +2270 -0
  16. data/docs/Wazuh/Api/Endpoints/Decoders.html +860 -0
  17. data/docs/Wazuh/Api/Endpoints/Experimental.html +2610 -0
  18. data/docs/Wazuh/Api/Endpoints/Lists.html +452 -0
  19. data/docs/Wazuh/Api/Endpoints/Manager.html +1596 -0
  20. data/docs/Wazuh/Api/Endpoints/Rootcheck.html +1025 -0
  21. data/docs/Wazuh/Api/Endpoints/Rules.html +872 -0
  22. data/docs/Wazuh/Api/Endpoints/SecurityConfigurationAssessment.html +680 -0
  23. data/docs/Wazuh/Api/Endpoints/Summary.html +199 -0
  24. data/docs/Wazuh/Api/Endpoints/Syscheck.html +755 -0
  25. data/docs/Wazuh/Api/Endpoints/Syscollector.html +2069 -0
  26. data/docs/Wazuh/Api/Endpoints.html +292 -0
  27. data/docs/Wazuh/Api/Errors/TooManyRequestsError.html +398 -0
  28. data/docs/Wazuh/Api/Errors/WazuhError.html +290 -0
  29. data/docs/Wazuh/Api/Errors.html +117 -0
  30. data/docs/Wazuh/Api.html +133 -0
  31. data/docs/Wazuh/Client.html +521 -0
  32. data/docs/Wazuh/Config.html +223 -0
  33. data/docs/Wazuh/Faraday/Connection.html +110 -0
  34. data/docs/Wazuh/Faraday/Request.html +335 -0
  35. data/docs/Wazuh/Faraday/Response/RaiseError.html +191 -0
  36. data/docs/Wazuh/Faraday/Response.html +115 -0
  37. data/docs/Wazuh/Faraday.html +117 -0
  38. data/docs/Wazuh/Logger.html +201 -0
  39. data/docs/Wazuh.html +256 -0
  40. data/docs/WazuhRubyClient.html +121 -0
  41. data/docs/_index.html +391 -0
  42. data/docs/class_list.html +51 -0
  43. data/docs/css/common.css +1 -0
  44. data/docs/css/full_list.css +58 -0
  45. data/docs/css/style.css +496 -0
  46. data/docs/file.README.html +142 -0
  47. data/docs/file_list.html +56 -0
  48. data/docs/frames.html +17 -0
  49. data/docs/index.html +142 -0
  50. data/docs/js/app.js +292 -0
  51. data/docs/js/full_list.js +216 -0
  52. data/docs/js/jquery.js +4 -0
  53. data/docs/method_list.html +1059 -0
  54. data/docs/top-level-namespace.html +110 -0
  55. data/lib/tasks/api.rake +78 -0
  56. data/lib/wazuh/api/endpoints/active_response.rb +22 -0
  57. data/lib/wazuh/api/endpoints/agents.rb +175 -0
  58. data/lib/wazuh/api/endpoints/cache.rb +38 -0
  59. data/lib/wazuh/api/endpoints/ciscat.rb +43 -0
  60. data/lib/wazuh/api/endpoints/cluster.rb +199 -0
  61. data/lib/wazuh/api/endpoints/decoders.rb +91 -0
  62. data/lib/wazuh/api/endpoints/experimental.rb +309 -0
  63. data/lib/wazuh/api/endpoints/lists.rb +42 -0
  64. data/lib/wazuh/api/endpoints/manager.rb +156 -0
  65. data/lib/wazuh/api/endpoints/rootcheck.rb +93 -0
  66. data/lib/wazuh/api/endpoints/rules.rb +80 -0
  67. data/lib/wazuh/api/endpoints/security_configuration_assessment.rb +73 -0
  68. data/lib/wazuh/api/endpoints/summary.rb +15 -0
  69. data/lib/wazuh/api/endpoints/syscheck.rb +75 -0
  70. data/lib/wazuh/api/endpoints/syscollector.rb +227 -0
  71. data/lib/wazuh/api/endpoints.rb +37 -0
  72. data/lib/wazuh/api/error.rb +6 -0
  73. data/lib/wazuh/api/errors/too_many_requests_error.rb +22 -0
  74. data/lib/wazuh/api/errors/wazuh_error.rb +14 -0
  75. data/lib/wazuh/client.rb +27 -0
  76. data/lib/wazuh/config.rb +42 -0
  77. data/lib/wazuh/faraday/connection.rb +38 -0
  78. data/lib/wazuh/faraday/request.rb +38 -0
  79. data/lib/wazuh/faraday/response/raise_error.rb +11 -0
  80. data/lib/wazuh/logger.rb +13 -0
  81. data/lib/wazuh/version.rb +4 -0
  82. data/lib/wazuh-ruby-client/version.rb +3 -0
  83. data/lib/wazuh-ruby-client.rb +17 -0
  84. data/lib/wazuh_ruby_client.rb +2 -0
  85. data/wazuh-ruby-client.gemspec +43 -0
  86. metadata +200 -0
data/docs/Wazuh/Api/Endpoints/Agents.html ADDED
@@ -0,0 +1,1877 @@
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: Wazuh::Api::Endpoints::Agents
8
+
9
+ &mdash; Documentation by YARD 0.9.16
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 = "Wazuh::Api::Endpoints::Agents";
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?1"></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 (A)</a> &raquo;
40
+ <span class='title'><span class='object_link'><a href="../../../Wazuh.html" title="Wazuh (module)">Wazuh</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Api.html" title="Wazuh::Api (module)">Api</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Endpoints.html" title="Wazuh::Api::Endpoints (module)">Endpoints</a></span></span>
41
+ &raquo;
42
+ <span class="title">Agents</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
+ <div id="content"><h1>Module: Wazuh::Api::Endpoints::Agents
63
+
64
+
65
+
66
+ </h1>
67
+ <div class="box_info">
68
+
69
+
70
+
71
+
72
+
73
+
74
+
75
+
76
+
77
+ <dl>
78
+ <dt>Included in:</dt>
79
+ <dd><span class='object_link'><a href="../Endpoints.html" title="Wazuh::Api::Endpoints (module)">Wazuh::Api::Endpoints</a></span></dd>
80
+ </dl>
81
+
82
+
83
+
84
+ <dl>
85
+ <dt>Defined in:</dt>
86
+ <dd>lib/wazuh/api/endpoints/agents.rb</dd>
87
+ </dl>
88
+
89
+ </div>
90
+
91
+
92
+
93
+
94
+
95
+
96
+
97
+
98
+
99
+ <h2>
100
+ Instance Method Summary
101
+ <small><a href="#" class="summary_toggle">collapse</a></small>
102
+ </h2>
103
+
104
+ <ul class="summary">
105
+
106
+ <li class="public ">
107
+ <span class="summary_signature">
108
+
109
+ <a href="#add_agent-instance_method" title="#add_agent (instance method)">#<strong>add_agent</strong>(options = {}) &#x21d2; Object </a>
110
+
111
+
112
+
113
+ </span>
114
+
115
+
116
+
117
+
118
+
119
+
120
+
121
+
122
+
123
+ <span class="summary_desc"><div class='inline'>
124
+ <p>Add a new agent.</p>
125
+ </div></span>
126
+
127
+ </li>
128
+
129
+
130
+ <li class="public ">
131
+ <span class="summary_signature">
132
+
133
+ <a href="#add_agent_quick-instance_method" title="#add_agent_quick (instance method)">#<strong>add_agent_quick</strong>(options = {}) &#x21d2; Object </a>
134
+
135
+
136
+
137
+ </span>
138
+
139
+
140
+
141
+
142
+
143
+
144
+
145
+
146
+
147
+ <span class="summary_desc"><div class='inline'>
148
+ <p>Adds a new agent with name :agent_name.</p>
149
+ </div></span>
150
+
151
+ </li>
152
+
153
+
154
+ <li class="public ">
155
+ <span class="summary_signature">
156
+
157
+ <a href="#agent-instance_method" title="#agent (instance method)">#<strong>agent</strong>(agent_id, options = {}) &#x21d2; Object </a>
158
+
159
+
160
+
161
+ </span>
162
+
163
+
164
+
165
+
166
+
167
+
168
+
169
+
170
+
171
+ <span class="summary_desc"><div class='inline'>
172
+ <p>Returns various information from an agent.</p>
173
+ </div></span>
174
+
175
+ </li>
176
+
177
+
178
+ <li class="public ">
179
+ <span class="summary_signature">
180
+
181
+ <a href="#agent_by_name-instance_method" title="#agent_by_name (instance method)">#<strong>agent_by_name</strong>(agent_name, options = {}) &#x21d2; Object </a>
182
+
183
+
184
+
185
+ </span>
186
+
187
+
188
+
189
+
190
+
191
+
192
+
193
+
194
+
195
+ <span class="summary_desc"><div class='inline'>
196
+ <p>Returns various information from an agent called :agent_name.</p>
197
+ </div></span>
198
+
199
+ </li>
200
+
201
+
202
+ <li class="public ">
203
+ <span class="summary_signature">
204
+
205
+ <a href="#agent_key-instance_method" title="#agent_key (instance method)">#<strong>agent_key</strong>(agent_id, options = {}) &#x21d2; Object </a>
206
+
207
+
208
+
209
+ </span>
210
+
211
+
212
+
213
+
214
+
215
+
216
+
217
+
218
+
219
+ <span class="summary_desc"><div class='inline'>
220
+ <p>Returns the key of an agent.</p>
221
+ </div></span>
222
+
223
+ </li>
224
+
225
+
226
+ <li class="public ">
227
+ <span class="summary_signature">
228
+
229
+ <a href="#all_agents-instance_method" title="#all_agents (instance method)">#<strong>all_agents</strong>(options = {}) &#x21d2; Object </a>
230
+
231
+
232
+
233
+ </span>
234
+
235
+
236
+
237
+
238
+
239
+
240
+
241
+
242
+
243
+ <span class="summary_desc"><div class='inline'>
244
+ <p>Returns a list with the available agents.</p>
245
+ </div></span>
246
+
247
+ </li>
248
+
249
+
250
+ <li class="public ">
251
+ <span class="summary_signature">
252
+
253
+ <a href="#distinct_fields_in_agents-instance_method" title="#distinct_fields_in_agents (instance method)">#<strong>distinct_fields_in_agents</strong>(options = {}) &#x21d2; Object </a>
254
+
255
+
256
+
257
+ </span>
258
+
259
+
260
+
261
+
262
+
263
+
264
+
265
+
266
+
267
+ <span class="summary_desc"><div class='inline'>
268
+ <p>Returns all the different combinations that agents have for the selected
269
+ fields.</p>
270
+ </div></span>
271
+
272
+ </li>
273
+
274
+
275
+ <li class="public ">
276
+ <span class="summary_signature">
277
+
278
+ <a href="#insert_agent-instance_method" title="#insert_agent (instance method)">#<strong>insert_agent</strong>(options = {}) &#x21d2; Object </a>
279
+
280
+
281
+
282
+ </span>
283
+
284
+
285
+
286
+
287
+
288
+
289
+
290
+
291
+
292
+ <span class="summary_desc"><div class='inline'>
293
+ <p>Insert an agent with an existing id and key.</p>
294
+ </div></span>
295
+
296
+ </li>
297
+
298
+
299
+ <li class="public ">
300
+ <span class="summary_signature">
301
+
302
+ <a href="#outdated_agents-instance_method" title="#outdated_agents (instance method)">#<strong>outdated_agents</strong>(options = {}) &#x21d2; Object </a>
303
+
304
+
305
+
306
+ </span>
307
+
308
+
309
+
310
+
311
+
312
+
313
+
314
+
315
+
316
+ <span class="summary_desc"><div class='inline'>
317
+ <p>Returns the list of outdated agents.</p>
318
+ </div></span>
319
+
320
+ </li>
321
+
322
+
323
+ <li class="public ">
324
+ <span class="summary_signature">
325
+
326
+ <a href="#restart_agents-instance_method" title="#restart_agents (instance method)">#<strong>restart_agents</strong>(options = {}) &#x21d2; Object </a>
327
+
328
+
329
+
330
+ </span>
331
+
332
+
333
+
334
+
335
+
336
+
337
+
338
+
339
+
340
+ <span class="summary_desc"><div class='inline'>
341
+ <p>Restarts a list of agents.</p>
342
+ </div></span>
343
+
344
+ </li>
345
+
346
+
347
+ <li class="public ">
348
+ <span class="summary_signature">
349
+
350
+ <a href="#restart_all_agents-instance_method" title="#restart_all_agents (instance method)">#<strong>restart_all_agents</strong> &#x21d2; Object </a>
351
+
352
+
353
+
354
+ </span>
355
+
356
+
357
+
358
+
359
+
360
+
361
+
362
+
363
+
364
+ <span class="summary_desc"><div class='inline'>
365
+ <p>Restarts all agents.</p>
366
+ </div></span>
367
+
368
+ </li>
369
+
370
+
371
+ <li class="public ">
372
+ <span class="summary_signature">
373
+
374
+ <a href="#restart_an_agents-instance_method" title="#restart_an_agents (instance method)">#<strong>restart_an_agents</strong>(agent_id, options = {}) &#x21d2; Object </a>
375
+
376
+
377
+
378
+ </span>
379
+
380
+
381
+
382
+
383
+
384
+
385
+
386
+
387
+
388
+ <span class="summary_desc"><div class='inline'>
389
+ <p>Restart an agent.</p>
390
+ </div></span>
391
+
392
+ </li>
393
+
394
+
395
+ <li class="public ">
396
+ <span class="summary_signature">
397
+
398
+ <a href="#upgrade_result_from_agent-instance_method" title="#upgrade_result_from_agent (instance method)">#<strong>upgrade_result_from_agent</strong>(agent_id, options = {}) &#x21d2; Object </a>
399
+
400
+
401
+
402
+ </span>
403
+
404
+
405
+
406
+
407
+
408
+
409
+
410
+
411
+
412
+ <span class="summary_desc"><div class='inline'>
413
+ <p>Returns the upgrade result from an agent.</p>
414
+ </div></span>
415
+
416
+ </li>
417
+
418
+
419
+ </ul>
420
+
421
+
422
+
423
+
424
+ <div id="instance_method_details" class="method_details_list">
425
+ <h2>Instance Method Details</h2>
426
+
427
+
428
+ <div class="method_details first">
429
+ <h3 class="signature first" id="add_agent-instance_method">
430
+
431
+ #<strong>add_agent</strong>(options = {}) &#x21d2; <tt>Object</tt>
432
+
433
+
434
+
435
+
436
+
437
+ </h3><div class="docstring">
438
+ <div class="discussion">
439
+
440
+ <p>Add a new agent</p>
441
+
442
+
443
+ </div>
444
+ </div>
445
+ <div class="tags">
446
+ <p class="tag_title">Parameters:</p>
447
+ <ul class="param">
448
+
449
+ <li>
450
+
451
+ <span class='name'>options</span>
452
+
453
+
454
+ <span class='type'>(<tt>Hash</tt>)</span>
455
+
456
+
457
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
458
+
459
+
460
+ &mdash;
461
+ <div class='inline'>
462
+ <p>a customizable set of options</p>
463
+ </div>
464
+
465
+ </li>
466
+
467
+ </ul>
468
+
469
+
470
+
471
+
472
+ <p class="tag_title">Options Hash (<tt>options</tt>):</p>
473
+ <ul class="option">
474
+
475
+ <li>
476
+ <span class="name">:name</span>
477
+ <span class="type">(<tt>name</tt>)</span>
478
+ <span class="default">
479
+
480
+ </span>
481
+
482
+ &mdash; <div class='inline'>
483
+ <p>Name to agent</p>
484
+ </div>
485
+
486
+ </li>
487
+
488
+ <li>
489
+ <span class="name">:ip</span>
490
+ <span class="type">(<tt>ip</tt>)</span>
491
+ <span class="default">
492
+
493
+ </span>
494
+
495
+ &mdash; <div class='inline'>
496
+ <p>IP to agent If this is not included, the API will get the IP automatically.
497
+ If you are behind a proxy, you must set the option config.BehindProxyServer
498
+ to yes at config.js. Allowed values: IP, IP/NET, ANY</p>
499
+ </div>
500
+
501
+ </li>
502
+
503
+ <li>
504
+ <span class="name">:force</span>
505
+ <span class="type">(<tt>force</tt>)</span>
506
+ <span class="default">
507
+
508
+ </span>
509
+
510
+ &mdash; <div class='inline'>
511
+ <p>Remove the old agent with the same IP if disconnected since &lt;force&gt;
512
+ seconds.</p>
513
+ </div>
514
+
515
+ </li>
516
+
517
+ </ul>
518
+
519
+
520
+
521
+ <p class="tag_title">See Also:</p>
522
+ <ul class="see">
523
+
524
+ <li><a href="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#add-agent" target="_parent" title="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#add-agent">https://documentation.wazuh.com/3.10/user-manual/api/reference.html#add-agent</a></li>
525
+
526
+ </ul>
527
+
528
+ </div><table class="source_code">
529
+ <tr>
530
+ <td>
531
+ <pre class="lines">
532
+
533
+
534
+ 143
535
+ 144
536
+ 145</pre>
537
+ </td>
538
+ <td>
539
+ <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/agents.rb', line 143</span>
540
+
541
+ <span class='kw'>def</span> <span class='id identifier rubyid_add_agent'>add_agent</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
542
+ <span class='id identifier rubyid_post'>post</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/agents</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span>
543
+ <span class='kw'>end</span></pre>
544
+ </td>
545
+ </tr>
546
+ </table>
547
+ </div>
548
+
549
+ <div class="method_details ">
550
+ <h3 class="signature " id="add_agent_quick-instance_method">
551
+
552
+ #<strong>add_agent_quick</strong>(options = {}) &#x21d2; <tt>Object</tt>
553
+
554
+
555
+
556
+
557
+
558
+ </h3><div class="docstring">
559
+ <div class="discussion">
560
+
561
+ <p>Adds a new agent with name :agent_name. This agent will use ANY as IP.</p>
562
+
563
+
564
+ </div>
565
+ </div>
566
+ <div class="tags">
567
+ <p class="tag_title">Parameters:</p>
568
+ <ul class="param">
569
+
570
+ <li>
571
+
572
+ <span class='name'>options</span>
573
+
574
+
575
+ <span class='type'>(<tt>Hash</tt>)</span>
576
+
577
+
578
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
579
+
580
+
581
+ &mdash;
582
+ <div class='inline'>
583
+ <p>a customizable set of options</p>
584
+ </div>
585
+
586
+ </li>
587
+
588
+ </ul>
589
+
590
+
591
+
592
+
593
+ <p class="tag_title">Options Hash (<tt>options</tt>):</p>
594
+ <ul class="option">
595
+
596
+ <li>
597
+ <span class="name">:name</span>
598
+ <span class="type">(<tt>name</tt>)</span>
599
+ <span class="default">
600
+
601
+ </span>
602
+
603
+ &mdash; <div class='inline'>
604
+ <p>Name to agent</p>
605
+ </div>
606
+
607
+ </li>
608
+
609
+ </ul>
610
+
611
+
612
+
613
+ <p class="tag_title">See Also:</p>
614
+ <ul class="see">
615
+
616
+ <li><a href="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#add-agent-quick-method" target="_parent" title="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#add-agent-quick-method">https://documentation.wazuh.com/3.10/user-manual/api/reference.html#add-agent-quick-method</a></li>
617
+
618
+ </ul>
619
+
620
+ </div><table class="source_code">
621
+ <tr>
622
+ <td>
623
+ <pre class="lines">
624
+
625
+
626
+ 152
627
+ 153
628
+ 154</pre>
629
+ </td>
630
+ <td>
631
+ <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/agents.rb', line 152</span>
632
+
633
+ <span class='kw'>def</span> <span class='id identifier rubyid_add_agent_quick'>add_agent_quick</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
634
+ <span class='id identifier rubyid_put'>put</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/agents</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span>
635
+ <span class='kw'>end</span></pre>
636
+ </td>
637
+ </tr>
638
+ </table>
639
+ </div>
640
+
641
+ <div class="method_details ">
642
+ <h3 class="signature " id="agent-instance_method">
643
+
644
+ #<strong>agent</strong>(agent_id, options = {}) &#x21d2; <tt>Object</tt>
645
+
646
+
647
+
648
+
649
+
650
+ </h3><div class="docstring">
651
+ <div class="discussion">
652
+
653
+ <p>Returns various information from an agent.</p>
654
+
655
+
656
+ </div>
657
+ </div>
658
+ <div class="tags">
659
+ <p class="tag_title">Parameters:</p>
660
+ <ul class="param">
661
+
662
+ <li>
663
+
664
+ <span class='name'>agent_id</span>
665
+
666
+
667
+ <span class='type'>(<tt>String</tt>)</span>
668
+
669
+
670
+
671
+ &mdash;
672
+ <div class='inline'>
673
+ <p>ID to agent</p>
674
+ </div>
675
+
676
+ </li>
677
+
678
+ <li>
679
+
680
+ <span class='name'>options</span>
681
+
682
+
683
+ <span class='type'>(<tt>Hash</tt>)</span>
684
+
685
+
686
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
687
+
688
+
689
+ &mdash;
690
+ <div class='inline'>
691
+ <p>a customizable set of options</p>
692
+ </div>
693
+
694
+ </li>
695
+
696
+ </ul>
697
+
698
+
699
+
700
+
701
+
702
+
703
+ <p class="tag_title">Options Hash (<tt>options</tt>):</p>
704
+ <ul class="option">
705
+
706
+ <li>
707
+ <span class="name">:select</span>
708
+ <span class="type">(<tt>select</tt>)</span>
709
+ <span class="default">
710
+
711
+ </span>
712
+
713
+ &mdash; <div class='inline'>
714
+ <p>List of selected fields separated by commas.</p>
715
+ </div>
716
+
717
+ </li>
718
+
719
+ </ul>
720
+
721
+
722
+
723
+ <p class="tag_title">See Also:</p>
724
+ <ul class="see">
725
+
726
+ <li><a href="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-an-agent" target="_parent" title="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-an-agent">https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-an-agent</a></li>
727
+
728
+ </ul>
729
+
730
+ </div><table class="source_code">
731
+ <tr>
732
+ <td>
733
+ <pre class="lines">
734
+
735
+
736
+ 37
737
+ 38
738
+ 39</pre>
739
+ </td>
740
+ <td>
741
+ <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/agents.rb', line 37</span>
742
+
743
+ <span class='kw'>def</span> <span class='id identifier rubyid_agent'>agent</span><span class='lparen'>(</span><span class='id identifier rubyid_agent_id'>agent_id</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
744
+ <span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/agents/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_agent_id'>agent_id</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span>
745
+ <span class='kw'>end</span></pre>
746
+ </td>
747
+ </tr>
748
+ </table>
749
+ </div>
750
+
751
+ <div class="method_details ">
752
+ <h3 class="signature " id="agent_by_name-instance_method">
753
+
754
+ #<strong>agent_by_name</strong>(agent_name, options = {}) &#x21d2; <tt>Object</tt>
755
+
756
+
757
+
758
+
759
+
760
+ </h3><div class="docstring">
761
+ <div class="discussion">
762
+
763
+ <p>Returns various information from an agent called :agent_name.</p>
764
+
765
+
766
+ </div>
767
+ </div>
768
+ <div class="tags">
769
+ <p class="tag_title">Parameters:</p>
770
+ <ul class="param">
771
+
772
+ <li>
773
+
774
+ <span class='name'>agent_name</span>
775
+
776
+
777
+ <span class='type'>(<tt>String</tt>)</span>
778
+
779
+
780
+
781
+ &mdash;
782
+ <div class='inline'>
783
+ <p>Name to agent</p>
784
+ </div>
785
+
786
+ </li>
787
+
788
+ <li>
789
+
790
+ <span class='name'>options</span>
791
+
792
+
793
+ <span class='type'>(<tt>Hash</tt>)</span>
794
+
795
+
796
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
797
+
798
+
799
+ &mdash;
800
+ <div class='inline'>
801
+ <p>a customizable set of options</p>
802
+ </div>
803
+
804
+ </li>
805
+
806
+ </ul>
807
+
808
+
809
+
810
+
811
+
812
+
813
+ <p class="tag_title">Options Hash (<tt>options</tt>):</p>
814
+ <ul class="option">
815
+
816
+ <li>
817
+ <span class="name">:select</span>
818
+ <span class="type">(<tt>select</tt>)</span>
819
+ <span class="default">
820
+
821
+ </span>
822
+
823
+ &mdash; <div class='inline'>
824
+ <p>List of selected fields separated by commas.</p>
825
+ </div>
826
+
827
+ </li>
828
+
829
+ </ul>
830
+
831
+
832
+
833
+ <p class="tag_title">See Also:</p>
834
+ <ul class="see">
835
+
836
+ <li><a href="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-an-agent-by-its-name" target="_parent" title="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-an-agent-by-its-name">https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-an-agent-by-its-name</a></li>
837
+
838
+ </ul>
839
+
840
+ </div><table class="source_code">
841
+ <tr>
842
+ <td>
843
+ <pre class="lines">
844
+
845
+
846
+ 48
847
+ 49
848
+ 50</pre>
849
+ </td>
850
+ <td>
851
+ <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/agents.rb', line 48</span>
852
+
853
+ <span class='kw'>def</span> <span class='id identifier rubyid_agent_by_name'>agent_by_name</span><span class='lparen'>(</span><span class='id identifier rubyid_agent_name'>agent_name</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
854
+ <span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/agents/name/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_agent_name'>agent_name</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span>
855
+ <span class='kw'>end</span></pre>
856
+ </td>
857
+ </tr>
858
+ </table>
859
+ </div>
860
+
861
+ <div class="method_details ">
862
+ <h3 class="signature " id="agent_key-instance_method">
863
+
864
+ #<strong>agent_key</strong>(agent_id, options = {}) &#x21d2; <tt>Object</tt>
865
+
866
+
867
+
868
+
869
+
870
+ </h3><div class="docstring">
871
+ <div class="discussion">
872
+
873
+ <p>Returns the key of an agent.</p>
874
+
875
+
876
+ </div>
877
+ </div>
878
+ <div class="tags">
879
+ <p class="tag_title">Parameters:</p>
880
+ <ul class="param">
881
+
882
+ <li>
883
+
884
+ <span class='name'>agent_id</span>
885
+
886
+
887
+ <span class='type'>(<tt>String</tt>)</span>
888
+
889
+
890
+
891
+ &mdash;
892
+ <div class='inline'>
893
+ <p>ID to agent</p>
894
+ </div>
895
+
896
+ </li>
897
+
898
+ </ul>
899
+
900
+
901
+ <p class="tag_title">See Also:</p>
902
+ <ul class="see">
903
+
904
+ <li><a href="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-agent-key" target="_parent" title="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-agent-key">https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-agent-key</a></li>
905
+
906
+ </ul>
907
+
908
+ </div><table class="source_code">
909
+ <tr>
910
+ <td>
911
+ <pre class="lines">
912
+
913
+
914
+ 57
915
+ 58
916
+ 59</pre>
917
+ </td>
918
+ <td>
919
+ <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/agents.rb', line 57</span>
920
+
921
+ <span class='kw'>def</span> <span class='id identifier rubyid_agent_key'>agent_key</span><span class='lparen'>(</span><span class='id identifier rubyid_agent_id'>agent_id</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
922
+ <span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/agents/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_agent_id'>agent_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/key</span><span class='tstring_end'>&quot;</span></span>
923
+ <span class='kw'>end</span></pre>
924
+ </td>
925
+ </tr>
926
+ </table>
927
+ </div>
928
+
929
+ <div class="method_details ">
930
+ <h3 class="signature " id="all_agents-instance_method">
931
+
932
+ #<strong>all_agents</strong>(options = {}) &#x21d2; <tt>Object</tt>
933
+
934
+
935
+
936
+
937
+
938
+ </h3><div class="docstring">
939
+ <div class="discussion">
940
+
941
+ <p>Returns a list with the available agents.</p>
942
+
943
+
944
+ </div>
945
+ </div>
946
+ <div class="tags">
947
+ <p class="tag_title">Parameters:</p>
948
+ <ul class="param">
949
+
950
+ <li>
951
+
952
+ <span class='name'>options</span>
953
+
954
+
955
+ <span class='type'>(<tt>Hash</tt>)</span>
956
+
957
+
958
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
959
+
960
+
961
+ &mdash;
962
+ <div class='inline'>
963
+ <p>a customizable set of options</p>
964
+ </div>
965
+
966
+ </li>
967
+
968
+ </ul>
969
+
970
+
971
+
972
+
973
+ <p class="tag_title">Options Hash (<tt>options</tt>):</p>
974
+ <ul class="option">
975
+
976
+ <li>
977
+ <span class="name">:offset</span>
978
+ <span class="type">(<tt>offset</tt>)</span>
979
+ <span class="default">
980
+
981
+ </span>
982
+
983
+ &mdash; <div class='inline'>
984
+ <p>First element to return in the collection.</p>
985
+ </div>
986
+
987
+ </li>
988
+
989
+ <li>
990
+ <span class="name">:limit</span>
991
+ <span class="type">(<tt>limit</tt>)</span>
992
+ <span class="default">
993
+
994
+ </span>
995
+
996
+ &mdash; <div class='inline'>
997
+ <p>Maximum number of elements to return.</p>
998
+ </div>
999
+
1000
+ </li>
1001
+
1002
+ <li>
1003
+ <span class="name">:select</span>
1004
+ <span class="type">(<tt>select</tt>)</span>
1005
+ <span class="default">
1006
+
1007
+ </span>
1008
+
1009
+ &mdash; <div class='inline'>
1010
+ <p>Select which fields to return (separated by comma).</p>
1011
+ </div>
1012
+
1013
+ </li>
1014
+
1015
+ <li>
1016
+ <span class="name">:sort</span>
1017
+ <span class="type">(<tt>sort</tt>)</span>
1018
+ <span class="default">
1019
+
1020
+ </span>
1021
+
1022
+ &mdash; <div class='inline'>
1023
+ <p>Sorts the collection by a field or fields (separated by comma). Use +/- at
1024
+ the beginning to list in ascending or descending order.</p>
1025
+ </div>
1026
+
1027
+ </li>
1028
+
1029
+ <li>
1030
+ <span class="name">:search</span>
1031
+ <span class="type">(<tt>search</tt>)</span>
1032
+ <span class="default">
1033
+
1034
+ </span>
1035
+
1036
+ &mdash; <div class='inline'>
1037
+ <p>Looks for elements with the specified string.</p>
1038
+ </div>
1039
+
1040
+ </li>
1041
+
1042
+ <li>
1043
+ <span class="name">:status</span>
1044
+ <span class="type">(<tt>status</tt>)</span>
1045
+ <span class="default">
1046
+
1047
+ </span>
1048
+
1049
+ &mdash; <div class='inline'>
1050
+ <p>Filters by agent status. Use commas to enter multiple statuses. Allowed
1051
+ values: active, pending, neverconnected, disconnected</p>
1052
+ </div>
1053
+
1054
+ </li>
1055
+
1056
+ <li>
1057
+ <span class="name">:q</span>
1058
+ <span class="type">(<tt>q</tt>)</span>
1059
+ <span class="default">
1060
+
1061
+ </span>
1062
+
1063
+ &mdash; <div class='inline'>
1064
+ <p>Query to filter results by. For example q=”status=Active”</p>
1065
+ </div>
1066
+
1067
+ </li>
1068
+
1069
+ <li>
1070
+ <span class="name">:order_than</span>
1071
+ <span class="type">(<tt>order_than</tt>)</span>
1072
+ <span class="default">
1073
+
1074
+ </span>
1075
+
1076
+ &mdash; <div class='inline'>
1077
+ <p>Filters out disconnected agents for longer than specified. Time in seconds,
1078
+ ‘[n_days]d’, ‘[n_hours]h’, ‘[n_minutes]m’ or ‘[n_seconds]s’. For never
1079
+ connected agents, uses the register date.</p>
1080
+ </div>
1081
+
1082
+ </li>
1083
+
1084
+ </ul>
1085
+
1086
+
1087
+
1088
+ <p class="tag_title">See Also:</p>
1089
+ <ul class="see">
1090
+
1091
+ <li><a href="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-all-agents" target="_parent" title="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-all-agents">https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-all-agents</a></li>
1092
+
1093
+ </ul>
1094
+
1095
+ </div><table class="source_code">
1096
+ <tr>
1097
+ <td>
1098
+ <pre class="lines">
1099
+
1100
+
1101
+ 26
1102
+ 27
1103
+ 28</pre>
1104
+ </td>
1105
+ <td>
1106
+ <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/agents.rb', line 26</span>
1107
+
1108
+ <span class='kw'>def</span> <span class='id identifier rubyid_all_agents'>all_agents</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
1109
+ <span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/agents</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span>
1110
+ <span class='kw'>end</span></pre>
1111
+ </td>
1112
+ </tr>
1113
+ </table>
1114
+ </div>
1115
+
1116
+ <div class="method_details ">
1117
+ <h3 class="signature " id="distinct_fields_in_agents-instance_method">
1118
+
1119
+ #<strong>distinct_fields_in_agents</strong>(options = {}) &#x21d2; <tt>Object</tt>
1120
+
1121
+
1122
+
1123
+
1124
+
1125
+ </h3><div class="docstring">
1126
+ <div class="discussion">
1127
+
1128
+ <p>Returns all the different combinations that agents have for the selected
1129
+ fields. It also indicates the total number of agents that have each
1130
+ combination.</p>
1131
+
1132
+
1133
+ </div>
1134
+ </div>
1135
+ <div class="tags">
1136
+ <p class="tag_title">Parameters:</p>
1137
+ <ul class="param">
1138
+
1139
+ <li>
1140
+
1141
+ <span class='name'>options</span>
1142
+
1143
+
1144
+ <span class='type'>(<tt>Hash</tt>)</span>
1145
+
1146
+
1147
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
1148
+
1149
+
1150
+ &mdash;
1151
+ <div class='inline'>
1152
+ <p>a customizable set of options</p>
1153
+ </div>
1154
+
1155
+ </li>
1156
+
1157
+ </ul>
1158
+
1159
+
1160
+
1161
+
1162
+ <p class="tag_title">Options Hash (<tt>options</tt>):</p>
1163
+ <ul class="option">
1164
+
1165
+ <li>
1166
+ <span class="name">:offset</span>
1167
+ <span class="type">(<tt>offset</tt>)</span>
1168
+ <span class="default">
1169
+
1170
+ </span>
1171
+
1172
+ &mdash; <div class='inline'>
1173
+ <p>First element to return in the collection.</p>
1174
+ </div>
1175
+
1176
+ </li>
1177
+
1178
+ <li>
1179
+ <span class="name">:limit</span>
1180
+ <span class="type">(<tt>limit</tt>)</span>
1181
+ <span class="default">
1182
+
1183
+ </span>
1184
+
1185
+ &mdash; <div class='inline'>
1186
+ <p>Maximum number of elements to return.</p>
1187
+ </div>
1188
+
1189
+ </li>
1190
+
1191
+ <li>
1192
+ <span class="name">:sort</span>
1193
+ <span class="type">(<tt>sort</tt>)</span>
1194
+ <span class="default">
1195
+
1196
+ </span>
1197
+
1198
+ &mdash; <div class='inline'>
1199
+ <p>Sorts the collection by a field or fields (separated by comma). Use +/- at
1200
+ the beginning to list in ascending or descending order.</p>
1201
+ </div>
1202
+
1203
+ </li>
1204
+
1205
+ <li>
1206
+ <span class="name">:search</span>
1207
+ <span class="type">(<tt>search</tt>)</span>
1208
+ <span class="default">
1209
+
1210
+ </span>
1211
+
1212
+ &mdash; <div class='inline'>
1213
+ <p>Looks for elements with the specified string.</p>
1214
+ </div>
1215
+
1216
+ </li>
1217
+
1218
+ <li>
1219
+ <span class="name">:fileds</span>
1220
+ <span class="type">(<tt>fileds</tt>)</span>
1221
+ <span class="default">
1222
+
1223
+ </span>
1224
+
1225
+ &mdash; <div class='inline'>
1226
+ <p>List of fields affecting the operation.</p>
1227
+ </div>
1228
+
1229
+ </li>
1230
+
1231
+ <li>
1232
+ <span class="name">:select</span>
1233
+ <span class="type">(<tt>select</tt>)</span>
1234
+ <span class="default">
1235
+
1236
+ </span>
1237
+
1238
+ &mdash; <div class='inline'>
1239
+ <p>List of selected fields separated by commas.</p>
1240
+ </div>
1241
+
1242
+ </li>
1243
+
1244
+ <li>
1245
+ <span class="name">:q</span>
1246
+ <span class="type">(<tt>q</tt>)</span>
1247
+ <span class="default">
1248
+
1249
+ </span>
1250
+
1251
+ &mdash; <div class='inline'>
1252
+ <p>Query to filter result. For example q=”status=Active”</p>
1253
+ </div>
1254
+
1255
+ </li>
1256
+
1257
+ </ul>
1258
+
1259
+
1260
+
1261
+ <p class="tag_title">See Also:</p>
1262
+ <ul class="see">
1263
+
1264
+ <li><a href="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-distinct-fields-in-agents" target="_parent" title="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-distinct-fields-in-agents">https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-distinct-fields-in-agents</a></li>
1265
+
1266
+ </ul>
1267
+
1268
+ </div><table class="source_code">
1269
+ <tr>
1270
+ <td>
1271
+ <pre class="lines">
1272
+
1273
+
1274
+ 102
1275
+ 103
1276
+ 104</pre>
1277
+ </td>
1278
+ <td>
1279
+ <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/agents.rb', line 102</span>
1280
+
1281
+ <span class='kw'>def</span> <span class='id identifier rubyid_distinct_fields_in_agents'>distinct_fields_in_agents</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
1282
+ <span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/agents/stats/distinct</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span>
1283
+ <span class='kw'>end</span></pre>
1284
+ </td>
1285
+ </tr>
1286
+ </table>
1287
+ </div>
1288
+
1289
+ <div class="method_details ">
1290
+ <h3 class="signature " id="insert_agent-instance_method">
1291
+
1292
+ #<strong>insert_agent</strong>(options = {}) &#x21d2; <tt>Object</tt>
1293
+
1294
+
1295
+
1296
+
1297
+
1298
+ </h3><div class="docstring">
1299
+ <div class="discussion">
1300
+
1301
+ <p>Insert an agent with an existing id and key.</p>
1302
+
1303
+
1304
+ </div>
1305
+ </div>
1306
+ <div class="tags">
1307
+ <p class="tag_title">Parameters:</p>
1308
+ <ul class="param">
1309
+
1310
+ <li>
1311
+
1312
+ <span class='name'>options</span>
1313
+
1314
+
1315
+ <span class='type'>(<tt>Hash</tt>)</span>
1316
+
1317
+
1318
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
1319
+
1320
+
1321
+ &mdash;
1322
+ <div class='inline'>
1323
+ <p>a customizable set of options</p>
1324
+ </div>
1325
+
1326
+ </li>
1327
+
1328
+ </ul>
1329
+
1330
+
1331
+
1332
+
1333
+ <p class="tag_title">Options Hash (<tt>options</tt>):</p>
1334
+ <ul class="option">
1335
+
1336
+ <li>
1337
+ <span class="name">:name</span>
1338
+ <span class="type">(<tt>name</tt>)</span>
1339
+ <span class="default">
1340
+
1341
+ </span>
1342
+
1343
+ &mdash; <div class='inline'>
1344
+ <p>Name to agent</p>
1345
+ </div>
1346
+
1347
+ </li>
1348
+
1349
+ <li>
1350
+ <span class="name">:ip</span>
1351
+ <span class="type">(<tt>ip</tt>)</span>
1352
+ <span class="default">
1353
+
1354
+ </span>
1355
+
1356
+ &mdash; <div class='inline'>
1357
+ <p>If this is not included, the API will get the IP automatically. If you are
1358
+ behind a proxy, you must set the option config.BehindProxyServer to yes at
1359
+ config.js. Allowed values: IP, IP/NET, ANY</p>
1360
+ </div>
1361
+
1362
+ </li>
1363
+
1364
+ <li>
1365
+ <span class="name">:id</span>
1366
+ <span class="type">(<tt>id</tt>)</span>
1367
+ <span class="default">
1368
+
1369
+ </span>
1370
+
1371
+ &mdash; <div class='inline'>
1372
+ <p>ID to agent</p>
1373
+ </div>
1374
+
1375
+ </li>
1376
+
1377
+ <li>
1378
+ <span class="name">:key</span>
1379
+ <span class="type">(<tt>key</tt>)</span>
1380
+ <span class="default">
1381
+
1382
+ </span>
1383
+
1384
+ &mdash; <div class='inline'>
1385
+ <p>Agent key. Minimum length: 64 characters. Allowed values: ^[a-zA-Z0-9]+$</p>
1386
+ </div>
1387
+
1388
+ </li>
1389
+
1390
+ <li>
1391
+ <span class="name">:force</span>
1392
+ <span class="type">(<tt>force</tt>)</span>
1393
+ <span class="default">
1394
+
1395
+ </span>
1396
+
1397
+ &mdash; <div class='inline'>
1398
+ <p>Remove the old agent the with same IP if disconnected since &lt;force&gt;
1399
+ seconds.</p>
1400
+ </div>
1401
+
1402
+ </li>
1403
+
1404
+ </ul>
1405
+
1406
+
1407
+
1408
+ </div><table class="source_code">
1409
+ <tr>
1410
+ <td>
1411
+ <pre class="lines">
1412
+
1413
+
1414
+ 169
1415
+ 170
1416
+ 171</pre>
1417
+ </td>
1418
+ <td>
1419
+ <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/agents.rb', line 169</span>
1420
+
1421
+ <span class='kw'>def</span> <span class='id identifier rubyid_insert_agent'>insert_agent</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
1422
+ <span class='id identifier rubyid_post'>post</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/agents/insert</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span>
1423
+ <span class='kw'>end</span></pre>
1424
+ </td>
1425
+ </tr>
1426
+ </table>
1427
+ </div>
1428
+
1429
+ <div class="method_details ">
1430
+ <h3 class="signature " id="outdated_agents-instance_method">
1431
+
1432
+ #<strong>outdated_agents</strong>(options = {}) &#x21d2; <tt>Object</tt>
1433
+
1434
+
1435
+
1436
+
1437
+
1438
+ </h3><div class="docstring">
1439
+ <div class="discussion">
1440
+
1441
+ <p>Returns the list of outdated agents.</p>
1442
+
1443
+
1444
+ </div>
1445
+ </div>
1446
+ <div class="tags">
1447
+ <p class="tag_title">Parameters:</p>
1448
+ <ul class="param">
1449
+
1450
+ <li>
1451
+
1452
+ <span class='name'>options</span>
1453
+
1454
+
1455
+ <span class='type'>(<tt>Hash</tt>)</span>
1456
+
1457
+
1458
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
1459
+
1460
+
1461
+ &mdash;
1462
+ <div class='inline'>
1463
+ <p>a customizable set of options</p>
1464
+ </div>
1465
+
1466
+ </li>
1467
+
1468
+ </ul>
1469
+
1470
+
1471
+
1472
+
1473
+ <p class="tag_title">Options Hash (<tt>options</tt>):</p>
1474
+ <ul class="option">
1475
+
1476
+ <li>
1477
+ <span class="name">:offset</span>
1478
+ <span class="type">(<tt>offset</tt>)</span>
1479
+ <span class="default">
1480
+
1481
+ </span>
1482
+
1483
+ &mdash; <div class='inline'>
1484
+ <p>First element to return in the collection.</p>
1485
+ </div>
1486
+
1487
+ </li>
1488
+
1489
+ <li>
1490
+ <span class="name">:limit</span>
1491
+ <span class="type">(<tt>limit</tt>)</span>
1492
+ <span class="default">
1493
+
1494
+ </span>
1495
+
1496
+ &mdash; <div class='inline'>
1497
+ <p>Maximum number of elements to return.</p>
1498
+ </div>
1499
+
1500
+ </li>
1501
+
1502
+ <li>
1503
+ <span class="name">:sort</span>
1504
+ <span class="type">(<tt>sort</tt>)</span>
1505
+ <span class="default">
1506
+
1507
+ </span>
1508
+
1509
+ &mdash; <div class='inline'>
1510
+ <p>Sorts the collection by a field or fields (separated by comma). Use +/- at
1511
+ the beginning to list in ascending or descending order.</p>
1512
+ </div>
1513
+
1514
+ </li>
1515
+
1516
+ <li>
1517
+ <span class="name">:q</span>
1518
+ <span class="type">(<tt>q</tt>)</span>
1519
+ <span class="default">
1520
+
1521
+ </span>
1522
+
1523
+ &mdash; <div class='inline'>
1524
+ <p>Query to filter result. For example q=”status=Active”</p>
1525
+ </div>
1526
+
1527
+ </li>
1528
+
1529
+ </ul>
1530
+
1531
+
1532
+
1533
+ <p class="tag_title">See Also:</p>
1534
+ <ul class="see">
1535
+
1536
+ <li><a href="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-outdated-agents" target="_parent" title="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-outdated-agents">https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-outdated-agents</a></li>
1537
+
1538
+ </ul>
1539
+
1540
+ </div><table class="source_code">
1541
+ <tr>
1542
+ <td>
1543
+ <pre class="lines">
1544
+
1545
+
1546
+ 117
1547
+ 118
1548
+ 119</pre>
1549
+ </td>
1550
+ <td>
1551
+ <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/agents.rb', line 117</span>
1552
+
1553
+ <span class='kw'>def</span> <span class='id identifier rubyid_outdated_agents'>outdated_agents</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
1554
+ <span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/agents/outdated</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span>
1555
+ <span class='kw'>end</span></pre>
1556
+ </td>
1557
+ </tr>
1558
+ </table>
1559
+ </div>
1560
+
1561
+ <div class="method_details ">
1562
+ <h3 class="signature " id="restart_agents-instance_method">
1563
+
1564
+ #<strong>restart_agents</strong>(options = {}) &#x21d2; <tt>Object</tt>
1565
+
1566
+
1567
+
1568
+
1569
+
1570
+ </h3><div class="docstring">
1571
+ <div class="discussion">
1572
+
1573
+ <p>Restarts a list of agents.</p>
1574
+
1575
+
1576
+ </div>
1577
+ </div>
1578
+ <div class="tags">
1579
+ <p class="tag_title">Parameters:</p>
1580
+ <ul class="param">
1581
+
1582
+ <li>
1583
+
1584
+ <span class='name'>options</span>
1585
+
1586
+
1587
+ <span class='type'>(<tt>Hash</tt>)</span>
1588
+
1589
+
1590
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
1591
+
1592
+
1593
+ &mdash;
1594
+ <div class='inline'>
1595
+ <p>a customizable set of options</p>
1596
+ </div>
1597
+
1598
+ </li>
1599
+
1600
+ </ul>
1601
+
1602
+
1603
+
1604
+
1605
+ <p class="tag_title">Options Hash (<tt>options</tt>):</p>
1606
+ <ul class="option">
1607
+
1608
+ <li>
1609
+ <span class="name">:ids</span>
1610
+ <span class="type">(<tt>ids</tt>)</span>
1611
+ <span class="default">
1612
+
1613
+ </span>
1614
+
1615
+ &mdash; <div class='inline'>
1616
+ <p>Array of agent ID’s.</p>
1617
+ </div>
1618
+
1619
+ </li>
1620
+
1621
+ </ul>
1622
+
1623
+
1624
+
1625
+ <p class="tag_title">See Also:</p>
1626
+ <ul class="see">
1627
+
1628
+ <li><a href="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#restart-a-list-of-agents" target="_parent" title="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#restart-a-list-of-agents">https://documentation.wazuh.com/3.10/user-manual/api/reference.html#restart-a-list-of-agents</a></li>
1629
+
1630
+ </ul>
1631
+
1632
+ </div><table class="source_code">
1633
+ <tr>
1634
+ <td>
1635
+ <pre class="lines">
1636
+
1637
+
1638
+ 66
1639
+ 67
1640
+ 68</pre>
1641
+ </td>
1642
+ <td>
1643
+ <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/agents.rb', line 66</span>
1644
+
1645
+ <span class='kw'>def</span> <span class='id identifier rubyid_restart_agents'>restart_agents</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
1646
+ <span class='id identifier rubyid_post'>post</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/agents/restart</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span>
1647
+ <span class='kw'>end</span></pre>
1648
+ </td>
1649
+ </tr>
1650
+ </table>
1651
+ </div>
1652
+
1653
+ <div class="method_details ">
1654
+ <h3 class="signature " id="restart_all_agents-instance_method">
1655
+
1656
+ #<strong>restart_all_agents</strong> &#x21d2; <tt>Object</tt>
1657
+
1658
+
1659
+
1660
+
1661
+
1662
+ </h3><div class="docstring">
1663
+ <div class="discussion">
1664
+
1665
+ <p>Restarts all agents.</p>
1666
+
1667
+
1668
+ </div>
1669
+ </div>
1670
+ <div class="tags">
1671
+
1672
+
1673
+ </div><table class="source_code">
1674
+ <tr>
1675
+ <td>
1676
+ <pre class="lines">
1677
+
1678
+
1679
+ 72
1680
+ 73
1681
+ 74</pre>
1682
+ </td>
1683
+ <td>
1684
+ <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/agents.rb', line 72</span>
1685
+
1686
+ <span class='kw'>def</span> <span class='id identifier rubyid_restart_all_agents'>restart_all_agents</span><span class='lparen'>(</span><span class='rparen'>)</span>
1687
+ <span class='id identifier rubyid_put'>put</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/agents/restart</span><span class='tstring_end'>&#39;</span></span>
1688
+ <span class='kw'>end</span></pre>
1689
+ </td>
1690
+ </tr>
1691
+ </table>
1692
+ </div>
1693
+
1694
+ <div class="method_details ">
1695
+ <h3 class="signature " id="restart_an_agents-instance_method">
1696
+
1697
+ #<strong>restart_an_agents</strong>(agent_id, options = {}) &#x21d2; <tt>Object</tt>
1698
+
1699
+
1700
+
1701
+
1702
+
1703
+ </h3><div class="docstring">
1704
+ <div class="discussion">
1705
+
1706
+ <p>Restart an agent.</p>
1707
+
1708
+
1709
+ </div>
1710
+ </div>
1711
+ <div class="tags">
1712
+ <p class="tag_title">Parameters:</p>
1713
+ <ul class="param">
1714
+
1715
+ <li>
1716
+
1717
+ <span class='name'>agent_id</span>
1718
+
1719
+
1720
+ <span class='type'>(<tt>String</tt>)</span>
1721
+
1722
+
1723
+
1724
+ &mdash;
1725
+ <div class='inline'>
1726
+ <p>Agent unique ID.</p>
1727
+ </div>
1728
+
1729
+ </li>
1730
+
1731
+ </ul>
1732
+
1733
+
1734
+ <p class="tag_title">See Also:</p>
1735
+ <ul class="see">
1736
+
1737
+ <li><a href="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#restart-an-agent" target="_parent" title="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#restart-an-agent">https://documentation.wazuh.com/3.10/user-manual/api/reference.html#restart-an-agent</a></li>
1738
+
1739
+ </ul>
1740
+
1741
+ </div><table class="source_code">
1742
+ <tr>
1743
+ <td>
1744
+ <pre class="lines">
1745
+
1746
+
1747
+ 81
1748
+ 82
1749
+ 83</pre>
1750
+ </td>
1751
+ <td>
1752
+ <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/agents.rb', line 81</span>
1753
+
1754
+ <span class='kw'>def</span> <span class='id identifier rubyid_restart_an_agents'>restart_an_agents</span><span class='lparen'>(</span><span class='id identifier rubyid_agent_id'>agent_id</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
1755
+ <span class='id identifier rubyid_put'>put</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/agents/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_agent_id'>agent_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/restart</span><span class='tstring_end'>&quot;</span></span>
1756
+ <span class='kw'>end</span></pre>
1757
+ </td>
1758
+ </tr>
1759
+ </table>
1760
+ </div>
1761
+
1762
+ <div class="method_details ">
1763
+ <h3 class="signature " id="upgrade_result_from_agent-instance_method">
1764
+
1765
+ #<strong>upgrade_result_from_agent</strong>(agent_id, options = {}) &#x21d2; <tt>Object</tt>
1766
+
1767
+
1768
+
1769
+
1770
+
1771
+ </h3><div class="docstring">
1772
+ <div class="discussion">
1773
+
1774
+ <p>Returns the upgrade result from an agent.</p>
1775
+
1776
+
1777
+ </div>
1778
+ </div>
1779
+ <div class="tags">
1780
+ <p class="tag_title">Parameters:</p>
1781
+ <ul class="param">
1782
+
1783
+ <li>
1784
+
1785
+ <span class='name'>agent_id</span>
1786
+
1787
+
1788
+ <span class='type'>(<tt>String</tt>)</span>
1789
+
1790
+
1791
+
1792
+ &mdash;
1793
+ <div class='inline'>
1794
+ <p>ID to agent</p>
1795
+ </div>
1796
+
1797
+ </li>
1798
+
1799
+ <li>
1800
+
1801
+ <span class='name'>options</span>
1802
+
1803
+
1804
+ <span class='type'>(<tt>Hash</tt>)</span>
1805
+
1806
+
1807
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
1808
+
1809
+
1810
+ &mdash;
1811
+ <div class='inline'>
1812
+ <p>a customizable set of options</p>
1813
+ </div>
1814
+
1815
+ </li>
1816
+
1817
+ </ul>
1818
+
1819
+
1820
+
1821
+
1822
+
1823
+
1824
+ <p class="tag_title">Options Hash (<tt>options</tt>):</p>
1825
+ <ul class="option">
1826
+
1827
+ <li>
1828
+ <span class="name">:timeout</span>
1829
+ <span class="type">(<tt>timeout</tt>)</span>
1830
+ <span class="default">
1831
+
1832
+ </span>
1833
+
1834
+ &mdash; <div class='inline'>
1835
+ <p>Seconds to wait for the agent to respond.</p>
1836
+ </div>
1837
+
1838
+ </li>
1839
+
1840
+ </ul>
1841
+
1842
+
1843
+
1844
+ </div><table class="source_code">
1845
+ <tr>
1846
+ <td>
1847
+ <pre class="lines">
1848
+
1849
+
1850
+ 127
1851
+ 128
1852
+ 129</pre>
1853
+ </td>
1854
+ <td>
1855
+ <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/agents.rb', line 127</span>
1856
+
1857
+ <span class='kw'>def</span> <span class='id identifier rubyid_upgrade_result_from_agent'>upgrade_result_from_agent</span><span class='lparen'>(</span><span class='id identifier rubyid_agent_id'>agent_id</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
1858
+ <span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/agents/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_agent_id'>agent_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/upgrade_result</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span>
1859
+ <span class='kw'>end</span></pre>
1860
+ </td>
1861
+ </tr>
1862
+ </table>
1863
+ </div>
1864
+
1865
+ </div>
1866
+
1867
+ </div>
1868
+
1869
+ <div id="footer">
1870
+ Generated on Sat Jan 25 00:19:40 2020 by
1871
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1872
+ 0.9.16 (ruby-2.5.1).
1873
+ </div>
1874
+
1875
+ </div>
1876
+ </body>
1877
+ </html>