sva.sentinelone.install_agent role – Entrypoint for install_agent role

Note

This role is part of the sva.sentinelone collection (version 2.2.0).

It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it use: ansible-galaxy collection install sva.sentinelone.

To use it in a playbook, specify: sva.sentinelone.install_agent.

Entry point main – Entrypoint for install_agent role

Synopsis

  • This is the main entrypoint for the install_agent role.

  • The entrypoint contains all os independent tasks and prepares the environment for the os specific tasks.

Parameters

Parameter

Comments

agent_version

string

The agent version string. default is to install ‘latest’ version.

latest: Install latest GA version.

latest_ea: Install latest EA version.

custom: Install custom agent version. If set to custom argument ‘custom_version’ is required.

Choices:

  • "latest" ← (default)

  • "latest_ea"

  • "custom"

api_token

string

The API token to authenticate at the management console.

Required if registration_token and custom_client_url both are not provided

check_console_retries

integer

How many times the ansible role tries to find the agent in the management console after installation

Default: 3

check_console_retry_delay

integer

The delay in s between two attempts to find the agent in the management console after installation

Default: 20

console_url

string

The SentinelOne management console URL. E.g. https://my-s1-console.net.

Required if registration_token and custom_client_url both are not provided

custom_client_url

string

Optional URL to a package source to download the SentinelOne client package. If not set, SentinelOne client will be downloaded by via SentinelOne Console.

‘console_url’, ‘api_token’ and ‘site’ will be ignored if registration_token and custom_client_url are both set

custom_version

string

Required when ‘agent_version’ is set to custom.

Explicit version of the agent to be installed.

gpg_key

string

The path to the gpg key to verify the agent package integrity on rpm based systems.

group

string

Optional: The name of the group where the new endpoint should join.

hide_sensitive

boolean

Hide sensitive information like API keys in module output.

Only change to false for debugging purposes.

Choices:

  • false

  • true ← (default)

lx_force_new_token

boolean

Linux only: Set the management token on the linux agent even if it is already registered.

Choices:

  • false ← (default)

  • true

registration_token

string

Optional registration token. Usefull if no API access is available and the agent should be registered manually.

‘console_url’, ‘api_token’ and ‘site’ will be ignored if registration_token and custom_client_url are both set

site

string

The name of the site where the new endpoint should join.

Required if registration_token and custom_client_url both are not provided

win_allow_reboot

boolean

Windows only: Endpoint needs to be rebooted to SentinelOne work properly.

Set to false to disable automatic reboot

Choices:

  • false

  • true ← (default)

win_use_exe

boolean

Windows only: Controls the Windows agent package format.

false: Downloads .msi installer file

true: Downloads .exe installer file

Choices:

  • false ← (default)

  • true

Authors

  • Marco Wester