Splunk Enterprise Ansible Collection

The Ansible Enterprise collection includes variety of content to help automate lifecycle management of Splunk Enterprise related functionality.

Code of Conduct

We follow the Ansible Code of Conduct in all our interactions within this project.

If you encounter abusive behavior, please refer to the policy violations section of the Code for information on how to raise a complaint.

Communication

• Join the Ansible forum:
• Get Help: get help or help others. Please add appropriate tags if you start new discussions
• Social Spaces: gather and interact with fellow enthusiasts.
• News & Announcements: track project-wide announcements including social events. The Bullhorn newsletter, which is used to announce releases and important changes, can also be found here.

For more information about communication, see the Ansible communication guide.

Contributing to this collection

We welcome community contributions to this collection. If you find problems, please open an issue or create a PR against the Splunk Enterprise collection repository. See Contributing to Ansible-maintained collections for complete details.

The content of this collection is made by people like you, a community of individuals collaborating on making the world better through developing automation software.

We are actively accepting new contributors and all types of contributions are very welcome.

Don't know how to start? Refer to the Ansible community guide!

Want to submit code changes? Take a look at the Quick-start development guide.

We also use the following guidelines:

• Collection review checklist
• Ansible development guide
• Ansible collection development guide

Collection maintenance

The current maintainers are listed in the MAINTAINERS file. If you have questions or need help, feel free to mention them in the proposals.

To learn how to maintain/become a maintainer of this collection, refer to the Maintainer guidelines.

It is necessary for maintainers of this collection to be subscribed to:

• The collection itself (the Watch button -> All Activity in the upper right corner of the repository's homepage).
• The news-for-maintainers repository.

They also should be subscribed to Ansible's The Bullhorn newsletter.

Governance

The process of decision making in this collection is based on discussing and finding consensus among participants.

Every voice is important. If you have something on your mind, create an issue or dedicated discussion and let's discuss it!

Ansible version compatibility

This collection has been tested against the following Ansible versions: >=2.17.0.

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.

Included content

Modules

Using this collection

Installing the Collection from Ansible Galaxy

Before using this collection, you need to install it with the Ansible Galaxy command-line tool:

ansible-galaxy collection install splunk.enterprise

You can also include it in a requirements.yml file and install it with ansible-galaxy collection install -r requirements.yml, using the format:

---
collections:
  - name: splunk.enterprise

Note that if you install the collection from Ansible Galaxy, it will not be upgraded automatically when you upgrade the ansible package. To upgrade the collection to the latest available version, run the following command:

ansible-galaxy collection install splunk.enterprise --upgrade

You can also install a specific version of the collection, for example, if you need to downgrade when something is broken in the latest version (please report an issue in this repository). Use the following syntax to install version 0.1.0:

ansible-galaxy collection install splunk.enterprise:==0.1.0

See using Ansible collections for more details.

Using modules from the Splunk Enterprise collection in your playbooks

You can call modules by their Fully Qualified Collection Namespace (FQCN), such as splunk.enterprise.splunk_universal_forwarder_linux. The following example task installs splunk universal forwarder on a RHEL machine that was specified in the inventory file, using the FQCN:

---
- name: Install Splunk Universal Forwarder (x86_64)
  splunk.enterprise.splunk_universal_forwarder_linux:
    state: present
    version: "9.4.7"
    release_id: "2a9293b80994"
    username: admin
    password: "changeme123"

for Windows we would have the following inventory format:

[windows]
windows_server_22 ansible_host=<insert_server_22_ip>
windows_server_19 ansible_host=<insert_server_19_ip>
windows_server_25 ansible_host=<insert_server_25_ip>

[windows:vars]
ansible_user=Admin
ansible_password=<insert password>
ansible_connection=winrm
ansible_winrm_transport=basic
ansible_winrm_server_cert_validation=ignore
ansible_port=5985

for rhel an example of a suggested inventory:

[rhel8]
<insert_server_rhel8_ip>
[rhel9]
<insert_server_rhel9_ip>
[rhel10]
<insert_server_rhel10_ip>
[rhel]
<insert_server_rhel8_ip>
<insert_server_rhel9_ip>
<insert_server_rhel10_ip>

See Also:

• Ansible Using collections for more details.

Release notes

See the changelog.

Roadmap

More information

• Ansible user guide
• Ansible developer guide
• Ansible collections requirements
• Ansible community Code of Conduct
• The Bullhorn (the Ansible contributor newsletter)
• Important announcements for maintainers

Licensing

GNU General Public License v3.0 or later.

See LICENSE to see the full text.