installer

Documentation

Index

• func Run(fc FalconInstaller)
• func Uninstall(fc FalconInstaller)
• type FalconInstaller
• type FalconSensorCLI

Functions

func Run

func Run(fc FalconInstaller)

Run installs the Falcon sensor on the system.

func Uninstall

func Uninstall(fc FalconInstaller)

Uninstall removes the Falcon Sensor from the target system.

Types

type FalconInstaller

type FalconInstaller struct {
	// ClientID is the client ID for accessing CrowdStrike Falcon Platform.
	ClientID string
	// ClientSecret is the client secret for accessing CrowdStrike Falcon Platform.
	ClientSecret string
	// AccessToken is the access token for accessing CrowdStrike Falcon Platform.
	AccessToken string
	// MemberCID is the member CID for MSSP (for cases when OAuth2 authenticates multiple CIDs).
	MemberCID string
	// Cloud is the Falcon cloud abbreviation (us-1, us-2, eu-1, us-gov-1). Defaults to autodiscover.
	Cloud string
	// SensorUpdatePolicyName is the sensor update policy name to use for sensor installation.
	SensorUpdatePolicyName string
	// TmpDir is the temporary directory to use for downloading the sensor.
	TmpDir string
	// Arch is the architecture to install the sensor on.
	Arch string
	// OSType is the type of operating system to install the sensor on e.g. linux, windows, macos, etc.
	OSType string
	// OsName is the name of the OS to use when querying for the sensor.
	OsName string
	// OsVersion is the version of the OS to use when querying for the sensor.
	OsVersion string
	// GpgKeyFile is the path to the GPG key file to use for importing the key. Linux only.
	GpgKeyFile string
	// UserAgent is the user agent string to use when making API requests.
	UserAgent string
	// ConfigureImage will configure the sensor on the image. Linux only.
	ConfigureImage bool

	// SensorConfig is the configuration for the Falcon sensor CLI args.
	SensorConfig FalconSensorCLI
}

FalconInstaller is the configuration for the Falcon installer.

type FalconSensorCLI

type FalconSensorCLI struct {
	// CID is the customer ID for the sensor to use when communicating with CrowdStrike.
	CID string
	// ProxyDisable will disable the sensor's proxy settings.
	ProxyDisable bool
	// ProxyHost is the proxy host for the sensor to use when communicating with CrowdStrike.
	ProxyHost string
	// ProxyPort is the proxy port for the sensor to use when communicating with CrowdStrike.
	ProxyPort string
	// Tags is a comma separated list of tags for sensor grouping.
	Tags string
	// MaintenanceToken is the token used to perform maintenance on the sensor when Tamper Protection is enabled.
	MaintenanceToken string
	// ProvisioningToken is the token used to provision the sensor. If not provided, the API will attempt to retrieve a token.
	ProvisioningToken string
	// DisableProvisioningWait allows the Windows installer more provisioning time when communicating with CrowdStrike. Windows only.
	DisableProvisioningWait bool
	// ProvisioningWaitTime is the time in milliseconds to wait for the sensor to provision. Windows only.
	ProvisioningWaitTime uint64
	// PACURL is the proxy auto-config URL for the sensor to use when communicating with CrowdStrike. Windows only.
	PACURL string
	// Restart will allow the system to restart if necessary after sensor installation. Windows only.
	Restart bool
	// NoStart will prevent the sensor from starting after installation until a reboot occurs. Windows only.
	NoStart bool
	// VDI will enable virtual desktop infrastructure mode. Windows only.
	VDI bool
}

FalconSensorCLI is the configuration for the Falcon sensor CLI args.