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/Rootcheck.html ADDED
@@ -0,0 +1,1025 @@
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::Rootcheck
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::Rootcheck";
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 (R)</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">Rootcheck</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::Rootcheck
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/rootcheck.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="#cleak_rootcheck_database_for_agent-instance_method" title="#cleak_rootcheck_database_for_agent (instance method)">#<strong>cleak_rootcheck_database_for_agent</strong>(agent_id) &#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>Clear rootcheck database of an agent Clears the rootcheck database for a
125
+ specific agent.</p>
126
+ </div></span>
127
+
128
+ </li>
129
+
130
+
131
+ <li class="public ">
132
+ <span class="summary_signature">
133
+
134
+ <a href="#clear_rootcheck_database-instance_method" title="#clear_rootcheck_database (instance method)">#<strong>clear_rootcheck_database</strong> &#x21d2; Object </a>
135
+
136
+
137
+
138
+ </span>
139
+
140
+
141
+
142
+
143
+
144
+
145
+
146
+
147
+
148
+ <span class="summary_desc"><div class='inline'>
149
+ <p>Clear rootcheck database Clears the rootcheck database for all agents.</p>
150
+ </div></span>
151
+
152
+ </li>
153
+
154
+
155
+ <li class="public ">
156
+ <span class="summary_signature">
157
+
158
+ <a href="#rootcheck_cis_requirements-instance_method" title="#rootcheck_cis_requirements (instance method)">#<strong>rootcheck_cis_requirements</strong>(agent_id, options = {}) &#x21d2; Object </a>
159
+
160
+
161
+
162
+ </span>
163
+
164
+
165
+
166
+
167
+
168
+
169
+
170
+
171
+
172
+ <span class="summary_desc"><div class='inline'>
173
+ <p>Get rootcheck CIS requirements Returns the CIS requirements of all
174
+ rootchecks of the specified agent.</p>
175
+ </div></span>
176
+
177
+ </li>
178
+
179
+
180
+ <li class="public ">
181
+ <span class="summary_signature">
182
+
183
+ <a href="#rootcheck_database-instance_method" title="#rootcheck_database (instance method)">#<strong>rootcheck_database</strong>(agent_id, options = {}) &#x21d2; Object </a>
184
+
185
+
186
+
187
+ </span>
188
+
189
+
190
+
191
+
192
+
193
+
194
+
195
+
196
+
197
+ <span class="summary_desc"><div class='inline'>
198
+ <p>Get rootcheck database Returns the rootcheck database of an agent.</p>
199
+ </div></span>
200
+
201
+ </li>
202
+
203
+
204
+ <li class="public ">
205
+ <span class="summary_signature">
206
+
207
+ <a href="#rootcheck_last_scan-instance_method" title="#rootcheck_last_scan (instance method)">#<strong>rootcheck_last_scan</strong>(agent_id) &#x21d2; Object </a>
208
+
209
+
210
+
211
+ </span>
212
+
213
+
214
+
215
+
216
+
217
+
218
+
219
+
220
+
221
+ <span class="summary_desc"><div class='inline'>
222
+ <p>Get last rootcheck scan Returns the timestamp of the last rootcheck scan.</p>
223
+ </div></span>
224
+
225
+ </li>
226
+
227
+
228
+ <li class="public ">
229
+ <span class="summary_signature">
230
+
231
+ <a href="#rootcheck_pic_requirements-instance_method" title="#rootcheck_pic_requirements (instance method)">#<strong>rootcheck_pic_requirements</strong>(agent_id, 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 rootcheck pci requirements Returns the PCI requirements of all
247
+ rootchecks of the agent.</p>
248
+ </div></span>
249
+
250
+ </li>
251
+
252
+
253
+ <li class="public ">
254
+ <span class="summary_signature">
255
+
256
+ <a href="#run_rootcheck-instance_method" title="#run_rootcheck (instance method)">#<strong>run_rootcheck</strong>(agent_id) &#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>Run rootcheck scan in an agent Runs syscheck and rootcheck on a specified
272
+ agent (Wazuh launches both processes simultaneously).</p>
273
+ </div></span>
274
+
275
+ </li>
276
+
277
+
278
+ <li class="public ">
279
+ <span class="summary_signature">
280
+
281
+ <a href="#run_rootcheck_all_agents-instance_method" title="#run_rootcheck_all_agents (instance method)">#<strong>run_rootcheck_all_agents</strong> &#x21d2; Object </a>
282
+
283
+
284
+
285
+ </span>
286
+
287
+
288
+
289
+
290
+
291
+
292
+
293
+
294
+
295
+ <span class="summary_desc"><div class='inline'>
296
+ <p>Run rootcheck scan in all agents Runs syscheck and rootcheck on all agents
297
+ (Wazuh launches both processes simultaneously).</p>
298
+ </div></span>
299
+
300
+ </li>
301
+
302
+
303
+ </ul>
304
+
305
+
306
+
307
+
308
+ <div id="instance_method_details" class="method_details_list">
309
+ <h2>Instance Method Details</h2>
310
+
311
+
312
+ <div class="method_details first">
313
+ <h3 class="signature first" id="cleak_rootcheck_database_for_agent-instance_method">
314
+
315
+ #<strong>cleak_rootcheck_database_for_agent</strong>(agent_id) &#x21d2; <tt>Object</tt>
316
+
317
+
318
+
319
+
320
+
321
+ </h3><div class="docstring">
322
+ <div class="discussion">
323
+
324
+ <p>Clear rootcheck database of an agent Clears the rootcheck database for a
325
+ specific agent.</p>
326
+
327
+
328
+ </div>
329
+ </div>
330
+ <div class="tags">
331
+ <p class="tag_title">Parameters:</p>
332
+ <ul class="param">
333
+
334
+ <li>
335
+
336
+ <span class='name'>agent_id</span>
337
+
338
+
339
+ <span class='type'>(<tt>String</tt>)</span>
340
+
341
+
342
+
343
+ </li>
344
+
345
+ </ul>
346
+
347
+
348
+ <p class="tag_title">See Also:</p>
349
+ <ul class="see">
350
+
351
+ <li><a href="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#clear-rootcheck-database-of-an-agent" target="_parent" title="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#clear-rootcheck-database-of-an-agent">https://documentation.wazuh.com/3.10/user-manual/api/reference.html#clear-rootcheck-database-of-an-agent</a></li>
352
+
353
+ </ul>
354
+
355
+ </div><table class="source_code">
356
+ <tr>
357
+ <td>
358
+ <pre class="lines">
359
+
360
+
361
+ 19
362
+ 20
363
+ 21</pre>
364
+ </td>
365
+ <td>
366
+ <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/rootcheck.rb', line 19</span>
367
+
368
+ <span class='kw'>def</span> <span class='id identifier rubyid_cleak_rootcheck_database_for_agent'>cleak_rootcheck_database_for_agent</span><span class='lparen'>(</span><span class='id identifier rubyid_agent_id'>agent_id</span><span class='rparen'>)</span>
369
+ <span class='id identifier rubyid_delete'>delete</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/rootcheck/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_agent_id'>agent_id</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
370
+ <span class='kw'>end</span></pre>
371
+ </td>
372
+ </tr>
373
+ </table>
374
+ </div>
375
+
376
+ <div class="method_details ">
377
+ <h3 class="signature " id="clear_rootcheck_database-instance_method">
378
+
379
+ #<strong>clear_rootcheck_database</strong> &#x21d2; <tt>Object</tt>
380
+
381
+
382
+
383
+
384
+
385
+ </h3><div class="docstring">
386
+ <div class="discussion">
387
+
388
+ <p>Clear rootcheck database Clears the rootcheck database for all agents.</p>
389
+
390
+
391
+ </div>
392
+ </div>
393
+ <div class="tags">
394
+
395
+
396
+ <p class="tag_title">See Also:</p>
397
+ <ul class="see">
398
+
399
+ <li><a href="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#clear-rootcheck-database" target="_parent" title="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#clear-rootcheck-database">https://documentation.wazuh.com/3.10/user-manual/api/reference.html#clear-rootcheck-database</a></li>
400
+
401
+ </ul>
402
+
403
+ </div><table class="source_code">
404
+ <tr>
405
+ <td>
406
+ <pre class="lines">
407
+
408
+
409
+ 10
410
+ 11
411
+ 12</pre>
412
+ </td>
413
+ <td>
414
+ <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/rootcheck.rb', line 10</span>
415
+
416
+ <span class='kw'>def</span> <span class='id identifier rubyid_clear_rootcheck_database'>clear_rootcheck_database</span>
417
+ <span class='id identifier rubyid_delete'>delete</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/rootcheck</span><span class='tstring_end'>&#39;</span></span>
418
+ <span class='kw'>end</span></pre>
419
+ </td>
420
+ </tr>
421
+ </table>
422
+ </div>
423
+
424
+ <div class="method_details ">
425
+ <h3 class="signature " id="rootcheck_cis_requirements-instance_method">
426
+
427
+ #<strong>rootcheck_cis_requirements</strong>(agent_id, options = {}) &#x21d2; <tt>Object</tt>
428
+
429
+
430
+
431
+
432
+
433
+ </h3><div class="docstring">
434
+ <div class="discussion">
435
+
436
+ <p>Get rootcheck CIS requirements Returns the CIS requirements of all
437
+ rootchecks of the specified agent.</p>
438
+
439
+
440
+ </div>
441
+ </div>
442
+ <div class="tags">
443
+ <p class="tag_title">Parameters:</p>
444
+ <ul class="param">
445
+
446
+ <li>
447
+
448
+ <span class='name'>agent_id</span>
449
+
450
+
451
+ <span class='type'>(<tt>String</tt>)</span>
452
+
453
+
454
+
455
+ </li>
456
+
457
+ <li>
458
+
459
+ <span class='name'>options</span>
460
+
461
+
462
+ <span class='type'>(<tt>Hash</tt>)</span>
463
+
464
+
465
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
466
+
467
+
468
+ &mdash;
469
+ <div class='inline'>
470
+ <p>a customizable set of options</p>
471
+ </div>
472
+
473
+ </li>
474
+
475
+ </ul>
476
+
477
+
478
+
479
+
480
+
481
+
482
+ <p class="tag_title">Options Hash (<tt>options</tt>):</p>
483
+ <ul class="option">
484
+
485
+ <li>
486
+ <span class="name">:offset</span>
487
+ <span class="type">(<tt>offset</tt>)</span>
488
+ <span class="default">
489
+
490
+ </span>
491
+
492
+ </li>
493
+
494
+ <li>
495
+ <span class="name">:limit</span>
496
+ <span class="type">(<tt>limit</tt>)</span>
497
+ <span class="default">
498
+
499
+ </span>
500
+
501
+ </li>
502
+
503
+ <li>
504
+ <span class="name">:sort</span>
505
+ <span class="type">(<tt>sort</tt>)</span>
506
+ <span class="default">
507
+
508
+ </span>
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
+ </li>
520
+
521
+ </ul>
522
+
523
+
524
+
525
+ <p class="tag_title">See Also:</p>
526
+ <ul class="see">
527
+
528
+ <li><a href="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-rootcheck-cis-requirements" target="_parent" title="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-rootcheck-cis-requirements">https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-rootcheck-cis-requirements</a></li>
529
+
530
+ </ul>
531
+
532
+ </div><table class="source_code">
533
+ <tr>
534
+ <td>
535
+ <pre class="lines">
536
+
537
+
538
+ 41
539
+ 42
540
+ 43</pre>
541
+ </td>
542
+ <td>
543
+ <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/rootcheck.rb', line 41</span>
544
+
545
+ <span class='kw'>def</span> <span class='id identifier rubyid_rootcheck_cis_requirements'>rootcheck_cis_requirements</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>
546
+ <span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/rootcheck/</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'>/cis</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span>
547
+ <span class='kw'>end</span></pre>
548
+ </td>
549
+ </tr>
550
+ </table>
551
+ </div>
552
+
553
+ <div class="method_details ">
554
+ <h3 class="signature " id="rootcheck_database-instance_method">
555
+
556
+ #<strong>rootcheck_database</strong>(agent_id, options = {}) &#x21d2; <tt>Object</tt>
557
+
558
+
559
+
560
+
561
+
562
+ </h3><div class="docstring">
563
+ <div class="discussion">
564
+
565
+ <p>Get rootcheck database Returns the rootcheck database of an agent.</p>
566
+
567
+
568
+ </div>
569
+ </div>
570
+ <div class="tags">
571
+ <p class="tag_title">Parameters:</p>
572
+ <ul class="param">
573
+
574
+ <li>
575
+
576
+ <span class='name'>agent_id</span>
577
+
578
+
579
+ <span class='type'>(<tt>String</tt>)</span>
580
+
581
+
582
+
583
+ </li>
584
+
585
+ <li>
586
+
587
+ <span class='name'>options</span>
588
+
589
+
590
+ <span class='type'>(<tt>Hash</tt>)</span>
591
+
592
+
593
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
594
+
595
+
596
+ &mdash;
597
+ <div class='inline'>
598
+ <p>a customizable set of options</p>
599
+ </div>
600
+
601
+ </li>
602
+
603
+ </ul>
604
+
605
+
606
+
607
+
608
+
609
+
610
+ <p class="tag_title">Options Hash (<tt>options</tt>):</p>
611
+ <ul class="option">
612
+
613
+ <li>
614
+ <span class="name">:pci</span>
615
+ <span class="type">(<tt>pci</tt>)</span>
616
+ <span class="default">
617
+
618
+ </span>
619
+
620
+ </li>
621
+
622
+ <li>
623
+ <span class="name">:cis</span>
624
+ <span class="type">(<tt>cis</tt>)</span>
625
+ <span class="default">
626
+
627
+ </span>
628
+
629
+ </li>
630
+
631
+ <li>
632
+ <span class="name">:offset</span>
633
+ <span class="type">(<tt>offset</tt>)</span>
634
+ <span class="default">
635
+
636
+ </span>
637
+
638
+ </li>
639
+
640
+ <li>
641
+ <span class="name">:limit</span>
642
+ <span class="type">(<tt>limit</tt>)</span>
643
+ <span class="default">
644
+
645
+ </span>
646
+
647
+ </li>
648
+
649
+ <li>
650
+ <span class="name">:sort</span>
651
+ <span class="type">(<tt>sort</tt>)</span>
652
+ <span class="default">
653
+
654
+ </span>
655
+
656
+ </li>
657
+
658
+ <li>
659
+ <span class="name">:search</span>
660
+ <span class="type">(<tt>search</tt>)</span>
661
+ <span class="default">
662
+
663
+ </span>
664
+
665
+ </li>
666
+
667
+ <li>
668
+ <span class="name">:status</span>
669
+ <span class="type">(<tt>status</tt>)</span>
670
+ <span class="default">
671
+
672
+ </span>
673
+
674
+ </li>
675
+
676
+ </ul>
677
+
678
+
679
+
680
+ <p class="tag_title">See Also:</p>
681
+ <ul class="see">
682
+
683
+ <li><a href="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-rootcheck-database" target="_parent" title="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-rootcheck-database">https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-rootcheck-database</a></li>
684
+
685
+ </ul>
686
+
687
+ </div><table class="source_code">
688
+ <tr>
689
+ <td>
690
+ <pre class="lines">
691
+
692
+
693
+ 57
694
+ 58
695
+ 59</pre>
696
+ </td>
697
+ <td>
698
+ <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/rootcheck.rb', line 57</span>
699
+
700
+ <span class='kw'>def</span> <span class='id identifier rubyid_rootcheck_database'>rootcheck_database</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>
701
+ <span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/rootcheck/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_agent_id'>agent_id</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span>
702
+ <span class='kw'>end</span></pre>
703
+ </td>
704
+ </tr>
705
+ </table>
706
+ </div>
707
+
708
+ <div class="method_details ">
709
+ <h3 class="signature " id="rootcheck_last_scan-instance_method">
710
+
711
+ #<strong>rootcheck_last_scan</strong>(agent_id) &#x21d2; <tt>Object</tt>
712
+
713
+
714
+
715
+
716
+
717
+ </h3><div class="docstring">
718
+ <div class="discussion">
719
+
720
+ <p>Get last rootcheck scan Returns the timestamp of the last rootcheck scan.</p>
721
+
722
+
723
+ </div>
724
+ </div>
725
+ <div class="tags">
726
+ <p class="tag_title">Parameters:</p>
727
+ <ul class="param">
728
+
729
+ <li>
730
+
731
+ <span class='name'>agent_id</span>
732
+
733
+
734
+ <span class='type'>(<tt>String</tt>)</span>
735
+
736
+
737
+
738
+ </li>
739
+
740
+ </ul>
741
+
742
+
743
+ <p class="tag_title">See Also:</p>
744
+ <ul class="see">
745
+
746
+ <li><a href="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-last-rootcheck-scan" target="_parent" title="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-last-rootcheck-scan">https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-last-rootcheck-scan</a></li>
747
+
748
+ </ul>
749
+
750
+ </div><table class="source_code">
751
+ <tr>
752
+ <td>
753
+ <pre class="lines">
754
+
755
+
756
+ 28
757
+ 29
758
+ 30</pre>
759
+ </td>
760
+ <td>
761
+ <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/rootcheck.rb', line 28</span>
762
+
763
+ <span class='kw'>def</span> <span class='id identifier rubyid_rootcheck_last_scan'>rootcheck_last_scan</span><span class='lparen'>(</span><span class='id identifier rubyid_agent_id'>agent_id</span><span class='rparen'>)</span>
764
+ <span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/rootcheck/</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'>/last_scan</span><span class='tstring_end'>&quot;</span></span>
765
+ <span class='kw'>end</span></pre>
766
+ </td>
767
+ </tr>
768
+ </table>
769
+ </div>
770
+
771
+ <div class="method_details ">
772
+ <h3 class="signature " id="rootcheck_pic_requirements-instance_method">
773
+
774
+ #<strong>rootcheck_pic_requirements</strong>(agent_id, options = {}) &#x21d2; <tt>Object</tt>
775
+
776
+
777
+
778
+
779
+
780
+ </h3><div class="docstring">
781
+ <div class="discussion">
782
+
783
+ <p>Get rootcheck pci requirements Returns the PCI requirements of all
784
+ rootchecks of the agent.</p>
785
+
786
+
787
+ </div>
788
+ </div>
789
+ <div class="tags">
790
+ <p class="tag_title">Parameters:</p>
791
+ <ul class="param">
792
+
793
+ <li>
794
+
795
+ <span class='name'>agent_id</span>
796
+
797
+
798
+ <span class='type'>(<tt>String</tt>)</span>
799
+
800
+
801
+
802
+ </li>
803
+
804
+ <li>
805
+
806
+ <span class='name'>options</span>
807
+
808
+
809
+ <span class='type'>(<tt>Hash</tt>)</span>
810
+
811
+
812
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
813
+
814
+
815
+ &mdash;
816
+ <div class='inline'>
817
+ <p>a customizable set of options</p>
818
+ </div>
819
+
820
+ </li>
821
+
822
+ </ul>
823
+
824
+
825
+
826
+
827
+
828
+
829
+ <p class="tag_title">Options Hash (<tt>options</tt>):</p>
830
+ <ul class="option">
831
+
832
+ <li>
833
+ <span class="name">:offset</span>
834
+ <span class="type">(<tt>offset</tt>)</span>
835
+ <span class="default">
836
+
837
+ </span>
838
+
839
+ </li>
840
+
841
+ <li>
842
+ <span class="name">:limit</span>
843
+ <span class="type">(<tt>limit</tt>)</span>
844
+ <span class="default">
845
+
846
+ </span>
847
+
848
+ </li>
849
+
850
+ <li>
851
+ <span class="name">:sort</span>
852
+ <span class="type">(<tt>sort</tt>)</span>
853
+ <span class="default">
854
+
855
+ </span>
856
+
857
+ </li>
858
+
859
+ <li>
860
+ <span class="name">:search</span>
861
+ <span class="type">(<tt>search</tt>)</span>
862
+ <span class="default">
863
+
864
+ </span>
865
+
866
+ </li>
867
+
868
+ </ul>
869
+
870
+
871
+
872
+ <p class="tag_title">See Also:</p>
873
+ <ul class="see">
874
+
875
+ <li><a href="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-rootcheck-pci-requirements" target="_parent" title="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-rootcheck-pci-requirements">https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-rootcheck-pci-requirements</a></li>
876
+
877
+ </ul>
878
+
879
+ </div><table class="source_code">
880
+ <tr>
881
+ <td>
882
+ <pre class="lines">
883
+
884
+
885
+ 70
886
+ 71
887
+ 72</pre>
888
+ </td>
889
+ <td>
890
+ <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/rootcheck.rb', line 70</span>
891
+
892
+ <span class='kw'>def</span> <span class='id identifier rubyid_rootcheck_pic_requirements'>rootcheck_pic_requirements</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>
893
+ <span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/rootcheck/</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'>/pci</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span>
894
+ <span class='kw'>end</span></pre>
895
+ </td>
896
+ </tr>
897
+ </table>
898
+ </div>
899
+
900
+ <div class="method_details ">
901
+ <h3 class="signature " id="run_rootcheck-instance_method">
902
+
903
+ #<strong>run_rootcheck</strong>(agent_id) &#x21d2; <tt>Object</tt>
904
+
905
+
906
+
907
+
908
+
909
+ </h3><div class="docstring">
910
+ <div class="discussion">
911
+
912
+ <p>Run rootcheck scan in an agent Runs syscheck and rootcheck on a specified
913
+ agent (Wazuh launches both processes simultaneously)</p>
914
+
915
+
916
+ </div>
917
+ </div>
918
+ <div class="tags">
919
+ <p class="tag_title">Parameters:</p>
920
+ <ul class="param">
921
+
922
+ <li>
923
+
924
+ <span class='name'>agent_id</span>
925
+
926
+
927
+ <span class='type'>(<tt>String</tt>)</span>
928
+
929
+
930
+
931
+ </li>
932
+
933
+ </ul>
934
+
935
+
936
+ <p class="tag_title">See Also:</p>
937
+ <ul class="see">
938
+
939
+ <li><a href="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#run-rootcheck-scan-in-an-agent" target="_parent" title="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#run-rootcheck-scan-in-an-agent">https://documentation.wazuh.com/3.10/user-manual/api/reference.html#run-rootcheck-scan-in-an-agent</a></li>
940
+
941
+ </ul>
942
+
943
+ </div><table class="source_code">
944
+ <tr>
945
+ <td>
946
+ <pre class="lines">
947
+
948
+
949
+ 87
950
+ 88
951
+ 89</pre>
952
+ </td>
953
+ <td>
954
+ <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/rootcheck.rb', line 87</span>
955
+
956
+ <span class='kw'>def</span> <span class='id identifier rubyid_run_rootcheck'>run_rootcheck</span><span class='lparen'>(</span><span class='id identifier rubyid_agent_id'>agent_id</span><span class='rparen'>)</span>
957
+ <span class='id identifier rubyid_put'>put</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/rootcheck/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_agent_id'>agent_id</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
958
+ <span class='kw'>end</span></pre>
959
+ </td>
960
+ </tr>
961
+ </table>
962
+ </div>
963
+
964
+ <div class="method_details ">
965
+ <h3 class="signature " id="run_rootcheck_all_agents-instance_method">
966
+
967
+ #<strong>run_rootcheck_all_agents</strong> &#x21d2; <tt>Object</tt>
968
+
969
+
970
+
971
+
972
+
973
+ </h3><div class="docstring">
974
+ <div class="discussion">
975
+
976
+ <p>Run rootcheck scan in all agents Runs syscheck and rootcheck on all agents
977
+ (Wazuh launches both processes simultaneously).</p>
978
+
979
+
980
+ </div>
981
+ </div>
982
+ <div class="tags">
983
+
984
+
985
+ <p class="tag_title">See Also:</p>
986
+ <ul class="see">
987
+
988
+ <li><a href="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#run-rootcheck-scan-in-all-agents" target="_parent" title="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#run-rootcheck-scan-in-all-agents">https://documentation.wazuh.com/3.10/user-manual/api/reference.html#run-rootcheck-scan-in-all-agents</a></li>
989
+
990
+ </ul>
991
+
992
+ </div><table class="source_code">
993
+ <tr>
994
+ <td>
995
+ <pre class="lines">
996
+
997
+
998
+ 78
999
+ 79
1000
+ 80</pre>
1001
+ </td>
1002
+ <td>
1003
+ <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/rootcheck.rb', line 78</span>
1004
+
1005
+ <span class='kw'>def</span> <span class='id identifier rubyid_run_rootcheck_all_agents'>run_rootcheck_all_agents</span>
1006
+ <span class='id identifier rubyid_put'>put</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/rootcheck</span><span class='tstring_end'>&#39;</span></span>
1007
+ <span class='kw'>end</span></pre>
1008
+ </td>
1009
+ </tr>
1010
+ </table>
1011
+ </div>
1012
+
1013
+ </div>
1014
+
1015
+ </div>
1016
+
1017
+ <div id="footer">
1018
+ Generated on Sat Jan 25 00:19:40 2020 by
1019
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1020
+ 0.9.16 (ruby-2.5.1).
1021
+ </div>
1022
+
1023
+ </div>
1024
+ </body>
1025
+ </html>