summaryrefslogtreecommitdiffstats
path: root/ansible_collections/splunk/es/README.md
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-18 05:52:22 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-18 05:52:22 +0000
commit38b7c80217c4e72b1d8988eb1e60bb6e77334114 (patch)
tree356e9fd3762877d07cde52d21e77070aeff7e789 /ansible_collections/splunk/es/README.md
parentAdding upstream version 7.7.0+dfsg. (diff)
downloadansible-38b7c80217c4e72b1d8988eb1e60bb6e77334114.tar.xz
ansible-38b7c80217c4e72b1d8988eb1e60bb6e77334114.zip
Adding upstream version 9.4.0+dfsg.upstream/9.4.0+dfsg
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'ansible_collections/splunk/es/README.md')
-rw-r--r--ansible_collections/splunk/es/README.md23
1 files changed, 13 insertions, 10 deletions
diff --git a/ansible_collections/splunk/es/README.md b/ansible_collections/splunk/es/README.md
index cc7c0037a..c329e2dc6 100644
--- a/ansible_collections/splunk/es/README.md
+++ b/ansible_collections/splunk/es/README.md
@@ -1,6 +1,8 @@
# Splunk Enterprise Security Ansible Collection
-[![CI](https://zuul-ci.org/gated.svg)](https://dashboard.zuul.ansible.com/t/ansible/project/github.com/ansible-collections/splunk.es) <!--[![Codecov](https://img.shields.io/codecov/c/github/ansible-collections/splunk.es)](https://codecov.io/gh/ansible-collections/splunk.es)-->
+[![CI](https://zuul-ci.org/gated.svg)](https://dashboard.zuul.ansible.com/t/ansible/project/github.com/ansible-collections/splunk.es)
+[![Codecov](https://codecov.io/gh/ansible-collections/splunk.es/branch/main/graph/badge.svg)](https://codecov.io/gh/ansible-collections/splunk.es)
+[![CI](https://github.com/ansible-collections/splunk.es/actions/workflows/tests.yml/badge.svg?branch=main&event=schedule)](https://github.com/ansible-collections/splunk.es/actions/workflows/tests.yml)
This is the [Ansible
Collection](https://docs.ansible.com/ansible/latest/user_guide/collections_using.html)
@@ -18,6 +20,8 @@ and provide feedback about.
This collection has been tested against following Ansible versions: **>=2.9.10**.
+For collections that support Ansible 2.9, please ensure you update your `network_os` to use the
+fully qualified collection name (for example, `cisco.ios.ios`).
Plugins and modules within a collection may be tested with only specific Ansible versions.
A collection may contain metadata that identifies these versions.
PEP440 is the schema used to describe the versions of Ansible.
@@ -89,7 +93,7 @@ collections:
**NOTE**: For Ansible 2.9, you may not see deprecation warnings when you run your playbooks with this collection. Use this documentation to track when a module is deprecated.
-An example for using this collection to manage a log source with [Splunk Enterprise Security SIEM](https://www.splunk.com/en_us/software/enterprise-security.html) is as follows.
+An example of using this collection to manage a log source with [Splunk Enterprise Security SIEM](https://www.splunk.com/en_us/software/enterprise-security.html) is as follows.
`inventory.ini` (Note the password should be managed by a [Vault](https://docs.ansible.com/ansible/latest/user_guide/vault.html) for a production environment.
@@ -112,7 +116,7 @@ ansible_connection=httpapi
With [Ansible
Collections](https://docs.ansible.com/ansible/latest/dev_guide/developing_collections.html)
there are various ways to utilize them either by calling specific Content from
-the Collection, such as a module, by it's Fully Qualified Collection Name (FQCN)
+the Collection, such as a module, by its Fully Qualified Collection Name (FQCN)
as we'll show in this example or by defining a Collection Search Path as the
examples below will display.
@@ -125,13 +129,13 @@ shorthand options listed below exist for convenience.
---
- name: demo splunk
hosts: splunk
- gather_facts: False
+ gather_facts: false
tasks:
- name: test splunk_data_input_monitor
splunk.es.data_input_monitor:
name: "/var/log/demo.log"
state: "present"
- recursive: True
+ recursive: true
- name: test splunk_data_input_network
splunk.es.data_input_network:
name: "9001"
@@ -167,7 +171,7 @@ splunk modules without specifying the need for the FQCN.
---
- name: demo splunk
hosts: splunk
- gather_facts: False
+ gather_facts: false
collections:
- splunk.es
tasks:
@@ -175,7 +179,7 @@ splunk modules without specifying the need for the FQCN.
data_input_monitor:
name: "/var/log/demo.log"
state: "present"
- recursive: True
+ recursive: true
- name: test splunk_data_input_network
data_input_network:
name: "9001"
@@ -212,14 +216,14 @@ FQCN.
---
- name: demo splunk
hosts: splunk
- gather_facts: False
+ gather_facts: false
tasks:
- name: collection namespace block
- name: test splunk_data_input_monitor
data_input_monitor:
name: "/var/log/demo.log"
state: "present"
- recursive: True
+ recursive: true
- name: test splunk_data_input_network
data_input_network:
name: "9001"
@@ -287,4 +291,3 @@ See [LICENSE](https://www.gnu.org/licenses/gpl-3.0.txt) to see the full text.
## Author Information
[Ansible Security Automation Team](https://github.com/ansible-security)
-