IConnectorFramework Interface

 

Applies To: Operations Manager for System Center 2012

Defines the methods to register and initialize a connector and to monitor its communication channel and state after it has begun sending data.

Namespace:   Microsoft.EnterpriseManagement.ConnectorFramework
Assembly:  Microsoft.EnterpriseManagement.OperationsManager (in Microsoft.EnterpriseManagement.OperationsManager.dll)

Syntax

[ServiceContractAttribute(SessionMode = SessionMode.Allowed, 
    Namespace = "https://www.microsoft.com/EnterpriseManagement/ConnectorFramework")]
public interface IConnectorFramework
[ServiceContractAttribute(SessionMode = SessionMode::Allowed, 
    Namespace = "https://www.microsoft.com/EnterpriseManagement/ConnectorFramework")]
public interface class IConnectorFramework
[<ServiceContractAttribute(SessionMode = SessionMode.Allowed,
    Namespace = "https://www.microsoft.com/EnterpriseManagement/ConnectorFramework")>]
type IConnectorFramework = interface end
<ServiceContractAttribute(SessionMode := SessionMode.Allowed,
    Namespace := "https://www.microsoft.com/EnterpriseManagement/ConnectorFramework")>
Public Interface IConnectorFramework

Methods

Name Description
System_CAPS_pubmethod AcknowledgeMonitoringAlerts(Guid, DateTime)

The monitoring connector acknowledges that it has successfully received monitoring alerts from the ConnectorFrameworkProxy. Acknowledges alerts up until the given bookmark.

System_CAPS_pubmethod AcknowledgeMonitoringAlertsForSpecificTiers(Guid, DateTime, String[], ConnectorTieredOperationFailure[])

The monitoring connector acknowledges that it has successfully received monitoring alerts from the ConnectorFrameworkProxy for the specific Management Groups. It acknowledges alerts up until the given bookmark. The failures that occurred for the configured tiers are returned.

System_CAPS_pubmethod AcknowledgeMonitoringAlertsForTiers(Guid, DateTime, ConnectorTieredOperationFailure[])

The monitoring connector acknowledges that it has successfully received monitoring alerts from the ConnectorFrameworkProxy for all tiered Management Groups. It acknowledges alerts up until the given bookmark. The failures that occurred for the configured tiers are returned.

System_CAPS_pubmethod Cleanup(Guid)

Deletes the specified monitoring connector.

System_CAPS_pubmethod GetConnectorBookmark(Guid)

Gets the bookmark for the specified monitoring connector.

System_CAPS_pubmethod GetConnectorState(Guid)

Gets the state of the specified monitoring connector.

System_CAPS_pubmethod GetGlobalConfiguration()

Gets the global configuration settings for the Management Group.

System_CAPS_pubmethod GetMonitoringAlertHistoryByAlertIds(Guid, Guid[])

Gets the alert history for the specified monitoring connector and the specified alerts.

System_CAPS_pubmethod GetMonitoringAlerts(Guid, String)

Gets alerts marked for the monitoring connector.

System_CAPS_pubmethod GetMonitoringAlertsByIds(Guid, Guid[], String)

Gets the specified alerts that are marked for the monitoring connector.

System_CAPS_pubmethod GetMonitoringAlertsForTiers(Guid, String, ConnectorTieredOperationFailure[])

Gets alerts marked for the monitoring connector from the current Management Group as well as from any additional tiers that are configured for this connector. The failures that occurred for the configured tiers are returned along with the alerts.

System_CAPS_pubmethod GetMonitoringAlertsWithBatchSize(Guid, String, Int32)

Gets alerts marked for the monitoring connector. The returned array is limited to the batchSize parameter.

System_CAPS_pubmethod GetMonitoringAlertsWithBatchSizeForTiers(Guid, String, Int32, ConnectorTieredOperationFailure[])

Gets alerts marked for the monitoring connector for all configured management tiers. The returned array is limited to the batchSize parameter. The failures that occurred for the configured tiers are returned.

System_CAPS_pubmethod GetMonitoringAlertsWithBookmark(Guid, String, DateTime)

Gets alerts marked for the monitoring connector. You also specify a timestamp bookmark, and all alerts with a timestamp after the bookmark will be returned.

System_CAPS_pubmethod GetMonitoringAlertsWithBookmarkForTiers(Guid, String, DateTime, ConnectorTieredOperationFailure[])

Gets alerts marked for the monitoring connector for each tiered Management Group. You also specify a timestamp bookmark, and all alerts with a timestamp after the bookmark will be returned. The failures that occurred for the configured tiers are returned.

System_CAPS_pubmethod GetMonitoringAlertsWithBookmarkWithBatchSize(Guid, String, DateTime, Int32)

Gets alerts marked for the monitoring connector. The returned array is limited to the batchSize parameter.

System_CAPS_pubmethod GetMonitoringAlertsWithBookmarkWithBatchSizeForTiers(Guid, String, DateTime, Int32, ConnectorTieredOperationFailure[])

Gets alerts marked for the monitoring connector for all configured management tiers. The returned array is limited to the batchSize parameter. The failures that occurred for the configured tiers are returned.

System_CAPS_pubmethod Initialize(Guid)

Initializes the monitoring connector that is required to get alerts by calling GetMonitoringAlerts.

System_CAPS_pubmethod InitializeForTiers(Guid, ConnectorTieredOperationFailure[])

Initializes the monitoring connector that is required to get alerts by calling GetMonitoringAlertsForTiers for all tiered Management Groups. The failures that occurred for the configured tiers are returned.

System_CAPS_pubmethod InitializeWithBookmark(Guid, DateTime)

Initializes the monitoring connector that is required to get alerts by calling GetMonitoringAlertsWithBookmark and sets the BookMark time to a specified date and time.

System_CAPS_pubmethod InitializeWithBookmarkForTiers(Guid, DateTime, ConnectorTieredOperationFailure[])

Initializes the monitoring connector that is required to get alerts by calling GetMonitoringAlertsWithBookmarkForTiers and sets the BookMark time to a specified date and time, for all tiered Management Groups. The failures that occurred for the configured tiers are returned.

System_CAPS_pubmethod InsertMonitoringEvents(Guid, Guid, CustomMonitoringEvent[])

Inserts events for the given monitoring object.

System_CAPS_pubmethod InsertMonitoringPerformanceData(Guid, Guid, CustomMonitoringPerformanceData[])

Inserts performance data for the given monitoring object.

System_CAPS_pubmethod Setup(ConnectorInfo)

Sets up a new monitoring connector with the specified ConnectorInfo information and returns the monitoring connector identifier.

System_CAPS_pubmethod SetupWithConnectorId(ConnectorInfo, Guid)

Sets up a new monitoring connector with the specified ConnectorInfo information using the specified connectorId.

System_CAPS_pubmethod Uninitialize(Guid)

Uninitializes the monitoring connector, which will prohibit getting any alerts when the GetMonitoringAlerts is called.

System_CAPS_pubmethod UninitializeForTiers(Guid, ConnectorTieredOperationFailure[])

Uninitializes the monitoring connector for all tiered Management Groups, which will prohibit getting any alerts when the GetMonitoringAlertsForTiers is called. The failures that occurred for the configured tiers are returned.

System_CAPS_pubmethod UpdateMonitoringAlerts(Guid, String, ConnectorMonitoringAlert[])

Updates the specified alerts.

Remarks

The ConnectorFrameworkProxy class exposes public implementations for the IConnectorFramework interface members and is used for building monitoring connector applications that synchronize data in System Center Operations Manager 2007 with other management applications.

See Also

Microsoft.EnterpriseManagement.ConnectorFramework Namespace

Return to top