wazuh-ruby-client 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
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/Syscollector.html ADDED
@@ -0,0 +1,2069 @@
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::Syscollector
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::Syscollector";
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 (S)</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">Syscollector</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::Syscollector
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/syscollector.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="#hardware-instance_method" title="#hardware (instance method)">#<strong>hardware</strong>(agent_id, 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>Returns the agent’s hardware info.</p>
125
+ </div></span>
126
+
127
+ </li>
128
+
129
+
130
+ <li class="public ">
131
+ <span class="summary_signature">
132
+
133
+ <a href="#netaddr-instance_method" title="#netaddr (instance method)">#<strong>netaddr</strong>(agent_id, 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>Returns the agent’s network address info.</p>
149
+ </div></span>
150
+
151
+ </li>
152
+
153
+
154
+ <li class="public ">
155
+ <span class="summary_signature">
156
+
157
+ <a href="#netiface-instance_method" title="#netiface (instance method)">#<strong>netiface</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 the agent’s network interface info.</p>
173
+ </div></span>
174
+
175
+ </li>
176
+
177
+
178
+ <li class="public ">
179
+ <span class="summary_signature">
180
+
181
+ <a href="#netproto-instance_method" title="#netproto (instance method)">#<strong>netproto</strong>(agent_id, 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 the agent’s network protocol info.</p>
197
+ </div></span>
198
+
199
+ </li>
200
+
201
+
202
+ <li class="public ">
203
+ <span class="summary_signature">
204
+
205
+ <a href="#os-instance_method" title="#os (instance method)">#<strong>os</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 agent’s OS info.</p>
221
+ </div></span>
222
+
223
+ </li>
224
+
225
+
226
+ <li class="public ">
227
+ <span class="summary_signature">
228
+
229
+ <a href="#packages-instance_method" title="#packages (instance method)">#<strong>packages</strong>(agent_id, 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 the agent’s packages info.</p>
245
+ </div></span>
246
+
247
+ </li>
248
+
249
+
250
+ <li class="public ">
251
+ <span class="summary_signature">
252
+
253
+ <a href="#ports-instance_method" title="#ports (instance method)">#<strong>ports</strong>(agent_id, 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>Get ports info of an agent Returns the agent’s ports info.</p>
269
+ </div></span>
270
+
271
+ </li>
272
+
273
+
274
+ <li class="public ">
275
+ <span class="summary_signature">
276
+
277
+ <a href="#processes-instance_method" title="#processes (instance method)">#<strong>processes</strong>(agent_id, options = {}) &#x21d2; Object </a>
278
+
279
+
280
+
281
+ </span>
282
+
283
+
284
+
285
+
286
+
287
+
288
+
289
+
290
+
291
+ <span class="summary_desc"><div class='inline'>
292
+ <p>Get processes info Returns the agent&#39;s processes info.</p>
293
+ </div></span>
294
+
295
+ </li>
296
+
297
+
298
+ </ul>
299
+
300
+
301
+
302
+
303
+ <div id="instance_method_details" class="method_details_list">
304
+ <h2>Instance Method Details</h2>
305
+
306
+
307
+ <div class="method_details first">
308
+ <h3 class="signature first" id="hardware-instance_method">
309
+
310
+ #<strong>hardware</strong>(agent_id, options = {}) &#x21d2; <tt>Object</tt>
311
+
312
+
313
+
314
+
315
+
316
+ </h3><div class="docstring">
317
+ <div class="discussion">
318
+
319
+ <p>Returns the agent’s hardware info.</p>
320
+
321
+
322
+ </div>
323
+ </div>
324
+ <div class="tags">
325
+ <p class="tag_title">Parameters:</p>
326
+ <ul class="param">
327
+
328
+ <li>
329
+
330
+ <span class='name'>agent_id</span>
331
+
332
+
333
+ <span class='type'>(<tt>String</tt>)</span>
334
+
335
+
336
+
337
+ </li>
338
+
339
+ <li>
340
+
341
+ <span class='name'>options</span>
342
+
343
+
344
+ <span class='type'>(<tt>Hash</tt>)</span>
345
+
346
+
347
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
348
+
349
+
350
+ &mdash;
351
+ <div class='inline'>
352
+ <p>a customizable set of options</p>
353
+ </div>
354
+
355
+ </li>
356
+
357
+ </ul>
358
+
359
+
360
+
361
+
362
+
363
+
364
+ <p class="tag_title">Options Hash (<tt>options</tt>):</p>
365
+ <ul class="option">
366
+
367
+ <li>
368
+ <span class="name">:select</span>
369
+ <span class="type">(<tt>select</tt>)</span>
370
+ <span class="default">
371
+
372
+ </span>
373
+
374
+ &mdash; <div class='inline'>
375
+ <p>List of selected fields separated by commas.</p>
376
+ </div>
377
+
378
+ </li>
379
+
380
+ </ul>
381
+
382
+
383
+
384
+ <p class="tag_title">See Also:</p>
385
+ <ul class="see">
386
+
387
+ <li><a href="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-hardware-info" target="_parent" title="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-hardware-info">https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-hardware-info</a></li>
388
+
389
+ </ul>
390
+
391
+ </div><table class="source_code">
392
+ <tr>
393
+ <td>
394
+ <pre class="lines">
395
+
396
+
397
+ 12
398
+ 13
399
+ 14</pre>
400
+ </td>
401
+ <td>
402
+ <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/syscollector.rb', line 12</span>
403
+
404
+ <span class='kw'>def</span> <span class='id identifier rubyid_hardware'>hardware</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>
405
+ <span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/syscollector/</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'>/hardware</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span>
406
+ <span class='kw'>end</span></pre>
407
+ </td>
408
+ </tr>
409
+ </table>
410
+ </div>
411
+
412
+ <div class="method_details ">
413
+ <h3 class="signature " id="netaddr-instance_method">
414
+
415
+ #<strong>netaddr</strong>(agent_id, options = {}) &#x21d2; <tt>Object</tt>
416
+
417
+
418
+
419
+
420
+
421
+ </h3><div class="docstring">
422
+ <div class="discussion">
423
+
424
+ <p>Returns the agent’s network address info.</p>
425
+
426
+
427
+ </div>
428
+ </div>
429
+ <div class="tags">
430
+ <p class="tag_title">Parameters:</p>
431
+ <ul class="param">
432
+
433
+ <li>
434
+
435
+ <span class='name'>agent_id</span>
436
+
437
+
438
+ <span class='type'>(<tt>String</tt>)</span>
439
+
440
+
441
+
442
+ </li>
443
+
444
+ <li>
445
+
446
+ <span class='name'>options</span>
447
+
448
+
449
+ <span class='type'>(<tt>Hash</tt>)</span>
450
+
451
+
452
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
453
+
454
+
455
+ &mdash;
456
+ <div class='inline'>
457
+ <p>a customizable set of options</p>
458
+ </div>
459
+
460
+ </li>
461
+
462
+ </ul>
463
+
464
+
465
+
466
+
467
+
468
+
469
+ <p class="tag_title">Options Hash (<tt>options</tt>):</p>
470
+ <ul class="option">
471
+
472
+ <li>
473
+ <span class="name">:offset</span>
474
+ <span class="type">(<tt>offset</tt>)</span>
475
+ <span class="default">
476
+
477
+ </span>
478
+
479
+ &mdash; <div class='inline'>
480
+ <p>First element to return in the collection.</p>
481
+ </div>
482
+
483
+ </li>
484
+
485
+ <li>
486
+ <span class="name">:limit</span>
487
+ <span class="type">(<tt>limit</tt>)</span>
488
+ <span class="default">
489
+
490
+ </span>
491
+
492
+ &mdash; <div class='inline'>
493
+ <p>Maximum number of elements to return.</p>
494
+ </div>
495
+
496
+ </li>
497
+
498
+ <li>
499
+ <span class="name">:sort</span>
500
+ <span class="type">(<tt>sort</tt>)</span>
501
+ <span class="default">
502
+
503
+ </span>
504
+
505
+ &mdash; <div class='inline'>
506
+ <p>Sorts the collection by a field or fields (separated by comma). Use +/- at
507
+ the beginning to list in ascending or descending order.</p>
508
+ </div>
509
+
510
+ </li>
511
+
512
+ <li>
513
+ <span class="name">:search</span>
514
+ <span class="type">(<tt>search</tt>)</span>
515
+ <span class="default">
516
+
517
+ </span>
518
+
519
+ &mdash; <div class='inline'>
520
+ <p>Looks for elements with the specified string.</p>
521
+ </div>
522
+
523
+ </li>
524
+
525
+ <li>
526
+ <span class="name">:select</span>
527
+ <span class="type">(<tt>select</tt>)</span>
528
+ <span class="default">
529
+
530
+ </span>
531
+
532
+ &mdash; <div class='inline'>
533
+ <p>List of selected fields separated by commas.</p>
534
+ </div>
535
+
536
+ </li>
537
+
538
+ <li>
539
+ <span class="name">:iface</span>
540
+ <span class="type">(<tt>iface</tt>)</span>
541
+ <span class="default">
542
+
543
+ </span>
544
+
545
+ &mdash; <div class='inline'>
546
+ <p>Filters by interface name.</p>
547
+ </div>
548
+
549
+ </li>
550
+
551
+ <li>
552
+ <span class="name">:proto</span>
553
+ <span class="type">(<tt>proto</tt>)</span>
554
+ <span class="default">
555
+
556
+ </span>
557
+
558
+ &mdash; <div class='inline'>
559
+ <p>Filters by proto.</p>
560
+ </div>
561
+
562
+ </li>
563
+
564
+ <li>
565
+ <span class="name">:address</span>
566
+ <span class="type">(<tt>address</tt>)</span>
567
+ <span class="default">
568
+
569
+ </span>
570
+
571
+ &mdash; <div class='inline'>
572
+ <p>Filters by address.</p>
573
+ </div>
574
+
575
+ </li>
576
+
577
+ <li>
578
+ <span class="name">:broadcast</span>
579
+ <span class="type">(<tt>broadcast</tt>)</span>
580
+ <span class="default">
581
+
582
+ </span>
583
+
584
+ &mdash; <div class='inline'>
585
+ <p>Filters by broadcast.</p>
586
+ </div>
587
+
588
+ </li>
589
+
590
+ <li>
591
+ <span class="name">:netmask</span>
592
+ <span class="type">(<tt>netmask</tt>)</span>
593
+ <span class="default">
594
+
595
+ </span>
596
+
597
+ &mdash; <div class='inline'>
598
+ <p>Filters by netmask.</p>
599
+ </div>
600
+
601
+ </li>
602
+
603
+ </ul>
604
+
605
+
606
+
607
+ <p class="tag_title">See Also:</p>
608
+ <ul class="see">
609
+
610
+ <li><a href="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-network-address-info-of-an-agent" target="_parent" title="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-network-address-info-of-an-agent">https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-network-address-info-of-an-agent</a></li>
611
+
612
+ </ul>
613
+
614
+ </div><table class="source_code">
615
+ <tr>
616
+ <td>
617
+ <pre class="lines">
618
+
619
+
620
+ 40
621
+ 41
622
+ 42</pre>
623
+ </td>
624
+ <td>
625
+ <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/syscollector.rb', line 40</span>
626
+
627
+ <span class='kw'>def</span> <span class='id identifier rubyid_netaddr'>netaddr</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>
628
+ <span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/syscollector/</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'>/netaddr</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span>
629
+ <span class='kw'>end</span></pre>
630
+ </td>
631
+ </tr>
632
+ </table>
633
+ </div>
634
+
635
+ <div class="method_details ">
636
+ <h3 class="signature " id="netiface-instance_method">
637
+
638
+ #<strong>netiface</strong>(agent_id, options = {}) &#x21d2; <tt>Object</tt>
639
+
640
+
641
+
642
+
643
+
644
+ </h3><div class="docstring">
645
+ <div class="discussion">
646
+
647
+ <p>Returns the agent’s network interface info</p>
648
+
649
+
650
+ </div>
651
+ </div>
652
+ <div class="tags">
653
+ <p class="tag_title">Parameters:</p>
654
+ <ul class="param">
655
+
656
+ <li>
657
+
658
+ <span class='name'>agent_id</span>
659
+
660
+
661
+ <span class='type'>(<tt>String</tt>)</span>
662
+
663
+
664
+
665
+ </li>
666
+
667
+ <li>
668
+
669
+ <span class='name'>options</span>
670
+
671
+
672
+ <span class='type'>(<tt>Hash</tt>)</span>
673
+
674
+
675
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
676
+
677
+
678
+ &mdash;
679
+ <div class='inline'>
680
+ <p>a customizable set of options</p>
681
+ </div>
682
+
683
+ </li>
684
+
685
+ </ul>
686
+
687
+
688
+
689
+
690
+
691
+
692
+ <p class="tag_title">Options Hash (<tt>options</tt>):</p>
693
+ <ul class="option">
694
+
695
+ <li>
696
+ <span class="name">:offset</span>
697
+ <span class="type">(<tt>offset</tt>)</span>
698
+ <span class="default">
699
+
700
+ </span>
701
+
702
+ &mdash; <div class='inline'>
703
+ <p>First element to return in the collection.</p>
704
+ </div>
705
+
706
+ </li>
707
+
708
+ <li>
709
+ <span class="name">:limit</span>
710
+ <span class="type">(<tt>limit</tt>)</span>
711
+ <span class="default">
712
+
713
+ </span>
714
+
715
+ &mdash; <div class='inline'>
716
+ <p>Maximum number of elements to return.</p>
717
+ </div>
718
+
719
+ </li>
720
+
721
+ <li>
722
+ <span class="name">:sort</span>
723
+ <span class="type">(<tt>sort</tt>)</span>
724
+ <span class="default">
725
+
726
+ </span>
727
+
728
+ &mdash; <div class='inline'>
729
+ <p>Sorts the collection by a field or fields (separated by comma). Use +/- at
730
+ the beginning to list in ascending or descending order.</p>
731
+ </div>
732
+
733
+ </li>
734
+
735
+ <li>
736
+ <span class="name">:search</span>
737
+ <span class="type">(<tt>search</tt>)</span>
738
+ <span class="default">
739
+
740
+ </span>
741
+
742
+ &mdash; <div class='inline'>
743
+ <p>Looks for elements with the specified string.</p>
744
+ </div>
745
+
746
+ </li>
747
+
748
+ <li>
749
+ <span class="name">:select</span>
750
+ <span class="type">(<tt>select</tt>)</span>
751
+ <span class="default">
752
+
753
+ </span>
754
+
755
+ &mdash; <div class='inline'>
756
+ <p>List of selected fields separated by commas.</p>
757
+ </div>
758
+
759
+ </li>
760
+
761
+ <li>
762
+ <span class="name">:name</span>
763
+ <span class="type">(<tt>name</tt>)</span>
764
+ <span class="default">
765
+
766
+ </span>
767
+
768
+ &mdash; <div class='inline'>
769
+ <p>Filters by name.</p>
770
+ </div>
771
+
772
+ </li>
773
+
774
+ <li>
775
+ <span class="name">:adapter</span>
776
+ <span class="type">(<tt>adapter</tt>)</span>
777
+ <span class="default">
778
+
779
+ </span>
780
+
781
+ &mdash; <div class='inline'>
782
+ <p>Filters by adapter.</p>
783
+ </div>
784
+
785
+ </li>
786
+
787
+ <li>
788
+ <span class="name">:type</span>
789
+ <span class="type">(<tt>type</tt>)</span>
790
+ <span class="default">
791
+
792
+ </span>
793
+
794
+ &mdash; <div class='inline'>
795
+ <p>Filters by type.</p>
796
+ </div>
797
+
798
+ </li>
799
+
800
+ <li>
801
+ <span class="name">:state</span>
802
+ <span class="type">(<tt>state</tt>)</span>
803
+ <span class="default">
804
+
805
+ </span>
806
+
807
+ &mdash; <div class='inline'>
808
+ <p>Filters by state.</p>
809
+ </div>
810
+
811
+ </li>
812
+
813
+ <li>
814
+ <span class="name">:mtu</span>
815
+ <span class="type">(<tt>mtu</tt>)</span>
816
+ <span class="default">
817
+
818
+ </span>
819
+
820
+ &mdash; <div class='inline'>
821
+ <p>Filters by mtu.</p>
822
+ </div>
823
+
824
+ </li>
825
+
826
+ <li>
827
+ <span class="name">:tx_packets</span>
828
+ <span class="type">(<tt>tx_packets</tt>)</span>
829
+ <span class="default">
830
+
831
+ </span>
832
+
833
+ </li>
834
+
835
+ <li>
836
+ <span class="name">:rx_packets</span>
837
+ <span class="type">(<tt>rx_packets</tt>)</span>
838
+ <span class="default">
839
+
840
+ </span>
841
+
842
+ </li>
843
+
844
+ <li>
845
+ <span class="name">:tx_bytes</span>
846
+ <span class="type">(<tt>tx_bytes</tt>)</span>
847
+ <span class="default">
848
+
849
+ </span>
850
+
851
+ </li>
852
+
853
+ <li>
854
+ <span class="name">:rx_bytes</span>
855
+ <span class="type">(<tt>rx_bytes</tt>)</span>
856
+ <span class="default">
857
+
858
+ </span>
859
+
860
+ </li>
861
+
862
+ <li>
863
+ <span class="name">:tx_errors</span>
864
+ <span class="type">(<tt>tx_errors</tt>)</span>
865
+ <span class="default">
866
+
867
+ </span>
868
+
869
+ </li>
870
+
871
+ <li>
872
+ <span class="name">:rx_errors</span>
873
+ <span class="type">(<tt>rx_errors</tt>)</span>
874
+ <span class="default">
875
+
876
+ </span>
877
+
878
+ </li>
879
+
880
+ <li>
881
+ <span class="name">:tx_dropped</span>
882
+ <span class="type">(<tt>tx_dropped</tt>)</span>
883
+ <span class="default">
884
+
885
+ </span>
886
+
887
+ </li>
888
+
889
+ <li>
890
+ <span class="name">:rx_dropped</span>
891
+ <span class="type">(<tt>rx_dropped</tt>)</span>
892
+ <span class="default">
893
+
894
+ </span>
895
+
896
+ </li>
897
+
898
+ </ul>
899
+
900
+
901
+
902
+ <p class="tag_title">See Also:</p>
903
+ <ul class="see">
904
+
905
+ <li><a href="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-network-interface-info-of-an-agent" target="_parent" title="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-network-interface-info-of-an-agent">https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-network-interface-info-of-an-agent</a></li>
906
+
907
+ </ul>
908
+
909
+ </div><table class="source_code">
910
+ <tr>
911
+ <td>
912
+ <pre class="lines">
913
+
914
+
915
+ 76
916
+ 77
917
+ 78</pre>
918
+ </td>
919
+ <td>
920
+ <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/syscollector.rb', line 76</span>
921
+
922
+ <span class='kw'>def</span> <span class='id identifier rubyid_netiface'>netiface</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>
923
+ <span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/syscollector/</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'>/netiface</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span>
924
+ <span class='kw'>end</span></pre>
925
+ </td>
926
+ </tr>
927
+ </table>
928
+ </div>
929
+
930
+ <div class="method_details ">
931
+ <h3 class="signature " id="netproto-instance_method">
932
+
933
+ #<strong>netproto</strong>(agent_id, options = {}) &#x21d2; <tt>Object</tt>
934
+
935
+
936
+
937
+
938
+
939
+ </h3><div class="docstring">
940
+ <div class="discussion">
941
+
942
+ <p>Returns the agent’s network protocol info.</p>
943
+
944
+
945
+ </div>
946
+ </div>
947
+ <div class="tags">
948
+ <p class="tag_title">Parameters:</p>
949
+ <ul class="param">
950
+
951
+ <li>
952
+
953
+ <span class='name'>agent_id</span>
954
+
955
+
956
+ <span class='type'>(<tt>String</tt>)</span>
957
+
958
+
959
+
960
+ </li>
961
+
962
+ <li>
963
+
964
+ <span class='name'>options</span>
965
+
966
+
967
+ <span class='type'>(<tt>Hash</tt>)</span>
968
+
969
+
970
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
971
+
972
+
973
+ &mdash;
974
+ <div class='inline'>
975
+ <p>a customizable set of options</p>
976
+ </div>
977
+
978
+ </li>
979
+
980
+ </ul>
981
+
982
+
983
+
984
+
985
+
986
+
987
+ <p class="tag_title">Options Hash (<tt>options</tt>):</p>
988
+ <ul class="option">
989
+
990
+ <li>
991
+ <span class="name">:offset</span>
992
+ <span class="type">(<tt>offset</tt>)</span>
993
+ <span class="default">
994
+
995
+ </span>
996
+
997
+ &mdash; <div class='inline'>
998
+ <p>First element to return in the collection.</p>
999
+ </div>
1000
+
1001
+ </li>
1002
+
1003
+ <li>
1004
+ <span class="name">:limit</span>
1005
+ <span class="type">(<tt>limit</tt>)</span>
1006
+ <span class="default">
1007
+
1008
+ </span>
1009
+
1010
+ &mdash; <div class='inline'>
1011
+ <p>Maximum number of elements to return.</p>
1012
+ </div>
1013
+
1014
+ </li>
1015
+
1016
+ <li>
1017
+ <span class="name">:sort</span>
1018
+ <span class="type">(<tt>sort</tt>)</span>
1019
+ <span class="default">
1020
+
1021
+ </span>
1022
+
1023
+ &mdash; <div class='inline'>
1024
+ <p>Sorts the collection by a field or fields (separated by comma). Use +/- at
1025
+ the beginning to list in ascending or descending order.</p>
1026
+ </div>
1027
+
1028
+ </li>
1029
+
1030
+ <li>
1031
+ <span class="name">:search</span>
1032
+ <span class="type">(<tt>search</tt>)</span>
1033
+ <span class="default">
1034
+
1035
+ </span>
1036
+
1037
+ &mdash; <div class='inline'>
1038
+ <p>Looks for elements with the specified string.</p>
1039
+ </div>
1040
+
1041
+ </li>
1042
+
1043
+ <li>
1044
+ <span class="name">:select</span>
1045
+ <span class="type">(<tt>select</tt>)</span>
1046
+ <span class="default">
1047
+
1048
+ </span>
1049
+
1050
+ &mdash; <div class='inline'>
1051
+ <p>List of selected fields separated by commas.</p>
1052
+ </div>
1053
+
1054
+ </li>
1055
+
1056
+ <li>
1057
+ <span class="name">:iface</span>
1058
+ <span class="type">(<tt>iface</tt>)</span>
1059
+ <span class="default">
1060
+
1061
+ </span>
1062
+
1063
+ &mdash; <div class='inline'>
1064
+ <p>Filters by interface name.</p>
1065
+ </div>
1066
+
1067
+ </li>
1068
+
1069
+ <li>
1070
+ <span class="name">:type</span>
1071
+ <span class="type">(<tt>type</tt>)</span>
1072
+ <span class="default">
1073
+
1074
+ </span>
1075
+
1076
+ &mdash; <div class='inline'>
1077
+ <p>Filters by type.</p>
1078
+ </div>
1079
+
1080
+ </li>
1081
+
1082
+ <li>
1083
+ <span class="name">:gateway</span>
1084
+ <span class="type">(<tt>gateway</tt>)</span>
1085
+ <span class="default">
1086
+
1087
+ </span>
1088
+
1089
+ &mdash; <div class='inline'>
1090
+ <p>Filters by gateway.</p>
1091
+ </div>
1092
+
1093
+ </li>
1094
+
1095
+ <li>
1096
+ <span class="name">:dhcp</span>
1097
+ <span class="type">(<tt>dhcp</tt>)</span>
1098
+ <span class="default">
1099
+
1100
+ </span>
1101
+
1102
+ &mdash; <div class='inline'>
1103
+ <p>Filters by dhcp.</p>
1104
+ </div>
1105
+
1106
+ </li>
1107
+
1108
+ </ul>
1109
+
1110
+
1111
+
1112
+ <p class="tag_title">See Also:</p>
1113
+ <ul class="see">
1114
+
1115
+ <li><a href="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-network-protocol-info-of-an-agent" target="_parent" title="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-network-protocol-info-of-an-agent">https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-network-protocol-info-of-an-agent</a></li>
1116
+
1117
+ </ul>
1118
+
1119
+ </div><table class="source_code">
1120
+ <tr>
1121
+ <td>
1122
+ <pre class="lines">
1123
+
1124
+
1125
+ 102
1126
+ 103
1127
+ 104</pre>
1128
+ </td>
1129
+ <td>
1130
+ <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/syscollector.rb', line 102</span>
1131
+
1132
+ <span class='kw'>def</span> <span class='id identifier rubyid_netproto'>netproto</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>
1133
+ <span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/syscollector/</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'>/netproto</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span>
1134
+ <span class='kw'>end</span></pre>
1135
+ </td>
1136
+ </tr>
1137
+ </table>
1138
+ </div>
1139
+
1140
+ <div class="method_details ">
1141
+ <h3 class="signature " id="os-instance_method">
1142
+
1143
+ #<strong>os</strong>(agent_id, options = {}) &#x21d2; <tt>Object</tt>
1144
+
1145
+
1146
+
1147
+
1148
+
1149
+ </h3><div class="docstring">
1150
+ <div class="discussion">
1151
+
1152
+ <p>Returns the agent’s OS info.</p>
1153
+
1154
+
1155
+ </div>
1156
+ </div>
1157
+ <div class="tags">
1158
+ <p class="tag_title">Parameters:</p>
1159
+ <ul class="param">
1160
+
1161
+ <li>
1162
+
1163
+ <span class='name'>agent_id</span>
1164
+
1165
+
1166
+ <span class='type'>(<tt>String</tt>)</span>
1167
+
1168
+
1169
+
1170
+ </li>
1171
+
1172
+ <li>
1173
+
1174
+ <span class='name'>options</span>
1175
+
1176
+
1177
+ <span class='type'>(<tt>Hash</tt>)</span>
1178
+
1179
+
1180
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
1181
+
1182
+
1183
+ &mdash;
1184
+ <div class='inline'>
1185
+ <p>a customizable set of options</p>
1186
+ </div>
1187
+
1188
+ </li>
1189
+
1190
+ </ul>
1191
+
1192
+
1193
+
1194
+
1195
+
1196
+
1197
+ <p class="tag_title">Options Hash (<tt>options</tt>):</p>
1198
+ <ul class="option">
1199
+
1200
+ <li>
1201
+ <span class="name">:select</span>
1202
+ <span class="type">(<tt>select</tt>)</span>
1203
+ <span class="default">
1204
+
1205
+ </span>
1206
+
1207
+ &mdash; <div class='inline'>
1208
+ <p>List of selected fields separated by commas.</p>
1209
+ </div>
1210
+
1211
+ </li>
1212
+
1213
+ </ul>
1214
+
1215
+
1216
+
1217
+ <p class="tag_title">See Also:</p>
1218
+ <ul class="see">
1219
+
1220
+ <li><a href="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-os-info" target="_parent" title="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-os-info">https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-os-info</a></li>
1221
+
1222
+ </ul>
1223
+
1224
+ </div><table class="source_code">
1225
+ <tr>
1226
+ <td>
1227
+ <pre class="lines">
1228
+
1229
+
1230
+ 112
1231
+ 113
1232
+ 114</pre>
1233
+ </td>
1234
+ <td>
1235
+ <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/syscollector.rb', line 112</span>
1236
+
1237
+ <span class='kw'>def</span> <span class='id identifier rubyid_os'>os</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>
1238
+ <span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/syscollector/</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'>/os</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span>
1239
+ <span class='kw'>end</span></pre>
1240
+ </td>
1241
+ </tr>
1242
+ </table>
1243
+ </div>
1244
+
1245
+ <div class="method_details ">
1246
+ <h3 class="signature " id="packages-instance_method">
1247
+
1248
+ #<strong>packages</strong>(agent_id, options = {}) &#x21d2; <tt>Object</tt>
1249
+
1250
+
1251
+
1252
+
1253
+
1254
+ </h3><div class="docstring">
1255
+ <div class="discussion">
1256
+
1257
+ <p>Returns the agent’s packages info.</p>
1258
+
1259
+
1260
+ </div>
1261
+ </div>
1262
+ <div class="tags">
1263
+ <p class="tag_title">Parameters:</p>
1264
+ <ul class="param">
1265
+
1266
+ <li>
1267
+
1268
+ <span class='name'>agent_id</span>
1269
+
1270
+
1271
+ <span class='type'>(<tt>String</tt>)</span>
1272
+
1273
+
1274
+
1275
+ </li>
1276
+
1277
+ <li>
1278
+
1279
+ <span class='name'>options</span>
1280
+
1281
+
1282
+ <span class='type'>(<tt>Hash</tt>)</span>
1283
+
1284
+
1285
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
1286
+
1287
+
1288
+ &mdash;
1289
+ <div class='inline'>
1290
+ <p>a customizable set of options</p>
1291
+ </div>
1292
+
1293
+ </li>
1294
+
1295
+ </ul>
1296
+
1297
+
1298
+
1299
+
1300
+
1301
+
1302
+ <p class="tag_title">Options Hash (<tt>options</tt>):</p>
1303
+ <ul class="option">
1304
+
1305
+ <li>
1306
+ <span class="name">:offset</span>
1307
+ <span class="type">(<tt>offset</tt>)</span>
1308
+ <span class="default">
1309
+
1310
+ </span>
1311
+
1312
+ &mdash; <div class='inline'>
1313
+ <p>First element to return in the collection.</p>
1314
+ </div>
1315
+
1316
+ </li>
1317
+
1318
+ <li>
1319
+ <span class="name">:limit</span>
1320
+ <span class="type">(<tt>limit</tt>)</span>
1321
+ <span class="default">
1322
+
1323
+ </span>
1324
+
1325
+ &mdash; <div class='inline'>
1326
+ <p>Maximum number of elements to return.</p>
1327
+ </div>
1328
+
1329
+ </li>
1330
+
1331
+ <li>
1332
+ <span class="name">:sort</span>
1333
+ <span class="type">(<tt>sort</tt>)</span>
1334
+ <span class="default">
1335
+
1336
+ </span>
1337
+
1338
+ &mdash; <div class='inline'>
1339
+ <p>Sorts the collection by a field or fields (separated by comma). Use +/- at
1340
+ the beginning to list in ascending or descending order.</p>
1341
+ </div>
1342
+
1343
+ </li>
1344
+
1345
+ <li>
1346
+ <span class="name">:search</span>
1347
+ <span class="type">(<tt>search</tt>)</span>
1348
+ <span class="default">
1349
+
1350
+ </span>
1351
+
1352
+ &mdash; <div class='inline'>
1353
+ <p>Looks for elements with the specified string.</p>
1354
+ </div>
1355
+
1356
+ </li>
1357
+
1358
+ <li>
1359
+ <span class="name">:select</span>
1360
+ <span class="type">(<tt>select</tt>)</span>
1361
+ <span class="default">
1362
+
1363
+ </span>
1364
+
1365
+ &mdash; <div class='inline'>
1366
+ <p>List of selected fields separated by commas.</p>
1367
+ </div>
1368
+
1369
+ </li>
1370
+
1371
+ <li>
1372
+ <span class="name">:vendor</span>
1373
+ <span class="type">(<tt>vendor</tt>)</span>
1374
+ <span class="default">
1375
+
1376
+ </span>
1377
+
1378
+ &mdash; <div class='inline'>
1379
+ <p>Filters by vendor.</p>
1380
+ </div>
1381
+
1382
+ </li>
1383
+
1384
+ <li>
1385
+ <span class="name">:name</span>
1386
+ <span class="type">(<tt>name</tt>)</span>
1387
+ <span class="default">
1388
+
1389
+ </span>
1390
+
1391
+ &mdash; <div class='inline'>
1392
+ <p>Filters by name.</p>
1393
+ </div>
1394
+
1395
+ </li>
1396
+
1397
+ <li>
1398
+ <span class="name">:architecture</span>
1399
+ <span class="type">(<tt>architecture</tt>)</span>
1400
+ <span class="default">
1401
+
1402
+ </span>
1403
+
1404
+ &mdash; <div class='inline'>
1405
+ <p>Filters by architecture.</p>
1406
+ </div>
1407
+
1408
+ </li>
1409
+
1410
+ <li>
1411
+ <span class="name">:format</span>
1412
+ <span class="type">(<tt>format</tt>)</span>
1413
+ <span class="default">
1414
+
1415
+ </span>
1416
+
1417
+ &mdash; <div class='inline'>
1418
+ <p>Filters by format.</p>
1419
+ </div>
1420
+
1421
+ </li>
1422
+
1423
+ <li>
1424
+ <span class="name">:version</span>
1425
+ <span class="type">(<tt>version</tt>)</span>
1426
+ <span class="default">
1427
+
1428
+ </span>
1429
+
1430
+ &mdash; <div class='inline'>
1431
+ <p>Filters by format.</p>
1432
+ </div>
1433
+
1434
+ </li>
1435
+
1436
+ </ul>
1437
+
1438
+
1439
+
1440
+ <p class="tag_title">See Also:</p>
1441
+ <ul class="see">
1442
+
1443
+ <li><a href="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-packages-info" target="_parent" title="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-packages-info">https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-packages-info</a></li>
1444
+
1445
+ </ul>
1446
+
1447
+ </div><table class="source_code">
1448
+ <tr>
1449
+ <td>
1450
+ <pre class="lines">
1451
+
1452
+
1453
+ 140
1454
+ 141
1455
+ 142</pre>
1456
+ </td>
1457
+ <td>
1458
+ <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/syscollector.rb', line 140</span>
1459
+
1460
+ <span class='kw'>def</span> <span class='id identifier rubyid_packages'>packages</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>
1461
+ <span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/syscollector/</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'>/packages</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span>
1462
+ <span class='kw'>end</span></pre>
1463
+ </td>
1464
+ </tr>
1465
+ </table>
1466
+ </div>
1467
+
1468
+ <div class="method_details ">
1469
+ <h3 class="signature " id="ports-instance_method">
1470
+
1471
+ #<strong>ports</strong>(agent_id, options = {}) &#x21d2; <tt>Object</tt>
1472
+
1473
+
1474
+
1475
+
1476
+
1477
+ </h3><div class="docstring">
1478
+ <div class="discussion">
1479
+
1480
+ <p>Get ports info of an agent Returns the agent’s ports info.</p>
1481
+
1482
+
1483
+ </div>
1484
+ </div>
1485
+ <div class="tags">
1486
+ <p class="tag_title">Parameters:</p>
1487
+ <ul class="param">
1488
+
1489
+ <li>
1490
+
1491
+ <span class='name'>agent_id</span>
1492
+
1493
+
1494
+ <span class='type'>(<tt>String</tt>)</span>
1495
+
1496
+
1497
+
1498
+ </li>
1499
+
1500
+ <li>
1501
+
1502
+ <span class='name'>options</span>
1503
+
1504
+
1505
+ <span class='type'>(<tt>Hash</tt>)</span>
1506
+
1507
+
1508
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
1509
+
1510
+
1511
+ &mdash;
1512
+ <div class='inline'>
1513
+ <p>a customizable set of options</p>
1514
+ </div>
1515
+
1516
+ </li>
1517
+
1518
+ </ul>
1519
+
1520
+
1521
+
1522
+
1523
+
1524
+
1525
+ <p class="tag_title">Options Hash (<tt>options</tt>):</p>
1526
+ <ul class="option">
1527
+
1528
+ <li>
1529
+ <span class="name">:offset</span>
1530
+ <span class="type">(<tt>offset</tt>)</span>
1531
+ <span class="default">
1532
+
1533
+ </span>
1534
+
1535
+ &mdash; <div class='inline'>
1536
+ <p>First element to return in the collection.</p>
1537
+ </div>
1538
+
1539
+ </li>
1540
+
1541
+ <li>
1542
+ <span class="name">:limit</span>
1543
+ <span class="type">(<tt>limit</tt>)</span>
1544
+ <span class="default">
1545
+
1546
+ </span>
1547
+
1548
+ &mdash; <div class='inline'>
1549
+ <p>Maximum number of elements to return.</p>
1550
+ </div>
1551
+
1552
+ </li>
1553
+
1554
+ <li>
1555
+ <span class="name">:sort</span>
1556
+ <span class="type">(<tt>sort</tt>)</span>
1557
+ <span class="default">
1558
+
1559
+ </span>
1560
+
1561
+ &mdash; <div class='inline'>
1562
+ <p>Sorts the collection by a field or fields (separated by comma). Use +/- at
1563
+ the beginning to list in ascending or descending order.</p>
1564
+ </div>
1565
+
1566
+ </li>
1567
+
1568
+ <li>
1569
+ <span class="name">:search</span>
1570
+ <span class="type">(<tt>search</tt>)</span>
1571
+ <span class="default">
1572
+
1573
+ </span>
1574
+
1575
+ &mdash; <div class='inline'>
1576
+ <p>Looks for elements with the specified string.</p>
1577
+ </div>
1578
+
1579
+ </li>
1580
+
1581
+ <li>
1582
+ <span class="name">:select</span>
1583
+ <span class="type">(<tt>select</tt>)</span>
1584
+ <span class="default">
1585
+
1586
+ </span>
1587
+
1588
+ &mdash; <div class='inline'>
1589
+ <p>List of selected fields separated by commas.</p>
1590
+ </div>
1591
+
1592
+ </li>
1593
+
1594
+ <li>
1595
+ <span class="name">:pid</span>
1596
+ <span class="type">(<tt>pid</tt>)</span>
1597
+ <span class="default">
1598
+
1599
+ </span>
1600
+
1601
+ &mdash; <div class='inline'>
1602
+ <p>Filters by pid.</p>
1603
+ </div>
1604
+
1605
+ </li>
1606
+
1607
+ <li>
1608
+ <span class="name">:protocol</span>
1609
+ <span class="type">(<tt>protocol</tt>)</span>
1610
+ <span class="default">
1611
+
1612
+ </span>
1613
+
1614
+ &mdash; <div class='inline'>
1615
+ <p>Filters by protocol.</p>
1616
+ </div>
1617
+
1618
+ </li>
1619
+
1620
+ <li>
1621
+ <span class="name">:local_ip</span>
1622
+ <span class="type">(<tt>local_ip</tt>)</span>
1623
+ <span class="default">
1624
+
1625
+ </span>
1626
+
1627
+ &mdash; <div class='inline'>
1628
+ <p>Filters by local_ip.</p>
1629
+ </div>
1630
+
1631
+ </li>
1632
+
1633
+ <li>
1634
+ <span class="name">:local_port</span>
1635
+ <span class="type">(<tt>local_port</tt>)</span>
1636
+ <span class="default">
1637
+
1638
+ </span>
1639
+
1640
+ &mdash; <div class='inline'>
1641
+ <p>Filters by local_port.</p>
1642
+ </div>
1643
+
1644
+ </li>
1645
+
1646
+ <li>
1647
+ <span class="name">:remote_ip</span>
1648
+ <span class="type">(<tt>remote_ip</tt>)</span>
1649
+ <span class="default">
1650
+
1651
+ </span>
1652
+
1653
+ &mdash; <div class='inline'>
1654
+ <p>Filters by remote_ip.</p>
1655
+ </div>
1656
+
1657
+ </li>
1658
+
1659
+ <li>
1660
+ <span class="name">:tx_queue</span>
1661
+ <span class="type">(<tt>tx_queue</tt>)</span>
1662
+ <span class="default">
1663
+
1664
+ </span>
1665
+
1666
+ &mdash; <div class='inline'>
1667
+ <p>Filters by tx_queue.</p>
1668
+ </div>
1669
+
1670
+ </li>
1671
+
1672
+ <li>
1673
+ <span class="name">:state</span>
1674
+ <span class="type">(<tt>state</tt>)</span>
1675
+ <span class="default">
1676
+
1677
+ </span>
1678
+
1679
+ &mdash; <div class='inline'>
1680
+ <p>Filters by state.</p>
1681
+ </div>
1682
+
1683
+ </li>
1684
+
1685
+ </ul>
1686
+
1687
+
1688
+
1689
+ <p class="tag_title">See Also:</p>
1690
+ <ul class="see">
1691
+
1692
+ <li><a href="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-ports-info-of-an-agent" target="_parent" title="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-ports-info-of-an-agent">https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-ports-info-of-an-agent</a></li>
1693
+
1694
+ </ul>
1695
+
1696
+ </div><table class="source_code">
1697
+ <tr>
1698
+ <td>
1699
+ <pre class="lines">
1700
+
1701
+
1702
+ 173
1703
+ 174
1704
+ 175</pre>
1705
+ </td>
1706
+ <td>
1707
+ <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/syscollector.rb', line 173</span>
1708
+
1709
+ <span class='kw'>def</span> <span class='id identifier rubyid_ports'>ports</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>
1710
+ <span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/syscollector/</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'>/ports</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span>
1711
+ <span class='kw'>end</span></pre>
1712
+ </td>
1713
+ </tr>
1714
+ </table>
1715
+ </div>
1716
+
1717
+ <div class="method_details ">
1718
+ <h3 class="signature " id="processes-instance_method">
1719
+
1720
+ #<strong>processes</strong>(agent_id, options = {}) &#x21d2; <tt>Object</tt>
1721
+
1722
+
1723
+
1724
+
1725
+
1726
+ </h3><div class="docstring">
1727
+ <div class="discussion">
1728
+
1729
+ <p>Get processes info Returns the agent&#39;s processes info.</p>
1730
+
1731
+
1732
+ </div>
1733
+ </div>
1734
+ <div class="tags">
1735
+ <p class="tag_title">Parameters:</p>
1736
+ <ul class="param">
1737
+
1738
+ <li>
1739
+
1740
+ <span class='name'>agent_id</span>
1741
+
1742
+
1743
+ <span class='type'>(<tt>String</tt>)</span>
1744
+
1745
+
1746
+
1747
+ </li>
1748
+
1749
+ <li>
1750
+
1751
+ <span class='name'>options</span>
1752
+
1753
+
1754
+ <span class='type'>(<tt>Hash</tt>)</span>
1755
+
1756
+
1757
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
1758
+
1759
+
1760
+ &mdash;
1761
+ <div class='inline'>
1762
+ <p>a customizable set of options</p>
1763
+ </div>
1764
+
1765
+ </li>
1766
+
1767
+ </ul>
1768
+
1769
+
1770
+
1771
+
1772
+
1773
+
1774
+ <p class="tag_title">Options Hash (<tt>options</tt>):</p>
1775
+ <ul class="option">
1776
+
1777
+ <li>
1778
+ <span class="name">:offset</span>
1779
+ <span class="type">(<tt>offset</tt>)</span>
1780
+ <span class="default">
1781
+
1782
+ </span>
1783
+
1784
+ &mdash; <div class='inline'>
1785
+ <p>First element to return in the collection.</p>
1786
+ </div>
1787
+
1788
+ </li>
1789
+
1790
+ <li>
1791
+ <span class="name">:limit</span>
1792
+ <span class="type">(<tt>limit</tt>)</span>
1793
+ <span class="default">
1794
+
1795
+ </span>
1796
+
1797
+ &mdash; <div class='inline'>
1798
+ <p>Maximum number of elements to return.</p>
1799
+ </div>
1800
+
1801
+ </li>
1802
+
1803
+ <li>
1804
+ <span class="name">:sort</span>
1805
+ <span class="type">(<tt>sort</tt>)</span>
1806
+ <span class="default">
1807
+
1808
+ </span>
1809
+
1810
+ &mdash; <div class='inline'>
1811
+ <p>Sorts the collection by a field or fields (separated by comma). Use +/- at
1812
+ the beginning to list in ascending or descending order.</p>
1813
+ </div>
1814
+
1815
+ </li>
1816
+
1817
+ <li>
1818
+ <span class="name">:search</span>
1819
+ <span class="type">(<tt>search</tt>)</span>
1820
+ <span class="default">
1821
+
1822
+ </span>
1823
+
1824
+ &mdash; <div class='inline'>
1825
+ <p>Looks for elements with the specified string.</p>
1826
+ </div>
1827
+
1828
+ </li>
1829
+
1830
+ <li>
1831
+ <span class="name">:select</span>
1832
+ <span class="type">(<tt>select</tt>)</span>
1833
+ <span class="default">
1834
+
1835
+ </span>
1836
+
1837
+ &mdash; <div class='inline'>
1838
+ <p>List of selected fields separated by commas.</p>
1839
+ </div>
1840
+
1841
+ </li>
1842
+
1843
+ <li>
1844
+ <span class="name">:pid</span>
1845
+ <span class="type">(<tt>pid</tt>)</span>
1846
+ <span class="default">
1847
+
1848
+ </span>
1849
+
1850
+ &mdash; <div class='inline'>
1851
+ <p>Filters by pid.</p>
1852
+ </div>
1853
+
1854
+ </li>
1855
+
1856
+ <li>
1857
+ <span class="name">:state</span>
1858
+ <span class="type">(<tt>state</tt>)</span>
1859
+ <span class="default">
1860
+
1861
+ </span>
1862
+
1863
+ &mdash; <div class='inline'>
1864
+ <p>Filters by process state.</p>
1865
+ </div>
1866
+
1867
+ </li>
1868
+
1869
+ <li>
1870
+ <span class="name">:ppid</span>
1871
+ <span class="type">(<tt>ppid</tt>)</span>
1872
+ <span class="default">
1873
+
1874
+ </span>
1875
+
1876
+ &mdash; <div class='inline'>
1877
+ <p>Filters by process parent pid.</p>
1878
+ </div>
1879
+
1880
+ </li>
1881
+
1882
+ <li>
1883
+ <span class="name">:egroup</span>
1884
+ <span class="type">(<tt>egroup</tt>)</span>
1885
+ <span class="default">
1886
+
1887
+ </span>
1888
+
1889
+ &mdash; <div class='inline'>
1890
+ <p>Filters by process egroup.</p>
1891
+ </div>
1892
+
1893
+ </li>
1894
+
1895
+ <li>
1896
+ <span class="name">:euser</span>
1897
+ <span class="type">(<tt>euser</tt>)</span>
1898
+ <span class="default">
1899
+
1900
+ </span>
1901
+
1902
+ &mdash; <div class='inline'>
1903
+ <p>Filters by process euser.</p>
1904
+ </div>
1905
+
1906
+ </li>
1907
+
1908
+ <li>
1909
+ <span class="name">:fgroup</span>
1910
+ <span class="type">(<tt>fgroup</tt>)</span>
1911
+ <span class="default">
1912
+
1913
+ </span>
1914
+
1915
+ &mdash; <div class='inline'>
1916
+ <p>Filters by process fgroup.</p>
1917
+ </div>
1918
+
1919
+ </li>
1920
+
1921
+ <li>
1922
+ <span class="name">:name</span>
1923
+ <span class="type">(<tt>name</tt>)</span>
1924
+ <span class="default">
1925
+
1926
+ </span>
1927
+
1928
+ &mdash; <div class='inline'>
1929
+ <p>Filters by process name.</p>
1930
+ </div>
1931
+
1932
+ </li>
1933
+
1934
+ <li>
1935
+ <span class="name">:nlwp</span>
1936
+ <span class="type">(<tt>nlwp</tt>)</span>
1937
+ <span class="default">
1938
+
1939
+ </span>
1940
+
1941
+ &mdash; <div class='inline'>
1942
+ <p>Filters by process nlwp.</p>
1943
+ </div>
1944
+
1945
+ </li>
1946
+
1947
+ <li>
1948
+ <span class="name">:pgrp</span>
1949
+ <span class="type">(<tt>pgrp</tt>)</span>
1950
+ <span class="default">
1951
+
1952
+ </span>
1953
+
1954
+ &mdash; <div class='inline'>
1955
+ <p>Filters by process pgrp.</p>
1956
+ </div>
1957
+
1958
+ </li>
1959
+
1960
+ <li>
1961
+ <span class="name">:priority</span>
1962
+ <span class="type">(<tt>priority</tt>)</span>
1963
+ <span class="default">
1964
+
1965
+ </span>
1966
+
1967
+ &mdash; <div class='inline'>
1968
+ <p>Filters by process priority.</p>
1969
+ </div>
1970
+
1971
+ </li>
1972
+
1973
+ <li>
1974
+ <span class="name">:rgroup</span>
1975
+ <span class="type">(<tt>rgroup</tt>)</span>
1976
+ <span class="default">
1977
+
1978
+ </span>
1979
+
1980
+ &mdash; <div class='inline'>
1981
+ <p>Filters by process rgroup.</p>
1982
+ </div>
1983
+
1984
+ </li>
1985
+
1986
+ <li>
1987
+ <span class="name">:ruser</span>
1988
+ <span class="type">(<tt>ruser</tt>)</span>
1989
+ <span class="default">
1990
+
1991
+ </span>
1992
+
1993
+ &mdash; <div class='inline'>
1994
+ <p>Filters by process ruser.</p>
1995
+ </div>
1996
+
1997
+ </li>
1998
+
1999
+ <li>
2000
+ <span class="name">:sgroup</span>
2001
+ <span class="type">(<tt>sgroup</tt>)</span>
2002
+ <span class="default">
2003
+
2004
+ </span>
2005
+
2006
+ &mdash; <div class='inline'>
2007
+ <p>Filters by process sgroup.</p>
2008
+ </div>
2009
+
2010
+ </li>
2011
+
2012
+ <li>
2013
+ <span class="name">:suser</span>
2014
+ <span class="type">(<tt>suser</tt>)</span>
2015
+ <span class="default">
2016
+
2017
+ </span>
2018
+
2019
+ &mdash; <div class='inline'>
2020
+ <p>Filters by process suser.</p>
2021
+ </div>
2022
+
2023
+ </li>
2024
+
2025
+ </ul>
2026
+
2027
+
2028
+
2029
+ <p class="tag_title">See Also:</p>
2030
+ <ul class="see">
2031
+
2032
+ <li><a href="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-processes-info" target="_parent" title="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-processes-info">https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-processes-info</a></li>
2033
+
2034
+ </ul>
2035
+
2036
+ </div><table class="source_code">
2037
+ <tr>
2038
+ <td>
2039
+ <pre class="lines">
2040
+
2041
+
2042
+ 221
2043
+ 222
2044
+ 223</pre>
2045
+ </td>
2046
+ <td>
2047
+ <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/syscollector.rb', line 221</span>
2048
+
2049
+ <span class='kw'>def</span> <span class='id identifier rubyid_processes'>processes</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>
2050
+ <span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/syscollector/</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'>/processes</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span>
2051
+ <span class='kw'>end</span></pre>
2052
+ </td>
2053
+ </tr>
2054
+ </table>
2055
+ </div>
2056
+
2057
+ </div>
2058
+
2059
+ </div>
2060
+
2061
+ <div id="footer">
2062
+ Generated on Sat Jan 25 00:19:41 2020 by
2063
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
2064
+ 0.9.16 (ruby-2.5.1).
2065
+ </div>
2066
+
2067
+ </div>
2068
+ </body>
2069
+ </html>