ComputerHealthService Class

 

Applies To: Operations Manager for System Center 2012

Represents an agent that captures information from the computer on which it is running, applies predefined rules to the captured data, and performs actions as defined by the rules.

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

Inheritance Hierarchy

System.Object
  Microsoft.EnterpriseManagement.Common.MonitoringBase
    Microsoft.EnterpriseManagement.Administration.ComputerHealthService
      Microsoft.EnterpriseManagement.Administration.AgentManagedComputer
      Microsoft.EnterpriseManagement.Administration.ManagementServer

Syntax

[SerializableAttribute]
public class ComputerHealthService : MonitoringBase
[SerializableAttribute]
public ref class ComputerHealthService : MonitoringBase
[<SerializableAttribute>]
type ComputerHealthService = 
    class
        inherit MonitoringBase
    end
<SerializableAttribute>
Public Class ComputerHealthService
    Inherits MonitoringBase

Properties

Name Description
System_CAPS_pubproperty ActionAccountIdentity

Gets the name of the user account under which the health service is running.

System_CAPS_pubproperty AuthenticationName

Gets the authentication name used to verify the identity of the health service.

System_CAPS_pubproperty CommunicationPort

Gets the port number that the health service uses to communicate with its primary Management Server.

System_CAPS_pubproperty ComputerName

Gets the NetBIOS name of the host computer on which the health service is running.

System_CAPS_pubproperty CreateListener

Gets a value that indicates whether the health service creates a listening socket.

System_CAPS_pubproperty DisplayName

Gets a descriptive name of the health service.

System_CAPS_pubproperty Domain

Gets the name of the domain in which the health service is running.

System_CAPS_pubproperty HealthState

Gets the current health state of the host computer on which the health service is running.

System_CAPS_pubproperty HeartbeatInterval

Gets or sets a value that indicates the number of seconds between heartbeats generated by the health service.

System_CAPS_pubproperty HostComputer

Gets a MonitoringObject that represents the Windows computer on which the health service is running.

System_CAPS_pubproperty HostedHealthService

Gets a MonitoringObject that represents the health service.

System_CAPS_pubproperty Id

Gets the health service's globally unique identifier (GUID).

System_CAPS_pubproperty InstalledBy

Gets the name of the user who installed the health service.

System_CAPS_pubproperty InstallTime

Gets the time at which the health service was installed.

System_CAPS_pubproperty IPAddress

Gets the IP address of the host computer on which the health service is running.

System_CAPS_pubproperty LastModified

Gets the date and time at which the health service was last modified (as stored in the operational database).

System_CAPS_pubproperty ManagementGroup

The connection management group connection used by this object.

System_CAPS_pubproperty ManagementGroupId

(Inherited from MonitoringBase.)

System_CAPS_pubproperty ManuallyInstalled

Gets a value that indicates whether the health service was manually installed or automatically installed by a Management Server.

System_CAPS_pubproperty MaximumQueueSizeBytes

Gets the maximum size of the health service's send queue, expressed in bytes.

System_CAPS_pubproperty MaximumSizeOfAllTransferredFilesBytes

Gets the maximum size of all files transferred to or from the health service, expressed in bytes.

System_CAPS_pubproperty Name

Gets the name of the health service.

System_CAPS_pubproperty NetworkName

Gets the network name of the computer. The IP address or DNS name will be set to this property to use it for IP connectivity to the computer.

System_CAPS_pubproperty PrincipalName

Gets the fully qualified domain name (FQDN) of the Root Management Server in the Management Group.

System_CAPS_pubproperty ProxyingEnabled

Gets or sets a value that determines whether a proxy is enabled for this object.

System_CAPS_pubproperty RequestCompression

Gets a value that indicates whether the health service requests compression for network communication.

System_CAPS_pubproperty Version

Gets the version number of the health service.

Methods

Name Description
System_CAPS_pubmethod ApplyChanges()

Updates the health service's property values in the Operations Manager database.

System_CAPS_pubmethod Equals(Object)

(Inherited from Object.)

System_CAPS_protmethod Finalize()

(Inherited from Object.)

System_CAPS_pubmethod GetFailoverManagementServers()

Gets the failover Management Servers for the health service.

System_CAPS_pubmethod GetHashCode()

(Inherited from Object.)

System_CAPS_pubmethod GetPrimaryManagementServer()

Gets the primary Management Server for the health Service.

System_CAPS_pubmethod GetRemotelyManagedComputers()

Gets a collection of agentless managed computers monitored by the health service.

System_CAPS_pubmethod GetRemotelyManagedDevices()

Gets a collection of network devices monitored by the health service.

System_CAPS_pubmethod GetType()

(Inherited from Object.)

System_CAPS_pubmethod InsertRemotelyManagedComputers(IList<CreatableEnterpriseManagementObject>)

System_CAPS_pubmethod InsertRemotelyManagedComputers(IList<CustomMonitoringObject>)

Obsolete.Inserts remotely managed computers into the computer health service.

System_CAPS_pubmethod InsertRemotelyManagedDevices(IList<CreatableEnterpriseManagementObject>)

System_CAPS_pubmethod InsertRemotelyManagedDevices(IList<CustomMonitoringObject>)

Obsolete.Inserts remotely managed devices into the computer health service.

System_CAPS_protmethod MemberwiseClone()

(Inherited from Object.)

System_CAPS_pubmethod Reconnect(EnterpriseManagementGroup)

Connects the health service to the specified Management Group.(Overrides MonitoringBase.Reconnect(EnterpriseManagementGroup).)

System_CAPS_pubmethod ResetHeartbeatInterval()

Sets the health service's HeartbeatInterval property to its default value.

System_CAPS_pubmethod ToString()

(Inherited from MonitoringBase.)

Remarks

A health service runs on each Management Server and on each agent-managed computer. A health service can collect information from its host computer, and it can act as a proxy agent that collects information from an agentless-managed computer or network device. A health service collects information using the configuration information provided in installed Management Packs.

You can access ComputerHealthService methods and properties for an agent-managed computer through the derived class AgentManagedComputer.

You can access ComputerHealthService methods and properties for a proxy agent that is managing a remotely managed computer or network device using GetProxyAgent or GetProxyAgent.

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.

See Also

GetComputerHealthServiceByHealthServiceId
Microsoft.EnterpriseManagement.Administration Namespace

Return to top