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/Cluster.html ADDED
@@ -0,0 +1,2270 @@
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::Cluster
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::Cluster";
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 (C)</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">Cluster</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::Cluster
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/cluster.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="#analysisd_stats-instance_method" title="#analysisd_stats (instance method)">#<strong>analysisd_stats</strong>(node_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>Get node node_id’s analysisd stats.</p>
125
+ </div></span>
126
+
127
+ </li>
128
+
129
+
130
+ <li class="public ">
131
+ <span class="summary_signature">
132
+
133
+ <a href="#check_configuration-instance_method" title="#check_configuration (instance method)">#<strong>check_configuration</strong> &#x21d2; Object </a>
134
+
135
+
136
+
137
+ </span>
138
+
139
+
140
+
141
+
142
+
143
+
144
+
145
+
146
+
147
+ <span class="summary_desc"><div class='inline'>
148
+ <p>Check Wazuh configuration in all cluster nodes.</p>
149
+ </div></span>
150
+
151
+ </li>
152
+
153
+
154
+ <li class="public ">
155
+ <span class="summary_signature">
156
+
157
+ <a href="#check_configuration_by_node-instance_method" title="#check_configuration_by_node (instance method)">#<strong>check_configuration_by_node</strong>(node_id) &#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>Check Wazuh configuration in a cluster node.</p>
173
+ </div></span>
174
+
175
+ </li>
176
+
177
+
178
+ <li class="public ">
179
+ <span class="summary_signature">
180
+
181
+ <a href="#cluster_configuration-instance_method" title="#cluster_configuration (instance method)">#<strong>cluster_configuration</strong>(options = {}) &#x21d2; Object </a>
182
+
183
+
184
+
185
+ </span>
186
+
187
+
188
+
189
+
190
+
191
+
192
+
193
+
194
+
195
+ <span class="summary_desc"><div class='inline'>
196
+ <p>Returns the cluster configuration.</p>
197
+ </div></span>
198
+
199
+ </li>
200
+
201
+
202
+ <li class="public ">
203
+ <span class="summary_signature">
204
+
205
+ <a href="#cluster_healthcheck-instance_method" title="#cluster_healthcheck (instance method)">#<strong>cluster_healthcheck</strong>(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>Show cluster health.</p>
221
+ </div></span>
222
+
223
+ </li>
224
+
225
+
226
+ <li class="public ">
227
+ <span class="summary_signature">
228
+
229
+ <a href="#cluster_logs_by_node-instance_method" title="#cluster_logs_by_node (instance method)">#<strong>cluster_logs_by_node</strong>(node_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>Get ossec.log from a specific node in cluster.</p>
245
+ </div></span>
246
+
247
+ </li>
248
+
249
+
250
+ <li class="public ">
251
+ <span class="summary_signature">
252
+
253
+ <a href="#cluster_logs_summary_by_node-instance_method" title="#cluster_logs_summary_by_node (instance method)">#<strong>cluster_logs_summary_by_node</strong>(node_id) &#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 summary of ossec.log from a specific node in cluster.</p>
269
+ </div></span>
270
+
271
+ </li>
272
+
273
+
274
+ <li class="public ">
275
+ <span class="summary_signature">
276
+
277
+ <a href="#cluster_status-instance_method" title="#cluster_status (instance method)">#<strong>cluster_status</strong> &#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 info about cluster status.</p>
293
+ </div></span>
294
+
295
+ </li>
296
+
297
+
298
+ <li class="public ">
299
+ <span class="summary_signature">
300
+
301
+ <a href="#component_configuration_by_node-instance_method" title="#component_configuration_by_node (instance method)">#<strong>component_configuration_by_node</strong>(node_id, component, configuration, options = {}) &#x21d2; Object </a>
302
+
303
+
304
+
305
+ </span>
306
+
307
+
308
+
309
+
310
+
311
+
312
+
313
+
314
+
315
+ <span class="summary_desc"><div class='inline'>
316
+ <p>Returns the requested configuration in JSON format.</p>
317
+ </div></span>
318
+
319
+ </li>
320
+
321
+
322
+ <li class="public ">
323
+ <span class="summary_signature">
324
+
325
+ <a href="#configuration_by_node-instance_method" title="#configuration_by_node (instance method)">#<strong>configuration_by_node</strong>(node_id, options = {}) &#x21d2; Object </a>
326
+
327
+
328
+
329
+ </span>
330
+
331
+
332
+
333
+
334
+
335
+
336
+
337
+
338
+
339
+ <span class="summary_desc"><div class='inline'>
340
+ <p>Returns ossec.conf in JSON format.</p>
341
+ </div></span>
342
+
343
+ </li>
344
+
345
+
346
+ <li class="public ">
347
+ <span class="summary_signature">
348
+
349
+ <a href="#delete_remote_file-instance_method" title="#delete_remote_file (instance method)">#<strong>delete_remote_file</strong>(node_id, options) &#x21d2; Object </a>
350
+
351
+
352
+
353
+ </span>
354
+
355
+
356
+
357
+
358
+
359
+
360
+
361
+
362
+
363
+ <span class="summary_desc"><div class='inline'>
364
+ <p>Delete a remote file in a cluster node.</p>
365
+ </div></span>
366
+
367
+ </li>
368
+
369
+
370
+ <li class="public ">
371
+ <span class="summary_signature">
372
+
373
+ <a href="#get_remote_file-instance_method" title="#get_remote_file (instance method)">#<strong>get_remote_file</strong>(node_id, options) &#x21d2; Object </a>
374
+
375
+
376
+
377
+ </span>
378
+
379
+
380
+
381
+
382
+
383
+
384
+
385
+
386
+
387
+ <span class="summary_desc"><div class='inline'>
388
+ <p>Get local file from any cluster node.</p>
389
+ </div></span>
390
+
391
+ </li>
392
+
393
+
394
+ <li class="public ">
395
+ <span class="summary_signature">
396
+
397
+ <a href="#local_node-instance_method" title="#local_node (instance method)">#<strong>local_node</strong> &#x21d2; Object </a>
398
+
399
+
400
+
401
+ </span>
402
+
403
+
404
+
405
+
406
+
407
+
408
+
409
+
410
+
411
+ <span class="summary_desc"><div class='inline'>
412
+ <p>Get local node info.</p>
413
+ </div></span>
414
+
415
+ </li>
416
+
417
+
418
+ <li class="public ">
419
+ <span class="summary_signature">
420
+
421
+ <a href="#node-instance_method" title="#node (instance method)">#<strong>node</strong>(node_name) &#x21d2; Object </a>
422
+
423
+
424
+
425
+ </span>
426
+
427
+
428
+
429
+
430
+
431
+
432
+
433
+
434
+
435
+ <span class="summary_desc"><div class='inline'>
436
+ <p>Get node info.</p>
437
+ </div></span>
438
+
439
+ </li>
440
+
441
+
442
+ <li class="public ">
443
+ <span class="summary_signature">
444
+
445
+ <a href="#node_info-instance_method" title="#node_info (instance method)">#<strong>node_info</strong>(node_id) &#x21d2; Object </a>
446
+
447
+
448
+
449
+ </span>
450
+
451
+
452
+
453
+
454
+
455
+
456
+
457
+
458
+
459
+ <span class="summary_desc"><div class='inline'>
460
+ <p>Get node_id’s information.</p>
461
+ </div></span>
462
+
463
+ </li>
464
+
465
+
466
+ <li class="public ">
467
+ <span class="summary_signature">
468
+
469
+ <a href="#node_status-instance_method" title="#node_status (instance method)">#<strong>node_status</strong>(node_id) &#x21d2; Object </a>
470
+
471
+
472
+
473
+ </span>
474
+
475
+
476
+
477
+
478
+
479
+
480
+
481
+
482
+
483
+ <span class="summary_desc"><div class='inline'>
484
+ <p>Get node node_id’s status.</p>
485
+ </div></span>
486
+
487
+ </li>
488
+
489
+
490
+ <li class="public ">
491
+ <span class="summary_signature">
492
+
493
+ <a href="#nodes-instance_method" title="#nodes (instance method)">#<strong>nodes</strong>(options = {}) &#x21d2; Object </a>
494
+
495
+
496
+
497
+ </span>
498
+
499
+
500
+
501
+
502
+
503
+
504
+
505
+
506
+
507
+ <span class="summary_desc"><div class='inline'>
508
+ <p>Get nodes info.</p>
509
+ </div></span>
510
+
511
+ </li>
512
+
513
+
514
+ <li class="public ">
515
+ <span class="summary_signature">
516
+
517
+ <a href="#nodes_stats-instance_method" title="#nodes_stats (instance method)">#<strong>nodes_stats</strong>(node_id, options) &#x21d2; Object </a>
518
+
519
+
520
+
521
+ </span>
522
+
523
+
524
+
525
+
526
+
527
+
528
+
529
+
530
+
531
+ <span class="summary_desc"><div class='inline'>
532
+ <p>Get node node_id’s stats.</p>
533
+ </div></span>
534
+
535
+ </li>
536
+
537
+
538
+ <li class="public ">
539
+ <span class="summary_signature">
540
+
541
+ <a href="#nodes_stats_by_hourly-instance_method" title="#nodes_stats_by_hourly (instance method)">#<strong>nodes_stats_by_hourly</strong>(node_id) &#x21d2; Object </a>
542
+
543
+
544
+
545
+ </span>
546
+
547
+
548
+
549
+
550
+
551
+
552
+
553
+
554
+
555
+ <span class="summary_desc"><div class='inline'>
556
+ <p>Get node node_id’s stats by hour.</p>
557
+ </div></span>
558
+
559
+ </li>
560
+
561
+
562
+ <li class="public ">
563
+ <span class="summary_signature">
564
+
565
+ <a href="#nodes_stats_by_weekly-instance_method" title="#nodes_stats_by_weekly (instance method)">#<strong>nodes_stats_by_weekly</strong>(node_id) &#x21d2; Object </a>
566
+
567
+
568
+
569
+ </span>
570
+
571
+
572
+
573
+
574
+
575
+
576
+
577
+
578
+
579
+ <span class="summary_desc"><div class='inline'>
580
+ <p>Get node node_id’s stats by weekly.</p>
581
+ </div></span>
582
+
583
+ </li>
584
+
585
+
586
+ <li class="public ">
587
+ <span class="summary_signature">
588
+
589
+ <a href="#remoted_stats-instance_method" title="#remoted_stats (instance method)">#<strong>remoted_stats</strong>(node_id) &#x21d2; Object </a>
590
+
591
+
592
+
593
+ </span>
594
+
595
+
596
+
597
+
598
+
599
+
600
+
601
+
602
+
603
+ <span class="summary_desc"><div class='inline'>
604
+ <p>Get node node_id’s remoted stats.</p>
605
+ </div></span>
606
+
607
+ </li>
608
+
609
+
610
+ <li class="public ">
611
+ <span class="summary_signature">
612
+
613
+ <a href="#restart_all_node-instance_method" title="#restart_all_node (instance method)">#<strong>restart_all_node</strong> &#x21d2; Object </a>
614
+
615
+
616
+
617
+ </span>
618
+
619
+
620
+
621
+
622
+
623
+
624
+
625
+
626
+
627
+ <span class="summary_desc"><div class='inline'>
628
+ <p>Restart all nodes in cluster.</p>
629
+ </div></span>
630
+
631
+ </li>
632
+
633
+
634
+ <li class="public ">
635
+ <span class="summary_signature">
636
+
637
+ <a href="#restart_node-instance_method" title="#restart_node (instance method)">#<strong>restart_node</strong>(node_id) &#x21d2; Object </a>
638
+
639
+
640
+
641
+ </span>
642
+
643
+
644
+
645
+
646
+
647
+
648
+
649
+
650
+
651
+ <span class="summary_desc"><div class='inline'>
652
+ <p>Restart a specific node in cluster.</p>
653
+ </div></span>
654
+
655
+ </li>
656
+
657
+
658
+ <li class="public ">
659
+ <span class="summary_signature">
660
+
661
+ <a href="#update_remote_file-instance_method" title="#update_remote_file (instance method)">#<strong>update_remote_file</strong>(node_id, options) &#x21d2; Object </a>
662
+
663
+
664
+
665
+ </span>
666
+
667
+
668
+
669
+
670
+
671
+
672
+
673
+
674
+
675
+ <span class="summary_desc"><div class='inline'>
676
+ <p>Update local file at any cluster node.</p>
677
+ </div></span>
678
+
679
+ </li>
680
+
681
+
682
+ </ul>
683
+
684
+
685
+
686
+
687
+ <div id="instance_method_details" class="method_details_list">
688
+ <h2>Instance Method Details</h2>
689
+
690
+
691
+ <div class="method_details first">
692
+ <h3 class="signature first" id="analysisd_stats-instance_method">
693
+
694
+ #<strong>analysisd_stats</strong>(node_id) &#x21d2; <tt>Object</tt>
695
+
696
+
697
+
698
+
699
+
700
+ </h3><div class="docstring">
701
+ <div class="discussion">
702
+
703
+ <p>Get node node_id’s analysisd stats</p>
704
+
705
+
706
+ </div>
707
+ </div>
708
+ <div class="tags">
709
+ <p class="tag_title">Parameters:</p>
710
+ <ul class="param">
711
+
712
+ <li>
713
+
714
+ <span class='name'>node_id</span>
715
+
716
+
717
+ <span class='type'></span>
718
+
719
+
720
+
721
+ </li>
722
+
723
+ </ul>
724
+
725
+
726
+ </div><table class="source_code">
727
+ <tr>
728
+ <td>
729
+ <pre class="lines">
730
+
731
+
732
+ 163
733
+ 164
734
+ 165</pre>
735
+ </td>
736
+ <td>
737
+ <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/cluster.rb', line 163</span>
738
+
739
+ <span class='kw'>def</span> <span class='id identifier rubyid_analysisd_stats'>analysisd_stats</span><span class='lparen'>(</span><span class='id identifier rubyid_node_id'>node_id</span><span class='rparen'>)</span>
740
+ <span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/cluster/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_node_id'>node_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/stats/analysisd</span><span class='tstring_end'>&quot;</span></span>
741
+ <span class='kw'>end</span></pre>
742
+ </td>
743
+ </tr>
744
+ </table>
745
+ </div>
746
+
747
+ <div class="method_details ">
748
+ <h3 class="signature " id="check_configuration-instance_method">
749
+
750
+ #<strong>check_configuration</strong> &#x21d2; <tt>Object</tt>
751
+
752
+
753
+
754
+
755
+
756
+ </h3><div class="docstring">
757
+ <div class="discussion">
758
+
759
+ <p>Check Wazuh configuration in all cluster nodes</p>
760
+
761
+
762
+ </div>
763
+ </div>
764
+ <div class="tags">
765
+
766
+
767
+ <p class="tag_title">See Also:</p>
768
+ <ul class="see">
769
+
770
+ <li><a href="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#check-wazuh-configuration-in-all-cluster-nodes" target="_parent" title="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#check-wazuh-configuration-in-all-cluster-nodes">https://documentation.wazuh.com/3.10/user-manual/api/reference.html#check-wazuh-configuration-in-all-cluster-nodes</a></li>
771
+
772
+ </ul>
773
+
774
+ </div><table class="source_code">
775
+ <tr>
776
+ <td>
777
+ <pre class="lines">
778
+
779
+
780
+ 37
781
+ 38
782
+ 39</pre>
783
+ </td>
784
+ <td>
785
+ <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/cluster.rb', line 37</span>
786
+
787
+ <span class='kw'>def</span> <span class='id identifier rubyid_check_configuration'>check_configuration</span>
788
+ <span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/cluster/configuration/validation</span><span class='tstring_end'>&quot;</span></span>
789
+ <span class='kw'>end</span></pre>
790
+ </td>
791
+ </tr>
792
+ </table>
793
+ </div>
794
+
795
+ <div class="method_details ">
796
+ <h3 class="signature " id="check_configuration_by_node-instance_method">
797
+
798
+ #<strong>check_configuration_by_node</strong>(node_id) &#x21d2; <tt>Object</tt>
799
+
800
+
801
+
802
+
803
+
804
+ </h3><div class="docstring">
805
+ <div class="discussion">
806
+
807
+ <p>Check Wazuh configuration in a cluster node</p>
808
+
809
+
810
+ </div>
811
+ </div>
812
+ <div class="tags">
813
+
814
+
815
+ <p class="tag_title">See Also:</p>
816
+ <ul class="see">
817
+
818
+ <li><a href="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#check-wazuh-configuration-in-a-cluster-node" target="_parent" title="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#check-wazuh-configuration-in-a-cluster-node">https://documentation.wazuh.com/3.10/user-manual/api/reference.html#check-wazuh-configuration-in-a-cluster-node</a></li>
819
+
820
+ </ul>
821
+
822
+ </div><table class="source_code">
823
+ <tr>
824
+ <td>
825
+ <pre class="lines">
826
+
827
+
828
+ 30
829
+ 31
830
+ 32</pre>
831
+ </td>
832
+ <td>
833
+ <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/cluster.rb', line 30</span>
834
+
835
+ <span class='kw'>def</span> <span class='id identifier rubyid_check_configuration_by_node'>check_configuration_by_node</span><span class='lparen'>(</span><span class='id identifier rubyid_node_id'>node_id</span><span class='rparen'>)</span>
836
+ <span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/cluster/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_node_id'>node_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/configuration/validation</span><span class='tstring_end'>&quot;</span></span>
837
+ <span class='kw'>end</span></pre>
838
+ </td>
839
+ </tr>
840
+ </table>
841
+ </div>
842
+
843
+ <div class="method_details ">
844
+ <h3 class="signature " id="cluster_configuration-instance_method">
845
+
846
+ #<strong>cluster_configuration</strong>(options = {}) &#x21d2; <tt>Object</tt>
847
+
848
+
849
+
850
+
851
+
852
+ </h3><div class="docstring">
853
+ <div class="discussion">
854
+
855
+ <p>Returns the cluster configuration.</p>
856
+
857
+
858
+ </div>
859
+ </div>
860
+ <div class="tags">
861
+
862
+
863
+ <p class="tag_title">See Also:</p>
864
+ <ul class="see">
865
+
866
+ <li><a href="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-the-cluster-configuration" target="_parent" title="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-the-cluster-configuration">https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-the-cluster-configuration</a></li>
867
+
868
+ </ul>
869
+
870
+ </div><table class="source_code">
871
+ <tr>
872
+ <td>
873
+ <pre class="lines">
874
+
875
+
876
+ 23
877
+ 24
878
+ 25</pre>
879
+ </td>
880
+ <td>
881
+ <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/cluster.rb', line 23</span>
882
+
883
+ <span class='kw'>def</span> <span class='id identifier rubyid_cluster_configuration'>cluster_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>
884
+ <span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/cluster/config</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span>
885
+ <span class='kw'>end</span></pre>
886
+ </td>
887
+ </tr>
888
+ </table>
889
+ </div>
890
+
891
+ <div class="method_details ">
892
+ <h3 class="signature " id="cluster_healthcheck-instance_method">
893
+
894
+ #<strong>cluster_healthcheck</strong>(options = {}) &#x21d2; <tt>Object</tt>
895
+
896
+
897
+
898
+
899
+
900
+ </h3><div class="docstring">
901
+ <div class="discussion">
902
+
903
+ <p>Show cluster health</p>
904
+
905
+
906
+ </div>
907
+ </div>
908
+ <div class="tags">
909
+ <p class="tag_title">Parameters:</p>
910
+ <ul class="param">
911
+
912
+ <li>
913
+
914
+ <span class='name'>options</span>
915
+
916
+
917
+ <span class='type'>(<tt>Hash</tt>)</span>
918
+
919
+
920
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
921
+
922
+
923
+ &mdash;
924
+ <div class='inline'>
925
+ <p>a customizable set of options</p>
926
+ </div>
927
+
928
+ </li>
929
+
930
+ </ul>
931
+
932
+
933
+
934
+
935
+ <p class="tag_title">Options Hash (<tt>options</tt>):</p>
936
+ <ul class="option">
937
+
938
+ <li>
939
+ <span class="name">:node</span>
940
+ <span class="type">(<tt><span class='object_link'><a href="#node-instance_method" title="Wazuh::Api::Endpoints::Cluster#node (method)">node</a></span></tt>)</span>
941
+ <span class="default">
942
+
943
+ </span>
944
+
945
+ </li>
946
+
947
+ </ul>
948
+
949
+
950
+
951
+ </div><table class="source_code">
952
+ <tr>
953
+ <td>
954
+ <pre class="lines">
955
+
956
+
957
+ 98
958
+ 99
959
+ 100</pre>
960
+ </td>
961
+ <td>
962
+ <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/cluster.rb', line 98</span>
963
+
964
+ <span class='kw'>def</span> <span class='id identifier rubyid_cluster_healthcheck'>cluster_healthcheck</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>
965
+ <span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/cluster/healthcheck</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span>
966
+ <span class='kw'>end</span></pre>
967
+ </td>
968
+ </tr>
969
+ </table>
970
+ </div>
971
+
972
+ <div class="method_details ">
973
+ <h3 class="signature " id="cluster_logs_by_node-instance_method">
974
+
975
+ #<strong>cluster_logs_by_node</strong>(node_id, options) &#x21d2; <tt>Object</tt>
976
+
977
+
978
+
979
+
980
+
981
+ </h3><div class="docstring">
982
+ <div class="discussion">
983
+
984
+ <p>Get ossec.log from a specific node in cluster</p>
985
+
986
+
987
+ </div>
988
+ </div>
989
+ <div class="tags">
990
+ <p class="tag_title">Parameters:</p>
991
+ <ul class="param">
992
+
993
+ <li>
994
+
995
+ <span class='name'>node_id</span>
996
+
997
+
998
+ <span class='type'></span>
999
+
1000
+
1001
+
1002
+ </li>
1003
+
1004
+ <li>
1005
+
1006
+ <span class='name'>options</span>
1007
+
1008
+
1009
+ <span class='type'>(<tt>Hash</tt>)</span>
1010
+
1011
+
1012
+
1013
+ &mdash;
1014
+ <div class='inline'>
1015
+ <p>a customizable set of options</p>
1016
+ </div>
1017
+
1018
+ </li>
1019
+
1020
+ </ul>
1021
+
1022
+
1023
+
1024
+
1025
+
1026
+
1027
+ <p class="tag_title">Options Hash (<tt>options</tt>):</p>
1028
+ <ul class="option">
1029
+
1030
+ <li>
1031
+ <span class="name">:offset</span>
1032
+ <span class="type">(<tt>offset</tt>)</span>
1033
+ <span class="default">
1034
+
1035
+ </span>
1036
+
1037
+ &mdash; <div class='inline'>
1038
+ <p>First element to return in the collection.</p>
1039
+ </div>
1040
+
1041
+ </li>
1042
+
1043
+ <li>
1044
+ <span class="name">:limit</span>
1045
+ <span class="type">(<tt>limit</tt>)</span>
1046
+ <span class="default">
1047
+
1048
+ </span>
1049
+
1050
+ &mdash; <div class='inline'>
1051
+ <p>Maximum number of elements to return.</p>
1052
+ </div>
1053
+
1054
+ </li>
1055
+
1056
+ <li>
1057
+ <span class="name">:sort</span>
1058
+ <span class="type">(<tt>sort</tt>)</span>
1059
+ <span class="default">
1060
+
1061
+ </span>
1062
+
1063
+ &mdash; <div class='inline'>
1064
+ <p>Sorts the collection by a field or fields (separated by comma). Use +/- at
1065
+ the beginning to list in ascending or descending order.</p>
1066
+ </div>
1067
+
1068
+ </li>
1069
+
1070
+ <li>
1071
+ <span class="name">:search</span>
1072
+ <span class="type">(<tt>search</tt>)</span>
1073
+ <span class="default">
1074
+
1075
+ </span>
1076
+
1077
+ &mdash; <div class='inline'>
1078
+ <p>Looks for elements with the specified string.</p>
1079
+ </div>
1080
+
1081
+ </li>
1082
+
1083
+ <li>
1084
+ <span class="name">:type_log</span>
1085
+ <span class="type">(<tt>type_log</tt>)</span>
1086
+ <span class="default">
1087
+
1088
+ </span>
1089
+
1090
+ &mdash; <div class='inline'>
1091
+ <p>Filters by type of log. Allowed values: all, error, warning, info</p>
1092
+ </div>
1093
+
1094
+ </li>
1095
+
1096
+ <li>
1097
+ <span class="name">:category</span>
1098
+ <span class="type">(<tt>category</tt>)</span>
1099
+ <span class="default">
1100
+
1101
+ </span>
1102
+
1103
+ &mdash; <div class='inline'>
1104
+ <p>Filters by category of log</p>
1105
+ </div>
1106
+
1107
+ </li>
1108
+
1109
+ </ul>
1110
+
1111
+
1112
+
1113
+ </div><table class="source_code">
1114
+ <tr>
1115
+ <td>
1116
+ <pre class="lines">
1117
+
1118
+
1119
+ 118
1120
+ 119
1121
+ 120</pre>
1122
+ </td>
1123
+ <td>
1124
+ <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/cluster.rb', line 118</span>
1125
+
1126
+ <span class='kw'>def</span> <span class='id identifier rubyid_cluster_logs_by_node'>cluster_logs_by_node</span><span class='lparen'>(</span><span class='id identifier rubyid_node_id'>node_id</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
1127
+ <span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/cluster/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_node_id'>node_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/logs</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span>
1128
+ <span class='kw'>end</span></pre>
1129
+ </td>
1130
+ </tr>
1131
+ </table>
1132
+ </div>
1133
+
1134
+ <div class="method_details ">
1135
+ <h3 class="signature " id="cluster_logs_summary_by_node-instance_method">
1136
+
1137
+ #<strong>cluster_logs_summary_by_node</strong>(node_id) &#x21d2; <tt>Object</tt>
1138
+
1139
+
1140
+
1141
+
1142
+
1143
+ </h3><div class="docstring">
1144
+ <div class="discussion">
1145
+
1146
+ <p>Get summary of ossec.log from a specific node in cluster</p>
1147
+
1148
+
1149
+ </div>
1150
+ </div>
1151
+ <div class="tags">
1152
+ <p class="tag_title">Parameters:</p>
1153
+ <ul class="param">
1154
+
1155
+ <li>
1156
+
1157
+ <span class='name'>node_id</span>
1158
+
1159
+
1160
+ <span class='type'></span>
1161
+
1162
+
1163
+
1164
+ </li>
1165
+
1166
+ </ul>
1167
+
1168
+
1169
+ </div><table class="source_code">
1170
+ <tr>
1171
+ <td>
1172
+ <pre class="lines">
1173
+
1174
+
1175
+ 125
1176
+ 126
1177
+ 127</pre>
1178
+ </td>
1179
+ <td>
1180
+ <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/cluster.rb', line 125</span>
1181
+
1182
+ <span class='kw'>def</span> <span class='id identifier rubyid_cluster_logs_summary_by_node'>cluster_logs_summary_by_node</span><span class='lparen'>(</span><span class='id identifier rubyid_node_id'>node_id</span><span class='rparen'>)</span>
1183
+ <span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/cluster/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_node_id'>node_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/logs/summary</span><span class='tstring_end'>&quot;</span></span>
1184
+ <span class='kw'>end</span></pre>
1185
+ </td>
1186
+ </tr>
1187
+ </table>
1188
+ </div>
1189
+
1190
+ <div class="method_details ">
1191
+ <h3 class="signature " id="cluster_status-instance_method">
1192
+
1193
+ #<strong>cluster_status</strong> &#x21d2; <tt>Object</tt>
1194
+
1195
+
1196
+
1197
+
1198
+
1199
+ </h3><div class="docstring">
1200
+ <div class="discussion">
1201
+
1202
+ <p>Get info about cluster status</p>
1203
+
1204
+
1205
+ </div>
1206
+ </div>
1207
+ <div class="tags">
1208
+
1209
+
1210
+ </div><table class="source_code">
1211
+ <tr>
1212
+ <td>
1213
+ <pre class="lines">
1214
+
1215
+
1216
+ 77
1217
+ 78
1218
+ 79</pre>
1219
+ </td>
1220
+ <td>
1221
+ <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/cluster.rb', line 77</span>
1222
+
1223
+ <span class='kw'>def</span> <span class='id identifier rubyid_cluster_status'>cluster_status</span>
1224
+ <span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/cluster/status</span><span class='tstring_end'>&#39;</span></span>
1225
+ <span class='kw'>end</span></pre>
1226
+ </td>
1227
+ </tr>
1228
+ </table>
1229
+ </div>
1230
+
1231
+ <div class="method_details ">
1232
+ <h3 class="signature " id="component_configuration_by_node-instance_method">
1233
+
1234
+ #<strong>component_configuration_by_node</strong>(node_id, component, configuration, options = {}) &#x21d2; <tt>Object</tt>
1235
+
1236
+
1237
+
1238
+
1239
+
1240
+ </h3><div class="docstring">
1241
+ <div class="discussion">
1242
+
1243
+ <p>Returns the requested configuration in JSON format.</p>
1244
+
1245
+
1246
+ </div>
1247
+ </div>
1248
+ <div class="tags">
1249
+
1250
+
1251
+ <p class="tag_title">See Also:</p>
1252
+ <ul class="see">
1253
+
1254
+ <li><a href="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-active-configuration-in-node-node-id" target="_parent" title="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-active-configuration-in-node-node-id">https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-active-configuration-in-node-node-id</a></li>
1255
+
1256
+ </ul>
1257
+
1258
+ </div><table class="source_code">
1259
+ <tr>
1260
+ <td>
1261
+ <pre class="lines">
1262
+
1263
+
1264
+ 9
1265
+ 10
1266
+ 11</pre>
1267
+ </td>
1268
+ <td>
1269
+ <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/cluster.rb', line 9</span>
1270
+
1271
+ <span class='kw'>def</span> <span class='id identifier rubyid_component_configuration_by_node'>component_configuration_by_node</span><span class='lparen'>(</span><span class='id identifier rubyid_node_id'>node_id</span><span class='comma'>,</span> <span class='id identifier rubyid_component'>component</span><span class='comma'>,</span> <span class='id identifier rubyid_configuration'>configuration</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>
1272
+ <span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/cluster/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_node_id'>node_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/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><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span>
1273
+ <span class='kw'>end</span></pre>
1274
+ </td>
1275
+ </tr>
1276
+ </table>
1277
+ </div>
1278
+
1279
+ <div class="method_details ">
1280
+ <h3 class="signature " id="configuration_by_node-instance_method">
1281
+
1282
+ #<strong>configuration_by_node</strong>(node_id, options = {}) &#x21d2; <tt>Object</tt>
1283
+
1284
+
1285
+
1286
+
1287
+
1288
+ </h3><div class="docstring">
1289
+ <div class="discussion">
1290
+
1291
+ <p>Returns ossec.conf in JSON format.</p>
1292
+
1293
+
1294
+ </div>
1295
+ </div>
1296
+ <div class="tags">
1297
+
1298
+
1299
+ <p class="tag_title">See Also:</p>
1300
+ <ul class="see">
1301
+
1302
+ <li><a href="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-node-node-id-s-configuration" target="_parent" title="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-node-node-id-s-configuration">https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-node-node-id-s-configuration</a></li>
1303
+
1304
+ </ul>
1305
+
1306
+ </div><table class="source_code">
1307
+ <tr>
1308
+ <td>
1309
+ <pre class="lines">
1310
+
1311
+
1312
+ 16
1313
+ 17
1314
+ 18</pre>
1315
+ </td>
1316
+ <td>
1317
+ <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/cluster.rb', line 16</span>
1318
+
1319
+ <span class='kw'>def</span> <span class='id identifier rubyid_configuration_by_node'>configuration_by_node</span><span class='lparen'>(</span><span class='id identifier rubyid_node_id'>node_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>
1320
+ <span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/cluster/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_node_id'>node_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/configuration</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span>
1321
+ <span class='kw'>end</span></pre>
1322
+ </td>
1323
+ </tr>
1324
+ </table>
1325
+ </div>
1326
+
1327
+ <div class="method_details ">
1328
+ <h3 class="signature " id="delete_remote_file-instance_method">
1329
+
1330
+ #<strong>delete_remote_file</strong>(node_id, options) &#x21d2; <tt>Object</tt>
1331
+
1332
+
1333
+
1334
+
1335
+
1336
+ </h3><div class="docstring">
1337
+ <div class="discussion">
1338
+
1339
+ <p>Delete a remote file in a cluster node</p>
1340
+
1341
+
1342
+ </div>
1343
+ </div>
1344
+ <div class="tags">
1345
+ <p class="tag_title">Parameters:</p>
1346
+ <ul class="param">
1347
+
1348
+ <li>
1349
+
1350
+ <span class='name'>node_id</span>
1351
+
1352
+
1353
+ <span class='type'></span>
1354
+
1355
+
1356
+
1357
+ </li>
1358
+
1359
+ <li>
1360
+
1361
+ <span class='name'>options</span>
1362
+
1363
+
1364
+ <span class='type'>(<tt>Hash</tt>)</span>
1365
+
1366
+
1367
+
1368
+ &mdash;
1369
+ <div class='inline'>
1370
+ <p>a customizable set of options</p>
1371
+ </div>
1372
+
1373
+ </li>
1374
+
1375
+ </ul>
1376
+
1377
+
1378
+
1379
+
1380
+
1381
+
1382
+ <p class="tag_title">Options Hash (<tt>options</tt>):</p>
1383
+ <ul class="option">
1384
+
1385
+ <li>
1386
+ <span class="name">:path</span>
1387
+ <span class="type">(<tt>path</tt>)</span>
1388
+ <span class="default">
1389
+
1390
+ </span>
1391
+
1392
+ &mdash; <div class='inline'>
1393
+ <p>Relative path of file. This parameter is mandatory.</p>
1394
+ </div>
1395
+
1396
+ </li>
1397
+
1398
+ </ul>
1399
+
1400
+
1401
+
1402
+ <p class="tag_title">See Also:</p>
1403
+ <ul class="see">
1404
+
1405
+ <li><a href="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#delete-a-remote-file-in-a-cluster-node" target="_parent" title="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#delete-a-remote-file-in-a-cluster-node">https://documentation.wazuh.com/3.10/user-manual/api/reference.html#delete-a-remote-file-in-a-cluster-node</a></li>
1406
+
1407
+ </ul>
1408
+
1409
+ </div><table class="source_code">
1410
+ <tr>
1411
+ <td>
1412
+ <pre class="lines">
1413
+
1414
+
1415
+ 47
1416
+ 48
1417
+ 49</pre>
1418
+ </td>
1419
+ <td>
1420
+ <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/cluster.rb', line 47</span>
1421
+
1422
+ <span class='kw'>def</span> <span class='id identifier rubyid_delete_remote_file'>delete_remote_file</span><span class='lparen'>(</span><span class='id identifier rubyid_node_id'>node_id</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
1423
+ <span class='id identifier rubyid_delete'>delete</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/cluster/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_node_id'>node_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/files</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span>
1424
+ <span class='kw'>end</span></pre>
1425
+ </td>
1426
+ </tr>
1427
+ </table>
1428
+ </div>
1429
+
1430
+ <div class="method_details ">
1431
+ <h3 class="signature " id="get_remote_file-instance_method">
1432
+
1433
+ #<strong>get_remote_file</strong>(node_id, options) &#x21d2; <tt>Object</tt>
1434
+
1435
+
1436
+
1437
+
1438
+
1439
+ </h3><div class="docstring">
1440
+ <div class="discussion">
1441
+
1442
+ <p>Get local file from any cluster node</p>
1443
+
1444
+
1445
+ </div>
1446
+ </div>
1447
+ <div class="tags">
1448
+ <p class="tag_title">Parameters:</p>
1449
+ <ul class="param">
1450
+
1451
+ <li>
1452
+
1453
+ <span class='name'>node_id</span>
1454
+
1455
+
1456
+ <span class='type'></span>
1457
+
1458
+
1459
+
1460
+ </li>
1461
+
1462
+ <li>
1463
+
1464
+ <span class='name'>options</span>
1465
+
1466
+
1467
+ <span class='type'>(<tt>Hash</tt>)</span>
1468
+
1469
+
1470
+
1471
+ &mdash;
1472
+ <div class='inline'>
1473
+ <p>a customizable set of options</p>
1474
+ </div>
1475
+
1476
+ </li>
1477
+
1478
+ </ul>
1479
+
1480
+
1481
+
1482
+
1483
+
1484
+
1485
+ <p class="tag_title">Options Hash (<tt>options</tt>):</p>
1486
+ <ul class="option">
1487
+
1488
+ <li>
1489
+ <span class="name">:path</span>
1490
+ <span class="type">(<tt>path</tt>)</span>
1491
+ <span class="default">
1492
+
1493
+ </span>
1494
+
1495
+ &mdash; <div class='inline'>
1496
+ <p>Relative path of file. This parameter is mandatory.</p>
1497
+ </div>
1498
+
1499
+ </li>
1500
+
1501
+ <li>
1502
+ <span class="name">:validation</span>
1503
+ <span class="type">(<tt>validation</tt>)</span>
1504
+ <span class="default">
1505
+
1506
+ </span>
1507
+
1508
+ &mdash; <div class='inline'>
1509
+ <p>Validates the content of the file. An error will be returned if file
1510
+ content is not strictly correct. False by default.</p>
1511
+ </div>
1512
+
1513
+ </li>
1514
+
1515
+ </ul>
1516
+
1517
+
1518
+
1519
+ </div><table class="source_code">
1520
+ <tr>
1521
+ <td>
1522
+ <pre class="lines">
1523
+
1524
+
1525
+ 58
1526
+ 59
1527
+ 60</pre>
1528
+ </td>
1529
+ <td>
1530
+ <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/cluster.rb', line 58</span>
1531
+
1532
+ <span class='kw'>def</span> <span class='id identifier rubyid_get_remote_file'>get_remote_file</span><span class='lparen'>(</span><span class='id identifier rubyid_node_id'>node_id</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
1533
+ <span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/cluster/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_node_id'>node_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/files</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span>
1534
+ <span class='kw'>end</span></pre>
1535
+ </td>
1536
+ </tr>
1537
+ </table>
1538
+ </div>
1539
+
1540
+ <div class="method_details ">
1541
+ <h3 class="signature " id="local_node-instance_method">
1542
+
1543
+ #<strong>local_node</strong> &#x21d2; <tt>Object</tt>
1544
+
1545
+
1546
+
1547
+
1548
+
1549
+ </h3><div class="docstring">
1550
+ <div class="discussion">
1551
+
1552
+ <p>Get local node info</p>
1553
+
1554
+
1555
+ </div>
1556
+ </div>
1557
+ <div class="tags">
1558
+
1559
+
1560
+ </div><table class="source_code">
1561
+ <tr>
1562
+ <td>
1563
+ <pre class="lines">
1564
+
1565
+
1566
+ 131
1567
+ 132
1568
+ 133</pre>
1569
+ </td>
1570
+ <td>
1571
+ <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/cluster.rb', line 131</span>
1572
+
1573
+ <span class='kw'>def</span> <span class='id identifier rubyid_local_node'>local_node</span>
1574
+ <span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/cluster/node</span><span class='tstring_end'>&#39;</span></span>
1575
+ <span class='kw'>end</span></pre>
1576
+ </td>
1577
+ </tr>
1578
+ </table>
1579
+ </div>
1580
+
1581
+ <div class="method_details ">
1582
+ <h3 class="signature " id="node-instance_method">
1583
+
1584
+ #<strong>node</strong>(node_name) &#x21d2; <tt>Object</tt>
1585
+
1586
+
1587
+
1588
+
1589
+
1590
+ </h3><div class="docstring">
1591
+ <div class="discussion">
1592
+
1593
+ <p>Get node info</p>
1594
+
1595
+
1596
+ </div>
1597
+ </div>
1598
+ <div class="tags">
1599
+
1600
+
1601
+ </div><table class="source_code">
1602
+ <tr>
1603
+ <td>
1604
+ <pre class="lines">
1605
+
1606
+
1607
+ 137
1608
+ 138
1609
+ 139</pre>
1610
+ </td>
1611
+ <td>
1612
+ <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/cluster.rb', line 137</span>
1613
+
1614
+ <span class='kw'>def</span> <span class='id identifier rubyid_node'>node</span><span class='lparen'>(</span><span class='id identifier rubyid_node_name'>node_name</span><span class='rparen'>)</span>
1615
+ <span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/cluster/nodes/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_node_name'>node_name</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
1616
+ <span class='kw'>end</span></pre>
1617
+ </td>
1618
+ </tr>
1619
+ </table>
1620
+ </div>
1621
+
1622
+ <div class="method_details ">
1623
+ <h3 class="signature " id="node_info-instance_method">
1624
+
1625
+ #<strong>node_info</strong>(node_id) &#x21d2; <tt>Object</tt>
1626
+
1627
+
1628
+
1629
+
1630
+
1631
+ </h3><div class="docstring">
1632
+ <div class="discussion">
1633
+
1634
+ <p>Get node_id’s information</p>
1635
+
1636
+
1637
+ </div>
1638
+ </div>
1639
+ <div class="tags">
1640
+ <p class="tag_title">Parameters:</p>
1641
+ <ul class="param">
1642
+
1643
+ <li>
1644
+
1645
+ <span class='name'>node_id</span>
1646
+
1647
+
1648
+ <span class='type'></span>
1649
+
1650
+
1651
+
1652
+ </li>
1653
+
1654
+ </ul>
1655
+
1656
+
1657
+ </div><table class="source_code">
1658
+ <tr>
1659
+ <td>
1660
+ <pre class="lines">
1661
+
1662
+
1663
+ 91
1664
+ 92
1665
+ 93</pre>
1666
+ </td>
1667
+ <td>
1668
+ <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/cluster.rb', line 91</span>
1669
+
1670
+ <span class='kw'>def</span> <span class='id identifier rubyid_node_info'>node_info</span><span class='lparen'>(</span><span class='id identifier rubyid_node_id'>node_id</span><span class='rparen'>)</span>
1671
+ <span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/cluster/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_node_id'>node_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/info</span><span class='tstring_end'>&quot;</span></span>
1672
+ <span class='kw'>end</span></pre>
1673
+ </td>
1674
+ </tr>
1675
+ </table>
1676
+ </div>
1677
+
1678
+ <div class="method_details ">
1679
+ <h3 class="signature " id="node_status-instance_method">
1680
+
1681
+ #<strong>node_status</strong>(node_id) &#x21d2; <tt>Object</tt>
1682
+
1683
+
1684
+
1685
+
1686
+
1687
+ </h3><div class="docstring">
1688
+ <div class="discussion">
1689
+
1690
+ <p>Get node node_id’s status</p>
1691
+
1692
+
1693
+ </div>
1694
+ </div>
1695
+ <div class="tags">
1696
+ <p class="tag_title">Parameters:</p>
1697
+ <ul class="param">
1698
+
1699
+ <li>
1700
+
1701
+ <span class='name'>node_id</span>
1702
+
1703
+
1704
+ <span class='type'></span>
1705
+
1706
+
1707
+
1708
+ </li>
1709
+
1710
+ </ul>
1711
+
1712
+
1713
+ </div><table class="source_code">
1714
+ <tr>
1715
+ <td>
1716
+ <pre class="lines">
1717
+
1718
+
1719
+ 84
1720
+ 85
1721
+ 86</pre>
1722
+ </td>
1723
+ <td>
1724
+ <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/cluster.rb', line 84</span>
1725
+
1726
+ <span class='kw'>def</span> <span class='id identifier rubyid_node_status'>node_status</span><span class='lparen'>(</span><span class='id identifier rubyid_node_id'>node_id</span><span class='rparen'>)</span>
1727
+ <span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/cluster/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_node_id'>node_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/status</span><span class='tstring_end'>&quot;</span></span>
1728
+ <span class='kw'>end</span></pre>
1729
+ </td>
1730
+ </tr>
1731
+ </table>
1732
+ </div>
1733
+
1734
+ <div class="method_details ">
1735
+ <h3 class="signature " id="nodes-instance_method">
1736
+
1737
+ #<strong>nodes</strong>(options = {}) &#x21d2; <tt>Object</tt>
1738
+
1739
+
1740
+
1741
+
1742
+
1743
+ </h3><div class="docstring">
1744
+ <div class="discussion">
1745
+
1746
+ <p>Get nodes info</p>
1747
+
1748
+
1749
+ </div>
1750
+ </div>
1751
+ <div class="tags">
1752
+
1753
+
1754
+ </div><table class="source_code">
1755
+ <tr>
1756
+ <td>
1757
+ <pre class="lines">
1758
+
1759
+
1760
+ 143
1761
+ 144
1762
+ 145</pre>
1763
+ </td>
1764
+ <td>
1765
+ <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/cluster.rb', line 143</span>
1766
+
1767
+ <span class='kw'>def</span> <span class='id identifier rubyid_nodes'>nodes</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>
1768
+ <span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/cluster/nodes</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span>
1769
+ <span class='kw'>end</span></pre>
1770
+ </td>
1771
+ </tr>
1772
+ </table>
1773
+ </div>
1774
+
1775
+ <div class="method_details ">
1776
+ <h3 class="signature " id="nodes_stats-instance_method">
1777
+
1778
+ #<strong>nodes_stats</strong>(node_id, options) &#x21d2; <tt>Object</tt>
1779
+
1780
+
1781
+
1782
+
1783
+
1784
+ </h3><div class="docstring">
1785
+ <div class="discussion">
1786
+
1787
+ <p>Get node node_id’s stats</p>
1788
+
1789
+
1790
+ </div>
1791
+ </div>
1792
+ <div class="tags">
1793
+ <p class="tag_title">Parameters:</p>
1794
+ <ul class="param">
1795
+
1796
+ <li>
1797
+
1798
+ <span class='name'>node_id</span>
1799
+
1800
+
1801
+ <span class='type'></span>
1802
+
1803
+
1804
+
1805
+ </li>
1806
+
1807
+ <li>
1808
+
1809
+ <span class='name'>options</span>
1810
+
1811
+
1812
+ <span class='type'>(<tt>Hash</tt>)</span>
1813
+
1814
+
1815
+
1816
+ &mdash;
1817
+ <div class='inline'>
1818
+ <p>a customizable set of options</p>
1819
+ </div>
1820
+
1821
+ </li>
1822
+
1823
+ </ul>
1824
+
1825
+
1826
+
1827
+
1828
+
1829
+
1830
+ <p class="tag_title">Options Hash (<tt>options</tt>):</p>
1831
+ <ul class="option">
1832
+
1833
+ <li>
1834
+ <span class="name">:data</span>
1835
+ <span class="type">(<tt>data</tt>)</span>
1836
+ <span class="default">
1837
+
1838
+ </span>
1839
+
1840
+ &mdash; <div class='inline'>
1841
+ <p>Selects the date for getting the statistical information. Format: YYYYMMDD</p>
1842
+ </div>
1843
+
1844
+ </li>
1845
+
1846
+ </ul>
1847
+
1848
+
1849
+
1850
+ </div><table class="source_code">
1851
+ <tr>
1852
+ <td>
1853
+ <pre class="lines">
1854
+
1855
+
1856
+ 179
1857
+ 180
1858
+ 181</pre>
1859
+ </td>
1860
+ <td>
1861
+ <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/cluster.rb', line 179</span>
1862
+
1863
+ <span class='kw'>def</span> <span class='id identifier rubyid_nodes_stats'>nodes_stats</span><span class='lparen'>(</span><span class='id identifier rubyid_node_id'>node_id</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
1864
+ <span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/cluster/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_node_id'>node_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/stats</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span>
1865
+ <span class='kw'>end</span></pre>
1866
+ </td>
1867
+ </tr>
1868
+ </table>
1869
+ </div>
1870
+
1871
+ <div class="method_details ">
1872
+ <h3 class="signature " id="nodes_stats_by_hourly-instance_method">
1873
+
1874
+ #<strong>nodes_stats_by_hourly</strong>(node_id) &#x21d2; <tt>Object</tt>
1875
+
1876
+
1877
+
1878
+
1879
+
1880
+ </h3><div class="docstring">
1881
+ <div class="discussion">
1882
+
1883
+ <p>Get node node_id’s stats by hour</p>
1884
+
1885
+
1886
+ </div>
1887
+ </div>
1888
+ <div class="tags">
1889
+ <p class="tag_title">Parameters:</p>
1890
+ <ul class="param">
1891
+
1892
+ <li>
1893
+
1894
+ <span class='name'>node_id</span>
1895
+
1896
+
1897
+ <span class='type'></span>
1898
+
1899
+
1900
+
1901
+ </li>
1902
+
1903
+ </ul>
1904
+
1905
+
1906
+ </div><table class="source_code">
1907
+ <tr>
1908
+ <td>
1909
+ <pre class="lines">
1910
+
1911
+
1912
+ 186
1913
+ 187
1914
+ 188</pre>
1915
+ </td>
1916
+ <td>
1917
+ <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/cluster.rb', line 186</span>
1918
+
1919
+ <span class='kw'>def</span> <span class='id identifier rubyid_nodes_stats_by_hourly'>nodes_stats_by_hourly</span><span class='lparen'>(</span><span class='id identifier rubyid_node_id'>node_id</span><span class='rparen'>)</span>
1920
+ <span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/cluster/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_node_id'>node_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/stats/hourly</span><span class='tstring_end'>&quot;</span></span>
1921
+ <span class='kw'>end</span></pre>
1922
+ </td>
1923
+ </tr>
1924
+ </table>
1925
+ </div>
1926
+
1927
+ <div class="method_details ">
1928
+ <h3 class="signature " id="nodes_stats_by_weekly-instance_method">
1929
+
1930
+ #<strong>nodes_stats_by_weekly</strong>(node_id) &#x21d2; <tt>Object</tt>
1931
+
1932
+
1933
+
1934
+
1935
+
1936
+ </h3><div class="docstring">
1937
+ <div class="discussion">
1938
+
1939
+ <p>Get node node_id’s stats by weekly</p>
1940
+
1941
+
1942
+ </div>
1943
+ </div>
1944
+ <div class="tags">
1945
+ <p class="tag_title">Parameters:</p>
1946
+ <ul class="param">
1947
+
1948
+ <li>
1949
+
1950
+ <span class='name'>node_id</span>
1951
+
1952
+
1953
+ <span class='type'></span>
1954
+
1955
+
1956
+
1957
+ </li>
1958
+
1959
+ </ul>
1960
+
1961
+
1962
+ </div><table class="source_code">
1963
+ <tr>
1964
+ <td>
1965
+ <pre class="lines">
1966
+
1967
+
1968
+ 193
1969
+ 194
1970
+ 195</pre>
1971
+ </td>
1972
+ <td>
1973
+ <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/cluster.rb', line 193</span>
1974
+
1975
+ <span class='kw'>def</span> <span class='id identifier rubyid_nodes_stats_by_weekly'>nodes_stats_by_weekly</span><span class='lparen'>(</span><span class='id identifier rubyid_node_id'>node_id</span><span class='rparen'>)</span>
1976
+ <span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/cluster/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_node_id'>node_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/stats/weekly</span><span class='tstring_end'>&quot;</span></span>
1977
+ <span class='kw'>end</span></pre>
1978
+ </td>
1979
+ </tr>
1980
+ </table>
1981
+ </div>
1982
+
1983
+ <div class="method_details ">
1984
+ <h3 class="signature " id="remoted_stats-instance_method">
1985
+
1986
+ #<strong>remoted_stats</strong>(node_id) &#x21d2; <tt>Object</tt>
1987
+
1988
+
1989
+
1990
+
1991
+
1992
+ </h3><div class="docstring">
1993
+ <div class="discussion">
1994
+
1995
+ <p>Get node node_id’s remoted stats</p>
1996
+
1997
+
1998
+ </div>
1999
+ </div>
2000
+ <div class="tags">
2001
+ <p class="tag_title">Parameters:</p>
2002
+ <ul class="param">
2003
+
2004
+ <li>
2005
+
2006
+ <span class='name'>node_id</span>
2007
+
2008
+
2009
+ <span class='type'></span>
2010
+
2011
+
2012
+
2013
+ </li>
2014
+
2015
+ </ul>
2016
+
2017
+
2018
+ </div><table class="source_code">
2019
+ <tr>
2020
+ <td>
2021
+ <pre class="lines">
2022
+
2023
+
2024
+ 170
2025
+ 171
2026
+ 172</pre>
2027
+ </td>
2028
+ <td>
2029
+ <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/cluster.rb', line 170</span>
2030
+
2031
+ <span class='kw'>def</span> <span class='id identifier rubyid_remoted_stats'>remoted_stats</span><span class='lparen'>(</span><span class='id identifier rubyid_node_id'>node_id</span><span class='rparen'>)</span>
2032
+ <span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/cluster/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_node_id'>node_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/stats/remoted</span><span class='tstring_end'>&quot;</span></span>
2033
+ <span class='kw'>end</span></pre>
2034
+ </td>
2035
+ </tr>
2036
+ </table>
2037
+ </div>
2038
+
2039
+ <div class="method_details ">
2040
+ <h3 class="signature " id="restart_all_node-instance_method">
2041
+
2042
+ #<strong>restart_all_node</strong> &#x21d2; <tt>Object</tt>
2043
+
2044
+
2045
+
2046
+
2047
+
2048
+ </h3><div class="docstring">
2049
+ <div class="discussion">
2050
+
2051
+ <p>Restart all nodes in cluster</p>
2052
+
2053
+
2054
+ </div>
2055
+ </div>
2056
+ <div class="tags">
2057
+
2058
+
2059
+ </div><table class="source_code">
2060
+ <tr>
2061
+ <td>
2062
+ <pre class="lines">
2063
+
2064
+
2065
+ 156
2066
+ 157
2067
+ 158</pre>
2068
+ </td>
2069
+ <td>
2070
+ <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/cluster.rb', line 156</span>
2071
+
2072
+ <span class='kw'>def</span> <span class='id identifier rubyid_restart_all_node'>restart_all_node</span>
2073
+ <span class='id identifier rubyid_put'>put</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/cluster/restart</span><span class='tstring_end'>&#39;</span></span>
2074
+ <span class='kw'>end</span></pre>
2075
+ </td>
2076
+ </tr>
2077
+ </table>
2078
+ </div>
2079
+
2080
+ <div class="method_details ">
2081
+ <h3 class="signature " id="restart_node-instance_method">
2082
+
2083
+ #<strong>restart_node</strong>(node_id) &#x21d2; <tt>Object</tt>
2084
+
2085
+
2086
+
2087
+
2088
+
2089
+ </h3><div class="docstring">
2090
+ <div class="discussion">
2091
+
2092
+ <p>Restart a specific node in cluster</p>
2093
+
2094
+
2095
+ </div>
2096
+ </div>
2097
+ <div class="tags">
2098
+ <p class="tag_title">Parameters:</p>
2099
+ <ul class="param">
2100
+
2101
+ <li>
2102
+
2103
+ <span class='name'>node_id</span>
2104
+
2105
+
2106
+ <span class='type'></span>
2107
+
2108
+
2109
+
2110
+ </li>
2111
+
2112
+ </ul>
2113
+
2114
+
2115
+ </div><table class="source_code">
2116
+ <tr>
2117
+ <td>
2118
+ <pre class="lines">
2119
+
2120
+
2121
+ 150
2122
+ 151
2123
+ 152</pre>
2124
+ </td>
2125
+ <td>
2126
+ <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/cluster.rb', line 150</span>
2127
+
2128
+ <span class='kw'>def</span> <span class='id identifier rubyid_restart_node'>restart_node</span><span class='lparen'>(</span><span class='id identifier rubyid_node_id'>node_id</span><span class='rparen'>)</span>
2129
+ <span class='id identifier rubyid_put'>put</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/cluster/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_node_id'>node_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/restart</span><span class='tstring_end'>&quot;</span></span>
2130
+ <span class='kw'>end</span></pre>
2131
+ </td>
2132
+ </tr>
2133
+ </table>
2134
+ </div>
2135
+
2136
+ <div class="method_details ">
2137
+ <h3 class="signature " id="update_remote_file-instance_method">
2138
+
2139
+ #<strong>update_remote_file</strong>(node_id, options) &#x21d2; <tt>Object</tt>
2140
+
2141
+
2142
+
2143
+
2144
+
2145
+ </h3><div class="docstring">
2146
+ <div class="discussion">
2147
+
2148
+ <p>Update local file at any cluster node</p>
2149
+
2150
+
2151
+ </div>
2152
+ </div>
2153
+ <div class="tags">
2154
+ <p class="tag_title">Parameters:</p>
2155
+ <ul class="param">
2156
+
2157
+ <li>
2158
+
2159
+ <span class='name'>node_id</span>
2160
+
2161
+
2162
+ <span class='type'></span>
2163
+
2164
+
2165
+
2166
+ </li>
2167
+
2168
+ <li>
2169
+
2170
+ <span class='name'>options</span>
2171
+
2172
+
2173
+ <span class='type'>(<tt>Hash</tt>)</span>
2174
+
2175
+
2176
+
2177
+ &mdash;
2178
+ <div class='inline'>
2179
+ <p>a customizable set of options</p>
2180
+ </div>
2181
+
2182
+ </li>
2183
+
2184
+ </ul>
2185
+
2186
+
2187
+
2188
+
2189
+
2190
+
2191
+ <p class="tag_title">Options Hash (<tt>options</tt>):</p>
2192
+ <ul class="option">
2193
+
2194
+ <li>
2195
+ <span class="name">:file</span>
2196
+ <span class="type">(<tt>file</tt>)</span>
2197
+ <span class="default">
2198
+
2199
+ </span>
2200
+
2201
+ &mdash; <div class='inline'>
2202
+ <p>Input file.</p>
2203
+ </div>
2204
+
2205
+ </li>
2206
+
2207
+ <li>
2208
+ <span class="name">:path</span>
2209
+ <span class="type">(<tt>path</tt>)</span>
2210
+ <span class="default">
2211
+
2212
+ </span>
2213
+
2214
+ &mdash; <div class='inline'>
2215
+ <p>Relative path were input file will be placed. This parameter is mandatory.</p>
2216
+ </div>
2217
+
2218
+ </li>
2219
+
2220
+ <li>
2221
+ <span class="name">:overwrite</span>
2222
+ <span class="type">(<tt>overwrite</tt>)</span>
2223
+ <span class="default">
2224
+
2225
+ </span>
2226
+
2227
+ &mdash; <div class='inline'>
2228
+ <p>Replaces the existing file. False by default.</p>
2229
+ </div>
2230
+
2231
+ </li>
2232
+
2233
+ </ul>
2234
+
2235
+
2236
+
2237
+ </div><table class="source_code">
2238
+ <tr>
2239
+ <td>
2240
+ <pre class="lines">
2241
+
2242
+
2243
+ 71
2244
+ 72
2245
+ 73</pre>
2246
+ </td>
2247
+ <td>
2248
+ <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/cluster.rb', line 71</span>
2249
+
2250
+ <span class='kw'>def</span> <span class='id identifier rubyid_update_remote_file'>update_remote_file</span><span class='lparen'>(</span><span class='id identifier rubyid_node_id'>node_id</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
2251
+ <span class='id identifier rubyid_post'>post</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/cluster/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_node_id'>node_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/files</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span>
2252
+ <span class='kw'>end</span></pre>
2253
+ </td>
2254
+ </tr>
2255
+ </table>
2256
+ </div>
2257
+
2258
+ </div>
2259
+
2260
+ </div>
2261
+
2262
+ <div id="footer">
2263
+ Generated on Sat Jan 25 00:19:40 2020 by
2264
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
2265
+ 0.9.16 (ruby-2.5.1).
2266
+ </div>
2267
+
2268
+ </div>
2269
+ </body>
2270
+ </html>