crowdstrike.falcon.sensor_download_info module – Get information about Falcon Sensor Installers

Note

This module is part of the crowdstrike.falcon collection (version 4.7.0).

To install it, use: ansible-galaxy collection install crowdstrike.falcon. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: crowdstrike.falcon.sensor_download_info.

New in crowdstrike.falcon 4.0.0

Synopsis

  • Returns a set of Sensor Installers which match the filter criteria.

Requirements

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

  • Sensor download [READ] API scope

  • crowdstrike-falconpy >= 1.3.0

  • python >= 3.6

Parameters

Parameter

Comments

auth

dictionary

The registered result of the crowdstrike.falcon.auth module, or a dictionary containing the access_token and cloud keys.

If provided, the client_id, client_secret, member_cid, and cloud options are ignored.

Useful when needing to make multiple API calls to avoid rate limiting issues.

access_token

string

The OAuth2 access token to use for authentication.

cloud

string

The CrowdStrike cloud region to use.

This can differ from the module’s cloud argument due to autodiscovery.

client_id

aliases: falcon_client_id

string

The CrowdStrike API client ID to use.

See the Falcon documentation for more information about API clients.

The FALCON_CLIENT_ID environment variable can also be used.

client_secret

aliases: falcon_client_secret

string

The CrowdStrike API secret that corresponds to the client ID.

See the Falcon documentation for more information about API clients.

The FALCON_CLIENT_SECRET environment variable can also be used.

cloud

string

The CrowdStrike cloud region to use.

All clouds are automatically discovered if not specified, except for the us-gov-1 cloud.

The FALCON_CLOUD environment variable can also be used.

Choices:

  • "us-1" ← (default)

  • "us-2"

  • "us-gov-1"

  • "eu-1"

ext_headers

dictionary

Extended headers that are prepended to the default headers dictionary.

filter

string

The filter expression that should be used to limit the results using FQL (Falcon Query Language) syntax.

See the return values or CrowdStrike docs for more information about the available filters that can be used.

member_cid

string

The CrowdStrike member CID for MSSP authentication.

See the Falcon documentation for more information about API clients.

The FALCON_MEMBER_CID environment variable can also be used.

sort

string

The property to sort by in FQL (Falcon Query Language) syntax.

See the FalconPy documentation for more information about sorting with FQL.

user_agent

string

Custom User-Agent string to use for requests to the API.

The user agent string is prepended to the default user agent string (crowdstrike-ansible/<version>).

See RFC 7231 for more information.

The FALCON_USER_AGENT environment variable can also be used.

Examples

- name: Get all Linux Sensor Installers
  crowdstrike.falcon.sensor_download_info:
    filter: "platform:'linux'"

- name: Get all Windows Sensor Installers sorted by version
  crowdstrike.falcon.sensor_download_info:
    filter: "platform:'windows'"
    sort: "version|desc"

- name: Get all zLinux(s390x) Sensor Installers
  crowdstrike.falcon.sensor_download_info:
    filter: "platform:'linux' + architectures:'s390x'"

Return Values

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

Key

Description

installers

list / elements=dictionary

A list of matching Sensor Installers

Returned: success

architectures

list / elements=string

A list of architectures supported by the Sensor Installer.

Returned: success

Sample: ["x86_64"]

description

string

The description of the Sensor Installer.

Returned: success

Sample: "Falcon Sensor for Ubuntu 18.04"

file_size

integer

The size of the Sensor Installer in bytes.

Returned: success

Sample: 123456789

file_type

string

The type of the Sensor Installer.

Returned: success

Sample: "rpm"

name

string

The name of the Sensor Installer.

Returned: success

Sample: "falcon-sensor-X.YY.Z-11404.el7.x86_64.rpm"

os

string

The operating system associated with the Sensor Installer.

Returned: success

Sample: "Ubuntu"

os_version

string

The operating system version associated with the Sensor Installer.

Returned: success

Sample: "16/18/20/22"

platform

string

The platform associated with the Sensor Installer.

Returned: success

Sample: "linux"

release_date

string

The release date of the Sensor Installer.

Returned: success

Sample: "2021-01-01T00:00:00Z"

sha256

string

The SHA256 checksum of the Sensor Installer.

This value is generally used to download the Sensor Installer.

Returned: success

Sample: "0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"

version

string

The version of the Sensor Installer.

Returned: success

Sample: "6.22.11404"

Authors

  • Carlos Matos (@carlosmmatos)