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/Manager.html ADDED
@@ -0,0 +1,1596 @@
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::Manager
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::Manager";
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 (M)</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">Manager</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::Manager
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/manager.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="#check_manager_configuration-instance_method" title="#check_manager_configuration (instance method)">#<strong>check_manager_configuration</strong> &#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>Check Wazuh configuration Returns if Wazuh configuration is OK.</p>
125
+ </div></span>
126
+
127
+ </li>
128
+
129
+
130
+ <li class="public ">
131
+ <span class="summary_signature">
132
+
133
+ <a href="#delete_manager_local_file-instance_method" title="#delete_manager_local_file (instance method)">#<strong>delete_manager_local_file</strong>(options = {}) &#x21d2; Object </a>
134
+
135
+
136
+
137
+ </span>
138
+
139
+
140
+
141
+
142
+
143
+
144
+
145
+
146
+
147
+ <span class="summary_desc"><div class='inline'>
148
+ <p>Delete a local file Confirmation message.</p>
149
+ </div></span>
150
+
151
+ </li>
152
+
153
+
154
+ <li class="public ">
155
+ <span class="summary_signature">
156
+
157
+ <a href="#get_manager_local_file-instance_method" title="#get_manager_local_file (instance method)">#<strong>get_manager_local_file</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 local file Returns the content of a local file (rules, decoders and
173
+ lists).</p>
174
+ </div></span>
175
+
176
+ </li>
177
+
178
+
179
+ <li class="public ">
180
+ <span class="summary_signature">
181
+
182
+ <a href="#manager_active_configuration-instance_method" title="#manager_active_configuration (instance method)">#<strong>manager_active_configuration</strong>(component, configuration) &#x21d2; Object </a>
183
+
184
+
185
+
186
+ </span>
187
+
188
+
189
+
190
+
191
+
192
+
193
+
194
+
195
+
196
+ <span class="summary_desc"><div class='inline'>
197
+ <p>Get manager active configuration Returns the requested configuration in
198
+ JSON format.</p>
199
+ </div></span>
200
+
201
+ </li>
202
+
203
+
204
+ <li class="public ">
205
+ <span class="summary_signature">
206
+
207
+ <a href="#manager_analysisd_stats-instance_method" title="#manager_analysisd_stats (instance method)">#<strong>manager_analysisd_stats</strong> &#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 analysisd stats Returns a summary of the current analysisd stats.</p>
223
+ </div></span>
224
+
225
+ </li>
226
+
227
+
228
+ <li class="public ">
229
+ <span class="summary_signature">
230
+
231
+ <a href="#manager_configuration-instance_method" title="#manager_configuration (instance method)">#<strong>manager_configuration</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 manager configuration Returns ossec.conf in JSON format.</p>
247
+ </div></span>
248
+
249
+ </li>
250
+
251
+
252
+ <li class="public ">
253
+ <span class="summary_signature">
254
+
255
+ <a href="#manager_information-instance_method" title="#manager_information (instance method)">#<strong>manager_information</strong> &#x21d2; Object </a>
256
+
257
+
258
+
259
+ </span>
260
+
261
+
262
+
263
+
264
+
265
+
266
+
267
+
268
+
269
+ <span class="summary_desc"><div class='inline'>
270
+ <p>Get manager information Returns basic information about manager.</p>
271
+ </div></span>
272
+
273
+ </li>
274
+
275
+
276
+ <li class="public ">
277
+ <span class="summary_signature">
278
+
279
+ <a href="#manager_log-instance_method" title="#manager_log (instance method)">#<strong>manager_log</strong> &#x21d2; Object </a>
280
+
281
+
282
+
283
+ </span>
284
+
285
+
286
+
287
+
288
+
289
+
290
+
291
+
292
+
293
+ <span class="summary_desc"><div class='inline'>
294
+ <p>Get ossec.log Returns the three last months of ossec.log.</p>
295
+ </div></span>
296
+
297
+ </li>
298
+
299
+
300
+ <li class="public ">
301
+ <span class="summary_signature">
302
+
303
+ <a href="#manager_remoted_stats-instance_method" title="#manager_remoted_stats (instance method)">#<strong>manager_remoted_stats</strong> &#x21d2; Object </a>
304
+
305
+
306
+
307
+ </span>
308
+
309
+
310
+
311
+
312
+
313
+
314
+
315
+
316
+
317
+ <span class="summary_desc"><div class='inline'>
318
+ <p>Get remoted stats Returns a summary of the current remoted stats.</p>
319
+ </div></span>
320
+
321
+ </li>
322
+
323
+
324
+ <li class="public ">
325
+ <span class="summary_signature">
326
+
327
+ <a href="#manager_stats-instance_method" title="#manager_stats (instance method)">#<strong>manager_stats</strong>(options = {}) &#x21d2; Object </a>
328
+
329
+
330
+
331
+ </span>
332
+
333
+
334
+
335
+
336
+
337
+
338
+
339
+
340
+
341
+ <span class="summary_desc"><div class='inline'>
342
+ <p>Get manager stats Returns Wazuh statistical information for the current or
343
+ specified date.</p>
344
+ </div></span>
345
+
346
+ </li>
347
+
348
+
349
+ <li class="public ">
350
+ <span class="summary_signature">
351
+
352
+ <a href="#manager_stats_by_hour-instance_method" title="#manager_stats_by_hour (instance method)">#<strong>manager_stats_by_hour</strong> &#x21d2; Object </a>
353
+
354
+
355
+
356
+ </span>
357
+
358
+
359
+
360
+
361
+
362
+
363
+
364
+
365
+
366
+ <span class="summary_desc"><div class='inline'>
367
+ <p>Get manager stats by hour Returns Wazuh statistical information per hour.</p>
368
+ </div></span>
369
+
370
+ </li>
371
+
372
+
373
+ <li class="public ">
374
+ <span class="summary_signature">
375
+
376
+ <a href="#manager_stats_by_weekly-instance_method" title="#manager_stats_by_weekly (instance method)">#<strong>manager_stats_by_weekly</strong> &#x21d2; Object </a>
377
+
378
+
379
+
380
+ </span>
381
+
382
+
383
+
384
+
385
+
386
+
387
+
388
+
389
+
390
+ <span class="summary_desc"><div class='inline'>
391
+ <p>Get manager stats by weekly Returns Wazuh statistical information per week.</p>
392
+ </div></span>
393
+
394
+ </li>
395
+
396
+
397
+ <li class="public ">
398
+ <span class="summary_signature">
399
+
400
+ <a href="#manager_status-instance_method" title="#manager_status (instance method)">#<strong>manager_status</strong> &#x21d2; Object </a>
401
+
402
+
403
+
404
+ </span>
405
+
406
+
407
+
408
+
409
+
410
+
411
+
412
+
413
+
414
+ <span class="summary_desc"><div class='inline'>
415
+ <p>Get manager status Returns the status of the manager processes.</p>
416
+ </div></span>
417
+
418
+ </li>
419
+
420
+
421
+ <li class="public ">
422
+ <span class="summary_signature">
423
+
424
+ <a href="#manager_summary_log-instance_method" title="#manager_summary_log (instance method)">#<strong>manager_summary_log</strong> &#x21d2; Object </a>
425
+
426
+
427
+
428
+ </span>
429
+
430
+
431
+
432
+
433
+
434
+
435
+
436
+
437
+
438
+ <span class="summary_desc"><div class='inline'>
439
+ <p>Get summary of ossec.log Returns a summary of the last three months of the
440
+ <code>ossec.log</code> file.</p>
441
+ </div></span>
442
+
443
+ </li>
444
+
445
+
446
+ <li class="public ">
447
+ <span class="summary_signature">
448
+
449
+ <a href="#restart_manager-instance_method" title="#restart_manager (instance method)">#<strong>restart_manager</strong> &#x21d2; Object </a>
450
+
451
+
452
+
453
+ </span>
454
+
455
+
456
+
457
+
458
+
459
+
460
+
461
+
462
+
463
+ <span class="summary_desc"><div class='inline'>
464
+ <p>Restart Wazuh manager Restarts Wazuh manager.</p>
465
+ </div></span>
466
+
467
+ </li>
468
+
469
+
470
+ <li class="public ">
471
+ <span class="summary_signature">
472
+
473
+ <a href="#update_manager_local_file-instance_method" title="#update_manager_local_file (instance method)">#<strong>update_manager_local_file</strong>(options = {}) &#x21d2; Object </a>
474
+
475
+
476
+
477
+ </span>
478
+
479
+
480
+
481
+
482
+
483
+
484
+
485
+
486
+
487
+ <span class="summary_desc"><div class='inline'>
488
+ <p>Update local file Upload a local file (rules, decoders and lists).</p>
489
+ </div></span>
490
+
491
+ </li>
492
+
493
+
494
+ </ul>
495
+
496
+
497
+
498
+
499
+ <div id="instance_method_details" class="method_details_list">
500
+ <h2>Instance Method Details</h2>
501
+
502
+
503
+ <div class="method_details first">
504
+ <h3 class="signature first" id="check_manager_configuration-instance_method">
505
+
506
+ #<strong>check_manager_configuration</strong> &#x21d2; <tt>Object</tt>
507
+
508
+
509
+
510
+
511
+
512
+ </h3><div class="docstring">
513
+ <div class="discussion">
514
+
515
+ <p>Check Wazuh configuration Returns if Wazuh configuration is OK.</p>
516
+
517
+
518
+ </div>
519
+ </div>
520
+ <div class="tags">
521
+
522
+
523
+ <p class="tag_title">See Also:</p>
524
+ <ul class="see">
525
+
526
+ <li><a href="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#check-wazuh-configuration" target="_parent" title="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#check-wazuh-configuration">https://documentation.wazuh.com/3.10/user-manual/api/reference.html#check-wazuh-configuration</a></li>
527
+
528
+ </ul>
529
+
530
+ </div><table class="source_code">
531
+ <tr>
532
+ <td>
533
+ <pre class="lines">
534
+
535
+
536
+ 32
537
+ 33
538
+ 34</pre>
539
+ </td>
540
+ <td>
541
+ <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/manager.rb', line 32</span>
542
+
543
+ <span class='kw'>def</span> <span class='id identifier rubyid_check_manager_configuration'>check_manager_configuration</span>
544
+ <span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/manager/configuration/validation</span><span class='tstring_end'>&#39;</span></span>
545
+ <span class='kw'>end</span></pre>
546
+ </td>
547
+ </tr>
548
+ </table>
549
+ </div>
550
+
551
+ <div class="method_details ">
552
+ <h3 class="signature " id="delete_manager_local_file-instance_method">
553
+
554
+ #<strong>delete_manager_local_file</strong>(options = {}) &#x21d2; <tt>Object</tt>
555
+
556
+
557
+
558
+
559
+
560
+ </h3><div class="docstring">
561
+ <div class="discussion">
562
+
563
+ <p>Delete a local file Confirmation message.</p>
564
+
565
+
566
+ </div>
567
+ </div>
568
+ <div class="tags">
569
+ <p class="tag_title">Parameters:</p>
570
+ <ul class="param">
571
+
572
+ <li>
573
+
574
+ <span class='name'>options</span>
575
+
576
+
577
+ <span class='type'>(<tt>Hash</tt>)</span>
578
+
579
+
580
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
581
+
582
+
583
+ &mdash;
584
+ <div class='inline'>
585
+ <p>a customizable set of options</p>
586
+ </div>
587
+
588
+ </li>
589
+
590
+ </ul>
591
+
592
+
593
+
594
+
595
+ <p class="tag_title">Options Hash (<tt>options</tt>):</p>
596
+ <ul class="option">
597
+
598
+ <li>
599
+ <span class="name">:path</span>
600
+ <span class="type">(<tt>path</tt>)</span>
601
+ <span class="default">
602
+
603
+ </span>
604
+
605
+ &mdash; <div class='inline'>
606
+ <p>Relative path of file. This parameter is mandatory.</p>
607
+ </div>
608
+
609
+ </li>
610
+
611
+ </ul>
612
+
613
+
614
+
615
+ <p class="tag_title">See Also:</p>
616
+ <ul class="see">
617
+
618
+ <li><a href="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#delete-a-local-file" target="_parent" title="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#delete-a-local-file">https://documentation.wazuh.com/3.10/user-manual/api/reference.html#delete-a-local-file</a></li>
619
+
620
+ </ul>
621
+
622
+ </div><table class="source_code">
623
+ <tr>
624
+ <td>
625
+ <pre class="lines">
626
+
627
+
628
+ 42
629
+ 43
630
+ 44</pre>
631
+ </td>
632
+ <td>
633
+ <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/manager.rb', line 42</span>
634
+
635
+ <span class='kw'>def</span> <span class='id identifier rubyid_delete_manager_local_file'>delete_manager_local_file</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>
636
+ <span class='id identifier rubyid_delete'>delete</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/manager/files</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span>
637
+ <span class='kw'>end</span></pre>
638
+ </td>
639
+ </tr>
640
+ </table>
641
+ </div>
642
+
643
+ <div class="method_details ">
644
+ <h3 class="signature " id="get_manager_local_file-instance_method">
645
+
646
+ #<strong>get_manager_local_file</strong>(options = {}) &#x21d2; <tt>Object</tt>
647
+
648
+
649
+
650
+
651
+
652
+ </h3><div class="docstring">
653
+ <div class="discussion">
654
+
655
+ <p>Get local file Returns the content of a local file (rules, decoders and
656
+ lists).</p>
657
+
658
+
659
+ </div>
660
+ </div>
661
+ <div class="tags">
662
+ <p class="tag_title">Parameters:</p>
663
+ <ul class="param">
664
+
665
+ <li>
666
+
667
+ <span class='name'>options</span>
668
+
669
+
670
+ <span class='type'>(<tt>Hash</tt>)</span>
671
+
672
+
673
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
674
+
675
+
676
+ &mdash;
677
+ <div class='inline'>
678
+ <p>a customizable set of options</p>
679
+ </div>
680
+
681
+ </li>
682
+
683
+ </ul>
684
+
685
+
686
+
687
+
688
+ <p class="tag_title">Options Hash (<tt>options</tt>):</p>
689
+ <ul class="option">
690
+
691
+ <li>
692
+ <span class="name">:path</span>
693
+ <span class="type">(<tt>path</tt>)</span>
694
+ <span class="default">
695
+
696
+ </span>
697
+
698
+ &mdash; <div class='inline'>
699
+ <p>Relative path of file. This parameter is mandatory.</p>
700
+ </div>
701
+
702
+ </li>
703
+
704
+ <li>
705
+ <span class="name">:validation</span>
706
+ <span class="type">(<tt>validation</tt>)</span>
707
+ <span class="default">
708
+
709
+ </span>
710
+
711
+ &mdash; <div class='inline'>
712
+ <p>Validates the content of the file. An error will be returned if file
713
+ content is not strictly correct. False by default.</p>
714
+ </div>
715
+
716
+ </li>
717
+
718
+ </ul>
719
+
720
+
721
+
722
+ <p class="tag_title">See Also:</p>
723
+ <ul class="see">
724
+
725
+ <li><a href="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-local-file" target="_parent" title="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-local-file">https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-local-file</a></li>
726
+
727
+ </ul>
728
+
729
+ </div><table class="source_code">
730
+ <tr>
731
+ <td>
732
+ <pre class="lines">
733
+
734
+
735
+ 54
736
+ 55
737
+ 56</pre>
738
+ </td>
739
+ <td>
740
+ <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/manager.rb', line 54</span>
741
+
742
+ <span class='kw'>def</span> <span class='id identifier rubyid_get_manager_local_file'>get_manager_local_file</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>
743
+ <span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/manager/files</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span>
744
+ <span class='kw'>end</span></pre>
745
+ </td>
746
+ </tr>
747
+ </table>
748
+ </div>
749
+
750
+ <div class="method_details ">
751
+ <h3 class="signature " id="manager_active_configuration-instance_method">
752
+
753
+ #<strong>manager_active_configuration</strong>(component, configuration) &#x21d2; <tt>Object</tt>
754
+
755
+
756
+
757
+
758
+
759
+ </h3><div class="docstring">
760
+ <div class="discussion">
761
+
762
+ <p>Get manager active configuration Returns the requested configuration in
763
+ JSON format.</p>
764
+
765
+
766
+ </div>
767
+ </div>
768
+ <div class="tags">
769
+ <p class="tag_title">Parameters:</p>
770
+ <ul class="param">
771
+
772
+ <li>
773
+
774
+ <span class='name'>component</span>
775
+
776
+
777
+ <span class='type'>(<tt>String</tt>)</span>
778
+
779
+
780
+
781
+ &mdash;
782
+ <div class='inline'>
783
+ <p>Selected component.</p>
784
+ </div>
785
+
786
+ </li>
787
+
788
+ <li>
789
+
790
+ <span class='name'>configuration</span>
791
+
792
+
793
+ <span class='type'>(<tt>String</tt>)</span>
794
+
795
+
796
+
797
+ &mdash;
798
+ <div class='inline'>
799
+ <p>Configuration to read.</p>
800
+ </div>
801
+
802
+ </li>
803
+
804
+ </ul>
805
+
806
+
807
+ <p class="tag_title">See Also:</p>
808
+ <ul class="see">
809
+
810
+ <li><a href="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-manager-active-configuration" target="_parent" title="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-manager-active-configuration">https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-manager-active-configuration</a></li>
811
+
812
+ </ul>
813
+
814
+ </div><table class="source_code">
815
+ <tr>
816
+ <td>
817
+ <pre class="lines">
818
+
819
+
820
+ 13
821
+ 14
822
+ 15</pre>
823
+ </td>
824
+ <td>
825
+ <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/manager.rb', line 13</span>
826
+
827
+ <span class='kw'>def</span> <span class='id identifier rubyid_manager_active_configuration'>manager_active_configuration</span><span class='lparen'>(</span><span class='id identifier rubyid_component'>component</span><span class='comma'>,</span> <span class='id identifier rubyid_configuration'>configuration</span><span class='rparen'>)</span>
828
+ <span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/manager/config/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_component'>component</span><span class='embexpr_end'>}</span><span class='tstring_content'>/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_configuration'>configuration</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
829
+ <span class='kw'>end</span></pre>
830
+ </td>
831
+ </tr>
832
+ </table>
833
+ </div>
834
+
835
+ <div class="method_details ">
836
+ <h3 class="signature " id="manager_analysisd_stats-instance_method">
837
+
838
+ #<strong>manager_analysisd_stats</strong> &#x21d2; <tt>Object</tt>
839
+
840
+
841
+
842
+
843
+
844
+ </h3><div class="docstring">
845
+ <div class="discussion">
846
+
847
+ <p>Get analysisd stats Returns a summary of the current analysisd stats.</p>
848
+
849
+
850
+ </div>
851
+ </div>
852
+ <div class="tags">
853
+
854
+
855
+ <p class="tag_title">See Also:</p>
856
+ <ul class="see">
857
+
858
+ <li><a href="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-analysisd-stats" target="_parent" title="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-analysisd-stats">https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-analysisd-stats</a></li>
859
+
860
+ </ul>
861
+
862
+ </div><table class="source_code">
863
+ <tr>
864
+ <td>
865
+ <pre class="lines">
866
+
867
+
868
+ 116
869
+ 117
870
+ 118</pre>
871
+ </td>
872
+ <td>
873
+ <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/manager.rb', line 116</span>
874
+
875
+ <span class='kw'>def</span> <span class='id identifier rubyid_manager_analysisd_stats'>manager_analysisd_stats</span>
876
+ <span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/manager/stats/analysisd</span><span class='tstring_end'>&#39;</span></span>
877
+ <span class='kw'>end</span></pre>
878
+ </td>
879
+ </tr>
880
+ </table>
881
+ </div>
882
+
883
+ <div class="method_details ">
884
+ <h3 class="signature " id="manager_configuration-instance_method">
885
+
886
+ #<strong>manager_configuration</strong>(options = {}) &#x21d2; <tt>Object</tt>
887
+
888
+
889
+
890
+
891
+
892
+ </h3><div class="docstring">
893
+ <div class="discussion">
894
+
895
+ <p>Get manager configuration Returns ossec.conf in JSON format.</p>
896
+
897
+
898
+ </div>
899
+ </div>
900
+ <div class="tags">
901
+ <p class="tag_title">Parameters:</p>
902
+ <ul class="param">
903
+
904
+ <li>
905
+
906
+ <span class='name'>options</span>
907
+
908
+
909
+ <span class='type'>(<tt>Hash</tt>)</span>
910
+
911
+
912
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
913
+
914
+
915
+ &mdash;
916
+ <div class='inline'>
917
+ <p>a customizable set of options</p>
918
+ </div>
919
+
920
+ </li>
921
+
922
+ </ul>
923
+
924
+
925
+
926
+
927
+ <p class="tag_title">Options Hash (<tt>options</tt>):</p>
928
+ <ul class="option">
929
+
930
+ <li>
931
+ <span class="name">:section</span>
932
+ <span class="type">(<tt>section</tt>)</span>
933
+ <span class="default">
934
+
935
+ </span>
936
+
937
+ &mdash; <div class='inline'>
938
+ <p>Indicates the ossec.conf section: global, rules, syscheck, rootcheck,
939
+ remote, alerts, command, active-response, localfile.</p>
940
+ </div>
941
+
942
+ </li>
943
+
944
+ <li>
945
+ <span class="name">:field</span>
946
+ <span class="type">(<tt>field</tt>)</span>
947
+ <span class="default">
948
+
949
+ </span>
950
+
951
+ &mdash; <div class='inline'>
952
+ <p>Indicates a section child, e.g, fields for rule section are: include,
953
+ decoder_dir, etc.</p>
954
+ </div>
955
+
956
+ </li>
957
+
958
+ </ul>
959
+
960
+
961
+
962
+ </div><table class="source_code">
963
+ <tr>
964
+ <td>
965
+ <pre class="lines">
966
+
967
+
968
+ 24
969
+ 25
970
+ 26</pre>
971
+ </td>
972
+ <td>
973
+ <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/manager.rb', line 24</span>
974
+
975
+ <span class='kw'>def</span> <span class='id identifier rubyid_manager_configuration'>manager_configuration</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>
976
+ <span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/manager/configuration</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span>
977
+ <span class='kw'>end</span></pre>
978
+ </td>
979
+ </tr>
980
+ </table>
981
+ </div>
982
+
983
+ <div class="method_details ">
984
+ <h3 class="signature " id="manager_information-instance_method">
985
+
986
+ #<strong>manager_information</strong> &#x21d2; <tt>Object</tt>
987
+
988
+
989
+
990
+
991
+
992
+ </h3><div class="docstring">
993
+ <div class="discussion">
994
+
995
+ <p>Get manager information Returns basic information about manager.</p>
996
+
997
+
998
+ </div>
999
+ </div>
1000
+ <div class="tags">
1001
+
1002
+
1003
+ <p class="tag_title">See Also:</p>
1004
+ <ul class="see">
1005
+
1006
+ <li><a href="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-manager-information" target="_parent" title="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-manager-information">https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-manager-information</a></li>
1007
+
1008
+ </ul>
1009
+
1010
+ </div><table class="source_code">
1011
+ <tr>
1012
+ <td>
1013
+ <pre class="lines">
1014
+
1015
+
1016
+ 76
1017
+ 77
1018
+ 78</pre>
1019
+ </td>
1020
+ <td>
1021
+ <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/manager.rb', line 76</span>
1022
+
1023
+ <span class='kw'>def</span> <span class='id identifier rubyid_manager_information'>manager_information</span>
1024
+ <span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/manager/info</span><span class='tstring_end'>&#39;</span></span>
1025
+ <span class='kw'>end</span></pre>
1026
+ </td>
1027
+ </tr>
1028
+ </table>
1029
+ </div>
1030
+
1031
+ <div class="method_details ">
1032
+ <h3 class="signature " id="manager_log-instance_method">
1033
+
1034
+ #<strong>manager_log</strong> &#x21d2; <tt>Object</tt>
1035
+
1036
+
1037
+
1038
+
1039
+
1040
+ </h3><div class="docstring">
1041
+ <div class="discussion">
1042
+
1043
+ <p>Get ossec.log Returns the three last months of ossec.log.</p>
1044
+
1045
+
1046
+ </div>
1047
+ </div>
1048
+ <div class="tags">
1049
+
1050
+
1051
+ <p class="tag_title">See Also:</p>
1052
+ <ul class="see">
1053
+
1054
+ <li><a href="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-ossec-log" target="_parent" title="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-ossec-log">https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-ossec-log</a></li>
1055
+
1056
+ </ul>
1057
+
1058
+ </div><table class="source_code">
1059
+ <tr>
1060
+ <td>
1061
+ <pre class="lines">
1062
+
1063
+
1064
+ 92
1065
+ 93
1066
+ 94</pre>
1067
+ </td>
1068
+ <td>
1069
+ <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/manager.rb', line 92</span>
1070
+
1071
+ <span class='kw'>def</span> <span class='id identifier rubyid_manager_log'>manager_log</span>
1072
+ <span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/manager/logs</span><span class='tstring_end'>&#39;</span></span>
1073
+ <span class='kw'>end</span></pre>
1074
+ </td>
1075
+ </tr>
1076
+ </table>
1077
+ </div>
1078
+
1079
+ <div class="method_details ">
1080
+ <h3 class="signature " id="manager_remoted_stats-instance_method">
1081
+
1082
+ #<strong>manager_remoted_stats</strong> &#x21d2; <tt>Object</tt>
1083
+
1084
+
1085
+
1086
+
1087
+
1088
+ </h3><div class="docstring">
1089
+ <div class="discussion">
1090
+
1091
+ <p>Get remoted stats Returns a summary of the current remoted stats.</p>
1092
+
1093
+
1094
+ </div>
1095
+ </div>
1096
+ <div class="tags">
1097
+
1098
+
1099
+ <p class="tag_title">See Also:</p>
1100
+ <ul class="see">
1101
+
1102
+ <li><a href="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-remoted-stats" target="_parent" title="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-remoted-stats">https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-remoted-stats</a></li>
1103
+
1104
+ </ul>
1105
+
1106
+ </div><table class="source_code">
1107
+ <tr>
1108
+ <td>
1109
+ <pre class="lines">
1110
+
1111
+
1112
+ 150
1113
+ 151
1114
+ 152</pre>
1115
+ </td>
1116
+ <td>
1117
+ <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/manager.rb', line 150</span>
1118
+
1119
+ <span class='kw'>def</span> <span class='id identifier rubyid_manager_remoted_stats'>manager_remoted_stats</span>
1120
+ <span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/manager/stats/remoted</span><span class='tstring_end'>&#39;</span></span>
1121
+ <span class='kw'>end</span></pre>
1122
+ </td>
1123
+ </tr>
1124
+ </table>
1125
+ </div>
1126
+
1127
+ <div class="method_details ">
1128
+ <h3 class="signature " id="manager_stats-instance_method">
1129
+
1130
+ #<strong>manager_stats</strong>(options = {}) &#x21d2; <tt>Object</tt>
1131
+
1132
+
1133
+
1134
+
1135
+
1136
+ </h3><div class="docstring">
1137
+ <div class="discussion">
1138
+
1139
+ <p>Get manager stats Returns Wazuh statistical information for the current or
1140
+ specified date.</p>
1141
+
1142
+
1143
+ </div>
1144
+ </div>
1145
+ <div class="tags">
1146
+ <p class="tag_title">Parameters:</p>
1147
+ <ul class="param">
1148
+
1149
+ <li>
1150
+
1151
+ <span class='name'>options</span>
1152
+
1153
+
1154
+ <span class='type'>(<tt>Hash</tt>)</span>
1155
+
1156
+
1157
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
1158
+
1159
+
1160
+ &mdash;
1161
+ <div class='inline'>
1162
+ <p>a customizable set of options</p>
1163
+ </div>
1164
+
1165
+ </li>
1166
+
1167
+ </ul>
1168
+
1169
+
1170
+
1171
+
1172
+ <p class="tag_title">Options Hash (<tt>options</tt>):</p>
1173
+ <ul class="option">
1174
+
1175
+ <li>
1176
+ <span class="name">:date</span>
1177
+ <span class="type">(<tt>date</tt>)</span>
1178
+ <span class="default">
1179
+
1180
+ </span>
1181
+
1182
+ &mdash; <div class='inline'>
1183
+ <p>Selects the date for getting the statistical information. Format: YYYYMMDD</p>
1184
+ </div>
1185
+
1186
+ </li>
1187
+
1188
+ </ul>
1189
+
1190
+
1191
+
1192
+ <p class="tag_title">See Also:</p>
1193
+ <ul class="see">
1194
+
1195
+ <li><a href="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-manager-stats" target="_parent" title="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-manager-stats">https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-manager-stats</a></li>
1196
+
1197
+ </ul>
1198
+
1199
+ </div><table class="source_code">
1200
+ <tr>
1201
+ <td>
1202
+ <pre class="lines">
1203
+
1204
+
1205
+ 126
1206
+ 127
1207
+ 128</pre>
1208
+ </td>
1209
+ <td>
1210
+ <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/manager.rb', line 126</span>
1211
+
1212
+ <span class='kw'>def</span> <span class='id identifier rubyid_manager_stats'>manager_stats</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>
1213
+ <span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/manager/stats</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span>
1214
+ <span class='kw'>end</span></pre>
1215
+ </td>
1216
+ </tr>
1217
+ </table>
1218
+ </div>
1219
+
1220
+ <div class="method_details ">
1221
+ <h3 class="signature " id="manager_stats_by_hour-instance_method">
1222
+
1223
+ #<strong>manager_stats_by_hour</strong> &#x21d2; <tt>Object</tt>
1224
+
1225
+
1226
+
1227
+
1228
+
1229
+ </h3><div class="docstring">
1230
+ <div class="discussion">
1231
+
1232
+ <p>Get manager stats by hour Returns Wazuh statistical information per hour.
1233
+ Each number in the averages field represents the average of alerts per
1234
+ hour.</p>
1235
+
1236
+
1237
+ </div>
1238
+ </div>
1239
+ <div class="tags">
1240
+
1241
+
1242
+ <p class="tag_title">See Also:</p>
1243
+ <ul class="see">
1244
+
1245
+ <li><a href="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-manager-stats-by-hour" target="_parent" title="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-manager-stats-by-hour">https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-manager-stats-by-hour</a></li>
1246
+
1247
+ </ul>
1248
+
1249
+ </div><table class="source_code">
1250
+ <tr>
1251
+ <td>
1252
+ <pre class="lines">
1253
+
1254
+
1255
+ 134
1256
+ 135
1257
+ 136</pre>
1258
+ </td>
1259
+ <td>
1260
+ <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/manager.rb', line 134</span>
1261
+
1262
+ <span class='kw'>def</span> <span class='id identifier rubyid_manager_stats_by_hour'>manager_stats_by_hour</span>
1263
+ <span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/manager/stats/hourly</span><span class='tstring_end'>&#39;</span></span>
1264
+ <span class='kw'>end</span></pre>
1265
+ </td>
1266
+ </tr>
1267
+ </table>
1268
+ </div>
1269
+
1270
+ <div class="method_details ">
1271
+ <h3 class="signature " id="manager_stats_by_weekly-instance_method">
1272
+
1273
+ #<strong>manager_stats_by_weekly</strong> &#x21d2; <tt>Object</tt>
1274
+
1275
+
1276
+
1277
+
1278
+
1279
+ </h3><div class="docstring">
1280
+ <div class="discussion">
1281
+
1282
+ <p>Get manager stats by weekly Returns Wazuh statistical information per week.
1283
+ Each number in the hours field represents the average alerts per hour for
1284
+ that specific day.</p>
1285
+
1286
+
1287
+ </div>
1288
+ </div>
1289
+ <div class="tags">
1290
+
1291
+
1292
+ <p class="tag_title">See Also:</p>
1293
+ <ul class="see">
1294
+
1295
+ <li><a href="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-manager-stats-by-week" target="_parent" title="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-manager-stats-by-week">https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-manager-stats-by-week</a></li>
1296
+
1297
+ </ul>
1298
+
1299
+ </div><table class="source_code">
1300
+ <tr>
1301
+ <td>
1302
+ <pre class="lines">
1303
+
1304
+
1305
+ 142
1306
+ 143
1307
+ 144</pre>
1308
+ </td>
1309
+ <td>
1310
+ <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/manager.rb', line 142</span>
1311
+
1312
+ <span class='kw'>def</span> <span class='id identifier rubyid_manager_stats_by_weekly'>manager_stats_by_weekly</span>
1313
+ <span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/manager/stats/weekly</span><span class='tstring_end'>&#39;</span></span>
1314
+ <span class='kw'>end</span></pre>
1315
+ </td>
1316
+ </tr>
1317
+ </table>
1318
+ </div>
1319
+
1320
+ <div class="method_details ">
1321
+ <h3 class="signature " id="manager_status-instance_method">
1322
+
1323
+ #<strong>manager_status</strong> &#x21d2; <tt>Object</tt>
1324
+
1325
+
1326
+
1327
+
1328
+
1329
+ </h3><div class="docstring">
1330
+ <div class="discussion">
1331
+
1332
+ <p>Get manager status Returns the status of the manager processes.</p>
1333
+
1334
+
1335
+ </div>
1336
+ </div>
1337
+ <div class="tags">
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-manager-status" target="_parent" title="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-manager-status">https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-manager-status</a></li>
1344
+
1345
+ </ul>
1346
+
1347
+ </div><table class="source_code">
1348
+ <tr>
1349
+ <td>
1350
+ <pre class="lines">
1351
+
1352
+
1353
+ 84
1354
+ 85
1355
+ 86</pre>
1356
+ </td>
1357
+ <td>
1358
+ <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/manager.rb', line 84</span>
1359
+
1360
+ <span class='kw'>def</span> <span class='id identifier rubyid_manager_status'>manager_status</span>
1361
+ <span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/manager/status</span><span class='tstring_end'>&#39;</span></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="manager_summary_log-instance_method">
1370
+
1371
+ #<strong>manager_summary_log</strong> &#x21d2; <tt>Object</tt>
1372
+
1373
+
1374
+
1375
+
1376
+
1377
+ </h3><div class="docstring">
1378
+ <div class="discussion">
1379
+
1380
+ <p>Get summary of ossec.log Returns a summary of the last three months of the
1381
+ <code>ossec.log</code> file.</p>
1382
+
1383
+
1384
+ </div>
1385
+ </div>
1386
+ <div class="tags">
1387
+
1388
+
1389
+ <p class="tag_title">See Also:</p>
1390
+ <ul class="see">
1391
+
1392
+ <li><a href="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-summary-of-ossec-log" target="_parent" title="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-summary-of-ossec-log">https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-summary-of-ossec-log</a></li>
1393
+
1394
+ </ul>
1395
+
1396
+ </div><table class="source_code">
1397
+ <tr>
1398
+ <td>
1399
+ <pre class="lines">
1400
+
1401
+
1402
+ 100
1403
+ 101
1404
+ 102</pre>
1405
+ </td>
1406
+ <td>
1407
+ <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/manager.rb', line 100</span>
1408
+
1409
+ <span class='kw'>def</span> <span class='id identifier rubyid_manager_summary_log'>manager_summary_log</span>
1410
+ <span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/manager/logs/summary</span><span class='tstring_end'>&#39;</span></span>
1411
+ <span class='kw'>end</span></pre>
1412
+ </td>
1413
+ </tr>
1414
+ </table>
1415
+ </div>
1416
+
1417
+ <div class="method_details ">
1418
+ <h3 class="signature " id="restart_manager-instance_method">
1419
+
1420
+ #<strong>restart_manager</strong> &#x21d2; <tt>Object</tt>
1421
+
1422
+
1423
+
1424
+
1425
+
1426
+ </h3><div class="docstring">
1427
+ <div class="discussion">
1428
+
1429
+ <p>Restart Wazuh manager Restarts Wazuh manager.</p>
1430
+
1431
+
1432
+ </div>
1433
+ </div>
1434
+ <div class="tags">
1435
+
1436
+
1437
+ <p class="tag_title">See Also:</p>
1438
+ <ul class="see">
1439
+
1440
+ <li><a href="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#restart-wazuh-manager" target="_parent" title="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#restart-wazuh-manager">https://documentation.wazuh.com/3.10/user-manual/api/reference.html#restart-wazuh-manager</a></li>
1441
+
1442
+ </ul>
1443
+
1444
+ </div><table class="source_code">
1445
+ <tr>
1446
+ <td>
1447
+ <pre class="lines">
1448
+
1449
+
1450
+ 108
1451
+ 109
1452
+ 110</pre>
1453
+ </td>
1454
+ <td>
1455
+ <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/manager.rb', line 108</span>
1456
+
1457
+ <span class='kw'>def</span> <span class='id identifier rubyid_restart_manager'>restart_manager</span>
1458
+ <span class='id identifier rubyid_put'>put</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/manager/restart</span><span class='tstring_end'>&#39;</span></span>
1459
+ <span class='kw'>end</span></pre>
1460
+ </td>
1461
+ </tr>
1462
+ </table>
1463
+ </div>
1464
+
1465
+ <div class="method_details ">
1466
+ <h3 class="signature " id="update_manager_local_file-instance_method">
1467
+
1468
+ #<strong>update_manager_local_file</strong>(options = {}) &#x21d2; <tt>Object</tt>
1469
+
1470
+
1471
+
1472
+
1473
+
1474
+ </h3><div class="docstring">
1475
+ <div class="discussion">
1476
+
1477
+ <p>Update local file Upload a local file (rules, decoders and lists).</p>
1478
+
1479
+
1480
+ </div>
1481
+ </div>
1482
+ <div class="tags">
1483
+ <p class="tag_title">Parameters:</p>
1484
+ <ul class="param">
1485
+
1486
+ <li>
1487
+
1488
+ <span class='name'>options</span>
1489
+
1490
+
1491
+ <span class='type'>(<tt>Hash</tt>)</span>
1492
+
1493
+
1494
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
1495
+
1496
+
1497
+ &mdash;
1498
+ <div class='inline'>
1499
+ <p>a customizable set of options</p>
1500
+ </div>
1501
+
1502
+ </li>
1503
+
1504
+ </ul>
1505
+
1506
+
1507
+
1508
+
1509
+ <p class="tag_title">Options Hash (<tt>options</tt>):</p>
1510
+ <ul class="option">
1511
+
1512
+ <li>
1513
+ <span class="name">:path</span>
1514
+ <span class="type">(<tt>path</tt>)</span>
1515
+ <span class="default">
1516
+
1517
+ </span>
1518
+
1519
+ &mdash; <div class='inline'>
1520
+ <p>Relative path of file. This parameter is mandatory.</p>
1521
+ </div>
1522
+
1523
+ </li>
1524
+
1525
+ <li>
1526
+ <span class="name">:validation</span>
1527
+ <span class="type">(<tt>validation</tt>)</span>
1528
+ <span class="default">
1529
+
1530
+ </span>
1531
+
1532
+ &mdash; <div class='inline'>
1533
+ <p>Validates the content of the file. An error will be returned if file
1534
+ content is not strictly correct. False by default.</p>
1535
+ </div>
1536
+
1537
+ </li>
1538
+
1539
+ <li>
1540
+ <span class="name">:overwrite</span>
1541
+ <span class="type">(<tt>overwrite</tt>)</span>
1542
+ <span class="default">
1543
+
1544
+ </span>
1545
+
1546
+ &mdash; <div class='inline'>
1547
+ <p>Replaces the existing file. False by default.</p>
1548
+ </div>
1549
+
1550
+ </li>
1551
+
1552
+ </ul>
1553
+
1554
+
1555
+
1556
+ <p class="tag_title">See Also:</p>
1557
+ <ul class="see">
1558
+
1559
+ <li><a href="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#update-local-file" target="_parent" title="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#update-local-file">https://documentation.wazuh.com/3.10/user-manual/api/reference.html#update-local-file</a></li>
1560
+
1561
+ </ul>
1562
+
1563
+ </div><table class="source_code">
1564
+ <tr>
1565
+ <td>
1566
+ <pre class="lines">
1567
+
1568
+
1569
+ 68
1570
+ 69
1571
+ 70</pre>
1572
+ </td>
1573
+ <td>
1574
+ <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/manager.rb', line 68</span>
1575
+
1576
+ <span class='kw'>def</span> <span class='id identifier rubyid_update_manager_local_file'>update_manager_local_file</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>
1577
+ <span class='id identifier rubyid_post'>post</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/manager/files</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span>
1578
+ <span class='kw'>end</span></pre>
1579
+ </td>
1580
+ </tr>
1581
+ </table>
1582
+ </div>
1583
+
1584
+ </div>
1585
+
1586
+ </div>
1587
+
1588
+ <div id="footer">
1589
+ Generated on Sat Jan 25 00:19:40 2020 by
1590
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1591
+ 0.9.16 (ruby-2.5.1).
1592
+ </div>
1593
+
1594
+ </div>
1595
+ </body>
1596
+ </html>