Skip to content
CA Client Automation - 14.0
Documentation powered by DocOps

How to Configure and Monitor the CA Client Automation Infrastructure Health

Last update January 4, 2017

As an administrator, your responsibilities include managing the health of CA Client Automation components. The Health Monitoring (HM) feature provides a health inspection mechanism to:

  • Define CA Client Automation health conditions
  • Monitor the infrastructure periodically
  • Raise an alert when a defined condition is detected
  • Notify the administrator by sending an email, raising an SNMP trap, and writing to Windows/CCS event logs.
  • Configure alert remediation

Use the HM feature to improve the CA Client Automation availability and resiliency. You can accomplish the following tasks:

  • Configure Alerts
    Configure the available alerts or define new alerts.
  • Configure Alert Actions
    Configure alert actions such as sending emails, raising SNMP traps, writing to the system, and writing to the CCS event log.
  • Manage Alerts
    View, track, follow up, and clear alerts from WAC.

Verify Prerequisites

Before you configure and monitor the HM alerts, ensure that you:

  • Have a working knowledge of the CA Client Automation infrastructure
  • Understand the HM architecture and basics
  • Install the Alert Collector

Understand HM Architecture and Basics

The following diagram shows the components of the HM feature and how they interact to monitor the health of CA Client Automation:

Health Alert Infrastructure

For more information about the HM basics, see

Alerts and Alert Templates

The HM feature monitors the following alert types:

  • Parameterized Alerts (Alert Templates):
    Supports additional parameters as part of the alert definition. You can customize alert properties such as the monitoring frequency, threshold, and severity based on the values that are set for those parameters. Defining and configuring the parameterized alerts is supported through Alert Templates. 
    An alert template provides a default definition of a parameterized alert with a list of supported parameters. Use the template as the basis for one or more alerts with different parameter values and associated configurations.
  • Non-parameterized or Plain Alerts (Alerts): 
    Supports no additional parameters. Use the alert properties as defined in the system.

The HM feature provides out-of-the-box alert templates and alerts. You can also base customized templates and alerts on DM Script. For a list of Alerts and Alert Templates, see the user interface.

Health Monitoring Components

The HM feature introduces the following components:

  • HM Agent:

A persistent module that is installed with the common agent and resides on all the tiers of the CA Client Automation infrastructure.

  • Interprets the alert configuration on the agents, periodically monitors the occurrence of the alert conditions, and notifies the administrator on detecting the health conditions.

    Alert monitoring is disabled by default. To enable health monitoring, apply a configuration policy.
  • Provides the following command-line options for interaction:

    hmagent start 
    hmagent stop 
    hmagent status 
    

    Starts the HM agent.
    Stops the HM agent.
    Displays whether the agent is running and health monitoring is enabled.

  • The HM agent is a service on Windows platforms and a daemon on Linux and UNIX platforms.
  • Alert Collector:

Alert Collector comprises the following modules:

  • Web Module
    Receives the alerts from the HM agent and copies them to a configured folder.
  • Persistent Module
    Monitors the configured folder and processes new alerts according to the configured alert collector role. For more information, see Configure Alert Collector.

The alert collector has the following requirements:

  • The alert collector is only supported on Windows.
  • IIS installation is a prerequisite.
  • Ensure that the ISAPI extensions and ISAPI filters available under the Application Development option are installed.
  • Depending on the DB type to which the alert collector persists the alerts, 32-bit SQL or the Oracle client must be installed.

The Web Module application hosts HM web services on IIS. This web service is independent of the existing CA Client Automation web services functionality and runs in a separate application pool.

The administrator can start, stop, and query the status of the alert collector process from the supported command line. Alert Collector supports the command line options similar to the HM agent.

Whenever the FIPS mode is changed, verify the associated Change Action parameter value. If the parameter value is other than Reboot the machine, after the CAF restart you must also restart the following ones to switch the FIPS mode successfully for all the CA Client Automation components:

On a Manager or standalone Alert Collector computer:

  • Alert collector
  • Health Monitoring Agent

On a scalability server or agent computer:

  • Health Monitoring Agent
  • Alerts on WAC:
    DSM Explorer displays a notification when new alerts are raised. The notification contains a hyperlink that launches WAC and navigates to the Alerts page when the unified login is enabled for WAC. If the unified login is not enabled, enter the appropriate user credentials to navigate to the alerts page.

External Process Manager (CAF Plug-in)

This plug-in (named cfProcessManager) manages external processes such as HM Agent and Alert Collector. The plug-in functionality is similar to CAF, where CAF manages the CA Client Automation-conformant plug-ins but Process Manager manages external processes that are not CAF plug-ins.

The external processes that cfProcessManager manages support the regular CAF plug-in properties such as Maxinstances, Maxrestarts, Restartifdied, Enabled, and Maxrestarttime. The behavior of these properties is similar to that of CAF plug-ins.

The following additional properties are supported:

  • Startwithcaf
    Defines the process to start when CAF starts.
    Default: Do not start with CAF.
  • Stopwithcaf
    Defines the process to stop when CAF stops. 
    Default: Do not stop with CAF.
  • Commandline
    Indicates Command line of the process.
  • Startcmd
    Defines the start command. 
    Default: start.
  • Stopcmd
    Defines the stop command. 
    Default: stop.
  • Statuscmd
    Defines the status command. 
    Default: status.
Restart cfProcessManager when you change the above settings.

A new /EXT option is introduced to work with the CAF start and stop commands.

Caf start /EXT

Starts all plug-ins and the enabled external processes that Process Manager manages.

  • Caf stop /EXT 
    Stops all plug-ins and the enabled external processes that Process Manager manages.

The Caf status cfProcessManager command shows the status of the external processes.

Alert Remediation

On detection of a particular alert condition, you can associate a remedial action to resolve the problem on the machine. Specify one of the following remedial actions:

  1. Default actions
  2. Script-based actions

Configure Alerts and Alert Templates

You can monitor the health of CA Client Automation components like DM, EM, SS, and Agent. Create an alert or alert template specifying severity, threshold, and frequency values.

Follow these steps:

  1. Navigate to Control Panel, Configuration, Configuration Policy, DSM, Health Monitoring, and Alert Configuration.
  2. Configure the following entities:
    • Alerts
      Configures the alert parameters such as frequency, threshold, severity of the predefined alerts, and create alerts based on templates or create DM script-based alerts.
    • Alert Templates
      Configures the parameters of the pre-defined alert templates and create templates based on DM script.

An alert or alert template is now defined.

Configure Alerts

Follow these steps:

  1. Navigate to Control Panel, Configuration, Configuration Policy, DSM, Health Monitoring, Alert Configuration, and Alerts.
  2. Select Add to create an alert based on a template or a script.
  3. Specify suitable values for the following fields:
    • Alert Name
      Specifies the name of the alert.
    • Template
      Specifies the alert template name from which the alert is derived.

      Select a template from the drop-down list to create a template-based alert. For example, Asset Jobs not Updated.
    • Script
      Specifies the script name for script-based alerts.
    • Parameters 
      Specifies the parameters suitable to the alert.

      When the alert is derived from a template, the template parameters are carried over from the template. For example,

      GROUPS=ComputerGroups;RequiredPercentage=MINPERCENT;IncludeLinkedAssetJobs=TRUE;IncludeLinkedGroupJobs=TRUE;assetJobNames=% 
      You can also specify parameters for script-based alerts.
    • Message
      Defines the alert-related information that is evaluated when an alert condition is detected. This evaluated information is passed as part of the alert raised by HM Agent. For example,

      Less than $PERCENTAGE of the computers reported the asset job results from within the computer group $GROUPS
      
    • Severity
      Configures the severity of the alert from the drop-down list.
    • Enable
      Specifies the state of the alert. When set to True, the alert is monitored by the HM agent otherwise excluded from monitoring.
    • Detection Tiers
      Specifies the tiers on which the alert is detected. For example, EM, DM, SS, and Agent.

      For predefined alerts, select the tiers from the supported list. For template-based alert, select a tier from the template-supported ones.
    • Frequency
      Specifies the interval at which the alert is monitored. You can specify the frequency in minutes, hours or days for each detected tier.
    • Threshold 
      Specifies the threshold value. This value indicates the minutes/hours/days an alert condition is present, or the number of times an alert condition occurs before raising an alert.
      For example, when you configure Agent not able to communicate to SS with a frequency of one hour and a threshold of six hours on the Agent tier, the HM Agent checks every one hour to see if the agent is able to communicate to the remote scalability server. On failure to communicate for six hours, an alert is raised.
    • Remediation
      Identifies the remediation methods for the alert.
      • hmStartCaf.dms
        Starts the CAF service.
      • hmRepairWinAgent.dms
        Repairs the components that are specified under Parameters. The agents must be staged on Scalability server. (available for Windows only).
    • Parameters
      Specifies the component(s) on which remediation is required. For example, for hmRepairWinAgent.dms, you can specify AM, SD, RC, and ALL that require repair as remediation. Specify combinations of AM, SD, RC, and ALL with comma separated list.

      In case of hmRepairWinAgent.dms, you must configure the following parameters before applying the policy to the agent.
  4. (Optional) Click Check to verify the values.
  5. Click Apply and OK
    The alert is now configured.

Create DM Script-based Alerts

You can create custom alerts based on DM Script. Deploy the script to Script Directory, which is configured at Configuration Policy, DSM, Health Monitoring, Health Monitoring Agent, ScriptDir, on the agent machines before applying the configuration related to these alerts.

Follow these steps:

  1. Navigate to Control Panel, Configuration, Configuration Policy, DSM, Health Monitoring, Alert Configuration, and Alerts.
  2. Select Add to create an alert based on a script and leave the template name field empty.
  3. Specify the DM script name that is deployed to the agent machines.
  4. Specify the parameters in the Parameters fields.
  5. In the message field, add any text related to the alert (have parameters if needed).
  6. Set other alert parameters and apply to the agents for monitoring.

DM Script Alert Example:

The following DM script reports the presence or absence of alert condition to the HM agent by invoking hmAlertOPFormatter. For example,

'Do your alert condition checking here.
'...
' At bottom of your DM script, execute hmAlertOPFormatter
' to create the alert XML output.
dim ret as integer
ret = Exec("hmAlertOPFormatter.exe alertconditionexist=1 raisealertnow=1 ""param1=" + argv(1)  + ",param2=" + argv(2) + """ additionalinfo=this is some additional text for script with Args", true)
print "hmAlertOPFormatter.exe: " + str(ret)

To create an XML file for HM Agent to process when invoked for monitoring alerts, execute the following command in the DM script:

hmAlertOPFormatter executable
   hmAlertOPFormatter.exe alertconditionexist=0|1 [raisealertnow=0|1] [PARAM1=data1,PARAM2=data2,..,PARAMX=datax] [additional info=Additional Info]
   alertconditionexist=0|1

Use value 0 when your DM script has not determined any alert condition. Use value 1 when your script has determined an alert condition.

raisealertnow=0|1
PARAM1=data1,PARAM2=data2 .. PARAMX=datax  -  
additionalinfo=<Additional Info> 

(optional) the default value is 0. Use value 1 to raise the alert immediately.

(optional) These key value pairs indicate the parameters and values in the alert message. The sequence of key value pairs is separated by a comma (,) where keys and values are separated by an equal sign (=).

(optional) This parameter is the last one on the command line. All the rest of the command line after equal sign (=) is accumulated together as one field of resulting alert XML.

Create Remediation Script Using DM Script

You can create custom remediation scripts based on DM Script. Deploy the script to Script Directory, which is configured at Configuration Policy, DSM, Health Monitoring, Health Monitoring Agent, ScriptDir, on the agent machines before configuring alerts to use this remediation script.

Follow these steps:

  1. Navigate to Control Panel, Configuration, Configuration Policy, DSM, Health Monitoring, Alert Configuration, and Alerts.
  2. Select any alert to which you want to configure remediation action.
  3. Under the remediation section of the alert, specify the DM script name that is deployed to the agent machines.
  4. Specify the parameters in the Parameters fields.
  5. In the message field, add any text related to the alert (have parameters if needed).
  6. Set other alert parameters and apply to the agents for monitoring.

DM Script Remediation Example:

The following DM script reports whether the remediation has been successful or not to the HM agent by invoking hmAlertOPFormatter. For example,

dim remediationStatus as string
dim validate as string
dim remediationInfo as string
dim ret as integer
dim commandline as string
'Do your remediation here.
'...
'Set the value of remediationStatus to either 0 or 1. 0 is for remediation successful and 1 is for remediation failure
'Set the value of remediationInfo to any string that you want to displayed in WAC for this remediation. IDS_REM_SUCCESS and IDS_REM_FAILURE are standard string IDs that can be used to represent success and failure respectively.
'Set valudate to 1 if alert validation is required post remediation or 0 otherwise
' At bottom of your DM script, execute hmAlertOPFormatter
' to notify HM Agent about the status of remediation.
If left(osstring, 3) = "Win" Then
	commandline = "hmAlertOPFormatter.exe"
Else
	commandline = "hmAlertOPFormatter"
Endif
commandline = commandline + " statuscode=" + remediationStatus + " validate= " + validate + " statusmsg=" + remediationInfo
ret = Exec(commandline, TRUE, 0)

To notify Health Monitoring Agent about the status of remediation, execute the following command in the DM script:

hmAlertOPFormatter executable
   hmAlertOPFormatter.exe statuscode=0|1 validate=0|1 statusmsg="<Any string>"
   stauscode=0|1

Use value 0, if remediation is successful. Use value 1, if remediation failed.

Validate=0|1
statusmsg

Use value 0, if no validation needs to be done to check whether the remediation has actually fixed the problem. Use 1 to inform Health Monitoring Agent to perform a validation and report remediation failed message if the alert condition still exists even after remediation.

(optional) String message representing the status of the remediation.

Configure Alert Templates

You can configure the alert templates.

Follow these steps:

  1. Navigate to Control Panel, Configuration, Configuration Policy, DSM, Health Monitoring, Alert Configuration, and Alert Templates.
  2. Select Add to create a script-based alert template.
  3. Specify suitable values for the following fields:
    • Alert Name
      Specifies the template name.
    • Template
      Configures the alert template name from which the alert is derived. See 
      Asset Jobs not Updated
      Asset Inventory not Updated during Collection from SS
    • Script
      Specifies the script name. This name must be same as the script filename passed to the HM agent in ScriptDir.
    • Parameters 
      Specifies the parameters suitable to the template.

      Use name-value pairs separated by a semi-colon (;) for specifying multiple parameters, and comma (,) to separate multiple values for one parameter. For example,

      GROUPS=Group1,Group2;RequiredPercentage=80;IncludeLinkedAssetJobs=TRUE;IncludeLinkedGroupJobs=TRUE;assetJobNames=% 
    • Message
      Defines the alert-related information, that is evaluated when an alert condition is detected. For example,

      Less than $PERCENTAGE of the computers reported the asset job results from within the computer group $GROUPS
      
    • Severity
      Configures the severity for the template alert from the drop-down list.
    • Detection Tiers
      Specifies the tiers on which the alert is detected. For example, EM, DM, SS, and Agent.
    • Default Frequency
      Specifies the default frequency for the template.
    • Default Threshold 
      Specifies the default threshold for the template.
  4. (Optional) Click Check to verify the values.
  5. Click Apply and OK
    The alert template is now configured.

Pre-defined Alert Templates

CA Client Automation provides the following alert templates out-of-the-box.

Asset Jobs not Updated

This template detects and alerts if a specified percentage of Asset jobs for one or more computer groups is not updated.

Parameters

This template supports the following parameters:

  • groups=<comma separated list of groups of interest>;
    Specifies one or more computer group names separated by commas.
  • requiredPercentage=<Required percentage>;
    Specifies the required percentage of the identified jobs within the specified groups that must be successful to avoid the alert being raised.
  • IncludeLinkedGroupJobs=[TRUE]|[FALSE];
    • TRUE
      Specifies the value TRUE to include jobs that are linked to groups while identifying the jobs that must be included for verification.
    • FALSE
      Specifies the value FALSE to ignore jobs that are linked to groups while identifying the jobs that must be included.
  • IncludeLinkedAssetJobs=[TRUE]|[FALSE];
    • TRUE
      Specifies the value TRUE to include jobs that are linked to assets while identifying the jobs that must be included for verification.
    • FALSE
      Specifies the value FALSE to ignore jobs that are linked to assets while identifying the jobs that must be included.
When you do not specify IncludeLinkedGroupJobs or IncludeLinkedAssetJobs in the parameter list, the default behavior is to include the respective job link types.

Example for the Parameters for Asset Jobs not Updated:

GROUPS=Groups1,Group2;RequiredPercentage=80;IncludeLinkedAssetJobs=TRUE;IncludeLinkedGroupJobs=FALSE;assetJobNames=% 

Asset Inventory not Updated during Collection from SS

This template detects and alerts if the inventory update is not successful from one or more Scalability Servers or Scalability Server groups in a specified amount of time.

  • Parameters

This template supports the following parameters:

Servers=<comma separated list of scalability server>;

Specifies one or more servers separated by commas.

Servers parameter requires the name of a server as listed in DSM Explorer, not the FQDN.
  • ServerGroups=<comma separated list of scalability server groups>;
    Specifies one or more server groups separated by commas.

    Server Groups parameter requires the name of a group from All Scalability Servers, DSM Explorer, and not from the All Computers and Users section.
When you do not specify the parameters, all the Scalability Servers are considered for evaluation.

Example for the Parameters for Asset Inventory not updated during Collection from SS :

Servers=Server1,Server2;ServerGroups=Group1,Group2

Configure Alert Collector

Configure Alert Collector in one of the following roles:

  • Persist Alerts into MDB
    Configures the alert collector to persist alerts into MDB.
  • Persist Alerts into MDB and Take Configured Actions
    Configures the collector to persist the alerts into MDB and take configured actions such as sending mails, raising SNMP trap, writing to Windows/CCS event log.
  • Persist Alerts, Take Configured Actions, and Forward
    Configures the collector to persist the alerts into MDB, take configured actions, and forward alerts to another alert collector.

    You can filter the alerts that are forwarded based on the severity or detection tier. For example, only forward High, Medium severity alerts raised on the DM.
  • Forward
    Configures the collector to forward the alerts to another alert collector.
Alert Collector is not supported in a cluster environment.

For more information about Alert Collector Roles, see Install Alert Collector.

Set Alert Collector Properties

Configuring the alert collector involves configuring both the web module and the alert collector process.

Web Module Configuration:

Follow these steps:

  1. Navigate to Control Panel, Configuration, Configuration Policy, DSM, Web Services, and Health Monitoring.
  2. Specify suitable values for the following options:
    • Alert Upload Folder
      Specifies a folder on the alert collector machine where the alert info xml files are uploaded. 
      Default: HMAlertUploads. This folder is relative to the CA Client Automation installation folder.
      When you use non-default value, the user account, under which the web module runs, must have write permissions for the folder.

      A network path for the folder location is not supported.
    • Copy Files to Alert Collector
      Specify value 1 to copy the uploaded files to the input folder of the alert collector.
      Default: 1
    • Delete Files after Copy to Alert Collector
      Specify value 1 to delete the alert info xml files after copying to the alert collector input folder.
      Default: 0

Web module is now configured.

Alert Collector Process Configuration:

Follow these steps:

  1. Navigate to Control Panel, Configuration, Configuration Policy, Policy Name, DSM, Health Monitoring, and Alert Collector.
  2. Specify suitable values for the following options:
    • Alert Collector Role (Locally Managed)
      Specifies the role in which the alert collector must run. This value is initially set during the installation. Post-installation, change to a different role in one of the following ways:
      • Change the role parameter to centrally managed, set the role value, and apply to the alert collector machine.
      • Use ccnfcmda CLI locally on the alert collector machine to set this value and restart the alert collector process.
    • Alert Info Folder
      Specifies a folder on the alert collector machine where the alert info xml files are uploaded. 
      Default: AlertCollectorInput. This folder is relative to the CA ITCM installation folder.
      When you use non-default value, the user account, under which the web module runs, must have write permissions for the folder.

      A network path for the folder location is not supported.
    • Manager (Locally Managed)
      Configures the manager to which the alert collector must connect. This value is initially set during the installation. Follow the Alert Collector Role (Locally Managed) procedure to change the manager post-installation.
    • Output Folder
      Configures the folder where alert info xml files are placed after processing by alert collector. 
      Default: AlertCollectorOutput. This folder is relative to the CA Client Automation installation folder.
    • Alert Purge Maximum Age
      Specifies the number of days after which the alerts are purged.
      Default: 60 days
    • Alerts Purge Interval
      Specifies the interval at which the alerts that are older than the alert purge maximum age value are deleted.
      Default: 10 days

Alert Collector process is now set.

Configure Alert Actions

Configure alert actions, apply to the alert collector(s) which are configured to take the following actions:

Follow these steps:

  1. Navigate to Control Panel, Configuration, Configuration Policy, Policy Name, DSM, Health Monitoring, Alert Collector, Alert Actions, and Actions Configuration.
    The alert actions dialog appears.
  2. Select Add to create an action for one of the configured alerts.
  3. Specify suitable values for the following items:
    • Alert Name
      Defines the alert name.

      You can select the alert from the list.
    • Possible Actions
      Specify the following actions as required:
      • Send Email
        Sends the alert information to the email address that is specified in To Address. When the address is not specified, mail is sent to the recipient address, specified globally in SMTP Email configuration.
      • Raise SNMP Trap
        Raises SNMP traps to the IP address specified in SNMP server. When the server is not specified, traps are raised to the SNMP server, specified globally in Alert Actions.
      • Write to Windows Event Log
        Writes the alert information to the windows event log.
      • Write to CCS Event Log
        Writes the alert information to the CCS event log.
    • To Address
      Configures the email address where you send the alert information. You may specify multiple addresses separated by semicolon.
    • SNMP Server
      Configures the SNMP server where the SNMP traps are raised.
  4. Click Apply and OK
    Actions for the alert are now configured.
You can configure the global settings for SMTP Email and SNMP Server from Alert Actions. 

SMTP Email Configuration

Configure SMTP Email with the following details:

  • From Address
    Defines the mail address to be sent in the mail header. For example, 
    Default: HealthMonitoringSystem

    Do not have spaces in From Address.
  • Mail Server
    Specifies the DNS name or IP Address of SMTP mail server.
  • To Address
    Defines the recipient mail address. You may specify multiple addresses separated by semi colon.
  • Subject
    Specifies the subject of the mail.
    Default: Health Monitoring Alert
    Configure SNMP server with the following details:
  • SNMP Server
    Configures the SNMP server where the SNMP traps are raised.

Specify the Alert Forwarding Details

Apply these settings for the alert collectors which are configured in a forwarding role.

Follow these steps:

  1. Navigate to Control Panel, Configuration, Configuration Policy, Policy Name, DSM, Health Monitoring, Alert Collector, Alert Forwarding.
  2. Specify suitable values for the following items:
    • Alert Collector Address
      Defines the host name or IP address of the alert collector server to which the alerts are forwarded.
    • Alert Forwarding: Alert Detected Tier
      Specifies the tiers that are used as a filter while forwarding the alerts.
      Default: DM
    • Alert Forwarding: Alert Detected Severity
      Specifies the alert severity that is used as a filter while forwarding the alerts.
    • Alert Forwarding: Forward Pending Folder
      Specifies the folder in which the alert info xml files, that failed to forward for the first time, are placed.
    • Alert Forwarding: Forward Rejected Folder
      Specifies the folder in which the alert info xml files that are no longer forwarded are placed.
    • Retry Interval
      Specifies the time interval in minutes to re-forward the pending alerts.
    • Use Https
      Specifies the use of https or plain http for connecting to the server. When set to True, https is used. To configure Alert Collector to connect through Https, see Configure Alert Upload Settings.

Alert forwarding details are now configured.

Forward Collector Settings

Configures the authentication details that are used for connecting to and authenticating the alert collector server to which the alerts are forwarded.

For more information, see Configure Alert Collector Server Settings.

Proxy Server Settings

Configures the Proxy Server details that are used for connecting to the alert collector server for alert forwarding.

For more information, see Configure Proxy Settings.

Configure Health Monitoring Agent

Modify the properties on Health Monitoring Agent.

Follow these steps:

  1. Navigate to Control Panel, Configuration, Configuration Policy, Policy Name, DSM, Health Monitoring, Health Monitoring Agent.
  2. On the Setting Properties dialog, specify suitable values for the following items:
    • Enable Health Monitoring
      Specifies the state of Health Monitoring. Default: False
      True 
      Enables health monitoring.
      False 
      Disables health monitoring.
    • Script Directory
      Specifies the folder to which custom alert scripts must be copied. Default: scriptdir

      When an absolute path is not specified, the folder is taken relative to the HM folder under DSM installation directory. Network paths are not supported.
    • Script Output Directory
      Defines the name of the folder to which the output of custom alert scripts are copied. Default: scriptoutputdir

      When an absolute path is not specified, the folder is taken relative to the HM folder under DSM installation directory. Network paths are not supported.
    • Script Timeout
      Defines the time in seconds for the Health Monitoring agent to wait for script execution to complete. Default: 120 seconds

      When the script execution fails with time-out error; increase the time in seconds, and retry.
    • Maximum Upload Retries
      Defines the number of times alert information upload is reattempted. Default: 3
    • Upload Retry Interval
      Defines the interval in seconds at which, the alert information upload is reattempted. Default: 5 seconds.
    • Enable Alert Remediation
      Specifies the state of Alert Remediation. Default: False
      True 
      Enables alert remediation.
      False 
      Disables alert remediation.
    • User name
      Specifies the user with permissions to access the shared package library.
    • Package Library Share
      Specifies the location of the shared package library. The library must be on a share location.

      When an absolute path is not specified, the folder is taken relative to the HM folder under DSM installation directory.
    • Remediation Script Timeout
      Defines the time in seconds for the health monitoring agent to wait for the remediation script execution to complete. Default: 120 seconds

      When the script execution fails with time-out error; increase the time in seconds, and retry.
    • Password
      Specifies the password to access the shared package library.
  3. Click OK.

The health monitoring agent is now enabled.

You must also configure additional parameters for HM event logging

Follow these steps:

  1. Navigate to Configuration Policy, Default Computer Policy, DSM, Common Components, Event Logging, Health Monitoring Events.
  2. Configure the following parameters
    • Event Log Destination Folder
      Defines the folder location relative to the DSM install folder for the event log files. The folder must exist on the agent.
      Default: HM
    • Event Log File Name
      Defines the file name to use for logging the health monitoring events
      Default: hmevents_list.xml

Configure Alert Upload Settings

Configure the alert collector server details and apply on the agent to enable the health monitoring agent to upload the detected alerts.

Follow these steps:

  1. Navigate to Control Panel, Configuration, Configuration Policy, Policy Name, DSM, Web Services, Client, and Health Monitoring.
  2. Specify suitable values for the following options:
    • Alert Collector Address
      Specifies the Host Name or IP address of the alert collector server where the alerts are uploaded.

      For HM agent on EM, configure the alert collector that is installed on the DM.
    • Use Https
      Specifies the connection to the alert collector server through http or https.
      Default: False indicates http.
      When the alert collector is configured for https, perform the following steps on the agent machine:
      • Export CA Root Certificate in DER format from the Web Server (alert collector) machine.
      • Copy the certificate to the Agent and import using the following command:
          cacertutil import -i:<cert-file-path> -it:X509V3 -trust
      

When HM agent must connect to the alert collector through the proxy and the alert collector server is configured to authenticate the client requests, configure the following options:

Configure Alert Collector Server Settings

Configure the alert collector server settings details in the following way:

Follow these steps:

  1. Navigate to Control Panel, Configuration, Configuration Policy, Policy Name, DSM, Web Services, Client, Health Monitoring, and Alert Collector Server Settings.
  2. Specify suitable values for the following items:
    • Authentication Method
      Defines the value that determines the authentication method.
    • Http Authentication Type
      Defines the value that determines the type of HTTP authentication.

      HTTP offers the basic, digest, and NTLM authentication.
    • Domain
      Specifies the domain name of the Server.
    • Password
      Defines the password to authenticate with the proxy.
    • Username
      Defines the username to authenticate with the Server.

Alert collector server settings are now configured.

Configure Proxy Settings

Configure the proxy settings in the following way:

Follow these steps:

  1. Navigate to Control Panel, Configuration, Configuration Policy, Policy Name, DSM, Web Services, Client, Health Monitoring, and Proxy Server Settings.
  2. Specify suitable values for the following items:
    • Proxy Password
      Defines the password to authenticate with the proxy.
    • Proxy User
      Defines the user to authenticate with the Server.
    • Proxy Server Address
      Defines the address of the Proxy Server.
    • Proxy Server Port
      Defines the port on which the proxy verifies for connection requests.
    • Proxy Type
      Defines the value that determines the type of proxy. The value None indicates the direct HTTP connection.

Proxy settings are now configured.

The HM agent supports only HTTP proxy. SOCKS proxy support is not available with this release.
Was this helpful?

Please log in to post comments.