NMM-PS Documentation¶
Welcome to the NMM-PS documentation - a PowerShell module for automating Nerdio Manager for MSP (NMM) operations.
Unofficial Module
This is an unofficial, community-maintained module created by Nerdio Sales Engineers. It is not officially supported by Nerdio. Use at your own risk. Do not contact Nerdio Support for issues with this module.
-
Quick Install
Install NMM-PS from PowerShell Gallery:
-
Authentication
Connect using client secret or certificate:
-
Cmdlet Reference
Browse all 60+ cmdlets organized by category
-
Open Source
Contribute on GitHub - issues, PRs welcome
Features¶
- 60+ Cmdlets covering accounts, host pools, session hosts, images, users, devices, and more
- Multiple Authentication Methods - Client secret or certificate-based authentication
- Pipeline Support - Chain cmdlets together for powerful automation
- Cross-Platform - Works on Windows, macOS, and Linux with PowerShell 7+
- Auto-Pagination - Handles large result sets automatically
Quick Start¶
# Install the module
Install-Module -Name NMM-PS
# Import the module
Import-Module NMM-PS
# Connect to NMM API
Connect-NMMApi
# List all accounts
Get-NMMAccount
# Get host pools for a specific account
Get-NMMAccount -AccountId 12345 | Get-NMMHostPool
API Coverage¶
NMM-PS covers the following NMM API areas:
| Category | Cmdlets | API Version |
|---|---|---|
| Accounts | Get-NMMAccount |
v1 |
| Host Pools | Get-NMMHostPool, Get-NMMHostPoolSettings, + 10 more |
v1 |
| Session Hosts | Get-NMMHost, Get-NMMHostSchedule |
v1 |
| Desktop Images | Get-NMMDesktopImage, Get-NMMImageTemplate, + 3 more |
v1 |
| Users & Groups | Get-NMMUser, Get-NMMUsers, Get-NMMGroup |
v1 |
| Devices | Get-NMMDevice, Sync-NMMDevice, + 6 more |
v1-beta |
| Backup | Get-NMMBackup, Get-NMMProtectedItem, Get-NMMRecoveryPoint |
v1 |
| Automation | Get-NMMScriptedAction, Get-NMMSchedule, + 3 more |
v1 |
Requirements¶
- PowerShell 7.0+ (PowerShell Core)
- NMM API Access - Valid API credentials from Nerdio Manager
Getting Help¶
- Documentation: You're here!
- GitHub Issues: Report bugs or request features
- PowerShell Help:
Get-Help Connect-NMMApi -Full
Disclaimer¶
Community Project
This module is maintained by Nerdio Sales Engineers on a best-effort basis.
- Unofficial - Not an official Nerdio product
- No warranty - Provided "as-is" without any guarantees
- No SLA - No commitment to response times or fixes
- Community support only - Use GitHub Issues for questions
License¶
NMM-PS is open source software licensed under the MIT license.