Skip to content

Latest commit

 

History

History
172 lines (100 loc) · 4.6 KB

REFERENCE.md

File metadata and controls

172 lines (100 loc) · 4.6 KB

Reference

Table of Contents

Classes

Defined types

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

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

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