Stops the management agent that is specified in the Get method. This call is synchronous and blocks any other calls to the specified management agent until this method is completed. To use this method, you must be logged on as a member of the MIISOperators security group or the MIISAdmins security group.

mof
String Stop();

Parameters

None

Name : Stop

Return Value

String

The return value can be one of the following values, or it can be one of the values that are listed in WMI Provider Return Strings.

Name Description

access-denied

The caller is not a member of the MIISAdmins group or the MIISOperators group on the server. Only members of those groups can run management agents.

ma-not-running

The management agent is idle. You cannot call the Stop method to stop a management agent that is idle.

success

The method stopped the management agent.

Remarks

This method stops only the specified management agent. Other running management agents are not affected by a call to this method. The time that is required to stop a management agent depends on the number of affected objects in the synchronization run.

Example

The following example shows how you can use Microsoft Visual Basic Scripting Edition (VBScript) to stop a specified management agent. This example stops the full import run profile of the Fabrikam HR MA management agent.

Visual Basic Script  Copy Code 
Option Explicit
Dim Service
Dim ManagementAgent

Set Service = GetObject("winmgmts:\root\MicrosoftIdentityIntegrationServer")
Set ManagementAgent = Service.Get("MIIS_ManagementAgent.Name='" & "Fabrikam HR MA" & "'")
WScript.Echo "Stop returned '" & ManagementAgent.Stop() & "'"

Requirements

Product

Forefront Identity Manager Synchronization Service 2010

MOF

Mmswmi.mof

See Also