Modules

Built in Modules

There are a few modules that are built in. These modules do not need to be enabled in the .env file and are considered core to MunkiReport

Module name	Description	Comment
comment	Comment Module	module to add comments to a machine in the GUI
machine	Machine Module	collects basic facts about the machine that don't change often
reportdata	Report Data Module	collects basic facts about the machine that do change often
tag	Tag Module	module to add tags to a machine in the GUI

Available Modules

Module	Tag	Comment	Availability
applications		Shows information about applications on the client.	> 3.0.0
appusage	munki, large_db	Requires Munki 3 and above or crankd to monitor application usage
ard		Shows ARD text fields and info. Rewritten to collect more information
backup2go	app_specific
bluetooth		Connected Bluetooth devices and battery state
caching
certificate
crashplan	app_specific
detectx	app_specific	Pulls data from DetectX results json.	> 3.0.0
devtools	developer	Details information about the development tools on the Mac.	> 3.2.0
directory_service	app_specific	Directory service binding type and status
disk_report	default	Default module. Connected drive type, size, and OS SMART status
displays_info		Connected display info
event		Dashboard widget showing client messages
extensions		Dashboard widget showing client messages	> 3.1.0
fan_temps	large_db	Fan speeds and thermal sensor temperatures
filevault_escrow	escrow
filevault_status
findmymac
firewall		Reports back on how the firewall is configured.
firmware_escrow	escrow
fonts	large_db
gpu		Video card information
homebrew	developer, app_specific
homebrew_info	developer, app_specific
ibridge		Details information about the iBridge in the Mac. (Apple T-Series chips)	> 3.2.3
installhistory	large_db	Apple and 3rd party install history
inventory
laps	app_specific, escrow	Implementation of macOSLAPs
location	app_specific	Requires external pinpoint project
managedinstalls	default, munki	Default module. munki managed installs info
mbbr_status	app_specific	Provides activation information for clients using Malwarebytes Breach Remediation's CLI tool, MBBR.
mdm_status		Provides information about the MDM and DEP status of machines	> 4.0.2
munki_facts	munki	Provides the results of munki conditions, allowing admins to easily generate their own reportable datapoints without creating custom MunkiReport modules.	> 3.0.0
munkiinfo	munki	munki client configuration info
munkireport	default, munkireport	Default module. Provides info about munki
munkireportinfo	munkireport
network		The networking module references the WiFi module in a few places. It is recommended to enable the WiFi module as well if Network is used.
network_shares
power
printer		Rewritten to collect more information
profile
sccm_status	app_specific
security
sentinelone	app_specific		> 3.2.0
sentinelonequarantine	app_specific		> 3.2.0
smart_stats	app_specific	Requires 3rd party smartmontools, rewritten in Python for faster more reliable operation
softwareupdate
sophos	app_specific		> 3.2.0
supported_os		Lists the highest supported OS version for a machine	> 5.5.0
timemachine
usage_stats	large_db	Presents information about network, disk, CPU, and GPU activity. This module is only supported on 10.10 and higher.	> 3.0.0
usb
users		Collects data on user accounts, replaces localadmin module	> 5.4.1
user_sessions		Gathers logins, logout, shut downs, and reboots on the client computer.
warranty
wifi		Rewritten to collect more WiFi information

Unofficial/Beta Modules

Unofficial modules are modules written by the community that are in need of testing or are in process of being written/updated. Admins are encouraged to install in development environments to test. For more information on installing custom modules, see Adding Custom Modules.

Module	Tag	Comment	Availability	Creator
crowdstrike	app_specific	Gets data about CrowdStrike Falcon sensors that are on the clients	Packagist	dcoobs
bees	fun	Bees?	Packagist	Tuxudo
browser_extensions		Browser Extensions module	Packagist	Tuxudo
extension_attributes		Extension Attributes module	Packagist	Tuxudo
geekbench	app_specific	Pulls geekbench data about the machine.	Packagist	Ofir Gal/Tuxudo
icloud		Gets data about iCloud accounts that are on the clients.	Packagist	Tuxudo
ios_devices		Gets data about iOS devices that have been connected to the client.	Packagist	Tuxudo
launchdaemons		Gets data about Launch Daemons and Launch Agents	Packagist	Tuxudo
jamf	app_specific	Jamf integration for MunkiReport.	Packagist	Tuxudo
jamf_protect	app_specific	Jamf Protect integration for MunkiReport.	Packagist	jc0b
kandji	app_specific	Kandji integration for MunkiReport.	Packagist	jc0b
kernel_panics		Collects kernel panic, iBridge crashed, and GPU resets from client devices.	Packagist	Tuxudo
manifests	munki	Extended info on the Munki manifests for a given machine.	Packagist	joncrain
memory		Provides information about installed memory.	Packagist	Tuxudo
ms_defender	app_specific	Gets data about Microsoft Defender on the clients.	Packagist	Tuxudo
ms_office	app_specific	Gets data about MS Office applications, licensing, and updates on the clients.	Packagist	Tuxudo
nomad	app_specific	Gets data about NoMAD applications, and settings on the clients.	Packagist	Tuxudo
nudge	app_specific	Gets data about Nudge runs and config.	Packagist	Tuxudo
pci		Provides the status of PCI devices.	Packagist	Ofir Gal/Tuxudo
snowagent	app_specific	Reports on the Snow Software agent	Packagist	Tuxudo
system_version		Sends the SystemVersion.plist from /System/Library/CoreServices/ for processing	Packagist	Tuxudo
tcc		Gathers config of client's TCC	Packagist	Tuxudo
teamviewer		Requires TeamViewer 10 or higher to be installed and configured on the client.	Packagist	Tuxudo
time		Extended information about time setup.	Packagist	joncrain
thunderbolt		Provides the status of Thunderbolt devices.	Packagist	Tuxudo
touch_id		Provides the status of Touch ID enrollments.	Packagist	Tuxudo

Deprecated Modules

Deprecated modules are ones that have been removed from supported first party modules either because they've been replaced, they are outdated, or the API the reference is non-functional. They may be supported again, but currently only get the most basic of bug and compatibility fixes.

Module	Note	Comment
deploystudio	DeployStudio has been end of lifed and is not supported on modern Macs	Requires DeployStudio server
gsx	GSX API changes to REST, module uses older SOAP based API	Requires GSX account with Apple.
localadmin	Replaced by users module	Lists local admins configured on the client
servermetrics		macOS Server specific
service		macOS Server specific
mbp15_battery_repair_program	Warranty Extension Program Specific	Checks for computers eligible for the MPB Battery Repair Program
ssd_service_program	Warranty Extension Program Specific	Checks for computers eligible for the SSD Service Program

Recommended Configs

We've grouped the modules together by category below. To get started with a general overview of the security and overall footprint of clients, these modules are recommended.

### Recommended Base Set:
MODULES='applications, ard, bluetooth, caching, certificate, disk_report, displays_info, extensions, filevault_status, findmymac, firewall, gpu, ibridge, inventory, mdm_status, munkireport, munkireportinfo, network, network_shares, power, printer, profile, security, softwareupdate, supported_os, timemachine, usb, users, user_sessions, warranty, wifi, event, managedinstalls, munki_facts, munkiinfo'

### Large DB Modules: add these if you want specific insights into these categories
appusage, fan_temps, fonts, installhistory, usage_stats

### Munki Specific Modules: these can be removed if you are not using Munki
appusage, event, managedinstalls, munki_facts, munkiinfo, manifests

### Developer Specific Modules: related to supporting developer machines
devtools, homebrew, homebrew_info

### Escrow Tools: These tools escrow security information into MunkiReport
filevault_escrow, firmware_escrow, laps

### App Specific Modules: These modules are built for specific apps, 
### or have other requirements
backup2go, crashplan, detectx, directory_service, homebrew, homebrew_info, laps, location, mbbr_status, sccm_status, sentinelone, sentinelonequarantine, sophos, crowdstrike, geekbench, jamf, ms_office, snowagent, ms_defender, nomad