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/Experimental.html ADDED
@@ -0,0 +1,2610 @@
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::Experimental
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::Experimental";
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 (E)</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">Experimental</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::Experimental
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/experimental.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="#experimental_ciscat_results-instance_method" title="#experimental_ciscat_results (instance method)">#<strong>experimental_ciscat_results</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>Get CIS-CAT results Returns the agent’s ciscat results info.</p>
125
+ </div></span>
126
+
127
+ </li>
128
+
129
+
130
+ <li class="public ">
131
+ <span class="summary_signature">
132
+
133
+ <a href="#experimental_clear_syscheck_database-instance_method" title="#experimental_clear_syscheck_database (instance method)">#<strong>experimental_clear_syscheck_database</strong> &#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>Clear syscheck database Clears the syscheck database for all agents.</p>
149
+ </div></span>
150
+
151
+ </li>
152
+
153
+
154
+ <li class="public ">
155
+ <span class="summary_signature">
156
+
157
+ <a href="#experimental_hardware-instance_method" title="#experimental_hardware (instance method)">#<strong>experimental_hardware</strong>(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>Get hardware info of all agents Returns the agent’s hardware info.</p>
173
+ </div></span>
174
+
175
+ </li>
176
+
177
+
178
+ <li class="public ">
179
+ <span class="summary_signature">
180
+
181
+ <a href="#experimental_netaddr-instance_method" title="#experimental_netaddr (instance method)">#<strong>experimental_netaddr</strong>(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>Get network address info of all agents Returns the agent’s network address
197
+ info.</p>
198
+ </div></span>
199
+
200
+ </li>
201
+
202
+
203
+ <li class="public ">
204
+ <span class="summary_signature">
205
+
206
+ <a href="#experimental_netiface-instance_method" title="#experimental_netiface (instance method)">#<strong>experimental_netiface</strong>(options = {}) &#x21d2; Object </a>
207
+
208
+
209
+
210
+ </span>
211
+
212
+
213
+
214
+
215
+
216
+
217
+
218
+
219
+
220
+ <span class="summary_desc"><div class='inline'>
221
+ <p>Get network interface info of all agents Returns the agent’s network
222
+ interface info.</p>
223
+ </div></span>
224
+
225
+ </li>
226
+
227
+
228
+ <li class="public ">
229
+ <span class="summary_signature">
230
+
231
+ <a href="#experimental_netproto-instance_method" title="#experimental_netproto (instance method)">#<strong>experimental_netproto</strong>(options = {}) &#x21d2; Object </a>
232
+
233
+
234
+
235
+ </span>
236
+
237
+
238
+
239
+
240
+
241
+
242
+
243
+
244
+
245
+ <span class="summary_desc"><div class='inline'>
246
+ <p>Get network protocol info of all agents Returns the agent’s network
247
+ protocol info.</p>
248
+ </div></span>
249
+
250
+ </li>
251
+
252
+
253
+ <li class="public ">
254
+ <span class="summary_signature">
255
+
256
+ <a href="#experimental_os-instance_method" title="#experimental_os (instance method)">#<strong>experimental_os</strong>(options = {}) &#x21d2; Object </a>
257
+
258
+
259
+
260
+ </span>
261
+
262
+
263
+
264
+
265
+
266
+
267
+
268
+
269
+
270
+ <span class="summary_desc"><div class='inline'>
271
+ <p>Get os info of all agents Returns the agent’s os info.</p>
272
+ </div></span>
273
+
274
+ </li>
275
+
276
+
277
+ <li class="public ">
278
+ <span class="summary_signature">
279
+
280
+ <a href="#experimental_packages-instance_method" title="#experimental_packages (instance method)">#<strong>experimental_packages</strong>(options = {}) &#x21d2; Object </a>
281
+
282
+
283
+
284
+ </span>
285
+
286
+
287
+
288
+
289
+
290
+
291
+
292
+
293
+
294
+ <span class="summary_desc"><div class='inline'>
295
+ <p>Get packages info of all agents Returns the agent’s packages info.</p>
296
+ </div></span>
297
+
298
+ </li>
299
+
300
+
301
+ <li class="public ">
302
+ <span class="summary_signature">
303
+
304
+ <a href="#experimental_ports-instance_method" title="#experimental_ports (instance method)">#<strong>experimental_ports</strong>(options = {}) &#x21d2; Object </a>
305
+
306
+
307
+
308
+ </span>
309
+
310
+
311
+
312
+
313
+
314
+
315
+
316
+
317
+
318
+ <span class="summary_desc"><div class='inline'>
319
+ <p>Get ports info of all agents Returns the agent’s ports info.</p>
320
+ </div></span>
321
+
322
+ </li>
323
+
324
+
325
+ <li class="public ">
326
+ <span class="summary_signature">
327
+
328
+ <a href="#experimental_processes-instance_method" title="#experimental_processes (instance method)">#<strong>experimental_processes</strong>(options = {}) &#x21d2; Object </a>
329
+
330
+
331
+
332
+ </span>
333
+
334
+
335
+
336
+
337
+
338
+
339
+
340
+
341
+
342
+ <span class="summary_desc"><div class='inline'>
343
+ <p>Get processes info of all agents Returns the agent’s processes info.</p>
344
+ </div></span>
345
+
346
+ </li>
347
+
348
+
349
+ </ul>
350
+
351
+
352
+
353
+
354
+ <div id="instance_method_details" class="method_details_list">
355
+ <h2>Instance Method Details</h2>
356
+
357
+
358
+ <div class="method_details first">
359
+ <h3 class="signature first" id="experimental_ciscat_results-instance_method">
360
+
361
+ #<strong>experimental_ciscat_results</strong>(options = {}) &#x21d2; <tt>Object</tt>
362
+
363
+
364
+
365
+
366
+
367
+ </h3><div class="docstring">
368
+ <div class="discussion">
369
+
370
+ <p>Get CIS-CAT results Returns the agent’s ciscat results info.</p>
371
+
372
+
373
+ </div>
374
+ </div>
375
+ <div class="tags">
376
+ <p class="tag_title">Parameters:</p>
377
+ <ul class="param">
378
+
379
+ <li>
380
+
381
+ <span class='name'>options</span>
382
+
383
+
384
+ <span class='type'>(<tt>Hash</tt>)</span>
385
+
386
+
387
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
388
+
389
+
390
+ &mdash;
391
+ <div class='inline'>
392
+ <p>a customizable set of options</p>
393
+ </div>
394
+
395
+ </li>
396
+
397
+ </ul>
398
+
399
+
400
+
401
+
402
+ <p class="tag_title">Options Hash (<tt>options</tt>):</p>
403
+ <ul class="option">
404
+
405
+ <li>
406
+ <span class="name">:agent_id</span>
407
+ <span class="type">(<tt>agent_id</tt>)</span>
408
+ <span class="default">
409
+
410
+ </span>
411
+
412
+ &mdash; <div class='inline'>
413
+ <p>ID to agent</p>
414
+ </div>
415
+
416
+ </li>
417
+
418
+ <li>
419
+ <span class="name">:offset</span>
420
+ <span class="type">(<tt>offset</tt>)</span>
421
+ <span class="default">
422
+
423
+ </span>
424
+
425
+ &mdash; <div class='inline'>
426
+ <p>First element to return in the collection.</p>
427
+ </div>
428
+
429
+ </li>
430
+
431
+ <li>
432
+ <span class="name">:limit</span>
433
+ <span class="type">(<tt>limit</tt>)</span>
434
+ <span class="default">
435
+
436
+ </span>
437
+
438
+ &mdash; <div class='inline'>
439
+ <p>Maximum number of elements to return.</p>
440
+ </div>
441
+
442
+ </li>
443
+
444
+ <li>
445
+ <span class="name">:sort</span>
446
+ <span class="type">(<tt>sort</tt>)</span>
447
+ <span class="default">
448
+
449
+ </span>
450
+
451
+ &mdash; <div class='inline'>
452
+ <p>Sorts the collection by a field or fields (separated by comma). Use +/- at
453
+ the beginning to list in ascending or descending order.</p>
454
+ </div>
455
+
456
+ </li>
457
+
458
+ <li>
459
+ <span class="name">:search</span>
460
+ <span class="type">(<tt>search</tt>)</span>
461
+ <span class="default">
462
+
463
+ </span>
464
+
465
+ &mdash; <div class='inline'>
466
+ <p>Looks for elements with the specified string.</p>
467
+ </div>
468
+
469
+ </li>
470
+
471
+ <li>
472
+ <span class="name">:select</span>
473
+ <span class="type">(<tt>select</tt>)</span>
474
+ <span class="default">
475
+
476
+ </span>
477
+
478
+ &mdash; <div class='inline'>
479
+ <p>List of selected fields separated by commas.</p>
480
+ </div>
481
+
482
+ </li>
483
+
484
+ <li>
485
+ <span class="name">:benchmark</span>
486
+ <span class="type">(<tt>benchmark</tt>)</span>
487
+ <span class="default">
488
+
489
+ </span>
490
+
491
+ </li>
492
+
493
+ <li>
494
+ <span class="name">:profile</span>
495
+ <span class="type">(<tt>profile</tt>)</span>
496
+ <span class="default">
497
+
498
+ </span>
499
+
500
+ </li>
501
+
502
+ <li>
503
+ <span class="name">:pass</span>
504
+ <span class="type">(<tt>pass</tt>)</span>
505
+ <span class="default">
506
+
507
+ </span>
508
+
509
+ </li>
510
+
511
+ <li>
512
+ <span class="name">:fail</span>
513
+ <span class="type">(<tt>fail</tt>)</span>
514
+ <span class="default">
515
+
516
+ </span>
517
+
518
+ </li>
519
+
520
+ <li>
521
+ <span class="name">:error</span>
522
+ <span class="type">(<tt>error</tt>)</span>
523
+ <span class="default">
524
+
525
+ </span>
526
+
527
+ </li>
528
+
529
+ <li>
530
+ <span class="name">:notchecked</span>
531
+ <span class="type">(<tt>notchecked</tt>)</span>
532
+ <span class="default">
533
+
534
+ </span>
535
+
536
+ </li>
537
+
538
+ <li>
539
+ <span class="name">:unkown</span>
540
+ <span class="type">(<tt>unknown</tt>)</span>
541
+ <span class="default">
542
+
543
+ </span>
544
+
545
+ </li>
546
+
547
+ <li>
548
+ <span class="name">:score</span>
549
+ <span class="type">(<tt>score</tt>)</span>
550
+ <span class="default">
551
+
552
+ </span>
553
+
554
+ </li>
555
+
556
+ </ul>
557
+
558
+
559
+
560
+ <p class="tag_title">See Also:</p>
561
+ <ul class="see">
562
+
563
+ <li><a href="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-cis-cat-results" target="_parent" title="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-cis-cat-results">https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-cis-cat-results</a></li>
564
+
565
+ </ul>
566
+
567
+ </div><table class="source_code">
568
+ <tr>
569
+ <td>
570
+ <pre class="lines">
571
+
572
+
573
+ 303
574
+ 304
575
+ 305</pre>
576
+ </td>
577
+ <td>
578
+ <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/experimental.rb', line 303</span>
579
+
580
+ <span class='kw'>def</span> <span class='id identifier rubyid_experimental_ciscat_results'>experimental_ciscat_results</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>
581
+ <span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/experimental/ciscat/results</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span>
582
+ <span class='kw'>end</span></pre>
583
+ </td>
584
+ </tr>
585
+ </table>
586
+ </div>
587
+
588
+ <div class="method_details ">
589
+ <h3 class="signature " id="experimental_clear_syscheck_database-instance_method">
590
+
591
+ #<strong>experimental_clear_syscheck_database</strong> &#x21d2; <tt>Object</tt>
592
+
593
+
594
+
595
+
596
+
597
+ </h3><div class="docstring">
598
+ <div class="discussion">
599
+
600
+ <p>Clear syscheck database Clears the syscheck database for all agents.</p>
601
+
602
+
603
+ </div>
604
+ </div>
605
+ <div class="tags">
606
+
607
+
608
+ </div><table class="source_code">
609
+ <tr>
610
+ <td>
611
+ <pre class="lines">
612
+
613
+
614
+ 12
615
+ 13
616
+ 14</pre>
617
+ </td>
618
+ <td>
619
+ <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/experimental.rb', line 12</span>
620
+
621
+ <span class='kw'>def</span> <span class='id identifier rubyid_experimental_clear_syscheck_database'>experimental_clear_syscheck_database</span>
622
+ <span class='id identifier rubyid_delete'>delete</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/experimental/syscheck</span><span class='tstring_end'>&#39;</span></span>
623
+ <span class='kw'>end</span></pre>
624
+ </td>
625
+ </tr>
626
+ </table>
627
+ </div>
628
+
629
+ <div class="method_details ">
630
+ <h3 class="signature " id="experimental_hardware-instance_method">
631
+
632
+ #<strong>experimental_hardware</strong>(options = {}) &#x21d2; <tt>Object</tt>
633
+
634
+
635
+
636
+
637
+
638
+ </h3><div class="docstring">
639
+ <div class="discussion">
640
+
641
+ <p>Get hardware info of all agents Returns the agent’s hardware info.</p>
642
+
643
+
644
+ </div>
645
+ </div>
646
+ <div class="tags">
647
+ <p class="tag_title">Parameters:</p>
648
+ <ul class="param">
649
+
650
+ <li>
651
+
652
+ <span class='name'>options</span>
653
+
654
+
655
+ <span class='type'>(<tt>Hash</tt>)</span>
656
+
657
+
658
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
659
+
660
+
661
+ &mdash;
662
+ <div class='inline'>
663
+ <p>a customizable set of options</p>
664
+ </div>
665
+
666
+ </li>
667
+
668
+ </ul>
669
+
670
+
671
+
672
+
673
+ <p class="tag_title">Options Hash (<tt>options</tt>):</p>
674
+ <ul class="option">
675
+
676
+ <li>
677
+ <span class="name">:agent_id</span>
678
+ <span class="type">(<tt>agent_id</tt>)</span>
679
+ <span class="default">
680
+
681
+ </span>
682
+
683
+ &mdash; <div class='inline'>
684
+ <p>Agent ID</p>
685
+ </div>
686
+
687
+ </li>
688
+
689
+ <li>
690
+ <span class="name">:offset</span>
691
+ <span class="type">(<tt>offset</tt>)</span>
692
+ <span class="default">
693
+
694
+ </span>
695
+
696
+ &mdash; <div class='inline'>
697
+ <p>First element to return in the collection.</p>
698
+ </div>
699
+
700
+ </li>
701
+
702
+ <li>
703
+ <span class="name">:limit</span>
704
+ <span class="type">(<tt>limit</tt>)</span>
705
+ <span class="default">
706
+
707
+ </span>
708
+
709
+ &mdash; <div class='inline'>
710
+ <p>Maximum number of elements to return.</p>
711
+ </div>
712
+
713
+ </li>
714
+
715
+ <li>
716
+ <span class="name">:sort</span>
717
+ <span class="type">(<tt>sort</tt>)</span>
718
+ <span class="default">
719
+
720
+ </span>
721
+
722
+ &mdash; <div class='inline'>
723
+ <p>Sorts the collection by a field or fields (separated by comma). Use +/- at
724
+ the beginning to list in ascending or descending order.</p>
725
+ </div>
726
+
727
+ </li>
728
+
729
+ <li>
730
+ <span class="name">:search</span>
731
+ <span class="type">(<tt>search</tt>)</span>
732
+ <span class="default">
733
+
734
+ </span>
735
+
736
+ &mdash; <div class='inline'>
737
+ <p>Looks for elements with the specified string.</p>
738
+ </div>
739
+
740
+ </li>
741
+
742
+ <li>
743
+ <span class="name">:select</span>
744
+ <span class="type">(<tt>select</tt>)</span>
745
+ <span class="default">
746
+
747
+ </span>
748
+
749
+ &mdash; <div class='inline'>
750
+ <p>List of selected fields separated by commas.</p>
751
+ </div>
752
+
753
+ </li>
754
+
755
+ <li>
756
+ <span class="name">:ram_free</span>
757
+ <span class="type">(<tt>ram_free</tt>)</span>
758
+ <span class="default">
759
+
760
+ </span>
761
+
762
+ &mdash; <div class='inline'>
763
+ <p>Filters by ram_free.</p>
764
+ </div>
765
+
766
+ </li>
767
+
768
+ <li>
769
+ <span class="name">:ram_total</span>
770
+ <span class="type">(<tt>ram_total</tt>)</span>
771
+ <span class="default">
772
+
773
+ </span>
774
+
775
+ &mdash; <div class='inline'>
776
+ <p>Filters by ram_total.</p>
777
+ </div>
778
+
779
+ </li>
780
+
781
+ <li>
782
+ <span class="name">:cpu_cores</span>
783
+ <span class="type">(<tt>cpu_cores</tt>)</span>
784
+ <span class="default">
785
+
786
+ </span>
787
+
788
+ &mdash; <div class='inline'>
789
+ <p>Filters by cpu_cores.</p>
790
+ </div>
791
+
792
+ </li>
793
+
794
+ <li>
795
+ <span class="name">:cpu_mhz</span>
796
+ <span class="type">(<tt>cpu_mhz</tt>)</span>
797
+ <span class="default">
798
+
799
+ </span>
800
+
801
+ &mdash; <div class='inline'>
802
+ <p>Filters by cpu_mhz.</p>
803
+ </div>
804
+
805
+ </li>
806
+
807
+ <li>
808
+ <span class="name">:cpu_name</span>
809
+ <span class="type">(<tt>cpu_name</tt>)</span>
810
+ <span class="default">
811
+
812
+ </span>
813
+
814
+ &mdash; <div class='inline'>
815
+ <p>Filters by cpu_name.</p>
816
+ </div>
817
+
818
+ </li>
819
+
820
+ <li>
821
+ <span class="name">:board_serial</span>
822
+ <span class="type">(<tt>board_serial</tt>)</span>
823
+ <span class="default">
824
+
825
+ </span>
826
+
827
+ &mdash; <div class='inline'>
828
+ <p>Filters by board_serial.</p>
829
+ </div>
830
+
831
+ </li>
832
+
833
+ </ul>
834
+
835
+
836
+
837
+ <p class="tag_title">See Also:</p>
838
+ <ul class="see">
839
+
840
+ <li><a href="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-hardware-info-of-all-agents" target="_parent" title="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-hardware-info-of-all-agents">https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-hardware-info-of-all-agents</a></li>
841
+
842
+ </ul>
843
+
844
+ </div><table class="source_code">
845
+ <tr>
846
+ <td>
847
+ <pre class="lines">
848
+
849
+
850
+ 44
851
+ 45
852
+ 46</pre>
853
+ </td>
854
+ <td>
855
+ <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/experimental.rb', line 44</span>
856
+
857
+ <span class='kw'>def</span> <span class='id identifier rubyid_experimental_hardware'>experimental_hardware</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>
858
+ <span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/experimental/syscollector/hardware</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span>
859
+ <span class='kw'>end</span></pre>
860
+ </td>
861
+ </tr>
862
+ </table>
863
+ </div>
864
+
865
+ <div class="method_details ">
866
+ <h3 class="signature " id="experimental_netaddr-instance_method">
867
+
868
+ #<strong>experimental_netaddr</strong>(options = {}) &#x21d2; <tt>Object</tt>
869
+
870
+
871
+
872
+
873
+
874
+ </h3><div class="docstring">
875
+ <div class="discussion">
876
+
877
+ <p>Get network address info of all agents Returns the agent’s network address
878
+ info.</p>
879
+
880
+
881
+ </div>
882
+ </div>
883
+ <div class="tags">
884
+ <p class="tag_title">Parameters:</p>
885
+ <ul class="param">
886
+
887
+ <li>
888
+
889
+ <span class='name'>options</span>
890
+
891
+
892
+ <span class='type'>(<tt>Hash</tt>)</span>
893
+
894
+
895
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
896
+
897
+
898
+ &mdash;
899
+ <div class='inline'>
900
+ <p>a customizable set of options</p>
901
+ </div>
902
+
903
+ </li>
904
+
905
+ </ul>
906
+
907
+
908
+
909
+
910
+ <p class="tag_title">Options Hash (<tt>options</tt>):</p>
911
+ <ul class="option">
912
+
913
+ <li>
914
+ <span class="name">:agent_id</span>
915
+ <span class="type">(<tt>agent_id</tt>)</span>
916
+ <span class="default">
917
+
918
+ </span>
919
+
920
+ </li>
921
+
922
+ <li>
923
+ <span class="name">:offset</span>
924
+ <span class="type">(<tt>offset</tt>)</span>
925
+ <span class="default">
926
+
927
+ </span>
928
+
929
+ &mdash; <div class='inline'>
930
+ <p>First element to return in the collection.</p>
931
+ </div>
932
+
933
+ </li>
934
+
935
+ <li>
936
+ <span class="name">:limit</span>
937
+ <span class="type">(<tt>limit</tt>)</span>
938
+ <span class="default">
939
+
940
+ </span>
941
+
942
+ &mdash; <div class='inline'>
943
+ <p>Maximum number of elements to return.</p>
944
+ </div>
945
+
946
+ </li>
947
+
948
+ <li>
949
+ <span class="name">:sort</span>
950
+ <span class="type">(<tt>sort</tt>)</span>
951
+ <span class="default">
952
+
953
+ </span>
954
+
955
+ &mdash; <div class='inline'>
956
+ <p>Sorts the collection by a field or fields (separated by comma). Use +/- at
957
+ the beginning to list in ascending or descending order.</p>
958
+ </div>
959
+
960
+ </li>
961
+
962
+ <li>
963
+ <span class="name">:search</span>
964
+ <span class="type">(<tt>search</tt>)</span>
965
+ <span class="default">
966
+
967
+ </span>
968
+
969
+ &mdash; <div class='inline'>
970
+ <p>Looks for elements with the specified string.</p>
971
+ </div>
972
+
973
+ </li>
974
+
975
+ <li>
976
+ <span class="name">:select</span>
977
+ <span class="type">(<tt>select</tt>)</span>
978
+ <span class="default">
979
+
980
+ </span>
981
+
982
+ &mdash; <div class='inline'>
983
+ <p>List of selected fields separated by commas.</p>
984
+ </div>
985
+
986
+ </li>
987
+
988
+ <li>
989
+ <span class="name">:iface</span>
990
+ <span class="type">(<tt>iface</tt>)</span>
991
+ <span class="default">
992
+
993
+ </span>
994
+
995
+ &mdash; <div class='inline'>
996
+ <p>Filters by interface name.</p>
997
+ </div>
998
+
999
+ </li>
1000
+
1001
+ <li>
1002
+ <span class="name">:proto</span>
1003
+ <span class="type">(<tt>proto</tt>)</span>
1004
+ <span class="default">
1005
+
1006
+ </span>
1007
+
1008
+ &mdash; <div class='inline'>
1009
+ <p>Filters by proto.</p>
1010
+ </div>
1011
+
1012
+ </li>
1013
+
1014
+ <li>
1015
+ <span class="name">:address</span>
1016
+ <span class="type">(<tt>address</tt>)</span>
1017
+ <span class="default">
1018
+
1019
+ </span>
1020
+
1021
+ &mdash; <div class='inline'>
1022
+ <p>Filters by address.</p>
1023
+ </div>
1024
+
1025
+ </li>
1026
+
1027
+ <li>
1028
+ <span class="name">:broadcast</span>
1029
+ <span class="type">(<tt>broadcast</tt>)</span>
1030
+ <span class="default">
1031
+
1032
+ </span>
1033
+
1034
+ &mdash; <div class='inline'>
1035
+ <p>Filters by broadcast.</p>
1036
+ </div>
1037
+
1038
+ </li>
1039
+
1040
+ <li>
1041
+ <span class="name">:netmask</span>
1042
+ <span class="type">(<tt>netmask</tt>)</span>
1043
+ <span class="default">
1044
+
1045
+ </span>
1046
+
1047
+ &mdash; <div class='inline'>
1048
+ <p>Filters by netmask.</p>
1049
+ </div>
1050
+
1051
+ </li>
1052
+
1053
+ </ul>
1054
+
1055
+
1056
+
1057
+ <p class="tag_title">See Also:</p>
1058
+ <ul class="see">
1059
+
1060
+ <li><a href="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-network-address-info-of-all-agents" target="_parent" title="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-network-address-info-of-all-agents">https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-network-address-info-of-all-agents</a></li>
1061
+
1062
+ </ul>
1063
+
1064
+ </div><table class="source_code">
1065
+ <tr>
1066
+ <td>
1067
+ <pre class="lines">
1068
+
1069
+
1070
+ 73
1071
+ 74
1072
+ 75</pre>
1073
+ </td>
1074
+ <td>
1075
+ <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/experimental.rb', line 73</span>
1076
+
1077
+ <span class='kw'>def</span> <span class='id identifier rubyid_experimental_netaddr'>experimental_netaddr</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>
1078
+ <span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/experimental/syscollector/netaddr</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span>
1079
+ <span class='kw'>end</span></pre>
1080
+ </td>
1081
+ </tr>
1082
+ </table>
1083
+ </div>
1084
+
1085
+ <div class="method_details ">
1086
+ <h3 class="signature " id="experimental_netiface-instance_method">
1087
+
1088
+ #<strong>experimental_netiface</strong>(options = {}) &#x21d2; <tt>Object</tt>
1089
+
1090
+
1091
+
1092
+
1093
+
1094
+ </h3><div class="docstring">
1095
+ <div class="discussion">
1096
+
1097
+ <p>Get network interface info of all agents Returns the agent’s network
1098
+ interface info.</p>
1099
+
1100
+
1101
+ </div>
1102
+ </div>
1103
+ <div class="tags">
1104
+ <p class="tag_title">Parameters:</p>
1105
+ <ul class="param">
1106
+
1107
+ <li>
1108
+
1109
+ <span class='name'>options</span>
1110
+
1111
+
1112
+ <span class='type'>(<tt>Hash</tt>)</span>
1113
+
1114
+
1115
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
1116
+
1117
+
1118
+ &mdash;
1119
+ <div class='inline'>
1120
+ <p>a customizable set of options</p>
1121
+ </div>
1122
+
1123
+ </li>
1124
+
1125
+ </ul>
1126
+
1127
+
1128
+
1129
+
1130
+ <p class="tag_title">Options Hash (<tt>options</tt>):</p>
1131
+ <ul class="option">
1132
+
1133
+ <li>
1134
+ <span class="name">:offset</span>
1135
+ <span class="type">(<tt>offset</tt>)</span>
1136
+ <span class="default">
1137
+
1138
+ </span>
1139
+
1140
+ &mdash; <div class='inline'>
1141
+ <p>First element to return in the collection.</p>
1142
+ </div>
1143
+
1144
+ </li>
1145
+
1146
+ <li>
1147
+ <span class="name">:limit</span>
1148
+ <span class="type">(<tt>limit</tt>)</span>
1149
+ <span class="default">
1150
+
1151
+ </span>
1152
+
1153
+ &mdash; <div class='inline'>
1154
+ <p>Maximum number of elements to return.</p>
1155
+ </div>
1156
+
1157
+ </li>
1158
+
1159
+ <li>
1160
+ <span class="name">:sort</span>
1161
+ <span class="type">(<tt>sort</tt>)</span>
1162
+ <span class="default">
1163
+
1164
+ </span>
1165
+
1166
+ &mdash; <div class='inline'>
1167
+ <p>Sorts the collection by a field or fields (separated by comma). Use +/- at
1168
+ the beginning to list in ascending or descending order.</p>
1169
+ </div>
1170
+
1171
+ </li>
1172
+
1173
+ <li>
1174
+ <span class="name">:search</span>
1175
+ <span class="type">(<tt>search</tt>)</span>
1176
+ <span class="default">
1177
+
1178
+ </span>
1179
+
1180
+ &mdash; <div class='inline'>
1181
+ <p>Looks for elements with the specified string.</p>
1182
+ </div>
1183
+
1184
+ </li>
1185
+
1186
+ <li>
1187
+ <span class="name">:select</span>
1188
+ <span class="type">(<tt>select</tt>)</span>
1189
+ <span class="default">
1190
+
1191
+ </span>
1192
+
1193
+ &mdash; <div class='inline'>
1194
+ <p>List of selected fields separated by commas.</p>
1195
+ </div>
1196
+
1197
+ </li>
1198
+
1199
+ <li>
1200
+ <span class="name">:name</span>
1201
+ <span class="type">(<tt>name</tt>)</span>
1202
+ <span class="default">
1203
+
1204
+ </span>
1205
+
1206
+ &mdash; <div class='inline'>
1207
+ <p>Filters by name.</p>
1208
+ </div>
1209
+
1210
+ </li>
1211
+
1212
+ <li>
1213
+ <span class="name">:adapter</span>
1214
+ <span class="type">(<tt>adapter</tt>)</span>
1215
+ <span class="default">
1216
+
1217
+ </span>
1218
+
1219
+ &mdash; <div class='inline'>
1220
+ <p>Filters by adapter.</p>
1221
+ </div>
1222
+
1223
+ </li>
1224
+
1225
+ <li>
1226
+ <span class="name">:type</span>
1227
+ <span class="type">(<tt>type</tt>)</span>
1228
+ <span class="default">
1229
+
1230
+ </span>
1231
+
1232
+ &mdash; <div class='inline'>
1233
+ <p>Filters by type.</p>
1234
+ </div>
1235
+
1236
+ </li>
1237
+
1238
+ <li>
1239
+ <span class="name">:state</span>
1240
+ <span class="type">(<tt>state</tt>)</span>
1241
+ <span class="default">
1242
+
1243
+ </span>
1244
+
1245
+ &mdash; <div class='inline'>
1246
+ <p>Filters by state.</p>
1247
+ </div>
1248
+
1249
+ </li>
1250
+
1251
+ <li>
1252
+ <span class="name">:mtu</span>
1253
+ <span class="type">(<tt>mtu</tt>)</span>
1254
+ <span class="default">
1255
+
1256
+ </span>
1257
+
1258
+ &mdash; <div class='inline'>
1259
+ <p>Filters by mtu.</p>
1260
+ </div>
1261
+
1262
+ </li>
1263
+
1264
+ <li>
1265
+ <span class="name">:tx_packets</span>
1266
+ <span class="type">(<tt>tx_packets</tt>)</span>
1267
+ <span class="default">
1268
+
1269
+ </span>
1270
+
1271
+ </li>
1272
+
1273
+ <li>
1274
+ <span class="name">:rx_packets</span>
1275
+ <span class="type">(<tt>rx_packets</tt>)</span>
1276
+ <span class="default">
1277
+
1278
+ </span>
1279
+
1280
+ </li>
1281
+
1282
+ <li>
1283
+ <span class="name">:tx_bytes</span>
1284
+ <span class="type">(<tt>tx_bytes</tt>)</span>
1285
+ <span class="default">
1286
+
1287
+ </span>
1288
+
1289
+ </li>
1290
+
1291
+ <li>
1292
+ <span class="name">:rx_bytes</span>
1293
+ <span class="type">(<tt>rx_bytes</tt>)</span>
1294
+ <span class="default">
1295
+
1296
+ </span>
1297
+
1298
+ </li>
1299
+
1300
+ <li>
1301
+ <span class="name">:tx_errors</span>
1302
+ <span class="type">(<tt>tx_errors</tt>)</span>
1303
+ <span class="default">
1304
+
1305
+ </span>
1306
+
1307
+ </li>
1308
+
1309
+ <li>
1310
+ <span class="name">:rx_errors</span>
1311
+ <span class="type">(<tt>rx_errors</tt>)</span>
1312
+ <span class="default">
1313
+
1314
+ </span>
1315
+
1316
+ </li>
1317
+
1318
+ <li>
1319
+ <span class="name">:tx_dropped</span>
1320
+ <span class="type">(<tt>tx_dropped</tt>)</span>
1321
+ <span class="default">
1322
+
1323
+ </span>
1324
+
1325
+ </li>
1326
+
1327
+ <li>
1328
+ <span class="name">:rx_dropped</span>
1329
+ <span class="type">(<tt>rx_dropped</tt>)</span>
1330
+ <span class="default">
1331
+
1332
+ </span>
1333
+
1334
+ </li>
1335
+
1336
+ </ul>
1337
+
1338
+
1339
+
1340
+ <p class="tag_title">See Also:</p>
1341
+ <ul class="see">
1342
+
1343
+ <li><a href="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-network-interface-info-of-all-agents" target="_parent" title="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-network-interface-info-of-all-agents">https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-network-interface-info-of-all-agents</a></li>
1344
+
1345
+ </ul>
1346
+
1347
+ </div><table class="source_code">
1348
+ <tr>
1349
+ <td>
1350
+ <pre class="lines">
1351
+
1352
+
1353
+ 109
1354
+ 110
1355
+ 111</pre>
1356
+ </td>
1357
+ <td>
1358
+ <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/experimental.rb', line 109</span>
1359
+
1360
+ <span class='kw'>def</span> <span class='id identifier rubyid_experimental_netiface'>experimental_netiface</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>
1361
+ <span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/experimental/syscollector/netiface</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span>
1362
+ <span class='kw'>end</span></pre>
1363
+ </td>
1364
+ </tr>
1365
+ </table>
1366
+ </div>
1367
+
1368
+ <div class="method_details ">
1369
+ <h3 class="signature " id="experimental_netproto-instance_method">
1370
+
1371
+ #<strong>experimental_netproto</strong>(options = {}) &#x21d2; <tt>Object</tt>
1372
+
1373
+
1374
+
1375
+
1376
+
1377
+ </h3><div class="docstring">
1378
+ <div class="discussion">
1379
+
1380
+ <p>Get network protocol info of all agents Returns the agent’s network
1381
+ protocol info.</p>
1382
+
1383
+
1384
+ </div>
1385
+ </div>
1386
+ <div class="tags">
1387
+ <p class="tag_title">Parameters:</p>
1388
+ <ul class="param">
1389
+
1390
+ <li>
1391
+
1392
+ <span class='name'>options</span>
1393
+
1394
+
1395
+ <span class='type'>(<tt>Hash</tt>)</span>
1396
+
1397
+
1398
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
1399
+
1400
+
1401
+ &mdash;
1402
+ <div class='inline'>
1403
+ <p>a customizable set of options</p>
1404
+ </div>
1405
+
1406
+ </li>
1407
+
1408
+ </ul>
1409
+
1410
+
1411
+
1412
+
1413
+ <p class="tag_title">Options Hash (<tt>options</tt>):</p>
1414
+ <ul class="option">
1415
+
1416
+ <li>
1417
+ <span class="name">:agent_id</span>
1418
+ <span class="type">(<tt>agent_id</tt>)</span>
1419
+ <span class="default">
1420
+
1421
+ </span>
1422
+
1423
+ </li>
1424
+
1425
+ <li>
1426
+ <span class="name">:offset</span>
1427
+ <span class="type">(<tt>offset</tt>)</span>
1428
+ <span class="default">
1429
+
1430
+ </span>
1431
+
1432
+ &mdash; <div class='inline'>
1433
+ <p>First element to return in the collection.</p>
1434
+ </div>
1435
+
1436
+ </li>
1437
+
1438
+ <li>
1439
+ <span class="name">:limit</span>
1440
+ <span class="type">(<tt>limit</tt>)</span>
1441
+ <span class="default">
1442
+
1443
+ </span>
1444
+
1445
+ &mdash; <div class='inline'>
1446
+ <p>Maximum number of elements to return.</p>
1447
+ </div>
1448
+
1449
+ </li>
1450
+
1451
+ <li>
1452
+ <span class="name">:sort</span>
1453
+ <span class="type">(<tt>sort</tt>)</span>
1454
+ <span class="default">
1455
+
1456
+ </span>
1457
+
1458
+ &mdash; <div class='inline'>
1459
+ <p>Sorts the collection by a field or fields (separated by comma). Use +/- at
1460
+ the beginning to list in ascending or descending order.</p>
1461
+ </div>
1462
+
1463
+ </li>
1464
+
1465
+ <li>
1466
+ <span class="name">:search</span>
1467
+ <span class="type">(<tt>search</tt>)</span>
1468
+ <span class="default">
1469
+
1470
+ </span>
1471
+
1472
+ &mdash; <div class='inline'>
1473
+ <p>Looks for elements with the specified string.</p>
1474
+ </div>
1475
+
1476
+ </li>
1477
+
1478
+ <li>
1479
+ <span class="name">:select</span>
1480
+ <span class="type">(<tt>select</tt>)</span>
1481
+ <span class="default">
1482
+
1483
+ </span>
1484
+
1485
+ &mdash; <div class='inline'>
1486
+ <p>List of selected fields separated by commas.</p>
1487
+ </div>
1488
+
1489
+ </li>
1490
+
1491
+ <li>
1492
+ <span class="name">:iface</span>
1493
+ <span class="type">(<tt>iface</tt>)</span>
1494
+ <span class="default">
1495
+
1496
+ </span>
1497
+
1498
+ &mdash; <div class='inline'>
1499
+ <p>Filters by interface name.</p>
1500
+ </div>
1501
+
1502
+ </li>
1503
+
1504
+ <li>
1505
+ <span class="name">:type</span>
1506
+ <span class="type">(<tt>type</tt>)</span>
1507
+ <span class="default">
1508
+
1509
+ </span>
1510
+
1511
+ &mdash; <div class='inline'>
1512
+ <p>Filters by type.</p>
1513
+ </div>
1514
+
1515
+ </li>
1516
+
1517
+ <li>
1518
+ <span class="name">:gateway</span>
1519
+ <span class="type">(<tt>gateway</tt>)</span>
1520
+ <span class="default">
1521
+
1522
+ </span>
1523
+
1524
+ &mdash; <div class='inline'>
1525
+ <p>Filters by gateway.</p>
1526
+ </div>
1527
+
1528
+ </li>
1529
+
1530
+ <li>
1531
+ <span class="name">:dhcp</span>
1532
+ <span class="type">(<tt>dhcp</tt>)</span>
1533
+ <span class="default">
1534
+
1535
+ </span>
1536
+
1537
+ &mdash; <div class='inline'>
1538
+ <p>Filters by dhcp.</p>
1539
+ </div>
1540
+
1541
+ </li>
1542
+
1543
+ </ul>
1544
+
1545
+
1546
+
1547
+ <p class="tag_title">See Also:</p>
1548
+ <ul class="see">
1549
+
1550
+ <li><a href="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-network-protocol-info-of-all-agents" target="_parent" title="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-network-protocol-info-of-all-agents">https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-network-protocol-info-of-all-agents</a></li>
1551
+
1552
+ </ul>
1553
+
1554
+ </div><table class="source_code">
1555
+ <tr>
1556
+ <td>
1557
+ <pre class="lines">
1558
+
1559
+
1560
+ 136
1561
+ 137
1562
+ 138</pre>
1563
+ </td>
1564
+ <td>
1565
+ <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/experimental.rb', line 136</span>
1566
+
1567
+ <span class='kw'>def</span> <span class='id identifier rubyid_experimental_netproto'>experimental_netproto</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>
1568
+ <span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/experimental/syscollector/netproto</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span>
1569
+ <span class='kw'>end</span></pre>
1570
+ </td>
1571
+ </tr>
1572
+ </table>
1573
+ </div>
1574
+
1575
+ <div class="method_details ">
1576
+ <h3 class="signature " id="experimental_os-instance_method">
1577
+
1578
+ #<strong>experimental_os</strong>(options = {}) &#x21d2; <tt>Object</tt>
1579
+
1580
+
1581
+
1582
+
1583
+
1584
+ </h3><div class="docstring">
1585
+ <div class="discussion">
1586
+
1587
+ <p>Get os info of all agents Returns the agent’s os info.</p>
1588
+
1589
+
1590
+ </div>
1591
+ </div>
1592
+ <div class="tags">
1593
+ <p class="tag_title">Parameters:</p>
1594
+ <ul class="param">
1595
+
1596
+ <li>
1597
+
1598
+ <span class='name'>options</span>
1599
+
1600
+
1601
+ <span class='type'>(<tt>Hash</tt>)</span>
1602
+
1603
+
1604
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
1605
+
1606
+
1607
+ &mdash;
1608
+ <div class='inline'>
1609
+ <p>a customizable set of options</p>
1610
+ </div>
1611
+
1612
+ </li>
1613
+
1614
+ </ul>
1615
+
1616
+
1617
+
1618
+
1619
+ <p class="tag_title">Options Hash (<tt>options</tt>):</p>
1620
+ <ul class="option">
1621
+
1622
+ <li>
1623
+ <span class="name">:agent_id</span>
1624
+ <span class="type">(<tt>agent_id</tt>)</span>
1625
+ <span class="default">
1626
+
1627
+ </span>
1628
+
1629
+ &mdash; <div class='inline'>
1630
+ <p>ID to agent</p>
1631
+ </div>
1632
+
1633
+ </li>
1634
+
1635
+ <li>
1636
+ <span class="name">:limit</span>
1637
+ <span class="type">(<tt>limit</tt>)</span>
1638
+ <span class="default">
1639
+
1640
+ </span>
1641
+
1642
+ &mdash; <div class='inline'>
1643
+ <p>Maximum number of elements to return.</p>
1644
+ </div>
1645
+
1646
+ </li>
1647
+
1648
+ <li>
1649
+ <span class="name">:sort</span>
1650
+ <span class="type">(<tt>sort</tt>)</span>
1651
+ <span class="default">
1652
+
1653
+ </span>
1654
+
1655
+ &mdash; <div class='inline'>
1656
+ <p>Sorts the collection by a field or fields (separated by comma). Use +/- at
1657
+ the beginning to list in ascending or descending order.</p>
1658
+ </div>
1659
+
1660
+ </li>
1661
+
1662
+ <li>
1663
+ <span class="name">:search</span>
1664
+ <span class="type">(<tt>search</tt>)</span>
1665
+ <span class="default">
1666
+
1667
+ </span>
1668
+
1669
+ &mdash; <div class='inline'>
1670
+ <p>Looks for elements with the specified string.</p>
1671
+ </div>
1672
+
1673
+ </li>
1674
+
1675
+ <li>
1676
+ <span class="name">:offset</span>
1677
+ <span class="type">(<tt>offset</tt>)</span>
1678
+ <span class="default">
1679
+
1680
+ </span>
1681
+
1682
+ &mdash; <div class='inline'>
1683
+ <p>First element to return in the collection.</p>
1684
+ </div>
1685
+
1686
+ </li>
1687
+
1688
+ <li>
1689
+ <span class="name">:select</span>
1690
+ <span class="type">(<tt>select</tt>)</span>
1691
+ <span class="default">
1692
+
1693
+ </span>
1694
+
1695
+ &mdash; <div class='inline'>
1696
+ <p>List of selected fields separated by commas.</p>
1697
+ </div>
1698
+
1699
+ </li>
1700
+
1701
+ <li>
1702
+ <span class="name">:os_name</span>
1703
+ <span class="type">(<tt>os_name</tt>)</span>
1704
+ <span class="default">
1705
+
1706
+ </span>
1707
+
1708
+ &mdash; <div class='inline'>
1709
+ <p>Filters by os_name.</p>
1710
+ </div>
1711
+
1712
+ </li>
1713
+
1714
+ <li>
1715
+ <span class="name">:architecture</span>
1716
+ <span class="type">(<tt>architecture</tt>)</span>
1717
+ <span class="default">
1718
+
1719
+ </span>
1720
+
1721
+ &mdash; <div class='inline'>
1722
+ <p>Filters by architecture.</p>
1723
+ </div>
1724
+
1725
+ </li>
1726
+
1727
+ <li>
1728
+ <span class="name">:os_version</span>
1729
+ <span class="type">(<tt>os_version</tt>)</span>
1730
+ <span class="default">
1731
+
1732
+ </span>
1733
+
1734
+ &mdash; <div class='inline'>
1735
+ <p>Filters by os_version.</p>
1736
+ </div>
1737
+
1738
+ </li>
1739
+
1740
+ <li>
1741
+ <span class="name">:version</span>
1742
+ <span class="type">(<tt>version</tt>)</span>
1743
+ <span class="default">
1744
+
1745
+ </span>
1746
+
1747
+ &mdash; <div class='inline'>
1748
+ <p>Filters by version.</p>
1749
+ </div>
1750
+
1751
+ </li>
1752
+
1753
+ <li>
1754
+ <span class="name">:release</span>
1755
+ <span class="type">(<tt>release</tt>)</span>
1756
+ <span class="default">
1757
+
1758
+ </span>
1759
+
1760
+ &mdash; <div class='inline'>
1761
+ <p>Filters by release.</p>
1762
+ </div>
1763
+
1764
+ </li>
1765
+
1766
+ </ul>
1767
+
1768
+
1769
+
1770
+ <p class="tag_title">See Also:</p>
1771
+ <ul class="see">
1772
+
1773
+ <li><a href="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-os-info-of-all-agents" target="_parent" title="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-os-info-of-all-agents">https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-os-info-of-all-agents</a></li>
1774
+
1775
+ </ul>
1776
+
1777
+ </div><table class="source_code">
1778
+ <tr>
1779
+ <td>
1780
+ <pre class="lines">
1781
+
1782
+
1783
+ 166
1784
+ 167
1785
+ 168</pre>
1786
+ </td>
1787
+ <td>
1788
+ <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/experimental.rb', line 166</span>
1789
+
1790
+ <span class='kw'>def</span> <span class='id identifier rubyid_experimental_os'>experimental_os</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>
1791
+ <span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/experimentalsyscollector/os</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span>
1792
+ <span class='kw'>end</span></pre>
1793
+ </td>
1794
+ </tr>
1795
+ </table>
1796
+ </div>
1797
+
1798
+ <div class="method_details ">
1799
+ <h3 class="signature " id="experimental_packages-instance_method">
1800
+
1801
+ #<strong>experimental_packages</strong>(options = {}) &#x21d2; <tt>Object</tt>
1802
+
1803
+
1804
+
1805
+
1806
+
1807
+ </h3><div class="docstring">
1808
+ <div class="discussion">
1809
+
1810
+ <p>Get packages info of all agents Returns the agent’s packages info.</p>
1811
+
1812
+
1813
+ </div>
1814
+ </div>
1815
+ <div class="tags">
1816
+ <p class="tag_title">Parameters:</p>
1817
+ <ul class="param">
1818
+
1819
+ <li>
1820
+
1821
+ <span class='name'>options</span>
1822
+
1823
+
1824
+ <span class='type'>(<tt>Hash</tt>)</span>
1825
+
1826
+
1827
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
1828
+
1829
+
1830
+ &mdash;
1831
+ <div class='inline'>
1832
+ <p>a customizable set of options</p>
1833
+ </div>
1834
+
1835
+ </li>
1836
+
1837
+ </ul>
1838
+
1839
+
1840
+
1841
+
1842
+ <p class="tag_title">Options Hash (<tt>options</tt>):</p>
1843
+ <ul class="option">
1844
+
1845
+ <li>
1846
+ <span class="name">:agent_id</span>
1847
+ <span class="type">(<tt>agent_id</tt>)</span>
1848
+ <span class="default">
1849
+
1850
+ </span>
1851
+
1852
+ </li>
1853
+
1854
+ <li>
1855
+ <span class="name">:offset</span>
1856
+ <span class="type">(<tt>offset</tt>)</span>
1857
+ <span class="default">
1858
+
1859
+ </span>
1860
+
1861
+ &mdash; <div class='inline'>
1862
+ <p>First element to return in the collection.</p>
1863
+ </div>
1864
+
1865
+ </li>
1866
+
1867
+ <li>
1868
+ <span class="name">:limit</span>
1869
+ <span class="type">(<tt>limit</tt>)</span>
1870
+ <span class="default">
1871
+
1872
+ </span>
1873
+
1874
+ &mdash; <div class='inline'>
1875
+ <p>Maximum number of elements to return.</p>
1876
+ </div>
1877
+
1878
+ </li>
1879
+
1880
+ <li>
1881
+ <span class="name">:sort</span>
1882
+ <span class="type">(<tt>sort</tt>)</span>
1883
+ <span class="default">
1884
+
1885
+ </span>
1886
+
1887
+ &mdash; <div class='inline'>
1888
+ <p>Sorts the collection by a field or fields (separated by comma). Use +/- at
1889
+ the beginning to list in ascending or descending order.</p>
1890
+ </div>
1891
+
1892
+ </li>
1893
+
1894
+ <li>
1895
+ <span class="name">:search</span>
1896
+ <span class="type">(<tt>search</tt>)</span>
1897
+ <span class="default">
1898
+
1899
+ </span>
1900
+
1901
+ &mdash; <div class='inline'>
1902
+ <p>Looks for elements with the specified string.</p>
1903
+ </div>
1904
+
1905
+ </li>
1906
+
1907
+ <li>
1908
+ <span class="name">:select</span>
1909
+ <span class="type">(<tt>select</tt>)</span>
1910
+ <span class="default">
1911
+
1912
+ </span>
1913
+
1914
+ &mdash; <div class='inline'>
1915
+ <p>List of selected fields separated by commas.</p>
1916
+ </div>
1917
+
1918
+ </li>
1919
+
1920
+ <li>
1921
+ <span class="name">:vendor</span>
1922
+ <span class="type">(<tt>vendor</tt>)</span>
1923
+ <span class="default">
1924
+
1925
+ </span>
1926
+
1927
+ &mdash; <div class='inline'>
1928
+ <p>Filters by vendor.</p>
1929
+ </div>
1930
+
1931
+ </li>
1932
+
1933
+ <li>
1934
+ <span class="name">:name</span>
1935
+ <span class="type">(<tt>name</tt>)</span>
1936
+ <span class="default">
1937
+
1938
+ </span>
1939
+
1940
+ &mdash; <div class='inline'>
1941
+ <p>Filters by name.</p>
1942
+ </div>
1943
+
1944
+ </li>
1945
+
1946
+ <li>
1947
+ <span class="name">:architecture</span>
1948
+ <span class="type">(<tt>architecture</tt>)</span>
1949
+ <span class="default">
1950
+
1951
+ </span>
1952
+
1953
+ &mdash; <div class='inline'>
1954
+ <p>Filters by architecture.</p>
1955
+ </div>
1956
+
1957
+ </li>
1958
+
1959
+ <li>
1960
+ <span class="name">:format</span>
1961
+ <span class="type">(<tt>format</tt>)</span>
1962
+ <span class="default">
1963
+
1964
+ </span>
1965
+
1966
+ &mdash; <div class='inline'>
1967
+ <p>Filters by format.</p>
1968
+ </div>
1969
+
1970
+ </li>
1971
+
1972
+ <li>
1973
+ <span class="name">:version</span>
1974
+ <span class="type">(<tt>version</tt>)</span>
1975
+ <span class="default">
1976
+
1977
+ </span>
1978
+
1979
+ &mdash; <div class='inline'>
1980
+ <p>Filters by format.</p>
1981
+ </div>
1982
+
1983
+ </li>
1984
+
1985
+ </ul>
1986
+
1987
+
1988
+
1989
+ <p class="tag_title">See Also:</p>
1990
+ <ul class="see">
1991
+
1992
+ <li><a href="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-packages-info-of-all-agents" target="_parent" title="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-packages-info-of-all-agents">https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-packages-info-of-all-agents</a></li>
1993
+
1994
+ </ul>
1995
+
1996
+ </div><table class="source_code">
1997
+ <tr>
1998
+ <td>
1999
+ <pre class="lines">
2000
+
2001
+
2002
+ 195
2003
+ 196
2004
+ 197</pre>
2005
+ </td>
2006
+ <td>
2007
+ <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/experimental.rb', line 195</span>
2008
+
2009
+ <span class='kw'>def</span> <span class='id identifier rubyid_experimental_packages'>experimental_packages</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>
2010
+ <span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/experimental/syscollector/packages</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span>
2011
+ <span class='kw'>end</span></pre>
2012
+ </td>
2013
+ </tr>
2014
+ </table>
2015
+ </div>
2016
+
2017
+ <div class="method_details ">
2018
+ <h3 class="signature " id="experimental_ports-instance_method">
2019
+
2020
+ #<strong>experimental_ports</strong>(options = {}) &#x21d2; <tt>Object</tt>
2021
+
2022
+
2023
+
2024
+
2025
+
2026
+ </h3><div class="docstring">
2027
+ <div class="discussion">
2028
+
2029
+ <p>Get ports info of all agents Returns the agent’s ports info.</p>
2030
+
2031
+
2032
+ </div>
2033
+ </div>
2034
+ <div class="tags">
2035
+ <p class="tag_title">Parameters:</p>
2036
+ <ul class="param">
2037
+
2038
+ <li>
2039
+
2040
+ <span class='name'>options</span>
2041
+
2042
+
2043
+ <span class='type'>(<tt>Hash</tt>)</span>
2044
+
2045
+
2046
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
2047
+
2048
+
2049
+ &mdash;
2050
+ <div class='inline'>
2051
+ <p>a customizable set of options</p>
2052
+ </div>
2053
+
2054
+ </li>
2055
+
2056
+ </ul>
2057
+
2058
+
2059
+
2060
+
2061
+ <p class="tag_title">Options Hash (<tt>options</tt>):</p>
2062
+ <ul class="option">
2063
+
2064
+ <li>
2065
+ <span class="name">:agent_id</span>
2066
+ <span class="type">(<tt>agent_id</tt>)</span>
2067
+ <span class="default">
2068
+
2069
+ </span>
2070
+
2071
+ </li>
2072
+
2073
+ <li>
2074
+ <span class="name">:offset</span>
2075
+ <span class="type">(<tt>offset</tt>)</span>
2076
+ <span class="default">
2077
+
2078
+ </span>
2079
+
2080
+ &mdash; <div class='inline'>
2081
+ <p>First element to return in the collection.</p>
2082
+ </div>
2083
+
2084
+ </li>
2085
+
2086
+ <li>
2087
+ <span class="name">:limit</span>
2088
+ <span class="type">(<tt>limit</tt>)</span>
2089
+ <span class="default">
2090
+
2091
+ </span>
2092
+
2093
+ &mdash; <div class='inline'>
2094
+ <p>Maximum number of elements to return.</p>
2095
+ </div>
2096
+
2097
+ </li>
2098
+
2099
+ <li>
2100
+ <span class="name">:sort</span>
2101
+ <span class="type">(<tt>sort</tt>)</span>
2102
+ <span class="default">
2103
+
2104
+ </span>
2105
+
2106
+ &mdash; <div class='inline'>
2107
+ <p>Sorts the collection by a field or fields (separated by comma). Use +/- at
2108
+ the beginning to list in ascending or descending order.</p>
2109
+ </div>
2110
+
2111
+ </li>
2112
+
2113
+ <li>
2114
+ <span class="name">:search</span>
2115
+ <span class="type">(<tt>search</tt>)</span>
2116
+ <span class="default">
2117
+
2118
+ </span>
2119
+
2120
+ &mdash; <div class='inline'>
2121
+ <p>Looks for elements with the specified string.</p>
2122
+ </div>
2123
+
2124
+ </li>
2125
+
2126
+ <li>
2127
+ <span class="name">:select</span>
2128
+ <span class="type">(<tt>select</tt>)</span>
2129
+ <span class="default">
2130
+
2131
+ </span>
2132
+
2133
+ &mdash; <div class='inline'>
2134
+ <p>List of selected fields separated by commas.</p>
2135
+ </div>
2136
+
2137
+ </li>
2138
+
2139
+ <li>
2140
+ <span class="name">:pid</span>
2141
+ <span class="type">(<tt>pid</tt>)</span>
2142
+ <span class="default">
2143
+
2144
+ </span>
2145
+
2146
+ &mdash; <div class='inline'>
2147
+ <p>Filters by pid.</p>
2148
+ </div>
2149
+
2150
+ </li>
2151
+
2152
+ <li>
2153
+ <span class="name">:protocol</span>
2154
+ <span class="type">(<tt>protocol</tt>)</span>
2155
+ <span class="default">
2156
+
2157
+ </span>
2158
+
2159
+ &mdash; <div class='inline'>
2160
+ <p>Filters by protocol.</p>
2161
+ </div>
2162
+
2163
+ </li>
2164
+
2165
+ <li>
2166
+ <span class="name">:local_ip</span>
2167
+ <span class="type">(<tt>local_ip</tt>)</span>
2168
+ <span class="default">
2169
+
2170
+ </span>
2171
+
2172
+ &mdash; <div class='inline'>
2173
+ <p>Filters by local_ip.</p>
2174
+ </div>
2175
+
2176
+ </li>
2177
+
2178
+ <li>
2179
+ <span class="name">:local_port</span>
2180
+ <span class="type">(<tt>local_port</tt>)</span>
2181
+ <span class="default">
2182
+
2183
+ </span>
2184
+
2185
+ &mdash; <div class='inline'>
2186
+ <p>Filters by local_port.</p>
2187
+ </div>
2188
+
2189
+ </li>
2190
+
2191
+ <li>
2192
+ <span class="name">:remote_ip</span>
2193
+ <span class="type">(<tt>remote_ip</tt>)</span>
2194
+ <span class="default">
2195
+
2196
+ </span>
2197
+
2198
+ &mdash; <div class='inline'>
2199
+ <p>Filters by remote_ip.</p>
2200
+ </div>
2201
+
2202
+ </li>
2203
+
2204
+ <li>
2205
+ <span class="name">:tx_queue</span>
2206
+ <span class="type">(<tt>tx_queue</tt>)</span>
2207
+ <span class="default">
2208
+
2209
+ </span>
2210
+
2211
+ &mdash; <div class='inline'>
2212
+ <p>Filters by tx_queue.</p>
2213
+ </div>
2214
+
2215
+ </li>
2216
+
2217
+ <li>
2218
+ <span class="name">:state</span>
2219
+ <span class="type">(<tt>state</tt>)</span>
2220
+ <span class="default">
2221
+
2222
+ </span>
2223
+
2224
+ &mdash; <div class='inline'>
2225
+ <p>Filters by state.</p>
2226
+ </div>
2227
+
2228
+ </li>
2229
+
2230
+ </ul>
2231
+
2232
+
2233
+
2234
+ <p class="tag_title">See Also:</p>
2235
+ <ul class="see">
2236
+
2237
+ <li><a href="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-ports-info-of-all-agents" target="_parent" title="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-ports-info-of-all-agents">https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-ports-info-of-all-agents</a></li>
2238
+
2239
+ </ul>
2240
+
2241
+ </div><table class="source_code">
2242
+ <tr>
2243
+ <td>
2244
+ <pre class="lines">
2245
+
2246
+
2247
+ 228
2248
+ 229
2249
+ 230</pre>
2250
+ </td>
2251
+ <td>
2252
+ <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/experimental.rb', line 228</span>
2253
+
2254
+ <span class='kw'>def</span> <span class='id identifier rubyid_experimental_ports'>experimental_ports</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>
2255
+ <span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/experimental/syscollector/ports</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span>
2256
+ <span class='kw'>end</span></pre>
2257
+ </td>
2258
+ </tr>
2259
+ </table>
2260
+ </div>
2261
+
2262
+ <div class="method_details ">
2263
+ <h3 class="signature " id="experimental_processes-instance_method">
2264
+
2265
+ #<strong>experimental_processes</strong>(options = {}) &#x21d2; <tt>Object</tt>
2266
+
2267
+
2268
+
2269
+
2270
+
2271
+ </h3><div class="docstring">
2272
+ <div class="discussion">
2273
+
2274
+ <p>Get processes info of all agents Returns the agent’s processes info.</p>
2275
+
2276
+
2277
+ </div>
2278
+ </div>
2279
+ <div class="tags">
2280
+ <p class="tag_title">Parameters:</p>
2281
+ <ul class="param">
2282
+
2283
+ <li>
2284
+
2285
+ <span class='name'>options</span>
2286
+
2287
+
2288
+ <span class='type'>(<tt>Hash</tt>)</span>
2289
+
2290
+
2291
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
2292
+
2293
+
2294
+ &mdash;
2295
+ <div class='inline'>
2296
+ <p>a customizable set of options</p>
2297
+ </div>
2298
+
2299
+ </li>
2300
+
2301
+ </ul>
2302
+
2303
+
2304
+
2305
+
2306
+ <p class="tag_title">Options Hash (<tt>options</tt>):</p>
2307
+ <ul class="option">
2308
+
2309
+ <li>
2310
+ <span class="name">:agent_id</span>
2311
+ <span class="type">(<tt>agent_id</tt>)</span>
2312
+ <span class="default">
2313
+
2314
+ </span>
2315
+
2316
+ </li>
2317
+
2318
+ <li>
2319
+ <span class="name">:offset</span>
2320
+ <span class="type">(<tt>offset</tt>)</span>
2321
+ <span class="default">
2322
+
2323
+ </span>
2324
+
2325
+ &mdash; <div class='inline'>
2326
+ <p>First element to return in the collection.</p>
2327
+ </div>
2328
+
2329
+ </li>
2330
+
2331
+ <li>
2332
+ <span class="name">:limit</span>
2333
+ <span class="type">(<tt>limit</tt>)</span>
2334
+ <span class="default">
2335
+
2336
+ </span>
2337
+
2338
+ &mdash; <div class='inline'>
2339
+ <p>Maximum number of elements to return.</p>
2340
+ </div>
2341
+
2342
+ </li>
2343
+
2344
+ <li>
2345
+ <span class="name">:sort</span>
2346
+ <span class="type">(<tt>sort</tt>)</span>
2347
+ <span class="default">
2348
+
2349
+ </span>
2350
+
2351
+ &mdash; <div class='inline'>
2352
+ <p>Sorts the collection by a field or fields (separated by comma). Use +/- at
2353
+ the beginning to list in ascending or descending order.</p>
2354
+ </div>
2355
+
2356
+ </li>
2357
+
2358
+ <li>
2359
+ <span class="name">:search</span>
2360
+ <span class="type">(<tt>search</tt>)</span>
2361
+ <span class="default">
2362
+
2363
+ </span>
2364
+
2365
+ &mdash; <div class='inline'>
2366
+ <p>Looks for elements with the specified string.</p>
2367
+ </div>
2368
+
2369
+ </li>
2370
+
2371
+ <li>
2372
+ <span class="name">:select</span>
2373
+ <span class="type">(<tt>select</tt>)</span>
2374
+ <span class="default">
2375
+
2376
+ </span>
2377
+
2378
+ &mdash; <div class='inline'>
2379
+ <p>List of selected fields separated by commas.</p>
2380
+ </div>
2381
+
2382
+ </li>
2383
+
2384
+ <li>
2385
+ <span class="name">:pid</span>
2386
+ <span class="type">(<tt>pid</tt>)</span>
2387
+ <span class="default">
2388
+
2389
+ </span>
2390
+
2391
+ &mdash; <div class='inline'>
2392
+ <p>Filters by pid.</p>
2393
+ </div>
2394
+
2395
+ </li>
2396
+
2397
+ <li>
2398
+ <span class="name">:state</span>
2399
+ <span class="type">(<tt>state</tt>)</span>
2400
+ <span class="default">
2401
+
2402
+ </span>
2403
+
2404
+ &mdash; <div class='inline'>
2405
+ <p>Filters by process state.</p>
2406
+ </div>
2407
+
2408
+ </li>
2409
+
2410
+ <li>
2411
+ <span class="name">:ppid</span>
2412
+ <span class="type">(<tt>ppid</tt>)</span>
2413
+ <span class="default">
2414
+
2415
+ </span>
2416
+
2417
+ &mdash; <div class='inline'>
2418
+ <p>Filters by process parent pid.</p>
2419
+ </div>
2420
+
2421
+ </li>
2422
+
2423
+ <li>
2424
+ <span class="name">:egroup</span>
2425
+ <span class="type">(<tt>egroup</tt>)</span>
2426
+ <span class="default">
2427
+
2428
+ </span>
2429
+
2430
+ &mdash; <div class='inline'>
2431
+ <p>Filters by process egroup.</p>
2432
+ </div>
2433
+
2434
+ </li>
2435
+
2436
+ <li>
2437
+ <span class="name">:euser</span>
2438
+ <span class="type">(<tt>euser</tt>)</span>
2439
+ <span class="default">
2440
+
2441
+ </span>
2442
+
2443
+ &mdash; <div class='inline'>
2444
+ <p>Filters by process euser.</p>
2445
+ </div>
2446
+
2447
+ </li>
2448
+
2449
+ <li>
2450
+ <span class="name">:fgroup</span>
2451
+ <span class="type">(<tt>fgroup</tt>)</span>
2452
+ <span class="default">
2453
+
2454
+ </span>
2455
+
2456
+ &mdash; <div class='inline'>
2457
+ <p>Filters by process fgroup.</p>
2458
+ </div>
2459
+
2460
+ </li>
2461
+
2462
+ <li>
2463
+ <span class="name">:name</span>
2464
+ <span class="type">(<tt>name</tt>)</span>
2465
+ <span class="default">
2466
+
2467
+ </span>
2468
+
2469
+ &mdash; <div class='inline'>
2470
+ <p>Filters by process name.</p>
2471
+ </div>
2472
+
2473
+ </li>
2474
+
2475
+ <li>
2476
+ <span class="name">:nlwp</span>
2477
+ <span class="type">(<tt>nlwp</tt>)</span>
2478
+ <span class="default">
2479
+
2480
+ </span>
2481
+
2482
+ &mdash; <div class='inline'>
2483
+ <p>Filters by process nlwp.</p>
2484
+ </div>
2485
+
2486
+ </li>
2487
+
2488
+ <li>
2489
+ <span class="name">:pgrp</span>
2490
+ <span class="type">(<tt>pgrp</tt>)</span>
2491
+ <span class="default">
2492
+
2493
+ </span>
2494
+
2495
+ &mdash; <div class='inline'>
2496
+ <p>Filters by process pgrp.</p>
2497
+ </div>
2498
+
2499
+ </li>
2500
+
2501
+ <li>
2502
+ <span class="name">:priority</span>
2503
+ <span class="type">(<tt>priority</tt>)</span>
2504
+ <span class="default">
2505
+
2506
+ </span>
2507
+
2508
+ &mdash; <div class='inline'>
2509
+ <p>Filters by process priority.</p>
2510
+ </div>
2511
+
2512
+ </li>
2513
+
2514
+ <li>
2515
+ <span class="name">:rgroup</span>
2516
+ <span class="type">(<tt>rgroup</tt>)</span>
2517
+ <span class="default">
2518
+
2519
+ </span>
2520
+
2521
+ &mdash; <div class='inline'>
2522
+ <p>Filters by process rgroup.</p>
2523
+ </div>
2524
+
2525
+ </li>
2526
+
2527
+ <li>
2528
+ <span class="name">:ruser</span>
2529
+ <span class="type">(<tt>ruser</tt>)</span>
2530
+ <span class="default">
2531
+
2532
+ </span>
2533
+
2534
+ &mdash; <div class='inline'>
2535
+ <p>Filters by process ruser.</p>
2536
+ </div>
2537
+
2538
+ </li>
2539
+
2540
+ <li>
2541
+ <span class="name">:sgroup</span>
2542
+ <span class="type">(<tt>sgroup</tt>)</span>
2543
+ <span class="default">
2544
+
2545
+ </span>
2546
+
2547
+ &mdash; <div class='inline'>
2548
+ <p>Filters by process sgroup.</p>
2549
+ </div>
2550
+
2551
+ </li>
2552
+
2553
+ <li>
2554
+ <span class="name">:suser</span>
2555
+ <span class="type">(<tt>suser</tt>)</span>
2556
+ <span class="default">
2557
+
2558
+ </span>
2559
+
2560
+ &mdash; <div class='inline'>
2561
+ <p>Filters by process suser.</p>
2562
+ </div>
2563
+
2564
+ </li>
2565
+
2566
+ </ul>
2567
+
2568
+
2569
+
2570
+ <p class="tag_title">See Also:</p>
2571
+ <ul class="see">
2572
+
2573
+ <li><a href="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-processes-info-of-all-agents" target="_parent" title="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-processes-info-of-all-agents">https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-processes-info-of-all-agents</a></li>
2574
+
2575
+ </ul>
2576
+
2577
+ </div><table class="source_code">
2578
+ <tr>
2579
+ <td>
2580
+ <pre class="lines">
2581
+
2582
+
2583
+ 275
2584
+ 276
2585
+ 277</pre>
2586
+ </td>
2587
+ <td>
2588
+ <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/experimental.rb', line 275</span>
2589
+
2590
+ <span class='kw'>def</span> <span class='id identifier rubyid_experimental_processes'>experimental_processes</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>
2591
+ <span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/experimental/syscollector/processes</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span>
2592
+ <span class='kw'>end</span></pre>
2593
+ </td>
2594
+ </tr>
2595
+ </table>
2596
+ </div>
2597
+
2598
+ </div>
2599
+
2600
+ </div>
2601
+
2602
+ <div id="footer">
2603
+ Generated on Sat Jan 25 00:19:41 2020 by
2604
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
2605
+ 0.9.16 (ruby-2.5.1).
2606
+ </div>
2607
+
2608
+ </div>
2609
+ </body>
2610
+ </html>