Set-ResourceManagementClient
Description
The Set-ResourceManagementClient cmdlet controls how the module connects to the FIM/MIM service. Call it before using other cmdlets to connect to a remote service, use alternate credentials, or select a specific connection mode. If it is not called, the client connects to the service on the local computer using default settings.
The connection mode is selected automatically from the scheme of the -BaseAddress URI, or can be forced with the -ConnectionMode parameter. See Connecting to the MIM service for an overview of the modes, and the connection guide for the server-side setup steps.
Syntax
Set-ResourceManagementClient [-BaseAddress] <string> [[-Credentials] <PSCredential>] [[-ServicePrincipalName] <string>]
[-ConnectionMode <ConnectionMode>] [-RefreshSchema] [-UsernamePassthrough] [-ConcurrentConnectionLimit <int>]
[-ConnectTimeoutSeconds <int>] [-ReceiveTimeoutSeconds <int>] [-SendTimeoutSeconds <int>]Parameters
BaseAddress
Required. The address of the resource management service, for example http://mim-service:5725. A plain hostname is treated as http://hostname:5725. The URI scheme selects the connection mode unless the -ConnectionMode parameter is specified: http:// connects directly to the service (Windows PowerShell only), net.tcp:// connects to the service's net.tcp endpoint, pipe:// launches the built-in local proxy (PowerShell 7 on Windows), and rmc:// connects to the Lithnet Resource Management Proxy service on the MIM server
Credentials
Optional. By default, the credentials of the currently logged on user are used. Other credentials can be specified using this parameter
ServicePrincipalName
Optional. Overrides the service principal name used for authentication. The default is FIMService/hostname, which identifies the MIM service. In RemoteProxy mode the SPN identifies the proxy service instead, and defaults to host/hostname, matching the proxy service's default account; only override it there if the proxy service runs under a custom account
ConnectionMode
Optional. Forces a specific connection mode, overriding the automatic selection based on the URI scheme and runtime. Valid values are Auto, DirectWsHttp, DirectNetTcp, LocalProxy, and RemoteProxy. The default is Auto. Approval operations are not supported in DirectNetTcp mode, and DirectWsHttp is only available in Windows PowerShell
RefreshSchema
Optional. Forces the client to reload the service schema after the connection is established
UsernamePassthrough
Optional. Passes the username to the service exactly as supplied. By default on non-Windows platforms, the domain suffix of a user principal name is converted to uppercase to match the expected Kerberos realm format
ConcurrentConnectionLimit
Optional. The maximum number of concurrent connections the client can open to the service. If not specified, the client default is used
ConnectTimeoutSeconds
Optional. The connection timeout, in seconds. If not specified, the client default of 30 seconds is used
ReceiveTimeoutSeconds
Optional. How long the client waits for a response from the service, in seconds. Increase this value for long-running operations such as large exports. If not specified, the client default of 20 minutes is used
SendTimeoutSeconds
Optional. How long the client waits for a request to be sent to the service, in seconds. If not specified, the client default of 20 minutes is used
Examples
Last updated