sva.sentinelone.agent_info module – Get info about the SentinelOne agent package

Note

This module 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. You need further requirements to be able to use this module, see Requirements for details.

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

New in sva.sentinelone 2.0.0

Synopsis

  • This module is able to get info about the sentinelone agent package you requested

Aliases: sentinelone_agent_info

Requirements

The below requirements are needed on the host that executes this module.

  • deepdiff >= 5.6

Parameters

Parameter

Comments

agent_version

string

Version of the agent to get info about

latest (default) - Latest GA (stable) release for the specified parameters

latest_ea - same as latest, but also includes EA packages

custom - custom_version is required when agent_versioin is custom

Choices:

  • "latest" ← (default)

  • "latest_ea"

  • "custom"

architecture

string

Architecture of the packet

Windows: Only 32_bit and 64_bit are allowed

Linux: If not set infos about the 64 bit agent will be retrieved. If set to aarch64 infos about the ARM agent will be retrieved

Choices:

  • "32_bit"

  • "64_bit" ← (default)

  • "aarch64"

console_url

string / required

Insert your management console URL

custom_version

string

Explicit version of the agent to get info about

Has to be set when agent_version=custom

Will be ignored if agent_version is not custom

os_type

string / required

The type of the OS

Choices:

  • "Linux"

  • "Windows"

packet_format

string / required

The format of the agent package

Choices:

  • "rpm"

  • "deb"

  • "msi"

  • "exe"

site

string

Optional name of the site from where the agent package is located

If omitted the scope will be on account level

token

string / required

SentinelOne API auth token to authenticate at the management API

Notes

Note

  • Python module deepdiff required. Tested with version >=5.6. Lower version may work too

  • Currently only supported in single-account management consoles

Examples

---
- name: Get info about specified package
  sva.sentinelone.agent_info:
    console_url: "https://XXXXX.sentinelone.net"
    token: "XXXXXXXXXXXXXXXXXXXXXXXXXXX"
    os_type: "Windows"
    packet_format: "msi"
    architecture: "64_bit"
    agent_version: "latest"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

message

string

Get basic infos about the agent package

Returned: on success

Sample: "Agent found: SentinelAgent_linux_x86_64_v24_2_2_20.rpm"

original_message

string

Detailed infos about the requested agent package

Returned: on success

Sample: "{'accounts': [], 'createdAt': '2024-09-17T14:28:31.657142Z', 'fileExtension': '.rpm', 'fileName': 'SentinelAgent_linux_x86_64_v24_2_2_20.rpm', 'fileSize': 46269381, 'id': '2041405603323138037', 'link': 'https://XXXXX.sentinelone.net/web/api/v2.1/update/agent/download/2049999999991104/2041999999999999037', 'majorVersion': '24.2', 'minorVersion': 'GA', 'osArch': '32/64 bit', 'osType': 'linux', 'packageType': 'Agent', 'platformType': 'linux', 'rangerVersion': null, 'scopeLevel': 'global', 'sha1': '3d32d43860bc0a77926a4d8186c8427be59c1a06', 'sites': [], 'status': 'ga', 'supportedOsVersions': null, 'updatedAt': '2024-09-17T14:28:31.655927Z', 'version': '24.2.2.20'}"

Authors

  • Marco Wester (@mwester117)