Ansible Collection - sva.sentinelone

Description

This is the unofficial SentinelOne Collection provided by SVA

This collection is a community project and is neither provided nor supported by SentinelOne itself.

It provides several modules which helps to configure and manage SentinelOne Management Consoles.

Included content

• Modules:

  • agent_info
  • config_overrides
  • download_agent
  • filters
  • groups
  • sites
  • upgrade_policies
  • path_exclusions
  • policies

• Roles:

  • install_agent
  • sentinelone_client_legacy (deprecated – see Migration)

Migration

sentinelone_client_legacy → install_agent

⚠️ Deprecated: The role sentinelone_client_legacy is deprecated and will be removed in a future release. Please migrate to the install_agent role.

The install_agent role now incorporates all functionality previously provided by sentinelone_client_legacy, including support for environments without API access. install_agent role now supports these two cases:

• Download agent from provided download URL
• Register agent with a provided registration_token

If both is provided no API access is needed. Please see install_agent role documentation for more details.

Requirements

Ansible

• ansible >= 10 or ansible-core >= 2.17 (Lower versions may work but they have not been tested)

Python

• Python >= 3.10 (Ansible control node requirement)

External

This collection needs the following Python modules:

• deepdiff >= 5.6.0 (Lower versions may work but they have not been tested)

Tested with Ansible and the following Python versions

Tested Ansible versions:

• 2.17
• 2.18
• 2.19
• 2.20
• 2.21

Tested Python versions:

• 3.10
• 3.11
• 3.12
• 3.13
• 3.14

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 sva.sentinelone

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: sva.sentinelone

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 sva.sentinelone --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 1.0.0:

ansible-galaxy collection install sva.sentinelone:==1.0.0

See Ansible Using collections for more details.

Documentation

User documentation

The module documentation can be found here.

The role documentation can be found here.

Changelog

Detailed Changelog can be found at CHANGELOG

Todo (help is welcome)

• Unit tests needs to be written

Licensing

The SVA SentinelOne collection is licensed under the GNU General Public License v3.0+. See LICENSE for the full license text.