REFERENCE.md

Reference

Table of Contents

Classes

• crowdstrike: Simple module installing CrowdStrike's Falcon Agent

Classes

crowdstrike

The module is designed to install, manage and remove CrowdStrike's Falcon Agent antivirus. Tags and proxy settings can be changed any time using module parameters.

• See also
  • https://www.crowdstrike.com/endpoint-security-products/falcon-endpoint-protection-enterprise/

Examples

Install Falcon Agent and use proxy for connections

class { '::crowdstrike':
  ensure             => present,
  cid                => 'AAAAAAAAAAAAAAA-BB',
  provisioning_token => 'XXXXXXXXXXXXXXXXXX',
  tags               => [ 'my_company', 'my_organization' ],
  proxy_host         => 'proxy.mycompany.com',
  proxy_port         => 3128
}

Parameters

The following parameters are available in the crowdstrike class:

• ensure
• cid
• provisioning_token
• tags
• proxy_host
• proxy_port
• package_source
• package_provider

ensure

Data type: Enum['present','absent','latest']

If present or latest installs the agent, keeping it up-to-date with the latter value. When set to absent uninstalls the agent's package.

Default value: 'present'

cid

Data type: Optional[Variant[String, Deferred]]

Customer IDentifier. Necessary to register the agent with the service. Mandatory.

Default value: undef

provisioning_token

Data type: Optional[Variant[String, Deferred]]

Provisioning token for the crowdstrike agent installation.

Default value: undef

tags

Data type: Optional[Array[String]]

Array of string tags used to group agents in the CrowdStrike console.

Default value: undef

proxy_host

Data type: Optional[String]

Proxy server host name for proxied connections. Mandatory if proxy_port is specified.

Default value: undef

proxy_port

Data type: Optional[Stdlib::Port]

Proxy server port for proxied connections. Mandatory if proxy_host is specified.

Default value: undef

package_source

Data type: Optional[String]

Define a package source for installation

Default value: undef

package_provider

Data type: Optional[String]

Define a package provider for installation

Default value: undef