Installation guide
This page is the reference for installing Maester and the modules its tests use. To go from nothing to your first report, follow Getting started.
Requirements
Section titled “Requirements”- PowerShell 7.4 or later on Windows, Linux or macOS. Windows PowerShell 5.1 is not supported.
- An account that can read your tenant’s configuration, such as Global Reader. See Connect-Maester.
Install Maester
Section titled “Install Maester”PS>Install-Module Maester -AllowPrereleaseInstall-Module MaesterInstalls the 3.0 preview, which these docs describe. About the previewInstalls the stable release, 2.3.0. 2.x docs
The tests ship inside the module, so there is nothing else to download and no folder to set up. The one module
Maester requires, Microsoft.Graph.Authentication, is installed with it.
You need a folder only to change settings or add your own tests. Put a maester-config.json (see
Configuration) and a custom folder for your tests (see
Writing custom tests) in it, and run Invoke-Maester -Path <folder> or run Maester from
that folder.
Upgrading from Maester 2.x? See Upgrading from 2.x.
Update or pin a version
Section titled “Update or pin a version”Update to the latest release (add -AllowPrerelease for the latest preview):
Update-Module MaesterFor scheduled runs, pin a version so that a new release changes your results only when you choose. Read the release notes, then install the version you reviewed:
Install-Module Maester -RequiredVersion <version> -Scope CurrentUserOptional modules and permissions
Section titled “Optional modules and permissions”Connect-Maester connects to Microsoft Graph, which is enough for the Entra ID tests and most of the others. The
tests for the services below need a module or a connection of their own. When one is missing, its tests are
reported as Skipped with the reason, and Connect-Maester shows the command that installs the missing module.
| Service | Module | How to connect | Permissions |
|---|---|---|---|
| Azure, Copilot Studio (Dataverse) | Az.Accounts | Connect-Maester | Azure, Dataverse |
| Exchange Online, Security & Compliance | ExchangeOnlineManagement | Connect-Maester | Exchange Online |
| Microsoft Teams | MicrosoftTeams | Connect-Maester | Teams |
| SharePoint Online | PnP.PowerShell, and an app registration whose client ID you pass with -SharePointClientId | Connect to SharePoint Online | SharePoint Online |
| GitHub | None | Connect to GitHub | The Maester GitHub App, or a token |
| Azure DevOps | ADOPS | Connect to Azure DevOps | Azure DevOps |
| Active Directory | None | Connect-Maester -Service ActiveDirectory, see AD connection troubleshooting |
Install the Microsoft 365 modules in one go:
Install-Module Az.Accounts, ExchangeOnlineManagement, MicrosoftTeams, PnP.PowerShell -Scope CurrentUserThen connect to all of them. GitHub, Azure DevOps and Active Directory are not part of All, so connect to them
separately.
Connect-Maester -Service All -SharePointClientId '<Client ID>'Exchange Online
Section titled “Exchange Online”Exchange Online has its own role-based access control. The Exchange tests need one of these roles:
- View-Only Configuration
- O365SupportViewConfig
The Security & Compliance tests connect with Connect-IPPSSession, which comes with the same
ExchangeOnlineManagement module. For unattended runs, see
Connect-Maester advanced.
Azure DevOps
Section titled “Azure DevOps”The Azure DevOps tests need the Project-Scoped Users role at the organization level, at least. Some need more,
see Connect-Maester advanced. Connect with
Connect-Maester -Service AzureDevOps -AzureDevOpsOrganization <your-organization>, see
Connect to Azure DevOps.
Pester
Section titled “Pester”Maester 3.0 does not need Pester. Install it only if you have custom tests written in the Pester format
(*.Tests.ps1), see Pester-format tests:
Install-Module Pester -MinimumVersion 5.7.1 -SkipPublisherCheck -Force -Scope CurrentUserNext steps
Section titled “Next steps”- Getting started: your first report, and the steps from there to continuous monitoring.
- Connect-Maester: every way to connect, including unattended runs.
- Monitoring with Maester: run Maester on a schedule.