ConnectorFrameworkProxy Class

Article
12/03/2015

Applies To: Operations Manager for System Center 2012

Used for building monitoring connector applications that synchronize data in System Center Operations Manager 2007 with other management applications. The ConnectorFrameworkProxy class provides methods to register and initialize a monitoring connector.

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

Inheritance Hierarchy

System.Object
Microsoft.EnterpriseManagement.ConnectorFramework.ConnectorFrameworkProxy

Syntax

public class ConnectorFrameworkProxy : IDisposable

public ref class ConnectorFrameworkProxy : IDisposable

type ConnectorFrameworkProxy = 
    class
        interface IDisposable
    end

Public Class ConnectorFrameworkProxy
    Implements IDisposable

Constructors

	Name	Description
	ConnectorFrameworkProxy(String)	Initializes a new instance of the ConnectorFrameworkProxy class, associated by name, by examining the configuration file for the running process and using the specified configuration.
	ConnectorFrameworkProxy(String, String)	Initializes a new instance of the ConnectorFrameworkProxy class, associated by name, by examining the configuration file for the running process and using the specified configuration and language settings.
	ConnectorFrameworkProxy(Uri)	Initializes a new instance of the ConnectorFrameworkProxy class, connecting to the specified Uniform Resource Identifier (URI) with default settings.
	ConnectorFrameworkProxy(Uri, EndpointIdentity)	Initializes a new instance of the ConnectorFrameworkProxy class, connecting to the specified Uniform Resource Identifier (URI) with default settings and using the specified endpoint identity.

Properties

	Name	Description
	Channel	Gets the communication channel used by the monitoring connector.
	IsConnected	Gets a value indicating whether the monitoring connector's channel is connected to an Operation Manager server.

Methods

	Name	Description
	AcknowledgeMonitoringAlerts(Guid, DateTime)	The monitoring connector acknowledges that it has successfully received monitoring alerts from the ConnectorFrameworkProxy. It acknowledges alerts that occur until the given bookmark time.
	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 that occur until the given bookmark time. The failures that occurred for the configured tiers are returned.
	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 that occur until the given bookmark time. The failures that occurred for the configured tiers are returned.
	Cleanup(Guid)	Deletes the specified monitoring connector.
	Dispose()	Immediately releases the unmanaged resources used by the ConnectorFrameworkProxy object.
	Equals(Object)	(Inherited from Object.)
	Finalize()	(Inherited from Object.)
	GetConnectorBookmark(Guid)	Gets the bookmark for the specified monitoring connector.
	GetConnectorState(Guid)	Gets the state of the specified monitoring connector.
	GetGlobalConfiguration()	Gets the global configuration settings for the Management Group.
	GetHashCode()	(Inherited from Object.)
	GetMonitoringAlertHistoryByAlertIds(Guid, Guid[])	Gets the alert history for the specified monitoring connector and the specified alerts.
	GetMonitoringAlerts(Guid)	Gets alerts marked for the monitoring connector.
	GetMonitoringAlertsByIds(Guid, Guid[])	Gets the specified alerts that are marked for the monitoring connector.
	GetMonitoringAlertsForTiers(Guid, 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.
	GetMonitoringAlertsWithBatchSize(Guid, Int32)	Gets alerts marked for the monitoring connector.
	GetMonitoringAlertsWithBatchSizeForTiers(Guid, Int32, ConnectorTieredOperationFailure[])	Gets alerts marked for the monitoring connector for all configured management tiers. The failures that occurred for the configured tiers are returned.
	GetMonitoringAlertsWithBookmark(Guid, 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.
	GetMonitoringAlertsWithBookmarkForTiers(Guid, 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.
	GetMonitoringAlertsWithBookmarkWithBatchSize(Guid, DateTime, Int32)	Gets alerts for the specified monitoring connector. You also specify a timestamp bookmark, and all alerts with a timestamp after the bookmark will be returned.
	GetMonitoringAlertsWithBookmarkWithBatchSizeForTiers(Guid, DateTime, Int32, ConnectorTieredOperationFailure[])	Gets alerts for the specified monitoring connector for all the management tiers. 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.
	GetType()	(Inherited from Object.)
	Initialize(Guid)	Initializes the monitoring connector that is required to get alerts by calling GetMonitoringAlerts.
	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.
	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.
	InitializeWithBookmarkForTiers(Guid, DateTime, ConnectorTieredOperationFailure[])	Initializes the monitoring connector that is required to get alerts by calling GetMonitoringAlertsForTiers 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.
	InsertMonitoringEvents(Guid, Guid, CustomMonitoringEvent[])	Inserts events for the given monitoring object.
	InsertMonitoringPerformanceData(Guid, Guid, CustomMonitoringPerformanceData[])	Inserts performance data for the given monitoring object.
	MemberwiseClone()	(Inherited from Object.)
	Reconnect()	Reconnects the ConnectorFrameworkProxy object to the management server after it has been disconnected from the server.
	Setup(ConnectorInfo)	Sets up a new monitoring connector with the specified ConnectorInfo information and returns the monitoring connector identifier.
	SetupWithConnectorId(ConnectorInfo, Guid)	Sets up a new monitoring connector with the specified ConnectorInfo information using the specified connectorId.
	ToString()	(Inherited from Object.)
	Uninitialize(Guid)	Uninitializes the monitoring connector, which will prohibit getting any alerts when the GetMonitoringAlerts. is called.
	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.
	UpdateMonitoringAlerts(Guid, String, ConnectorMonitoringAlert[])	Updates the alerts, including the alert history, to the System Center Operation Manager. The comments are part of the alert history.

Remarks

This class is the public interface for the Microsoft.EnterpriseManagement.ConnectorFramework. The ConnectorFrameworkProxy class is used for building applications through the Web Service interface of the Operation Manager Connector Framework. The ConnectorFrameworkProxy class is derived from methods within the Microsoft.EnterpriseManagement.ConnectorFramework namespace.

The recommended mechanisms for connector-related tasks are the ConnectorFrameworkAdministration and MonitoringConnector classes. The ConnectorFrameworkProxy call performs some of the same work as the ConnectorFrameworkAdministration and Microsoft.EnterpriseManagement.ConnectorFramework.MonitoringConnector classes, but uses a different port to the Operation Manager and is more limited.

The calling process for the ConnectorFrameworkProxy must be run under an account that is a member of the Operations Manager Administrator user role.

Instances of this class can be run only on machines running Microsoft Windows.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Share via