Execute Health Check Job

1	Introduction
1.1	Prerequisites
2	Procedure

1 Introduction

This document describes how to manually execute a health check job previously created in the Managed Object Model (MOM). After a successful execution, the Managed Element (ME) health status is provided in the MOM as condensed result. More details are provided in a report file that is stored, as default, in a predefined location under Node file system.

1.1 Prerequisites

This section describes the prerequisites, which must be fulfilled before using the procedure.

1.1.1 Conditions

The following conditions must apply:

The name of the health check job to execute is known. For instructions on how to create the job, refer to Create Health Check Job.
No other health check job execution is in progress.
An Ericsson Command-Line Interface (ECLI) session in Exec mode is in progress.

2 Procedure

To execute a health check job manually storing report file in default location under Node file system:

Navigate to the HealthCheckM Managed Object (MO):
>dn ManagedElement=<node_name>,SystemFunctions=1,HealthCheckM=1

Note:
The string node_name is specific for the ME.
Navigate to the HcJob MO representing the health check job to be executed, for example:
(HealthCheckM=1)>HcJob=jobName
Start the job execution:
(HcJob=jobName)>execute

Check the job execution progress:

(HcJob=jobName)>show progressReport

The following are example outputs:

   actionName="EXECUTE"
   progressInfo="Job Execution ongoing"
   progressPercentage=57
   result=NOT_AVAILABLE
   resultInfo=""
   state=RUNNING
   timeActionStarted="2015-04-23T15:09:57"
   timeOfLastStatusUpdate="2015-04-23T15:10:04"

   actionName="EXECUTE"
   progressInfo="Job Execution ongoing"
   progressPercentage=80
   result=NOT_AVAILABLE
   resultInfo=""
   state=RUNNING
   timeActionStarted="2015-04-23T15:09:57"
   timeOfLastStatusUpdate="2015-04-23T15:10:05"

Note:

The current job execution percentage is available in the progressPercentage attribute. Once the job completes execution, progressPercentage=100 is shown.

The progress of job execution is available in the progressInfo attribute. When the job execution is complete, it shows the Job Execution completed value.

The result of job execution, in terms of success or failure, is available in the result attribute. It shows value NOT_AVAILABLE until job completion. Once the job is executed, it shows SUCCESS if the job accomplished its execution without problem or FAILURE if the job execution terminated because of an error.

The current state of the job is available in the state attribute. While the job is executing, state=RUNNING is shown. When the job ends its execution successfully, state=FINISHED is shown. If the job terminates its execution because of an error state=CANCELLED and result=FAILURE are the provided outputs.

Check the job execution progress until completion:

(HcJob=jobName)>show progressReport

The following is an example output in case of success:

   actionName="EXECUTE"
   progressInfo="Job Execution completed"
   progressPercentage=100
   result=SUCCESS
   resultInfo="Job correctly executed"
   state=FINISHED
   timeActionCompleted="2015-04-23T15:10:07"
   timeActionStarted="2015-04-23T15:09:57"
   timeOfLastStatusUpdate="2015-04-23T15:10:07"

The following is an example output in case of failure:

   actionName="EXECUTE"
   progressInfo="Job Execution completed"
   progressPercentage=100
   result=FAILURE
   resultInfo="Job execution stopped due to error."
   state=CANCELLED
   timeActionCompleted="2015-04-23T15:26:21"
   timeActionStarted="2015-04-23T15:25:24"
   timeOfLastStatusUpdate="2015-04-23T15:26:21"

Is the job execution ended with success?
Note:
A job is ended with success if the value of attribute result is SUCCESS. Only in that case the new ME status is updated.

Yes: Continue with the next step.

No: Proceed with Step 3.
Note:
Job execution failure can depend on any of the following:
- A rule set file containing rules not correct from the semantic perspective. The rule set file must be checked.
- It was not possible to write the report file in the output directory. Check the output directory on the file system.
Retry executing the job. If the problem persists, consult the next level of maintenance support. This procedure ends.

Check the ME health status:
(HcJob=jobName)>show status

The health status of the ME, as computed by the job execution, is shown.

The following is an example output in case all rules check executed by the job were successful:
status=HEALTHY
The following is an example output in case the check of at least one rule whose severity is CRITICAL failed:
status=NOT_HEALTHY
Under the default location specified by localFileStorePath, the report file is available with details about job execution, computed ME health status, and information about successful and failed rules. Moreover, in the same directory, a compressed archive file containing logs used for the rules evaluation is stored.
Is the ME health status different from HEALTHY?
Yes: Continue with the next step.

No: This procedure ends.

Check the list of failed rules:

(HcJob=jobName)>show failedRules

The list of rules, executed by the health check job for which the check result did not pass, is shown, for example:

failedRules
   hcRule="hcRuleId=PROVIDER2_006"
   reason="The CPU usage percentage is Greater than the defined threshold value."
   severity=CRITICAL
failedRules
   hcRule="hcRuleId=PROVIDER2_007"
   reason="There is at least one software item not used. Please check and manage it properly."
   severity=WARNING
failedRules
   hcRule="hcRuleId=PROVIDER_0015"
   reason="Core Dumps present."
   severity=CRITICAL

Note:: The attribute hcRule specifies the relative distinguished name of the failed rule. It is expressed in the form of "hcRuleId=<rule_id>".

For each failed rule, retrieve the recommended action. Navigate to the HcRule MO representing each rule:
(HcJob=jobName)>dn ManagedElement=1,SystemFunctions=1,HealthCheckM=1,HcRule=<rule_id>

(HcRule=<rule_id>)>show recommendedAction

Note:
The string rule_id is the value component of each failed rule retrieved in Step 9.

The following is an example output:
(HcRule=PROVIDER_0015)>show recommendedAction recommendedAction="Collect all the needed information according ⇒ to the OPI and contact the next level of support"

The suggested action must be performed to get related rule successfully executed.