sentinelone_agent

A Puppet module to manage the SentinelOne agent.

Table of Contents

1. Description
2. Setup - The basics of getting started with sentinelone_agent
   • Setup requirements
   • Installation
3. Usage - Configuration options and additional functionality
4. Reference
5. Limitations - OS compatibility, etc.

Description

This module will install the SentinelOne Agent from a repository and keep the required configuration files updated.

Setup

Setup Requirements

Due to the nature of SentinelOne's distribution methods, making the actual package available in a repository is outside the scope of this module. In most cases, you can create your own custom Yum, Apt, etc. repository and serve out the SentinelAgent package you can download from the SentinelOne interface.

This module was tested on versions of SentinelAgent >= 4, and therefore cannot be guaranteed to work on older versions of the agent installation.

Installation

The easiest way to install this module is through Puppet Forge:

puppet module install broadinstitute-sentinelone_agent

If you use the Puppet environment automation tool r10k, you can also simply add this to your Puppetfile:

mod 'broadinstitute/sentinelone_agent'

Usage

Puppet Manifest

class { 'sentinelone_agent':
  token => 'abc123',
}

With Hiera

---
classes:
  - sentinelone_agent
sentinelone_agent::token: 'abc123'

Reference

REFERENCE.md (generated with Puppet Strings)

Limitations

This has currently only been tested extensively on RedHat-based systems.

Reference

Table of Contents

Classes

• sentinelone_agent: Manage an installation of the SentinelOne Agent
• sentinelone_agent::config: Manage the SentinelOne Agent configuration
• sentinelone_agent::install: Manage the SentinelOne Agent installation
• sentinelone_agent::service: Manage the SentinelOne Agent service

Defined types

• sentinelone_agent::option: Control an option in the SentinelOne Agent configuration file

Classes

sentinelone_agent

Manage an installation of the SentinelOne Agent

Examples

class { 'sentinelone_agent':
  token => 'abc123',
}

Parameters

The following parameters are available in the sentinelone_agent class:

• logrotate_ensure
• manage_logrotate
• manage_package
• manage_service
• options
• package_ensure
• package_name
• service_enable
• service_ensure
• service_name
• token

logrotate_ensure

Data type: Enum['absent', 'present']

Ensure whether the logrotate file is present or not (default: 'present').

manage_logrotate

Data type: Boolean

Decide whether to manage the logrotate configuration for the service (default: true).

manage_package

Data type: Boolean

Decide whether to manage the package (default: true).

manage_service

Data type: Boolean

Decide whether to manage the service (default: true).

options

Data type: Optional[Hash]

Custom options to be changed in the SentinelOne Agent configuration

package_ensure

Data type: Variant[Enum['absent', 'installed', 'latest'], Pattern[/^(\d+\.){3}\d+$/]]

Ensure the state of the package (default: 'installed').

package_name

Data type: String

The name of the SentinelOne agent package (default: 'SentinelAgent').

service_enable

Data type: Boolean

Decide whether to enable the service (default: true).

service_ensure

Data type: Enum['running', 'stopped']

Ensure the state of the service (default: 'running').

service_name

Data type: String

The name of the SentinelOne agent service (default: 'sentinelone').

token

Data type: String

The token to be used by the SentinelOne agent (no default, but required)

sentinelone_agent::config

Manage the SentinelOne Agent configuration

sentinelone_agent::install

Manage the SentinelOne Agent installation

sentinelone_agent::service

Manage the SentinelOne Agent service

Defined types

sentinelone_agent::option

Control an option in the SentinelOne Agent configuration file

Examples

sentinelone_agent::option { 'mgmt_proxy_url':
  value => 'http://example.org:8888',
}

sentinelone_agent::option { 'some_option_name':
  setting => 'mgmt_proxy_url'
  value   => 'http://example.org:8888',
}

Parameters

The following parameters are available in the sentinelone_agent::option defined type:

• value
• setting

value

Data type: String

The value to set for the given option.

setting

Data type: Optional[String]

Optionally set the option name. If not provided, the resource title will be used.

Default value: undef

Changelog

0.2.0 (2023-11-15)

Full Changelog

Implemented enhancements:

• Move to puppet/augeasproviders_core #80 (coreone)

Fixed bugs:

• Upgrade dependencies #49 (teluq-pbrideau)

0.1.3 (2022-01-05)

Full Changelog

Fixed bugs:

• Fix initial config file state bug #25 (coreone)

0.1.2 (2021-07-14)

Full Changelog

Implemented enhancements:

• Configuration system revamp #7 (coreone)
• Add the ability to configure a proxy #6 (coreone)

0.1.1 (2021-04-02)

Full Changelog

Fixed bugs:

• Fix service name bug #4 (coreone)

0.1.0 (2021-04-02)

Full Changelog

Implemented enhancements:

• Initial release #1 (coreone)

* This Changelog was automatically generated by github_changelog_generator