REFERENCE.md

Reference

Table of Contents

Classes

Public Classes

• ir_agent: Module for installing and managing Rapid7 Insight Agent.

Private Classes

• ir_agent::audit: Class for configuring audit service for Insight agent.
• ir_agent::install: Class for installing the Insight agent.
• ir_agent::uninstall: Class for uninstalling the Insight agent.

Classes

ir_agent

Module for installing and managing Rapid7 Insight Agent.

Examples

Deploy the agent with default options.

class { 'ir_agent':
  source => 'puppet:///modules/my_module/agent_installer_x64.sh',
  token  => 'us:01234567-89ab-cdef-0123-4567890abcde',
}

Parameters

The following parameters are available in the ir_agent class:

• ensure
• source
• checksum
• checksum_type
• token
• semantic_version
• auditd_compatibility_mode
• manage_auditd
• https_proxy

ensure

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

If present, installs the agent. If absent, uninstalls the agent. The agent is self-updating, so there is no latest option provided.

Default value: 'present'

source

Data type: Optional[String]

Source location for the agent installer script.

Default value: undef

checksum

Data type: Optional[String]

Checksum for the agent installer script source file.

Default value: undef

checksum_type

Data type: Optional[Enum['md5', 'sha256', 'sha224', 'sha384', 'sha512']]

Checksum type for the source_checksum.

Default value: undef

token

Data type: Optional[String]

Token needed to download the certificates needed to enable the agent.

Default value: undef

semantic_version

Data type: Optional[String]

Reinstall the agent if the current semantic version is less than this version. The agent will never be reinstalled if this is not set.

Default value: undef

auditd_compatibility_mode

Data type: Boolean

Run the agent in auditd compatibility mode.

Default value: false

manage_auditd

Data type: Boolean

Manage the auditd configuration. This is ignored if auditd_compatibility_mode is false.

Default value: true

https_proxy

Data type: Optional[String]

Proxy host and port to use for communicating with Rapid7 cloud.

Default value: undef