For the complete documentation index, see llms.txt. This page is also available as Markdown.

Connecting to the MIM service

Use Set-ResourceManagementClient to configure the connection before calling other cmdlets. If you do not call it, the client connects to the MIM service on the local computer using default settings.

# Windows PowerShell 5.1, connecting directly to the MIM service
Set-ResourceManagementClient -BaseAddress http://mim-service:5725

# PowerShell 7 on Windows, using the built-in local proxy
Set-ResourceManagementClient -BaseAddress pipe://mim-service

# PowerShell 7 on any platform, using the remote proxy service installed on the MIM server
Set-ResourceManagementClient -BaseAddress rmc://mim-service

Connection modes

The client library supports several connection modes. The mode is selected automatically from the scheme of the address, or you can force one with the -ConnectionMode parameter.

Mode
URI scheme
Works in
Approval operations

DirectWsHttp

http:// (port 5725)

Windows PowerShell 5.1

Supported

DirectNetTcp

net.tcp:// (port 5736)

Both editions, all platforms

Not supported

LocalProxy

pipe://

PowerShell 7 on Windows

Supported

RemoteProxy

rmc:// (port 5735)

Both editions, all platforms

Supported

Windows

On Windows, no setup is needed. Windows PowerShell connects directly to the service, and PowerShell 7 launches a built-in local proxy when given a pipe:// address or a plain hostname.

Linux and macOS

PowerShell 7 on Linux and macOS cannot use the MIM service's default WS-Http endpoint, which relies on components that exist only on .NET Framework. Two connection modes work on these platforms. Choose based on whether you need to run approvals:

  • Remote proxy (rmc://) supports every operation, including approvals, but requires a service to be installed on the MIM server. Use this in most cases.

  • Direct net.tcp (net.tcp://) needs nothing installed on the client and connects straight to the MIM service, but it cannot run approvals. Use this when you cannot install the proxy service and do not need approvals.

Each option has a one-time server-side setup, described below.

Setting up the remote proxy

The remote proxy is a Windows service that runs on the MIM server. The client connects to it over TCP using Negotiate (Kerberos) authentication, and the proxy makes the WS-Http calls to the local MIM service for you. It works from Windows, Linux, and macOS, and supports all operations. On Linux and macOS the client requires .NET 8 or later.

  1. Download the Lithnet Resource Management Client Proxy installer from the releases page.

  2. Run the installer on the MIM server. It registers a Windows service named LithnetRMCProxy running as NT AUTHORITY\NetworkService, and starts it. The service listens on TCP port 5735. See the proxy installation guide for full details, including silent installation.

  3. Allow inbound TCP 5735 through the server firewall.

  4. Authorize the accounts that will connect by adding them to the Lithnet RMC Proxy Users local group on the server. The installer creates this group and seeds it with the local Administrators group. To authorize a different group instead, set the AuthorizedUsers value to that group's SID under HKLM\SYSTEM\CurrentControlSet\Services\LithnetRMCProxy, then restart the service.

Then connect:

The listening port and the local MIM service port can be changed with the ProxyPort and ResourceManagementServicePort registry values under the same key (defaults 5735 and 5725).

The client authenticates to the proxy with the SPN host/hostname, which matches the service's default account. This only needs attention if you change the service to run under a custom account: in that case, pass an SPN held by that account using the -ServicePrincipalName parameter of Set-ResourceManagementClient.

Setting up net.tcp endpoints

The MIM service does not expose net.tcp endpoints by default. Add them to the service configuration on the MIM server. This mode connects directly to the MIM service and needs nothing on the client, but it does not support approvals.

Edit Microsoft.ResourceManagement.Service.exe.config in the MIM Service installation folder on the server. Add these bindings inside <system.serviceModel>:

Add these endpoints to the Microsoft.ResourceManagement.WebServices.ResourceManagementService service:

Then make sure the Net.Tcp Port Sharing Service is running on the MIM server, allow inbound TCP 5736 through the server firewall, and restart the Forefront Identity Manager Service. A complete example is provided with the client as sample.nettcp.config.

Then connect:

More detail

The connection guide covers the automatic mode selection rules, authentication and credential options, timeouts, and the full configuration reference.

Last updated