crowdstrike.falcon.sensor_download_info (4.3.2) — module

Get information about Falcon Sensor Installers

| "added in version" 4.0.0 of crowdstrike.falcon"

Authors: Carlos Matos (@carlosmmatos)

Install collection

Install with ansible-galaxy collection install crowdstrike.falcon:==4.3.2


Add to requirements.yml

  collections:
    - name: crowdstrike.falcon
      version: 4.3.2

Description

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


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Get a list of Linux Sensor Installers
  crowdstrike.falcon.sensor_download_info:
    filter: "platform:'linux'"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Get a list of the 2 latest Windows Sensor Installers
  crowdstrike.falcon.sensor_download_info:
    limit: 2
    filter: "platform:'windows'"
    sort: "version|desc"

Inputs

    
auth:
    description:
    - The registered result of the M(crowdstrike.falcon.auth) module, or a dictionary
      containing the I(access_token) and I(cloud) keys.
    - If provided, the I(client_id), I(client_secret), I(member_cid), and I(cloud) options
      are ignored.
    - Useful when needing to make multiple API calls to avoid rate limiting issues.
    suboptions:
      access_token:
        description:
        - The OAuth2 access token to use for authentication.
        type: str
      cloud:
        description:
        - The CrowdStrike cloud region to use.
        - This can differ from the module's I(cloud) argument due to autodiscovery.
        type: str
    type: dict

sort:
    description:
    - The property to sort by in FQL (Falcon Query Language) syntax.
    - See the L(FalconPy documentation,https://www.falconpy.io/Usage/Falcon-Query-Language.html#using-fql-in-a-sort)
      for more information about sorting with FQL.
    type: str

cloud:
    choices:
    - us-1
    - us-2
    - us-gov-1
    - eu-1
    default: us-1
    description:
    - The CrowdStrike cloud region to use.
    - All clouds are automatically discovered if not specified, except for the C(us-gov-1)
      cloud.
    - The C(FALCON_CLOUD) environment variable can also be used.
    type: str

limit:
    description:
    - The maximum number of records to return. [1-500]
    - Use with the offset parameter to manage pagination of results.
    type: int

filter:
    description:
    - The filter expression that should be used to limit the results using FQL (Falcon
      Query Language) syntax.
    - See the return values for more information about the available filters that can
      be used.
    type: str

offset:
    description:
    - The offset to start retrieving records from.
    type: int

client_id:
    aliases:
    - falcon_client_id
    description:
    - The CrowdStrike API client ID to use.
    - See the L(Falcon documentation,https://falcon.crowdstrike.com/documentation/46/crowdstrike-oauth2-based-apis#understanding-api-clients)
      for more information about API clients.
    - The C(FALCON_CLIENT_ID) environment variable can also be used.
    type: str

member_cid:
    description:
    - The CrowdStrike member CID for MSSP authentication.
    - See the L(Falcon documentation,https://falcon.crowdstrike.com/documentation/46/crowdstrike-oauth2-based-apis#understanding-api-clients)
      for more information about API clients.
    - The C(FALCON_MEMBER_CID) environment variable can also be used.
    type: str

user_agent:
    description:
    - Custom User-Agent string to use for requests to the API.
    - The user agent string is prepended to the default user agent string (C(crowdstrike-ansible/<version>)).
    - See L(RFC 7231,https://tools.ietf.org/html/rfc7231#section-5.5.3) for more information.
    - The C(FALCON_USER_AGENT) environment variable can also be used.
    type: str

ext_headers:
    description:
    - Extended headers that are prepended to the default headers dictionary.
    type: dict

client_secret:
    aliases:
    - falcon_client_secret
    description:
    - The CrowdStrike API secret that corresponds to the client ID.
    - See the L(Falcon documentation,https://falcon.crowdstrike.com/documentation/46/crowdstrike-oauth2-based-apis#understanding-api-clients)
      for more information about API clients.
    - The C(FALCON_CLIENT_SECRET) environment variable can also be used.
    type: str

Outputs

installers:
  contains:
    description:
      description: The description of the Sensor Installer.
      returned: success
      sample: Falcon Sensor for Ubuntu 18.04
      type: str
    file_size:
      description: The size of the Sensor Installer in bytes.
      returned: success
      sample: 123456789
      type: int
    file_type:
      description: The type of the Sensor Installer.
      returned: success
      sample: rpm
      type: str
    name:
      description: The name of the Sensor Installer.
      returned: success
      sample: falcon-sensor-X.YY.Z-11404.el7.x86_64.rpm
      type: str
    os:
      description: The operating system associated with the Sensor Installer.
      returned: success
      sample: Ubuntu
      type: str
    os_version:
      description: The operating system version associated with the Sensor Installer.
      returned: success
      sample: 16/18/20/22
      type: str
    platform:
      description: The platform associated with the Sensor Installer.
      returned: success
      sample: linux
      type: str
    release_date:
      description: The release date of the Sensor Installer.
      returned: success
      sample: '2021-01-01T00:00:00Z'
      type: str
    sha256:
      description:
      - The SHA256 checksum of the Sensor Installer.
      - This value is generally used to download the Sensor Installer.
      returned: success
      sample: 0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef
      type: str
    version:
      description: The version of the Sensor Installer.
      returned: success
      sample: 6.22.11404
      type: str
  description: A list of matching Sensor Installers
  elements: dict
  returned: success
  type: list