File: splunk.es.splunk_adaptive_response_notable_events_module.rst

package info (click to toggle)
ansible 12.0.0%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky
  • size: 420,012 kB
  • sloc: python: 4,118,863; javascript: 16,878; xml: 5,260; sh: 4,634; cs: 3,510; makefile: 597; sql: 85; ansic: 14
file content (846 lines) | stat: -rw-r--r-- 33,711 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
.. _splunk.es.splunk_adaptive_response_notable_events_module:


*************************************************
splunk.es.splunk_adaptive_response_notable_events
*************************************************

**Manage Adaptive Responses notable events resource module**


Version added: 2.1.0

.. contents::
   :local:
   :depth: 1


Synopsis
--------
- This module allows for creation, deletion, and modification of Splunk Enterprise Security Notable Event Adaptive Responses that are associated with a correlation search
- Tested against Splunk Enterprise Server 8.2.3




Parameters
----------

.. raw:: html

    <table  border=0 cellpadding=0 class="documentation-table">
        <tr>
            <th colspan="3">Parameter</th>
            <th>Choices/<font color="blue">Defaults</font></th>
            <th width="100%">Comments</th>
        </tr>
            <tr>
                <td colspan="3">
                    <div class="ansibleOptionAnchor" id="parameter-"></div>
                    <b>config</b>
                    <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
                    <div style="font-size: small">
                        <span style="color: purple">list</span>
                         / <span style="color: purple">elements=dictionary</span>
                    </div>
                </td>
                <td>
                </td>
                <td>
                        <div>Configure file and directory monitoring on the system</div>
                </td>
            </tr>
                                <tr>
                    <td class="elbow-placeholder"></td>
                <td colspan="2">
                    <div class="ansibleOptionAnchor" id="parameter-"></div>
                    <b>correlation_search_name</b>
                    <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
                    <div style="font-size: small">
                        <span style="color: purple">string</span>
                         / <span style="color: red">required</span>
                    </div>
                </td>
                <td>
                </td>
                <td>
                        <div>Name of correlation search to associate this notable event adaptive response with</div>
                </td>
            </tr>
            <tr>
                    <td class="elbow-placeholder"></td>
                <td colspan="2">
                    <div class="ansibleOptionAnchor" id="parameter-"></div>
                    <b>default_owner</b>
                    <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
                    <div style="font-size: small">
                        <span style="color: purple">string</span>
                    </div>
                </td>
                <td>
                </td>
                <td>
                        <div>Default owner of the notable event, if unset it will default to Splunk System Defaults</div>
                </td>
            </tr>
            <tr>
                    <td class="elbow-placeholder"></td>
                <td colspan="2">
                    <div class="ansibleOptionAnchor" id="parameter-"></div>
                    <b>default_status</b>
                    <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
                    <div style="font-size: small">
                        <span style="color: purple">string</span>
                    </div>
                </td>
                <td>
                        <ul style="margin: 0; padding: 0"><b>Choices:</b>
                                    <li>unassigned</li>
                                    <li>new</li>
                                    <li>in progress</li>
                                    <li>pending</li>
                                    <li>resolved</li>
                                    <li>closed</li>
                        </ul>
                </td>
                <td>
                        <div>Default status of the notable event, if unset it will default to Splunk System Defaults</div>
                </td>
            </tr>
            <tr>
                    <td class="elbow-placeholder"></td>
                <td colspan="2">
                    <div class="ansibleOptionAnchor" id="parameter-"></div>
                    <b>description</b>
                    <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
                    <div style="font-size: small">
                        <span style="color: purple">string</span>
                    </div>
                </td>
                <td>
                </td>
                <td>
                        <div>Description of the notable event, this will populate the description field for the web console</div>
                </td>
            </tr>
            <tr>
                    <td class="elbow-placeholder"></td>
                <td colspan="2">
                    <div class="ansibleOptionAnchor" id="parameter-"></div>
                    <b>drilldown_earliest_offset</b>
                    <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
                    <div style="font-size: small">
                        <span style="color: purple">string</span>
                    </div>
                </td>
                <td>
                        <b>Default:</b><br/><div style="color: blue">"$info_min_time$"</div>
                </td>
                <td>
                        <div>Set the amount of time before the triggering event to search for related events. For example, 2h. Use &#x27;$info_min_time$&#x27; to set the drill-down time to match the earliest time of the search</div>
                </td>
            </tr>
            <tr>
                    <td class="elbow-placeholder"></td>
                <td colspan="2">
                    <div class="ansibleOptionAnchor" id="parameter-"></div>
                    <b>drilldown_latest_offset</b>
                    <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
                    <div style="font-size: small">
                        <span style="color: purple">string</span>
                    </div>
                </td>
                <td>
                        <b>Default:</b><br/><div style="color: blue">"$info_max_time$"</div>
                </td>
                <td>
                        <div>Set the amount of time after the triggering event to search for related events. For example, 1m. Use &#x27;$info_max_time$&#x27; to set the drill-down time to match the latest time of the search</div>
                </td>
            </tr>
            <tr>
                    <td class="elbow-placeholder"></td>
                <td colspan="2">
                    <div class="ansibleOptionAnchor" id="parameter-"></div>
                    <b>drilldown_name</b>
                    <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
                    <div style="font-size: small">
                        <span style="color: purple">string</span>
                    </div>
                </td>
                <td>
                </td>
                <td>
                        <div>Name for drill down search, Supports variable substitution with fields from the matching event.</div>
                </td>
            </tr>
            <tr>
                    <td class="elbow-placeholder"></td>
                <td colspan="2">
                    <div class="ansibleOptionAnchor" id="parameter-"></div>
                    <b>drilldown_search</b>
                    <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
                    <div style="font-size: small">
                        <span style="color: purple">string</span>
                    </div>
                </td>
                <td>
                </td>
                <td>
                        <div>Drill down search, Supports variable substitution with fields from the matching event.</div>
                </td>
            </tr>
            <tr>
                    <td class="elbow-placeholder"></td>
                <td colspan="2">
                    <div class="ansibleOptionAnchor" id="parameter-"></div>
                    <b>extract_artifacts</b>
                    <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
                    <div style="font-size: small">
                        <span style="color: purple">dictionary</span>
                    </div>
                </td>
                <td>
                </td>
                <td>
                        <div>Assets and identities to be extracted</div>
                </td>
            </tr>
                                <tr>
                    <td class="elbow-placeholder"></td>
                    <td class="elbow-placeholder"></td>
                <td colspan="1">
                    <div class="ansibleOptionAnchor" id="parameter-"></div>
                    <b>asset</b>
                    <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
                    <div style="font-size: small">
                        <span style="color: purple">list</span>
                         / <span style="color: purple">elements=string</span>
                    </div>
                </td>
                <td>
                        <ul style="margin: 0; padding: 0"><b>Choices:</b>
                                    <li>src</li>
                                    <li>dest</li>
                                    <li>dvc</li>
                                    <li>orig_host</li>
                        </ul>
                </td>
                <td>
                        <div>list of assets to extract, select any one or many of the available choices</div>
                        <div>defaults to all available choices</div>
                </td>
            </tr>
            <tr>
                    <td class="elbow-placeholder"></td>
                    <td class="elbow-placeholder"></td>
                <td colspan="1">
                    <div class="ansibleOptionAnchor" id="parameter-"></div>
                    <b>file</b>
                    <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
                    <div style="font-size: small">
                        <span style="color: purple">list</span>
                         / <span style="color: purple">elements=string</span>
                    </div>
                </td>
                <td>
                </td>
                <td>
                        <div>list of files to extract</div>
                </td>
            </tr>
            <tr>
                    <td class="elbow-placeholder"></td>
                    <td class="elbow-placeholder"></td>
                <td colspan="1">
                    <div class="ansibleOptionAnchor" id="parameter-"></div>
                    <b>identity</b>
                    <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
                    <div style="font-size: small">
                        <span style="color: purple">list</span>
                         / <span style="color: purple">elements=string</span>
                    </div>
                </td>
                <td>
                        <ul style="margin: 0; padding: 0"><b>Choices:</b>
                                    <li>user</li>
                                    <li>src_user</li>
                                    <li>src_user_id</li>
                                    <li>user_id</li>
                                    <li>src_user_role</li>
                                    <li>user_role</li>
                                    <li>vendor_account</li>
                        </ul>
                </td>
                <td>
                        <div>list of identity fields to extract, select any one or many of the available choices</div>
                        <div>defaults to &#x27;user&#x27; and &#x27;src_user&#x27;</div>
                </td>
            </tr>
            <tr>
                    <td class="elbow-placeholder"></td>
                    <td class="elbow-placeholder"></td>
                <td colspan="1">
                    <div class="ansibleOptionAnchor" id="parameter-"></div>
                    <b>url</b>
                    <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
                    <div style="font-size: small">
                        <span style="color: purple">list</span>
                         / <span style="color: purple">elements=string</span>
                    </div>
                </td>
                <td>
                </td>
                <td>
                        <div>list of URLs to extract</div>
                </td>
            </tr>

            <tr>
                    <td class="elbow-placeholder"></td>
                <td colspan="2">
                    <div class="ansibleOptionAnchor" id="parameter-"></div>
                    <b>investigation_profiles</b>
                    <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
                    <div style="font-size: small">
                        <span style="color: purple">list</span>
                         / <span style="color: purple">elements=string</span>
                    </div>
                </td>
                <td>
                </td>
                <td>
                        <div>Investigation profile to associate the notable event with.</div>
                </td>
            </tr>
            <tr>
                    <td class="elbow-placeholder"></td>
                <td colspan="2">
                    <div class="ansibleOptionAnchor" id="parameter-"></div>
                    <b>name</b>
                    <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
                    <div style="font-size: small">
                        <span style="color: purple">string</span>
                    </div>
                </td>
                <td>
                </td>
                <td>
                        <div>Name of notable event</div>
                </td>
            </tr>
            <tr>
                    <td class="elbow-placeholder"></td>
                <td colspan="2">
                    <div class="ansibleOptionAnchor" id="parameter-"></div>
                    <b>next_steps</b>
                    <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
                    <div style="font-size: small">
                        <span style="color: purple">list</span>
                         / <span style="color: purple">elements=string</span>
                    </div>
                </td>
                <td>
                </td>
                <td>
                        <div>List of adaptive responses that should be run next</div>
                        <div>Describe next steps and response actions that an analyst could take to address this threat.</div>
                </td>
            </tr>
            <tr>
                    <td class="elbow-placeholder"></td>
                <td colspan="2">
                    <div class="ansibleOptionAnchor" id="parameter-"></div>
                    <b>recommended_actions</b>
                    <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
                    <div style="font-size: small">
                        <span style="color: purple">list</span>
                         / <span style="color: purple">elements=string</span>
                    </div>
                </td>
                <td>
                </td>
                <td>
                        <div>List of adaptive responses that are recommended to be run next</div>
                        <div>Identifying Recommended Adaptive Responses will highlight those actions for the analyst when looking at the list of response actions available, making it easier to find them among the longer list of available actions.</div>
                </td>
            </tr>
            <tr>
                    <td class="elbow-placeholder"></td>
                <td colspan="2">
                    <div class="ansibleOptionAnchor" id="parameter-"></div>
                    <b>security_domain</b>
                    <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
                    <div style="font-size: small">
                        <span style="color: purple">string</span>
                    </div>
                </td>
                <td>
                        <ul style="margin: 0; padding: 0"><b>Choices:</b>
                                    <li>access</li>
                                    <li>endpoint</li>
                                    <li>network</li>
                                    <li><div style="color: blue"><b>threat</b>&nbsp;&larr;</div></li>
                                    <li>identity</li>
                                    <li>audit</li>
                        </ul>
                </td>
                <td>
                        <div>Splunk Security Domain</div>
                </td>
            </tr>
            <tr>
                    <td class="elbow-placeholder"></td>
                <td colspan="2">
                    <div class="ansibleOptionAnchor" id="parameter-"></div>
                    <b>severity</b>
                    <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
                    <div style="font-size: small">
                        <span style="color: purple">string</span>
                    </div>
                </td>
                <td>
                        <ul style="margin: 0; padding: 0"><b>Choices:</b>
                                    <li>informational</li>
                                    <li>low</li>
                                    <li>medium</li>
                                    <li><div style="color: blue"><b>high</b>&nbsp;&larr;</div></li>
                                    <li>critical</li>
                                    <li>unknown</li>
                        </ul>
                </td>
                <td>
                        <div>Severity rating</div>
                </td>
            </tr>

            <tr>
                <td colspan="3">
                    <div class="ansibleOptionAnchor" id="parameter-"></div>
                    <b>running_config</b>
                    <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
                    <div style="font-size: small">
                        <span style="color: purple">string</span>
                    </div>
                </td>
                <td>
                </td>
                <td>
                        <div>The module, by default, will connect to the remote device and retrieve the current running-config to use as a base for comparing against the contents of source. There are times when it is not desirable to have the task get the current running-config for every task in a playbook.  The <em>running_config</em> argument allows the implementer to pass in the configuration to use as the base config for comparison. This value of this option should be the output received from device by executing command.</div>
                </td>
            </tr>
            <tr>
                <td colspan="3">
                    <div class="ansibleOptionAnchor" id="parameter-"></div>
                    <b>state</b>
                    <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
                    <div style="font-size: small">
                        <span style="color: purple">string</span>
                    </div>
                </td>
                <td>
                        <ul style="margin: 0; padding: 0"><b>Choices:</b>
                                    <li><div style="color: blue"><b>merged</b>&nbsp;&larr;</div></li>
                                    <li>replaced</li>
                                    <li>deleted</li>
                                    <li>gathered</li>
                        </ul>
                </td>
                <td>
                        <div>The state the configuration should be left in</div>
                </td>
            </tr>
    </table>
    <br/>




Examples
--------

.. code-block:: yaml

    # Using gathered
    # --------------

    - name: Gather adaptive response notable events config
      splunk.es.splunk_adaptive_response_notable_events:
        config:
          - correlation_search_name: Ansible Test
          - correlation_search_name: Ansible Test 2
        state: gathered

    # RUN output:
    # -----------

    # "gathered": [
    #     {
    #         "correlation_search_name": "Ansible Test",
    #         "description": "test notable event",
    #         "drilldown_earliest_offset": "$info_min_time$",
    #         "drilldown_latest_offset": "$info_max_time$",
    #         "drilldown_name": "test_drill_name",
    #         "drilldown_search": "test_drill",
    #         "extract_artifacts": {
    #             "asset": [
    #                 "src",
    #                 "dest",
    #                 "dvc",
    #                 "orig_host"
    #             ],
    #             "identity": [
    #                 "src_user",
    #                 "user",
    #                 "src_user_id",
    #                 "src_user_role",
    #                 "user_id",
    #                 "user_role",
    #                 "vendor_account"
    #             ]
    #         },
    #         "investigation_profiles": [
    #             "test profile 1",
    #             "test profile 2",
    #             "test profile 3"
    #         ],
    #         "next_steps": [
    #             "makestreams",
    #             "nbtstat",
    #             "nslookup"
    #         ],
    #         "name": "ansible_test_notable",
    #         "recommended_actions": [
    #             "email",
    #             "logevent",
    #             "makestreams",
    #             "nbtstat"
    #         ],
    #         "security_domain": "threat",
    #         "severity": "high"
    #     },
    #     { } # there is no configuration associated with "/var"
    # ]

    # Using merged
    # ------------

    - name: Example to add config
      splunk.es.splunk_adaptive_response_notable_events:
        config:
          - correlation_search_name: Ansible Test
            description: test notable event
            drilldown_earliest_offset: $info_min_time$
            drilldown_latest_offset: $info_max_time$
            extract_artifacts:
              asset:
                - src
                - dest
              identity:
                - src_user
                - user
                - src_user_id
            next_steps:
              - makestreams
            name: ansible_test_notable
            recommended_actions:
              - email
              - logevent
            security_domain: threat
            severity: high
        state: merged

    # RUN output:
    # -----------

    # "after": [
    #     {
    #         "correlation_search_name": "Ansible Test",
    #         "description": "test notable event",
    #         "drilldown_earliest_offset": "$info_min_time$",
    #         "drilldown_latest_offset": "$info_max_time$",
    #         "drilldown_name": "test_drill_name",
    #         "drilldown_search": "test_drill",
    #         "extract_artifacts": {
    #             "asset": [
    #                 "src",
    #                 "dest",
    #                 "dvc",
    #                 "orig_host"
    #             ],
    #             "identity": [
    #                 "src_user",
    #                 "user",
    #                 "src_user_id",
    #                 "src_user_role",
    #                 "user_id",
    #                 "user_role",
    #                 "vendor_account"
    #             ]
    #         },
    #         "investigation_profiles": [
    #             "test profile 1",
    #             "test profile 2",
    #             "test profile 3"
    #         ],
    #         "next_steps": [
    #             "makestreams",
    #             "nbtstat",
    #             "nslookup"
    #         ],
    #         "name": "ansible_test_notable",
    #         "recommended_actions": [
    #             "email",
    #             "logevent",
    #             "makestreams",
    #             "nbtstat"
    #         ],
    #         "security_domain": "threat",
    #         "severity": "high"
    #     }
    # ],
    # "before": [],

    # Using replaced
    # --------------

    - name: Example to Replace the config
      splunk.es.splunk_adaptive_response_notable_events:
        config:
          - correlation_search_name: Ansible Test
            description: test notable event
            drilldown_earliest_offset: $info_min_time$
            drilldown_latest_offset: $info_max_time$
            extract_artifacts:
              asset:
                - src
                - dest
              identity:
                - src_user
                - user
                - src_user_id
            next_steps:
              - makestreams
            name: ansible_test_notable
            recommended_actions:
              - email
              - logevent
            security_domain: threat
            severity: high
        state: replaced

    # RUN output:
    # -----------

    # "after": [
    #     {
    #         "correlation_search_name": "Ansible Test",
    #         "description": "test notable event",
    #         "drilldown_earliest_offset": "$info_min_time$",
    #         "drilldown_latest_offset": "$info_max_time$",
    #         "extract_artifacts": {
    #             "asset": [
    #                 "src",
    #                 "dest"
    #             ],
    #             "identity": [
    #                 "src_user",
    #                 "user",
    #                 "src_user_id"
    #             ]
    #         },
    #         "next_steps": [
    #             "makestreams"
    #         ],
    #         "name": "ansible_test_notable",
    #         "recommended_actions": [
    #             "email",
    #             "logevent"
    #         ],
    #         "security_domain": "threat",
    #         "severity": "high"
    #     }
    # ],
    # "before": [
    #     {
    #         "correlation_search_name": "Ansible Test",
    #         "description": "test notable event",
    #         "drilldown_earliest_offset": "$info_min_time$",
    #         "drilldown_latest_offset": "$info_max_time$",
    #         "drilldown_name": "test_drill_name",
    #         "drilldown_search": "test_drill",
    #         "extract_artifacts": {
    #             "asset": [
    #                 "src",
    #                 "dest",
    #                 "dvc",
    #                 "orig_host"
    #             ],
    #             "identity": [
    #                 "src_user",
    #                 "user",
    #                 "src_user_id",
    #                 "src_user_role",
    #                 "user_id",
    #                 "user_role",
    #                 "vendor_account"
    #             ]
    #         },
    #         "investigation_profiles": [
    #             "test profile 1",
    #             "test profile 2",
    #             "test profile 3"
    #         ],
    #         "next_steps": [
    #             "makestreams",
    #             "nbtstat",
    #             "nslookup"
    #         ],
    #         "name": "ansible_test_notable",
    #         "recommended_actions": [
    #             "email",
    #             "logevent",
    #             "makestreams",
    #             "nbtstat"
    #         ],
    #         "security_domain": "threat",
    #         "severity": "high"
    #     }
    # ],

    # USING DELETED
    # -------------

    - name: Example to remove the config
      splunk.es.splunk_adaptive_response_notable_events:
        config:
          - correlation_search_name: Ansible Test
        state: deleted

    # RUN output:
    # -----------

    # "after": [],
    # "before": [
    #     {
    #         "correlation_search_name": "Ansible Test",
    #         "description": "test notable event",
    #         "drilldown_earliest_offset": "$info_min_time$",
    #         "drilldown_latest_offset": "$info_max_time$",
    #         "drilldown_name": "test_drill_name",
    #         "drilldown_search": "test_drill",
    #         "extract_artifacts": {
    #             "asset": [
    #                 "src",
    #                 "dest",
    #                 "dvc",
    #                 "orig_host"
    #             ],
    #             "identity": [
    #                 "src_user",
    #                 "user",
    #                 "src_user_id",
    #                 "src_user_role",
    #                 "user_id",
    #                 "user_role",
    #                 "vendor_account"
    #             ]
    #         },
    #         "investigation_profiles": [
    #             "test profile 1",
    #             "test profile 2",
    #             "test profile 3"
    #         ],
    #         "next_steps": [
    #             "makestreams",
    #             "nbtstat",
    #             "nslookup"
    #         ],
    #         "name": "ansible_test_notable",
    #         "recommended_actions": [
    #             "email",
    #             "logevent",
    #             "makestreams",
    #             "nbtstat"
    #         ],
    #         "security_domain": "threat",
    #         "severity": "high"
    #     }
    # ]



Return Values
-------------
Common return values are documented `here <https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values>`_, the following are the fields unique to this module:

.. raw:: html

    <table border=0 cellpadding=0 class="documentation-table">
        <tr>
            <th colspan="1">Key</th>
            <th>Returned</th>
            <th width="100%">Description</th>
        </tr>
            <tr>
                <td colspan="1">
                    <div class="ansibleOptionAnchor" id="return-"></div>
                    <b>after</b>
                    <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a>
                    <div style="font-size: small">
                      <span style="color: purple">list</span>
                    </div>
                </td>
                <td>when changed</td>
                <td>
                            <div>The configuration as structured data after module completion.</div>
                    <br/>
                        <div style="font-size: smaller"><b>Sample:</b></div>
                        <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">The configuration returned will always be in the same format of the parameters above.</div>
                </td>
            </tr>
            <tr>
                <td colspan="1">
                    <div class="ansibleOptionAnchor" id="return-"></div>
                    <b>before</b>
                    <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a>
                    <div style="font-size: small">
                      <span style="color: purple">list</span>
                    </div>
                </td>
                <td>always</td>
                <td>
                            <div>The configuration as structured data prior to module invocation.</div>
                    <br/>
                        <div style="font-size: smaller"><b>Sample:</b></div>
                        <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">The configuration returned will always be in the same format of the parameters above.</div>
                </td>
            </tr>
            <tr>
                <td colspan="1">
                    <div class="ansibleOptionAnchor" id="return-"></div>
                    <b>gathered</b>
                    <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a>
                    <div style="font-size: small">
                      <span style="color: purple">dictionary</span>
                    </div>
                </td>
                <td>when state is <em>gathered</em></td>
                <td>
                            <div>Facts about the network resource gathered from the remote device as structured data.</div>
                    <br/>
                        <div style="font-size: smaller"><b>Sample:</b></div>
                        <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">This output will always be in the same format as the module argspec.</div>
                </td>
            </tr>
    </table>
    <br/><br/>


Status
------


Authors
~~~~~~~

- Ansible Security Automation Team (@pranav-bhatt) <https://github.com/ansible-security>