wazuh-ruby-client 0.3.3 → 0.3.6
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.github/workflows/codeql-analysis.yml +70 -0
- data/.rubocop.yml +59 -0
- data/CHANGELOG.md +35 -0
- data/README.md +18 -1
- data/Rakefile +5 -1
- data/docs/Wazuh/Api/Endpoints/ActiveResponse.html +10 -13
- data/docs/Wazuh/Api/Endpoints/Agents.html +483 -204
- data/docs/Wazuh/Api/Endpoints/Cache.html +7 -7
- data/docs/Wazuh/Api/Endpoints/Ciscat.html +10 -13
- data/docs/Wazuh/Api/Endpoints/Cluster.html +52 -58
- data/docs/Wazuh/Api/Endpoints/Decoders.html +27 -39
- data/docs/Wazuh/Api/Endpoints/Experimental.html +63 -96
- data/docs/Wazuh/Api/Endpoints/Lists.html +15 -21
- data/docs/Wazuh/Api/Endpoints/Manager.html +44 -62
- data/docs/Wazuh/Api/Endpoints/Rootcheck.html +36 -52
- data/docs/Wazuh/Api/Endpoints/Rules.html +49 -68
- data/docs/Wazuh/Api/Endpoints/SecurityConfigurationAssessment.html +20 -31
- data/docs/Wazuh/Api/Endpoints/Summary.html +7 -7
- data/docs/Wazuh/Api/Endpoints/Syscheck.html +26 -33
- data/docs/Wazuh/Api/Endpoints/Syscollector.html +43 -61
- data/docs/Wazuh/Api/Endpoints/V4/ActiveResponse.html +198 -0
- data/docs/Wazuh/Api/Endpoints/V4/Agents.html +1079 -0
- data/docs/Wazuh/Api/Endpoints/V4/Cache.html +195 -0
- data/docs/Wazuh/Api/Endpoints/V4/Ciscat.html +126 -0
- data/docs/Wazuh/Api/Endpoints/V4/Cluster.html +126 -0
- data/docs/Wazuh/Api/Endpoints/V4/Decoders.html +126 -0
- data/docs/Wazuh/Api/Endpoints/V4/Experimental.html +126 -0
- data/docs/Wazuh/Api/Endpoints/V4/Lists.html +126 -0
- data/docs/Wazuh/Api/Endpoints/V4/Manager.html +126 -0
- data/docs/Wazuh/Api/Endpoints/V4/Rootcheck.html +126 -0
- data/docs/Wazuh/Api/Endpoints/V4/Rules.html +126 -0
- data/docs/Wazuh/Api/Endpoints/V4/SecurityConfigurationAssessment.html +126 -0
- data/docs/Wazuh/Api/Endpoints/V4/Summary.html +126 -0
- data/docs/Wazuh/Api/Endpoints/V4/Syscheck.html +126 -0
- data/docs/Wazuh/Api/Endpoints/V4/Syscollector.html +126 -0
- data/docs/Wazuh/Api/Endpoints/V4/Vulnerabilities.html +399 -0
- data/docs/Wazuh/Api/Endpoints/V4.html +403 -0
- data/docs/Wazuh/Api/Endpoints.html +9 -14
- data/docs/Wazuh/Api/Errors/WazuhError.html +9 -9
- data/docs/Wazuh/Api/Errors.html +6 -6
- data/docs/Wazuh/Api.html +7 -7
- data/docs/Wazuh/Client.html +35 -190
- data/docs/Wazuh/Config.html +20 -11
- data/docs/Wazuh/Logger.html +6 -6
- data/docs/Wazuh/Sawyer/Connection/Token.html +208 -0
- data/docs/Wazuh/Sawyer/Connection.html +19 -7
- data/docs/Wazuh/Sawyer/Request.html +78 -6
- data/docs/Wazuh/Sawyer.html +8 -8
- data/docs/Wazuh.html +16 -16
- data/docs/WazuhRubyClient.html +7 -7
- data/docs/_index.html +149 -7
- data/docs/class_list.html +3 -3
- data/docs/css/style.css +2 -2
- data/docs/file.README.html +39 -18
- data/docs/file_list.html +2 -2
- data/docs/frames.html +2 -2
- data/docs/index.html +39 -18
- data/docs/js/app.js +25 -3
- data/docs/method_list.html +269 -69
- data/docs/top-level-namespace.html +6 -6
- data/lib/wazuh/api/endpoints/agents.rb +1 -1
- data/lib/wazuh/api/endpoints/rootcheck.rb +1 -1
- data/lib/wazuh/api/endpoints/security_configuration_assessment.rb +1 -1
- data/lib/wazuh/api/endpoints/syscollector.rb +1 -1
- data/lib/wazuh/api/endpoints/v4/cluster.rb +127 -0
- data/lib/wazuh/api/endpoints/v4/vulnerabilities.rb +47 -0
- data/lib/wazuh/api/endpoints/v4.rb +2 -1
- data/lib/wazuh/client.rb +0 -1
- data/lib/wazuh/sawyer/connection.rb +1 -1
- data/lib/wazuh/sawyer/request.rb +26 -16
- data/lib/wazuh/version.rb +1 -1
- data/lib/wazuh-ruby-client/version.rb +1 -1
- metadata +23 -3
- data/.travis.yml +0 -7
@@ -6,15 +6,15 @@
|
|
6
6
|
<title>
|
7
7
|
Module: Wazuh::Api::Endpoints::Agents
|
8
8
|
|
9
|
-
— Documentation by YARD 0.9.
|
9
|
+
— Documentation by YARD 0.9.25
|
10
10
|
|
11
11
|
</title>
|
12
12
|
|
13
|
-
<link rel="stylesheet" href="../../../css/style.css" type="text/css"
|
13
|
+
<link rel="stylesheet" href="../../../css/style.css" type="text/css" />
|
14
14
|
|
15
|
-
<link rel="stylesheet" href="../../../css/common.css" type="text/css"
|
15
|
+
<link rel="stylesheet" href="../../../css/common.css" type="text/css" />
|
16
16
|
|
17
|
-
<script type="text/javascript"
|
17
|
+
<script type="text/javascript">
|
18
18
|
pathId = "Wazuh::Api::Endpoints::Agents";
|
19
19
|
relpath = '../../../';
|
20
20
|
</script>
|
@@ -76,7 +76,7 @@
|
|
76
76
|
|
77
77
|
<dl>
|
78
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>
|
79
|
+
<dd><span class='object_link'><a href="../Endpoints.html" title="Wazuh::Api::Endpoints (module)">Wazuh::Api::Endpoints</a></span>, <span class='object_link'><a href="V4/Agents.html" title="Wazuh::Api::Endpoints::V4::Agents (module)">V4::Agents</a></span></dd>
|
80
80
|
</dl>
|
81
81
|
|
82
82
|
|
@@ -193,8 +193,7 @@
|
|
193
193
|
|
194
194
|
|
195
195
|
<span class="summary_desc"><div class='inline'>
|
196
|
-
<p>Add a list of agents to a group Adds a list of agents to the specified
|
197
|
-
group.</p>
|
196
|
+
<p>Add a list of agents to a group Adds a list of agents to the specified group.</p>
|
198
197
|
</div></span>
|
199
198
|
|
200
199
|
</li>
|
@@ -365,6 +364,54 @@ group.</p>
|
|
365
364
|
<p>Get sync status of agent Returns the sync status in JSON format.</p>
|
366
365
|
</div></span>
|
367
366
|
|
367
|
+
</li>
|
368
|
+
|
369
|
+
|
370
|
+
<li class="public ">
|
371
|
+
<span class="summary_signature">
|
372
|
+
|
373
|
+
<a href="#agent_upgrade-instance_method" title="#agent_upgrade (instance method)">#<strong>agent_upgrade</strong>(agent_id, options = {}) ⇒ 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>Upgrade agent using online repository.</p>
|
389
|
+
</div></span>
|
390
|
+
|
391
|
+
</li>
|
392
|
+
|
393
|
+
|
394
|
+
<li class="public ">
|
395
|
+
<span class="summary_signature">
|
396
|
+
|
397
|
+
<a href="#agent_upgrade_custom-instance_method" title="#agent_upgrade_custom (instance method)">#<strong>agent_upgrade_custom</strong>(agent_id, options = {}) ⇒ 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>Upgrade agent using custom file.</p>
|
413
|
+
</div></span>
|
414
|
+
|
368
415
|
</li>
|
369
416
|
|
370
417
|
|
@@ -410,8 +457,7 @@ group.</p>
|
|
410
457
|
|
411
458
|
|
412
459
|
<span class="summary_desc"><div class='inline'>
|
413
|
-
<p>Get agents without group Returns a list with the available agents without
|
414
|
-
group.</p>
|
460
|
+
<p>Get agents without group Returns a list with the available agents without group.</p>
|
415
461
|
</div></span>
|
416
462
|
|
417
463
|
</li>
|
@@ -531,8 +577,7 @@ group.</p>
|
|
531
577
|
|
532
578
|
|
533
579
|
<span class="summary_desc"><div class='inline'>
|
534
|
-
<p>Delete agents Removes agents, using a list of them or a criterion based on
|
535
|
-
the status or time of the last connection.</p>
|
580
|
+
<p>Delete agents Removes agents, using a list of them or a criterion based on the status or time of the last connection.</p>
|
536
581
|
</div></span>
|
537
582
|
|
538
583
|
</li>
|
@@ -556,8 +601,7 @@ the status or time of the last connection.</p>
|
|
556
601
|
|
557
602
|
|
558
603
|
<span class="summary_desc"><div class='inline'>
|
559
|
-
<p>Returns all the different combinations that agents have for the selected
|
560
|
-
fields.</p>
|
604
|
+
<p>Returns all the different combinations that agents have for the selected fields.</p>
|
561
605
|
</div></span>
|
562
606
|
|
563
607
|
</li>
|
@@ -581,8 +625,7 @@ fields.</p>
|
|
581
625
|
|
582
626
|
|
583
627
|
<span class="summary_desc"><div class='inline'>
|
584
|
-
<p>Get a file in group Returns the specified file belonging to the group
|
585
|
-
parsed to JSON.</p>
|
628
|
+
<p>Get a file in group Returns the specified file belonging to the group parsed to JSON.</p>
|
586
629
|
</div></span>
|
587
630
|
|
588
631
|
</li>
|
@@ -726,8 +769,7 @@ parsed to JSON.</p>
|
|
726
769
|
|
727
770
|
|
728
771
|
<span class="summary_desc"><div class='inline'>
|
729
|
-
<p>Remove a single group of an agent Remove the group of the agent but will
|
730
|
-
leave the rest of its group if it belongs to a multigroup.</p>
|
772
|
+
<p>Remove a single group of an agent Remove the group of the agent but will leave the rest of its group if it belongs to a multigroup.</p>
|
731
773
|
</div></span>
|
732
774
|
|
733
775
|
</li>
|
@@ -751,8 +793,7 @@ leave the rest of its group if it belongs to a multigroup.</p>
|
|
751
793
|
|
752
794
|
|
753
795
|
<span class="summary_desc"><div class='inline'>
|
754
|
-
<p>Remove a single group of multiple agents Remove a list of agents of a
|
755
|
-
group.</p>
|
796
|
+
<p>Remove a single group of multiple agents Remove a list of agents of a group.</p>
|
756
797
|
</div></span>
|
757
798
|
|
758
799
|
</li>
|
@@ -896,8 +937,7 @@ group.</p>
|
|
896
937
|
|
897
938
|
|
898
939
|
<span class="summary_desc"><div class='inline'>
|
899
|
-
<p>Put configuration file (agent.conf) into a group Upload the group
|
900
|
-
configuration (agent.conf).</p>
|
940
|
+
<p>Put configuration file (agent.conf) into a group Upload the group configuration (agent.conf).</p>
|
901
941
|
</div></span>
|
902
942
|
|
903
943
|
</li>
|
@@ -1004,9 +1044,7 @@ configuration (agent.conf).</p>
|
|
1004
1044
|
</span>
|
1005
1045
|
|
1006
1046
|
— <div class='inline'>
|
1007
|
-
<p>IP to agent If this is not included, the API will get the IP automatically.
|
1008
|
-
If you are behind a proxy, you must set the option config.BehindProxyServer
|
1009
|
-
to yes at config.js. Allowed values: IP, IP/NET, ANY</p>
|
1047
|
+
<p>IP to agent If this is not included, the API will get the IP automatically. If you are behind a proxy, you must set the option config.BehindProxyServer to yes at config.js. Allowed values: IP, IP/NET, ANY</p>
|
1010
1048
|
</div>
|
1011
1049
|
|
1012
1050
|
</li>
|
@@ -1019,8 +1057,7 @@ to yes at config.js. Allowed values: IP, IP/NET, ANY</p>
|
|
1019
1057
|
</span>
|
1020
1058
|
|
1021
1059
|
— <div class='inline'>
|
1022
|
-
<p>Remove the old agent with the same IP if disconnected since <force>
|
1023
|
-
seconds.</p>
|
1060
|
+
<p>Remove the old agent with the same IP if disconnected since <force> seconds.</p>
|
1024
1061
|
</div>
|
1025
1062
|
|
1026
1063
|
</li>
|
@@ -1042,12 +1079,12 @@ seconds.</p>
|
|
1042
1079
|
<pre class="lines">
|
1043
1080
|
|
1044
1081
|
|
1045
|
-
|
1046
|
-
|
1047
|
-
|
1082
|
+
176
|
1083
|
+
177
|
1084
|
+
178</pre>
|
1048
1085
|
</td>
|
1049
1086
|
<td>
|
1050
|
-
<pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/agents.rb', line
|
1087
|
+
<pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/agents.rb', line 176</span>
|
1051
1088
|
|
1052
1089
|
<span class='kw'>def</span> <span class='id identifier rubyid_add_agent'>add_agent</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>
|
1053
1090
|
<span class='id identifier rubyid_post'>post</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/agents</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span>
|
@@ -1110,12 +1147,12 @@ seconds.</p>
|
|
1110
1147
|
<pre class="lines">
|
1111
1148
|
|
1112
1149
|
|
1113
|
-
|
1114
|
-
|
1115
|
-
|
1150
|
+
210
|
1151
|
+
211
|
1152
|
+
212</pre>
|
1116
1153
|
</td>
|
1117
1154
|
<td>
|
1118
|
-
<pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/agents.rb', line
|
1155
|
+
<pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/agents.rb', line 210</span>
|
1119
1156
|
|
1120
1157
|
<span class='kw'>def</span> <span class='id identifier rubyid_add_agent_quick'>add_agent_quick</span><span class='lparen'>(</span><span class='id identifier rubyid_agent_name'>agent_name</span><span class='rparen'>)</span>
|
1121
1158
|
<span class='id identifier rubyid_put'>put</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/agents/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_agent_name'>agent_name</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
|
@@ -1238,12 +1275,12 @@ seconds.</p>
|
|
1238
1275
|
<pre class="lines">
|
1239
1276
|
|
1240
1277
|
|
1241
|
-
|
1242
|
-
|
1243
|
-
|
1278
|
+
280
|
1279
|
+
281
|
1280
|
+
282</pre>
|
1244
1281
|
</td>
|
1245
1282
|
<td>
|
1246
|
-
<pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/agents.rb', line
|
1283
|
+
<pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/agents.rb', line 280</span>
|
1247
1284
|
|
1248
1285
|
<span class='kw'>def</span> <span class='id identifier rubyid_add_agent_to_group'>add_agent_to_group</span><span class='lparen'>(</span><span class='id identifier rubyid_agent_id'>agent_id</span><span class='comma'>,</span> <span class='id identifier rubyid_group_id'>group_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>
|
1249
1286
|
<span class='id identifier rubyid_put'>put</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/agents/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_agent_id'>agent_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/group/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_group_id'>group_id</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span>
|
@@ -1265,8 +1302,7 @@ seconds.</p>
|
|
1265
1302
|
</h3><div class="docstring">
|
1266
1303
|
<div class="discussion">
|
1267
1304
|
|
1268
|
-
<p>Add a list of agents to a group Adds a list of agents to the specified
|
1269
|
-
group</p>
|
1305
|
+
<p>Add a list of agents to a group Adds a list of agents to the specified group</p>
|
1270
1306
|
|
1271
1307
|
|
1272
1308
|
</div>
|
@@ -1318,12 +1354,12 @@ group</p>
|
|
1318
1354
|
<pre class="lines">
|
1319
1355
|
|
1320
1356
|
|
1321
|
-
|
1322
|
-
|
1323
|
-
|
1357
|
+
266
|
1358
|
+
267
|
1359
|
+
268</pre>
|
1324
1360
|
</td>
|
1325
1361
|
<td>
|
1326
|
-
<pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/agents.rb', line
|
1362
|
+
<pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/agents.rb', line 266</span>
|
1327
1363
|
|
1328
1364
|
<span class='kw'>def</span> <span class='id identifier rubyid_add_agents_to_group'>add_agents_to_group</span><span class='lparen'>(</span><span class='id identifier rubyid_ids'>ids</span><span class='comma'>,</span> <span class='id identifier rubyid_group_id'>group_id</span><span class='rparen'>)</span>
|
1329
1365
|
<span class='id identifier rubyid_post'>post</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/agents/group/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_group_id'>group_id</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='lbrace'>{</span><span class='label'>ids:</span> <span class='id identifier rubyid_ids'>ids</span><span class='rbrace'>}</span>
|
@@ -1446,12 +1482,12 @@ group</p>
|
|
1446
1482
|
<pre class="lines">
|
1447
1483
|
|
1448
1484
|
|
1485
|
+
37
|
1449
1486
|
38
|
1450
|
-
39
|
1451
|
-
40</pre>
|
1487
|
+
39</pre>
|
1452
1488
|
</td>
|
1453
1489
|
<td>
|
1454
|
-
<pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/agents.rb', line
|
1490
|
+
<pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/agents.rb', line 37</span>
|
1455
1491
|
|
1456
1492
|
<span class='kw'>def</span> <span class='id identifier rubyid_agent'>agent</span><span class='lparen'>(</span><span class='id identifier rubyid_agent_id'>agent_id</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
1457
1493
|
<span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/agents/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_agent_id'>agent_id</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span>
|
@@ -1574,12 +1610,12 @@ group</p>
|
|
1574
1610
|
<pre class="lines">
|
1575
1611
|
|
1576
1612
|
|
1613
|
+
49
|
1577
1614
|
50
|
1578
|
-
51
|
1579
|
-
52</pre>
|
1615
|
+
51</pre>
|
1580
1616
|
</td>
|
1581
1617
|
<td>
|
1582
|
-
<pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/agents.rb', line
|
1618
|
+
<pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/agents.rb', line 49</span>
|
1583
1619
|
|
1584
1620
|
<span class='kw'>def</span> <span class='id identifier rubyid_agent_by_name'>agent_by_name</span><span class='lparen'>(</span><span class='id identifier rubyid_agent_name'>agent_name</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>
|
1585
1621
|
<span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/agents/name/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_agent_name'>agent_name</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span>
|
@@ -1669,12 +1705,12 @@ group</p>
|
|
1669
1705
|
<pre class="lines">
|
1670
1706
|
|
1671
1707
|
|
1672
|
-
|
1673
|
-
|
1674
|
-
|
1708
|
+
238
|
1709
|
+
239
|
1710
|
+
240</pre>
|
1675
1711
|
</td>
|
1676
1712
|
<td>
|
1677
|
-
<pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/agents.rb', line
|
1713
|
+
<pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/agents.rb', line 238</span>
|
1678
1714
|
|
1679
1715
|
<span class='kw'>def</span> <span class='id identifier rubyid_agent_config'>agent_config</span><span class='lparen'>(</span><span class='id identifier rubyid_agent_id'>agent_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='rparen'>)</span>
|
1680
1716
|
<span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/agents/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_agent_id'>agent_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/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'>"</span></span>
|
@@ -1755,12 +1791,12 @@ group</p>
|
|
1755
1791
|
<pre class="lines">
|
1756
1792
|
|
1757
1793
|
|
1794
|
+
60
|
1758
1795
|
61
|
1759
|
-
62
|
1760
|
-
63</pre>
|
1796
|
+
62</pre>
|
1761
1797
|
</td>
|
1762
1798
|
<td>
|
1763
|
-
<pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/agents.rb', line
|
1799
|
+
<pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/agents.rb', line 60</span>
|
1764
1800
|
|
1765
1801
|
<span class='kw'>def</span> <span class='id identifier rubyid_agent_key'>agent_key</span><span class='lparen'>(</span><span class='id identifier rubyid_agent_id'>agent_id</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
1766
1802
|
<span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/agents/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_agent_id'>agent_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/key</span><span class='tstring_end'>"</span></span>
|
@@ -1879,12 +1915,12 @@ group</p>
|
|
1879
1915
|
<pre class="lines">
|
1880
1916
|
|
1881
1917
|
|
1882
|
-
|
1883
|
-
|
1884
|
-
|
1918
|
+
436
|
1919
|
+
437
|
1920
|
+
438</pre>
|
1885
1921
|
</td>
|
1886
1922
|
<td>
|
1887
|
-
<pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/agents.rb', line
|
1923
|
+
<pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/agents.rb', line 436</span>
|
1888
1924
|
|
1889
1925
|
<span class='kw'>def</span> <span class='id identifier rubyid_agent_os_summary'>agent_os_summary</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>
|
1890
1926
|
<span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/agents/summary/os</span><span class='tstring_end'>"</span></span>
|
@@ -1927,12 +1963,12 @@ group</p>
|
|
1927
1963
|
<pre class="lines">
|
1928
1964
|
|
1929
1965
|
|
1930
|
-
|
1931
|
-
|
1932
|
-
|
1966
|
+
444
|
1967
|
+
445
|
1968
|
+
446</pre>
|
1933
1969
|
</td>
|
1934
1970
|
<td>
|
1935
|
-
<pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/agents.rb', line
|
1971
|
+
<pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/agents.rb', line 444</span>
|
1936
1972
|
|
1937
1973
|
<span class='kw'>def</span> <span class='id identifier rubyid_agent_summary'>agent_summary</span>
|
1938
1974
|
<span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/agents/summary</span><span class='tstring_end'>"</span></span>
|
@@ -1995,12 +2031,12 @@ group</p>
|
|
1995
2031
|
<pre class="lines">
|
1996
2032
|
|
1997
2033
|
|
1998
|
-
|
1999
|
-
|
2000
|
-
|
2034
|
+
255
|
2035
|
+
256
|
2036
|
+
257</pre>
|
2001
2037
|
</td>
|
2002
2038
|
<td>
|
2003
|
-
<pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/agents.rb', line
|
2039
|
+
<pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/agents.rb', line 255</span>
|
2004
2040
|
|
2005
2041
|
<span class='kw'>def</span> <span class='id identifier rubyid_agent_sync_status'>agent_sync_status</span><span class='lparen'>(</span><span class='id identifier rubyid_agent_id'>agent_id</span><span class='rparen'>)</span>
|
2006
2042
|
<span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/agent/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_agent_id'>agent_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/group/is_sync</span><span class='tstring_end'>"</span></span>
|
@@ -2008,6 +2044,275 @@ group</p>
|
|
2008
2044
|
</td>
|
2009
2045
|
</tr>
|
2010
2046
|
</table>
|
2047
|
+
</div>
|
2048
|
+
|
2049
|
+
<div class="method_details ">
|
2050
|
+
<h3 class="signature " id="agent_upgrade-instance_method">
|
2051
|
+
|
2052
|
+
#<strong>agent_upgrade</strong>(agent_id, options = {}) ⇒ <tt>Object</tt>
|
2053
|
+
|
2054
|
+
|
2055
|
+
|
2056
|
+
|
2057
|
+
|
2058
|
+
</h3><div class="docstring">
|
2059
|
+
<div class="discussion">
|
2060
|
+
|
2061
|
+
<p>Upgrade agent using online repository</p>
|
2062
|
+
|
2063
|
+
<p>Upgrade the agent using a WPK file from online repository.</p>
|
2064
|
+
|
2065
|
+
|
2066
|
+
</div>
|
2067
|
+
</div>
|
2068
|
+
<div class="tags">
|
2069
|
+
<p class="tag_title">Parameters:</p>
|
2070
|
+
<ul class="param">
|
2071
|
+
|
2072
|
+
<li>
|
2073
|
+
|
2074
|
+
<span class='name'>:agent_id</span>
|
2075
|
+
|
2076
|
+
|
2077
|
+
<span class='type'>(<tt>String</tt>)</span>
|
2078
|
+
|
2079
|
+
|
2080
|
+
|
2081
|
+
</li>
|
2082
|
+
|
2083
|
+
<li>
|
2084
|
+
|
2085
|
+
<span class='name'>options</span>
|
2086
|
+
|
2087
|
+
|
2088
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
2089
|
+
|
2090
|
+
|
2091
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
2092
|
+
|
2093
|
+
|
2094
|
+
—
|
2095
|
+
<div class='inline'>
|
2096
|
+
<p>a customizable set of options</p>
|
2097
|
+
</div>
|
2098
|
+
|
2099
|
+
</li>
|
2100
|
+
|
2101
|
+
</ul>
|
2102
|
+
|
2103
|
+
|
2104
|
+
|
2105
|
+
|
2106
|
+
|
2107
|
+
|
2108
|
+
<p class="tag_title">Options Hash (<tt>options</tt>):</p>
|
2109
|
+
<ul class="option">
|
2110
|
+
|
2111
|
+
<li>
|
2112
|
+
<span class="name">:wpk_repo</span>
|
2113
|
+
<span class="type">(<tt>String</tt>)</span>
|
2114
|
+
<span class="default">
|
2115
|
+
|
2116
|
+
</span>
|
2117
|
+
|
2118
|
+
— <div class='inline'>
|
2119
|
+
<p>WPK repository.</p>
|
2120
|
+
</div>
|
2121
|
+
|
2122
|
+
</li>
|
2123
|
+
|
2124
|
+
<li>
|
2125
|
+
<span class="name">:version</span>
|
2126
|
+
<span class="type">(<tt>String</tt>)</span>
|
2127
|
+
<span class="default">
|
2128
|
+
|
2129
|
+
</span>
|
2130
|
+
|
2131
|
+
— <div class='inline'>
|
2132
|
+
<p>Wazuh version</p>
|
2133
|
+
</div>
|
2134
|
+
|
2135
|
+
</li>
|
2136
|
+
|
2137
|
+
<li>
|
2138
|
+
<span class="name">:use_http</span>
|
2139
|
+
<span class="type">(<tt>Boolean</tt>)</span>
|
2140
|
+
<span class="default">
|
2141
|
+
|
2142
|
+
</span>
|
2143
|
+
|
2144
|
+
— <div class='inline'>
|
2145
|
+
<p>Use protocol HTTP. If it is false use HTTPS. By default the value is set to false.</p>
|
2146
|
+
</div>
|
2147
|
+
|
2148
|
+
</li>
|
2149
|
+
|
2150
|
+
<li>
|
2151
|
+
<span class="name">:force</span>
|
2152
|
+
<span class="type">(<tt>Integer</tt>)</span>
|
2153
|
+
<span class="default">
|
2154
|
+
|
2155
|
+
</span>
|
2156
|
+
|
2157
|
+
— <div class='inline'>
|
2158
|
+
<p>Force upgrade. Allow values: 0 or 1.</p>
|
2159
|
+
</div>
|
2160
|
+
|
2161
|
+
</li>
|
2162
|
+
|
2163
|
+
</ul>
|
2164
|
+
|
2165
|
+
|
2166
|
+
|
2167
|
+
<p class="tag_title">See Also:</p>
|
2168
|
+
<ul class="see">
|
2169
|
+
|
2170
|
+
<li><a href="https://documentation.wazuh.com/3.12/user-manual/api/reference.html#upgrade-agent-using-online-repository" target="_parent" title="https://documentation.wazuh.com/3.12/user-manual/api/reference.html#upgrade-agent-using-online-repository">https://documentation.wazuh.com/3.12/user-manual/api/reference.html#upgrade-agent-using-online-repository</a></li>
|
2171
|
+
|
2172
|
+
</ul>
|
2173
|
+
|
2174
|
+
</div><table class="source_code">
|
2175
|
+
<tr>
|
2176
|
+
<td>
|
2177
|
+
<pre class="lines">
|
2178
|
+
|
2179
|
+
|
2180
|
+
160
|
2181
|
+
161
|
2182
|
+
162</pre>
|
2183
|
+
</td>
|
2184
|
+
<td>
|
2185
|
+
<pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/agents.rb', line 160</span>
|
2186
|
+
|
2187
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_agent_upgrade'>agent_upgrade</span><span class='lparen'>(</span><span class='id identifier rubyid_agent_id'>agent_id</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
2188
|
+
<span class='id identifier rubyid_put'>put</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/agents/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_agent_id'>agent_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/upgrade</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span>
|
2189
|
+
<span class='kw'>end</span></pre>
|
2190
|
+
</td>
|
2191
|
+
</tr>
|
2192
|
+
</table>
|
2193
|
+
</div>
|
2194
|
+
|
2195
|
+
<div class="method_details ">
|
2196
|
+
<h3 class="signature " id="agent_upgrade_custom-instance_method">
|
2197
|
+
|
2198
|
+
#<strong>agent_upgrade_custom</strong>(agent_id, options = {}) ⇒ <tt>Object</tt>
|
2199
|
+
|
2200
|
+
|
2201
|
+
|
2202
|
+
|
2203
|
+
|
2204
|
+
</h3><div class="docstring">
|
2205
|
+
<div class="discussion">
|
2206
|
+
|
2207
|
+
<p>Upgrade agent using custom file.</p>
|
2208
|
+
|
2209
|
+
|
2210
|
+
</div>
|
2211
|
+
</div>
|
2212
|
+
<div class="tags">
|
2213
|
+
<p class="tag_title">Parameters:</p>
|
2214
|
+
<ul class="param">
|
2215
|
+
|
2216
|
+
<li>
|
2217
|
+
|
2218
|
+
<span class='name'>:agent_id</span>
|
2219
|
+
|
2220
|
+
|
2221
|
+
<span class='type'>(<tt>String</tt>)</span>
|
2222
|
+
|
2223
|
+
|
2224
|
+
|
2225
|
+
—
|
2226
|
+
<div class='inline'>
|
2227
|
+
<p>Agent unique ID.</p>
|
2228
|
+
</div>
|
2229
|
+
|
2230
|
+
</li>
|
2231
|
+
|
2232
|
+
<li>
|
2233
|
+
|
2234
|
+
<span class='name'>options</span>
|
2235
|
+
|
2236
|
+
|
2237
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
2238
|
+
|
2239
|
+
|
2240
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
2241
|
+
|
2242
|
+
|
2243
|
+
—
|
2244
|
+
<div class='inline'>
|
2245
|
+
<p>a customizable set of options</p>
|
2246
|
+
</div>
|
2247
|
+
|
2248
|
+
</li>
|
2249
|
+
|
2250
|
+
</ul>
|
2251
|
+
|
2252
|
+
|
2253
|
+
|
2254
|
+
|
2255
|
+
|
2256
|
+
|
2257
|
+
<p class="tag_title">Options Hash (<tt>options</tt>):</p>
|
2258
|
+
<ul class="option">
|
2259
|
+
|
2260
|
+
<li>
|
2261
|
+
<span class="name">:file_path</span>
|
2262
|
+
<span class="type">(<tt>String</tt>)</span>
|
2263
|
+
<span class="default">
|
2264
|
+
|
2265
|
+
</span>
|
2266
|
+
|
2267
|
+
— <div class='inline'>
|
2268
|
+
<p>Path to the WPK file. The file must be on a folder on the Wazuh’s installation directory (by default, <code>/var/ossec</code>).</p>
|
2269
|
+
</div>
|
2270
|
+
|
2271
|
+
</li>
|
2272
|
+
|
2273
|
+
<li>
|
2274
|
+
<span class="name">:installer</span>
|
2275
|
+
<span class="type">(<tt>String</tt>)</span>
|
2276
|
+
<span class="default">
|
2277
|
+
|
2278
|
+
</span>
|
2279
|
+
|
2280
|
+
— <div class='inline'>
|
2281
|
+
<p>Installation script.</p>
|
2282
|
+
</div>
|
2283
|
+
|
2284
|
+
</li>
|
2285
|
+
|
2286
|
+
</ul>
|
2287
|
+
|
2288
|
+
|
2289
|
+
|
2290
|
+
<p class="tag_title">See Also:</p>
|
2291
|
+
<ul class="see">
|
2292
|
+
|
2293
|
+
<li><a href="https://documentation.wazuh.com/3.12/user-manual/api/reference.html#upgrade-agent-using-custom-file" target="_parent" title="https://documentation.wazuh.com/3.12/user-manual/api/reference.html#upgrade-agent-using-custom-file">https://documentation.wazuh.com/3.12/user-manual/api/reference.html#upgrade-agent-using-custom-file</a></li>
|
2294
|
+
|
2295
|
+
</ul>
|
2296
|
+
|
2297
|
+
</div><table class="source_code">
|
2298
|
+
<tr>
|
2299
|
+
<td>
|
2300
|
+
<pre class="lines">
|
2301
|
+
|
2302
|
+
|
2303
|
+
143
|
2304
|
+
144
|
2305
|
+
145</pre>
|
2306
|
+
</td>
|
2307
|
+
<td>
|
2308
|
+
<pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/agents.rb', line 143</span>
|
2309
|
+
|
2310
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_agent_upgrade_custom'>agent_upgrade_custom</span><span class='lparen'>(</span><span class='id identifier rubyid_agent_id'>agent_id</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
2311
|
+
<span class='id identifier rubyid_put'>put</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/agents/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_agent_id'>agent_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/upgrade_custom</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span>
|
2312
|
+
<span class='kw'>end</span></pre>
|
2313
|
+
</td>
|
2314
|
+
</tr>
|
2315
|
+
</table>
|
2011
2316
|
</div>
|
2012
2317
|
|
2013
2318
|
<div class="method_details ">
|
@@ -2155,15 +2460,15 @@ group</p>
|
|
2155
2460
|
<pre class="lines">
|
2156
2461
|
|
2157
2462
|
|
2158
|
-
|
2159
|
-
|
2160
|
-
|
2463
|
+
321
|
2464
|
+
322
|
2465
|
+
323</pre>
|
2161
2466
|
</td>
|
2162
2467
|
<td>
|
2163
|
-
<pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/agents.rb', line
|
2468
|
+
<pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/agents.rb', line 321</span>
|
2164
2469
|
|
2165
2470
|
<span class='kw'>def</span> <span class='id identifier rubyid_agents_by_group'>agents_by_group</span><span class='lparen'>(</span><span class='id identifier rubyid_group_id'>group_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>
|
2166
|
-
<span class='id identifier
|
2471
|
+
<span class='id identifier rubyid_offset_request'>offset_request</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>get</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/agents/groups/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_group_id'>group_id</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
2167
2472
|
<span class='kw'>end</span></pre>
|
2168
2473
|
</td>
|
2169
2474
|
</tr>
|
@@ -2182,8 +2487,7 @@ group</p>
|
|
2182
2487
|
</h3><div class="docstring">
|
2183
2488
|
<div class="discussion">
|
2184
2489
|
|
2185
|
-
<p>Get agents without group Returns a list with the available agents without
|
2186
|
-
group.</p>
|
2490
|
+
<p>Get agents without group Returns a list with the available agents without group.</p>
|
2187
2491
|
|
2188
2492
|
|
2189
2493
|
</div>
|
@@ -2298,12 +2602,12 @@ group.</p>
|
|
2298
2602
|
<pre class="lines">
|
2299
2603
|
|
2300
2604
|
|
2301
|
-
|
2302
|
-
|
2303
|
-
|
2605
|
+
336
|
2606
|
+
337
|
2607
|
+
338</pre>
|
2304
2608
|
</td>
|
2305
2609
|
<td>
|
2306
|
-
<pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/agents.rb', line
|
2610
|
+
<pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/agents.rb', line 336</span>
|
2307
2611
|
|
2308
2612
|
<span class='kw'>def</span> <span class='id identifier rubyid_agents_by_no_group'>agents_by_no_group</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>
|
2309
2613
|
<span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>agents/no_group</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span>
|
@@ -2407,8 +2711,7 @@ group.</p>
|
|
2407
2711
|
</span>
|
2408
2712
|
|
2409
2713
|
— <div class='inline'>
|
2410
|
-
<p>Sorts the collection by a field or fields (separated by comma). Use +/- at
|
2411
|
-
the beginning to list in ascending or descending order.</p>
|
2714
|
+
<p>Sorts the collection by a field or fields (separated by comma). Use +/- at the beginning to list in ascending or descending order.</p>
|
2412
2715
|
</div>
|
2413
2716
|
|
2414
2717
|
</li>
|
@@ -2434,8 +2737,7 @@ the beginning to list in ascending or descending order.</p>
|
|
2434
2737
|
</span>
|
2435
2738
|
|
2436
2739
|
— <div class='inline'>
|
2437
|
-
<p>Filters by agent status. Use commas to enter multiple statuses. Allowed
|
2438
|
-
values: active, pending, neverconnected, disconnected</p>
|
2740
|
+
<p>Filters by agent status. Use commas to enter multiple statuses. Allowed values: active, pending, neverconnected, disconnected</p>
|
2439
2741
|
</div>
|
2440
2742
|
|
2441
2743
|
</li>
|
@@ -2448,9 +2750,7 @@ values: active, pending, neverconnected, disconnected</p>
|
|
2448
2750
|
</span>
|
2449
2751
|
|
2450
2752
|
— <div class='inline'>
|
2451
|
-
<p>Filters out disconnected agents for longer than specified. Time in seconds,
|
2452
|
-
‘[n_days]d’, ‘[n_hours]h’, ‘[n_minutes]m’ or ‘[n_seconds]s’. For never
|
2453
|
-
connected agents, uses the register date.</p>
|
2753
|
+
<p>Filters out disconnected agents for longer than specified. Time in seconds, ‘[n_days]d’, ‘[n_hours]h’, ‘[n_minutes]m’ or ‘[n_seconds]s’. For never connected agents, uses the register date.</p>
|
2454
2754
|
</div>
|
2455
2755
|
|
2456
2756
|
</li>
|
@@ -2492,15 +2792,13 @@ connected agents, uses the register date.</p>
|
|
2492
2792
|
|
2493
2793
|
25
|
2494
2794
|
26
|
2495
|
-
27
|
2496
|
-
28</pre>
|
2795
|
+
27</pre>
|
2497
2796
|
</td>
|
2498
2797
|
<td>
|
2499
2798
|
<pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/agents.rb', line 25</span>
|
2500
2799
|
|
2501
2800
|
<span class='kw'>def</span> <span class='id identifier rubyid_all_agents'>all_agents</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>
|
2502
|
-
<span class='id identifier
|
2503
|
-
<span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_items'>items</span>
|
2801
|
+
<span class='id identifier rubyid_offset_request'>offset_request</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>get</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/agents</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
2504
2802
|
<span class='kw'>end</span></pre>
|
2505
2803
|
</td>
|
2506
2804
|
</tr>
|
@@ -2560,12 +2858,12 @@ connected agents, uses the register date.</p>
|
|
2560
2858
|
<pre class="lines">
|
2561
2859
|
|
2562
2860
|
|
2563
|
-
|
2564
|
-
|
2565
|
-
|
2861
|
+
290
|
2862
|
+
291
|
2863
|
+
292</pre>
|
2566
2864
|
</td>
|
2567
2865
|
<td>
|
2568
|
-
<pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/agents.rb', line
|
2866
|
+
<pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/agents.rb', line 290</span>
|
2569
2867
|
|
2570
2868
|
<span class='kw'>def</span> <span class='id identifier rubyid_create_group'>create_group</span><span class='lparen'>(</span><span class='id identifier rubyid_group_id'>group_id</span><span class='rparen'>)</span>
|
2571
2869
|
<span class='id identifier rubyid_put'>put</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/agents/groups/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_group_id'>group_id</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
|
@@ -2643,8 +2941,7 @@ connected agents, uses the register date.</p>
|
|
2643
2941
|
</span>
|
2644
2942
|
|
2645
2943
|
— <div class='inline'>
|
2646
|
-
<p>Delete an agent from the key store. This parameter is only valid if purge
|
2647
|
-
is set to no in the manager’s ossec.conf.</p>
|
2944
|
+
<p>Delete an agent from the key store. This parameter is only valid if purge is set to no in the manager’s ossec.conf.</p>
|
2648
2945
|
</div>
|
2649
2946
|
|
2650
2947
|
</li>
|
@@ -2666,12 +2963,12 @@ is set to no in the manager’s ossec.conf.</p>
|
|
2666
2963
|
<pre class="lines">
|
2667
2964
|
|
2668
2965
|
|
2669
|
-
|
2670
|
-
|
2671
|
-
|
2966
|
+
187
|
2967
|
+
188
|
2968
|
+
189</pre>
|
2672
2969
|
</td>
|
2673
2970
|
<td>
|
2674
|
-
<pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/agents.rb', line
|
2971
|
+
<pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/agents.rb', line 187</span>
|
2675
2972
|
|
2676
2973
|
<span class='kw'>def</span> <span class='id identifier rubyid_delete_agent'>delete_agent</span><span class='lparen'>(</span><span class='id identifier rubyid_agent_id'>agent_id</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
2677
2974
|
<span class='id identifier rubyid_delete'>delete</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/agents/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_agent_id'>agent_id</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span>
|
@@ -2729,12 +3026,12 @@ is set to no in the manager’s ossec.conf.</p>
|
|
2729
3026
|
<pre class="lines">
|
2730
3027
|
|
2731
3028
|
|
2732
|
-
|
2733
|
-
|
2734
|
-
|
3029
|
+
245
|
3030
|
+
246
|
3031
|
+
247</pre>
|
2735
3032
|
</td>
|
2736
3033
|
<td>
|
2737
|
-
<pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/agents.rb', line
|
3034
|
+
<pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/agents.rb', line 245</span>
|
2738
3035
|
|
2739
3036
|
<span class='kw'>def</span> <span class='id identifier rubyid_delete_agent_by_group'>delete_agent_by_group</span><span class='lparen'>(</span><span class='id identifier rubyid_ids'>ids</span><span class='rparen'>)</span>
|
2740
3037
|
<span class='id identifier rubyid_delete'>delete</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/agents/groups</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='lbrace'>{</span><span class='label'>ids:</span> <span class='id identifier rubyid_ids'>ids</span><span class='rbrace'>}</span>
|
@@ -2756,8 +3053,7 @@ is set to no in the manager’s ossec.conf.</p>
|
|
2756
3053
|
</h3><div class="docstring">
|
2757
3054
|
<div class="discussion">
|
2758
3055
|
|
2759
|
-
<p>Delete agents Removes agents, using a list of them or a criterion based on
|
2760
|
-
the status or time of the last connection.</p>
|
3056
|
+
<p>Delete agents Removes agents, using a list of them or a criterion based on the status or time of the last connection.</p>
|
2761
3057
|
|
2762
3058
|
|
2763
3059
|
</div>
|
@@ -2813,8 +3109,7 @@ the status or time of the last connection.</p>
|
|
2813
3109
|
</span>
|
2814
3110
|
|
2815
3111
|
— <div class='inline'>
|
2816
|
-
<p>Delete an agent from the key store. This parameter is only valid if purge
|
2817
|
-
is set to no in the manager’s ossec.conf.</p>
|
3112
|
+
<p>Delete an agent from the key store. This parameter is only valid if purge is set to no in the manager’s ossec.conf.</p>
|
2818
3113
|
</div>
|
2819
3114
|
|
2820
3115
|
</li>
|
@@ -2827,8 +3122,7 @@ is set to no in the manager’s ossec.conf.</p>
|
|
2827
3122
|
</span>
|
2828
3123
|
|
2829
3124
|
— <div class='inline'>
|
2830
|
-
<p>Filters by agent status. Use commas to enter multiple statuses. Allowed
|
2831
|
-
values: active, pending, neverconnected, disconnected</p>
|
3125
|
+
<p>Filters by agent status. Use commas to enter multiple statuses. Allowed values: active, pending, neverconnected, disconnected</p>
|
2832
3126
|
</div>
|
2833
3127
|
|
2834
3128
|
</li>
|
@@ -2841,9 +3135,7 @@ values: active, pending, neverconnected, disconnected</p>
|
|
2841
3135
|
</span>
|
2842
3136
|
|
2843
3137
|
— <div class='inline'>
|
2844
|
-
<p>Filters out disconnected agents for longer than specified. Time in seconds,
|
2845
|
-
‘[n_days]d’, ‘[n_hours]h’, ‘[n_minutes]m’ or ‘[n_seconds]s’. For never
|
2846
|
-
connected agents, uses the register date. Default value: 7d.</p>
|
3138
|
+
<p>Filters out disconnected agents for longer than specified. Time in seconds, ‘[n_days]d’, ‘[n_hours]h’, ‘[n_minutes]m’ or ‘[n_seconds]s’. For never connected agents, uses the register date. Default value: 7d.</p>
|
2847
3139
|
</div>
|
2848
3140
|
|
2849
3141
|
</li>
|
@@ -2858,12 +3150,12 @@ connected agents, uses the register date. Default value: 7d.</p>
|
|
2858
3150
|
<pre class="lines">
|
2859
3151
|
|
2860
3152
|
|
2861
|
-
|
2862
|
-
|
2863
|
-
|
3153
|
+
201
|
3154
|
+
202
|
3155
|
+
203</pre>
|
2864
3156
|
</td>
|
2865
3157
|
<td>
|
2866
|
-
<pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/agents.rb', line
|
3158
|
+
<pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/agents.rb', line 201</span>
|
2867
3159
|
|
2868
3160
|
<span class='kw'>def</span> <span class='id identifier rubyid_delete_agents'>delete_agents</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>
|
2869
3161
|
<span class='id identifier rubyid_delete'>delete</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/agents</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span>
|
@@ -2885,9 +3177,7 @@ connected agents, uses the register date. Default value: 7d.</p>
|
|
2885
3177
|
</h3><div class="docstring">
|
2886
3178
|
<div class="discussion">
|
2887
3179
|
|
2888
|
-
<p>Returns all the different combinations that agents have for the selected
|
2889
|
-
fields. It also indicates the total number of agents that have each
|
2890
|
-
combination.</p>
|
3180
|
+
<p>Returns all the different combinations that agents have for the selected fields. It also indicates the total number of agents that have each combination.</p>
|
2891
3181
|
|
2892
3182
|
|
2893
3183
|
</div>
|
@@ -2956,8 +3246,7 @@ combination.</p>
|
|
2956
3246
|
</span>
|
2957
3247
|
|
2958
3248
|
— <div class='inline'>
|
2959
|
-
<p>Sorts the collection by a field or fields (separated by comma). Use +/- at
|
2960
|
-
the beginning to list in ascending or descending order.</p>
|
3249
|
+
<p>Sorts the collection by a field or fields (separated by comma). Use +/- at the beginning to list in ascending or descending order.</p>
|
2961
3250
|
</div>
|
2962
3251
|
|
2963
3252
|
</li>
|
@@ -3031,12 +3320,12 @@ the beginning to list in ascending or descending order.</p>
|
|
3031
3320
|
<pre class="lines">
|
3032
3321
|
|
3033
3322
|
|
3323
|
+
105
|
3034
3324
|
106
|
3035
|
-
107
|
3036
|
-
108</pre>
|
3325
|
+
107</pre>
|
3037
3326
|
</td>
|
3038
3327
|
<td>
|
3039
|
-
<pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/agents.rb', line
|
3328
|
+
<pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/agents.rb', line 105</span>
|
3040
3329
|
|
3041
3330
|
<span class='kw'>def</span> <span class='id identifier rubyid_distinct_fields_in_agents'>distinct_fields_in_agents</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>
|
3042
3331
|
<span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/agents/stats/distinct</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span>
|
@@ -3058,8 +3347,7 @@ the beginning to list in ascending or descending order.</p>
|
|
3058
3347
|
</h3><div class="docstring">
|
3059
3348
|
<div class="discussion">
|
3060
3349
|
|
3061
|
-
<p>Get a file in group Returns the specified file belonging to the group
|
3062
|
-
parsed to JSON.</p>
|
3350
|
+
<p>Get a file in group Returns the specified file belonging to the group parsed to JSON.</p>
|
3063
3351
|
|
3064
3352
|
|
3065
3353
|
</div>
|
@@ -3165,12 +3453,12 @@ parsed to JSON.</p>
|
|
3165
3453
|
<pre class="lines">
|
3166
3454
|
|
3167
3455
|
|
3168
|
-
|
3169
|
-
|
3170
|
-
|
3456
|
+
304
|
3457
|
+
305
|
3458
|
+
306</pre>
|
3171
3459
|
</td>
|
3172
3460
|
<td>
|
3173
|
-
<pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/agents.rb', line
|
3461
|
+
<pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/agents.rb', line 304</span>
|
3174
3462
|
|
3175
3463
|
<span class='kw'>def</span> <span class='id identifier rubyid_get_file_in_group'>get_file_in_group</span><span class='lparen'>(</span><span class='id identifier rubyid_group_id'>group_id</span><span class='comma'>,</span> <span class='id identifier rubyid_filename'>filename</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>
|
3176
3464
|
<span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>agents/groups/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_group_id'>group_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/files/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_filename'>filename</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span>
|
@@ -3275,12 +3563,12 @@ parsed to JSON.</p>
|
|
3275
3563
|
<pre class="lines">
|
3276
3564
|
|
3277
3565
|
|
3278
|
-
|
3279
|
-
|
3280
|
-
|
3566
|
+
346
|
3567
|
+
347
|
3568
|
+
348</pre>
|
3281
3569
|
</td>
|
3282
3570
|
<td>
|
3283
|
-
<pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/agents.rb', line
|
3571
|
+
<pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/agents.rb', line 346</span>
|
3284
3572
|
|
3285
3573
|
<span class='kw'>def</span> <span class='id identifier rubyid_group_configuration'>group_configuration</span><span class='lparen'>(</span><span class='id identifier rubyid_group_id'>group_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>
|
3286
3574
|
<span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/agents/groups/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_group_id'>group_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/configuration</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span>
|
@@ -3412,12 +3700,12 @@ parsed to JSON.</p>
|
|
3412
3700
|
<pre class="lines">
|
3413
3701
|
|
3414
3702
|
|
3415
|
-
|
3416
|
-
|
3417
|
-
|
3703
|
+
360
|
3704
|
+
361
|
3705
|
+
362</pre>
|
3418
3706
|
</td>
|
3419
3707
|
<td>
|
3420
|
-
<pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/agents.rb', line
|
3708
|
+
<pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/agents.rb', line 360</span>
|
3421
3709
|
|
3422
3710
|
<span class='kw'>def</span> <span class='id identifier rubyid_group_files'>group_files</span><span class='lparen'>(</span><span class='id identifier rubyid_group_id'>group_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>
|
3423
3711
|
<span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/agents/groups/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_group_id'>group_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/files</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span>
|
@@ -3538,12 +3826,12 @@ parsed to JSON.</p>
|
|
3538
3826
|
<pre class="lines">
|
3539
3827
|
|
3540
3828
|
|
3541
|
-
|
3542
|
-
|
3543
|
-
|
3829
|
+
373
|
3830
|
+
374
|
3831
|
+
375</pre>
|
3544
3832
|
</td>
|
3545
3833
|
<td>
|
3546
|
-
<pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/agents.rb', line
|
3834
|
+
<pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/agents.rb', line 373</span>
|
3547
3835
|
|
3548
3836
|
<span class='kw'>def</span> <span class='id identifier rubyid_groups'>groups</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>
|
3549
3837
|
<span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/agents/groups</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span>
|
@@ -3621,9 +3909,7 @@ parsed to JSON.</p>
|
|
3621
3909
|
</span>
|
3622
3910
|
|
3623
3911
|
— <div class='inline'>
|
3624
|
-
<p>If this is not included, the API will get the IP automatically. If you are
|
3625
|
-
behind a proxy, you must set the option config.BehindProxyServer to yes at
|
3626
|
-
config.js. Allowed values: IP, IP/NET, ANY</p>
|
3912
|
+
<p>If this is not included, the API will get the IP automatically. If you are behind a proxy, you must set the option config.BehindProxyServer to yes at config.js. Allowed values: IP, IP/NET, ANY</p>
|
3627
3913
|
</div>
|
3628
3914
|
|
3629
3915
|
</li>
|
@@ -3662,8 +3948,7 @@ config.js. Allowed values: IP, IP/NET, ANY</p>
|
|
3662
3948
|
</span>
|
3663
3949
|
|
3664
3950
|
— <div class='inline'>
|
3665
|
-
<p>Remove the old agent the with same IP if disconnected since <force>
|
3666
|
-
seconds.</p>
|
3951
|
+
<p>Remove the old agent the with same IP if disconnected since <force> seconds.</p>
|
3667
3952
|
</div>
|
3668
3953
|
|
3669
3954
|
</li>
|
@@ -3678,12 +3963,12 @@ seconds.</p>
|
|
3678
3963
|
<pre class="lines">
|
3679
3964
|
|
3680
3965
|
|
3681
|
-
|
3682
|
-
|
3683
|
-
|
3966
|
+
227
|
3967
|
+
228
|
3968
|
+
229</pre>
|
3684
3969
|
</td>
|
3685
3970
|
<td>
|
3686
|
-
<pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/agents.rb', line
|
3971
|
+
<pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/agents.rb', line 227</span>
|
3687
3972
|
|
3688
3973
|
<span class='kw'>def</span> <span class='id identifier rubyid_insert_agent'>insert_agent</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>
|
3689
3974
|
<span class='id identifier rubyid_post'>post</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/agents/insert</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span>
|
@@ -3774,8 +4059,7 @@ seconds.</p>
|
|
3774
4059
|
</span>
|
3775
4060
|
|
3776
4061
|
— <div class='inline'>
|
3777
|
-
<p>Sorts the collection by a field or fields (separated by comma). Use +/- at
|
3778
|
-
the beginning to list in ascending or descending order.</p>
|
4062
|
+
<p>Sorts the collection by a field or fields (separated by comma). Use +/- at the beginning to list in ascending or descending order.</p>
|
3779
4063
|
</div>
|
3780
4064
|
|
3781
4065
|
</li>
|
@@ -3810,12 +4094,12 @@ the beginning to list in ascending or descending order.</p>
|
|
3810
4094
|
<pre class="lines">
|
3811
4095
|
|
3812
4096
|
|
4097
|
+
120
|
3813
4098
|
121
|
3814
|
-
122
|
3815
|
-
123</pre>
|
4099
|
+
122</pre>
|
3816
4100
|
</td>
|
3817
4101
|
<td>
|
3818
|
-
<pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/agents.rb', line
|
4102
|
+
<pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/agents.rb', line 120</span>
|
3819
4103
|
|
3820
4104
|
<span class='kw'>def</span> <span class='id identifier rubyid_outdated_agents'>outdated_agents</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>
|
3821
4105
|
<span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/agents/outdated</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span>
|
@@ -3837,8 +4121,7 @@ the beginning to list in ascending or descending order.</p>
|
|
3837
4121
|
</h3><div class="docstring">
|
3838
4122
|
<div class="discussion">
|
3839
4123
|
|
3840
|
-
<p>Remove a single group of an agent Remove the group of the agent but will
|
3841
|
-
leave the rest of its group if it belongs to a multigroup.</p>
|
4124
|
+
<p>Remove a single group of an agent Remove the group of the agent but will leave the rest of its group if it belongs to a multigroup.</p>
|
3842
4125
|
|
3843
4126
|
|
3844
4127
|
</div>
|
@@ -3885,12 +4168,12 @@ leave the rest of its group if it belongs to a multigroup.</p>
|
|
3885
4168
|
<pre class="lines">
|
3886
4169
|
|
3887
4170
|
|
3888
|
-
|
3889
|
-
|
3890
|
-
|
4171
|
+
395
|
4172
|
+
396
|
4173
|
+
397</pre>
|
3891
4174
|
</td>
|
3892
4175
|
<td>
|
3893
|
-
<pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/agents.rb', line
|
4176
|
+
<pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/agents.rb', line 395</span>
|
3894
4177
|
|
3895
4178
|
<span class='kw'>def</span> <span class='id identifier rubyid_remove_agent_of_group'>remove_agent_of_group</span><span class='lparen'>(</span><span class='id identifier rubyid_agent_id'>agent_id</span><span class='comma'>,</span> <span class='id identifier rubyid_group_id'>group_id</span><span class='rparen'>)</span>
|
3896
4179
|
<span class='id identifier rubyid_delete'>delete</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/agents/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_agent_id'>agent_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/group/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_group_id'>group_id</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
|
@@ -3912,8 +4195,7 @@ leave the rest of its group if it belongs to a multigroup.</p>
|
|
3912
4195
|
</h3><div class="docstring">
|
3913
4196
|
<div class="discussion">
|
3914
4197
|
|
3915
|
-
<p>Remove a single group of multiple agents Remove a list of agents of a
|
3916
|
-
group.</p>
|
4198
|
+
<p>Remove a single group of multiple agents Remove a list of agents of a group.</p>
|
3917
4199
|
|
3918
4200
|
|
3919
4201
|
</div>
|
@@ -3960,12 +4242,12 @@ group.</p>
|
|
3960
4242
|
<pre class="lines">
|
3961
4243
|
|
3962
4244
|
|
3963
|
-
|
3964
|
-
|
3965
|
-
|
4245
|
+
405
|
4246
|
+
406
|
4247
|
+
407</pre>
|
3966
4248
|
</td>
|
3967
4249
|
<td>
|
3968
|
-
<pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/agents.rb', line
|
4250
|
+
<pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/agents.rb', line 405</span>
|
3969
4251
|
|
3970
4252
|
<span class='kw'>def</span> <span class='id identifier rubyid_remove_agents_of_group'>remove_agents_of_group</span><span class='lparen'>(</span><span class='id identifier rubyid_ids'>ids</span><span class='comma'>,</span> <span class='id identifier rubyid_groups'>groups</span><span class='rparen'>)</span>
|
3971
4253
|
<span class='id identifier rubyid_delete'>delete</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/agents/group/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_group_id'>group_id</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='lbrace'>{</span><span class='label'>ids:</span> <span class='id identifier rubyid_ids'>ids</span><span class='rbrace'>}</span>
|
@@ -3987,8 +4269,7 @@ group.</p>
|
|
3987
4269
|
</h3><div class="docstring">
|
3988
4270
|
<div class="discussion">
|
3989
4271
|
|
3990
|
-
<p>Remove all agent groups. Removes the group of the agent. The agent will
|
3991
|
-
automatically revert to the ‘default’ group.</p>
|
4272
|
+
<p>Remove all agent groups. Removes the group of the agent. The agent will automatically revert to the ‘default’ group.</p>
|
3992
4273
|
|
3993
4274
|
|
3994
4275
|
</div>
|
@@ -4024,12 +4305,12 @@ automatically revert to the ‘default’ group.</p>
|
|
4024
4305
|
<pre class="lines">
|
4025
4306
|
|
4026
4307
|
|
4027
|
-
|
4028
|
-
|
4029
|
-
|
4308
|
+
414
|
4309
|
+
415
|
4310
|
+
416</pre>
|
4030
4311
|
</td>
|
4031
4312
|
<td>
|
4032
|
-
<pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/agents.rb', line
|
4313
|
+
<pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/agents.rb', line 414</span>
|
4033
4314
|
|
4034
4315
|
<span class='kw'>def</span> <span class='id identifier rubyid_remove_all_agent_of_group'>remove_all_agent_of_group</span><span class='lparen'>(</span><span class='id identifier rubyid_agent_id'>agent_id</span><span class='rparen'>)</span>
|
4035
4316
|
<span class='id identifier rubyid_delete'>delete</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/agents/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_agent_id'>agent_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/group</span><span class='tstring_end'>"</span></span>
|
@@ -4051,8 +4332,7 @@ automatically revert to the ‘default’ group.</p>
|
|
4051
4332
|
</h3><div class="docstring">
|
4052
4333
|
<div class="discussion">
|
4053
4334
|
|
4054
|
-
<p>Remove group Removes the group. Agents that were assigned to the removed
|
4055
|
-
group will automatically revert to the ‘default’ group.</p>
|
4335
|
+
<p>Remove group Removes the group. Agents that were assigned to the removed group will automatically revert to the ‘default’ group.</p>
|
4056
4336
|
|
4057
4337
|
|
4058
4338
|
</div>
|
@@ -4088,12 +4368,12 @@ group will automatically revert to the ‘default’ group.</p>
|
|
4088
4368
|
<pre class="lines">
|
4089
4369
|
|
4090
4370
|
|
4091
|
-
|
4092
|
-
|
4093
|
-
|
4371
|
+
423
|
4372
|
+
424
|
4373
|
+
425</pre>
|
4094
4374
|
</td>
|
4095
4375
|
<td>
|
4096
|
-
<pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/agents.rb', line
|
4376
|
+
<pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/agents.rb', line 423</span>
|
4097
4377
|
|
4098
4378
|
<span class='kw'>def</span> <span class='id identifier rubyid_remove_group'>remove_group</span><span class='lparen'>(</span><span class='id identifier rubyid_group_id'>group_id</span><span class='rparen'>)</span>
|
4099
4379
|
<span class='id identifier rubyid_delete'>delete</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/agents/groups/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_group_id'>group_id</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
|
@@ -4180,12 +4460,12 @@ group will automatically revert to the ‘default’ group.</p>
|
|
4180
4460
|
<pre class="lines">
|
4181
4461
|
|
4182
4462
|
|
4463
|
+
69
|
4183
4464
|
70
|
4184
|
-
71
|
4185
|
-
72</pre>
|
4465
|
+
71</pre>
|
4186
4466
|
</td>
|
4187
4467
|
<td>
|
4188
|
-
<pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/agents.rb', line
|
4468
|
+
<pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/agents.rb', line 69</span>
|
4189
4469
|
|
4190
4470
|
<span class='kw'>def</span> <span class='id identifier rubyid_restart_agents'>restart_agents</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>
|
4191
4471
|
<span class='id identifier rubyid_post'>post</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/agents/restart</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span>
|
@@ -4221,12 +4501,12 @@ group will automatically revert to the ‘default’ group.</p>
|
|
4221
4501
|
<pre class="lines">
|
4222
4502
|
|
4223
4503
|
|
4504
|
+
75
|
4224
4505
|
76
|
4225
|
-
77
|
4226
|
-
78</pre>
|
4506
|
+
77</pre>
|
4227
4507
|
</td>
|
4228
4508
|
<td>
|
4229
|
-
<pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/agents.rb', line
|
4509
|
+
<pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/agents.rb', line 75</span>
|
4230
4510
|
|
4231
4511
|
<span class='kw'>def</span> <span class='id identifier rubyid_restart_all_agents'>restart_all_agents</span><span class='lparen'>(</span><span class='rparen'>)</span>
|
4232
4512
|
<span class='id identifier rubyid_put'>put</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/agents/restart</span><span class='tstring_end'>'</span></span>
|
@@ -4289,12 +4569,12 @@ group will automatically revert to the ‘default’ group.</p>
|
|
4289
4569
|
<pre class="lines">
|
4290
4570
|
|
4291
4571
|
|
4572
|
+
84
|
4292
4573
|
85
|
4293
|
-
86
|
4294
|
-
87</pre>
|
4574
|
+
86</pre>
|
4295
4575
|
</td>
|
4296
4576
|
<td>
|
4297
|
-
<pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/agents.rb', line
|
4577
|
+
<pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/agents.rb', line 84</span>
|
4298
4578
|
|
4299
4579
|
<span class='kw'>def</span> <span class='id identifier rubyid_restart_an_agents'>restart_an_agents</span><span class='lparen'>(</span><span class='id identifier rubyid_agent_id'>agent_id</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
4300
4580
|
<span class='id identifier rubyid_put'>put</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/agents/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_agent_id'>agent_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/restart</span><span class='tstring_end'>"</span></span>
|
@@ -4316,8 +4596,7 @@ group will automatically revert to the ‘default’ group.</p>
|
|
4316
4596
|
</h3><div class="docstring">
|
4317
4597
|
<div class="discussion">
|
4318
4598
|
|
4319
|
-
<p>Put configuration file (agent.conf) into a group Upload the group
|
4320
|
-
configuration (agent.conf).</p>
|
4599
|
+
<p>Put configuration file (agent.conf) into a group Upload the group configuration (agent.conf).</p>
|
4321
4600
|
|
4322
4601
|
|
4323
4602
|
</div>
|
@@ -4364,14 +4643,14 @@ configuration (agent.conf).</p>
|
|
4364
4643
|
<pre class="lines">
|
4365
4644
|
|
4366
4645
|
|
4367
|
-
|
4368
|
-
|
4369
|
-
|
4370
|
-
|
4371
|
-
|
4646
|
+
383
|
4647
|
+
384
|
4648
|
+
385
|
4649
|
+
386
|
4650
|
+
387</pre>
|
4372
4651
|
</td>
|
4373
4652
|
<td>
|
4374
|
-
<pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/agents.rb', line
|
4653
|
+
<pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/agents.rb', line 383</span>
|
4375
4654
|
|
4376
4655
|
<span class='kw'>def</span> <span class='id identifier rubyid_update_group_ossec_configuration'>update_group_ossec_configuration</span><span class='lparen'>(</span><span class='id identifier rubyid_group_id'>group_id</span><span class='comma'>,</span> <span class='id identifier rubyid_config'>config</span><span class='rparen'>)</span>
|
4377
4656
|
<span class='comment'># post "/agents/groups/#{group_id}/configuration"
|
@@ -4471,12 +4750,12 @@ configuration (agent.conf).</p>
|
|
4471
4750
|
<pre class="lines">
|
4472
4751
|
|
4473
4752
|
|
4753
|
+
130
|
4474
4754
|
131
|
4475
|
-
132
|
4476
|
-
133</pre>
|
4755
|
+
132</pre>
|
4477
4756
|
</td>
|
4478
4757
|
<td>
|
4479
|
-
<pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/agents.rb', line
|
4758
|
+
<pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/agents.rb', line 130</span>
|
4480
4759
|
|
4481
4760
|
<span class='kw'>def</span> <span class='id identifier rubyid_upgrade_result_from_agent'>upgrade_result_from_agent</span><span class='lparen'>(</span><span class='id identifier rubyid_agent_id'>agent_id</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
4482
4761
|
<span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/agents/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_agent_id'>agent_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/upgrade_result</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span>
|
@@ -4491,9 +4770,9 @@ configuration (agent.conf).</p>
|
|
4491
4770
|
</div>
|
4492
4771
|
|
4493
4772
|
<div id="footer">
|
4494
|
-
Generated on
|
4773
|
+
Generated on Thu Feb 3 21:40:18 2022 by
|
4495
4774
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
4496
|
-
0.9.
|
4775
|
+
0.9.25 (ruby-2.6.3).
|
4497
4776
|
</div>
|
4498
4777
|
|
4499
4778
|
</div>
|