Entra ECMA2Host Tools PowerShell Module

If you’ve ever worked with the ECMA2Host for Entra Outbound Provisioning you’ll be immediately presented with a lack of visibility of the connectors. Especially if you’ve previously used Microsoft / Forefront Identity Manager.

You’ll want to be able to have a simple method to query connector caches (e.g Management Agent Connector Space), see the last events on the connector, invoke events through connectors and much more.

This ECMA2Host Tools PowerShell Module is what you need. It provides a comprehensive set of cmdlets for managing the ECMA2Host service and its connectors, enabling automation of common administrative tasks such as starting/stopping services, monitoring run profiles, and managing connector configurations. in Microsoft Entra ID OnPremises ECMA Application environments.

Features

Service Management: Start, stop, and monitor the ECMA2Host service
Connector Operations: Manage connector lifecycle and status
Run Profile Monitoring: Monitor connector run history and execution status
Configuration Management: Export and import connector configurations
Remote Management: Query service status on remote computers and access remote configuration files via UNC paths or mapped drives

Why Use ECMA2HostTools?

Simplified Authentication: No need to manually manage secret tokens – the module automatically decrypts and retrieves them from your connector configuration
Query Connector Caches: Directly query ECMA2Host connector caches using SCIM protocol without needing Microsoft Entra provisioning service
Real-time Monitoring: Get live connector status, run history, and object counts to monitor provisioning operations
Automation-Ready: Automate connector management, validation, and reporting tasks with PowerShell scripts
Comprehensive Object Access: Retrieve, filter, and analyze connector objects with full attribute access and PowerShell filtering capabilities
Configuration Management: Easily backup, export, import, and restore connector configurations for disaster recovery or environment migrations
Self-Service Diagnostics: Troubleshoot connector issues without requiring access to the ECMA2Host Configuration Wizard

Recommended Installation: PowerShell Gallery

Install directly from the PowerShell Gallery (recommended method):

Install-Module -Name ECMA2HostTools

Or download from GitHub

Download the source code from GitHub:

Visit the repository
Click the green Code button
Select Download ZIP
Extract the ZIP file to a temporary location
Continue with Manual Installation steps below

Requirements

This ECMA2HostTools Module installed on the target system
PowerShell 5.1 or later (PowerShell 7+ supported with automatic fallback for secrets decryption)
Administrator privileges required for service management operations (Start/Stop/Resume)
Appropriate permissions to manage services and connectors
Secret decryption must run on the same machine where ECMA2Host is installed

Available Cmdlets

Name                                 Synopsis
----                                 --------
Backup-ECMA2HostConfiguration        Backs up the complete ECMA2Host configuration.
Export-ECMA2ConnectorConfiguration   Exports an ECMA2 connector configuration.
Get-ECMA2Connector                   Gets ECMA2 connector information.
Get-ECMA2ConnectorObjects            Retrieves objects from an ECMA2 connector cache using SCIM queries.
Get-ECMA2ConnectorRunHistory         Gets the run history for an ECMA2 connector.
Get-ECMA2ConnectorSecret             Decrypts encrypted parameters and secret tokens from ECMA2 connectors.
Get-ECMA2ConnectorStatus             Gets the status of an ECMA2 connector.
Get-ECMA2HostStatus                  Gets the status of the ECMA2Host service.
Import-ECMA2ConnectorConfiguration   Imports an ECMA2 connector configuration.
Invoke-ECMA2ConnectorRequest         Sends a SCIM request (create/update/delete) to an ECMA2 connector.
New-ECMA2ConnectorDocumentation      Generates markdown documentation for ECMA2 connectors.
Restore-ECMA2HostConfiguration       Restores a complete ECMA2Host configuration.
Set-ECMA2Connector                   Updates ECMA2 connector parameters.
Set-ECMA2ConnectorEncryptedParameter Sets an encrypted parameter value for an ECMA2 connector.
Start-ECMA2Host                      Starts the ECMA2Host service.
Stop-ECMA2Host                       Stops the ECMA2Host service.