List Health Check Jobs

1	Introduction
1.1	Prerequisites
2	Procedure

1 Introduction

This document describes how to list the health check jobs available on a Managed Element (ME). Information about associated rules categories, last computed ME status, name of the last report file, and job to be triggered if a ME healthiness status different from HEALTHY is detected, is provided. A list of customizable parameters values used during rule check phase, and information about rules for which the check failed, are provided as well.

1.1 Prerequisites

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

1.1.1 Conditions

The following condition must apply:

An Ericsson Command-Line Interface (ECLI) session in Exec mode is in progress.

2 Procedure

To list health check jobs:

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.
List available jobs and related hcJobId, lastReportFileName, and status attributes:
(HealthCheckM=1)>show-table -m HcJob -p hcJobId, status, lastReportFileName

The following is an example output:

hcJobId

lastReportFileName

status

firstJob

1_firstJob_20150506T120032_man

NOT_HEALTHY

secondJob

1_secondJob_20150506T103634_man

NOT_HEALTHY

The following is a description of each shown attribute:
- hcJobId – the name used to identify each HcJob MO.
- lastReportFileName – the name of the report file generated from the latest execution of the job.
- status – the ME health status as computed from the last execution of the job.
Navigate to a particular HcJob MO, for example:
(HealthCheckM=1)>HcJob=firstJob

Note:
The string firstJob is the value of the attribute hcJobId retrieved in Step 2

hcJobId	lastReportFileName	status
firstJob	1_firstJob_20150506T120032_man	NOT_HEALTHY
secondJob	1_secondJob_20150506T103634_man	NOT_HEALTHY

List the job attributes in verbose mode, for example:

(HcJob=firstJob)>show -v

All the attributes for the specific job are shown.

The following is an example output:

 hcJobId="firstJob"
   jobToTrigger="ManagedElement=1,SystemFunctions=1,HealthCheckM=1,HcJob=secondJob"
   lastReportFileName="1_firstJob_20150507T140547_man" <read-only>
   lastRunTime="2015-05-07T14:05:47" <read-only>
   localFileStorePath="/var/filem/internal_root/health_check"  <read-only>
   rulesCategories
      MANDATORY
      OTHER
      SHORT
      TROUBLESHOOT
   status=NOT_HEALTHY <read-only>
   failedRules[@1]
     hcRule="hcRuleId=HealthCheckFramework_003" <read-only>
     reason="The idle CPU percentage is smaller than the predefined/customized threshold value."⇒
             <read-only>
     severity=CRITICAL <read-only>
   inputParameters[@1]
     hcRule="HcRule=HealthCheckFramework_002"
     name="usageThreshold"
     value="50"
  inputParameters[@2]
     hcRule="HcRule=HealthCheckFramework_003"
     name="idleCpuThreshold"
     value="99"
   progressReport
     actionId=[] <read-only>
     actionName="EXECUTE" <read-only>
     additionalInfo=[] <read-only>
     progressInfo="Job Execution completed" <read-only>
     progressPercentage=100 <read-only>
     result=SUCCESS <read-only>
     resultInfo="Job correctly executed" <read-only>
     state=FINISHED <read-only>
     timeActionCompleted="2015-05-07T14:05:48" <read-only>
     timeActionStarted="2015-05-07T14:05:47" <read-only>
     timeOfLastStatusUpdate="2015-05-07T14:05:48" <read-only>
HcJobScheduler=1

Details about shown attributes are as follows:

jobToTrigger is the distinguished name (DN) of another job to be executed when the current job execution reports ME status different from HEALTHY.
lastReportFileName is the name of the report file produced from last job execution.
lastRunTime provides date and time of last job execution.
localFileStorePath is the default location where report files are stored.
rulesCategories is the list of categories of health check rules associated to the job.
status is last computed ME health status.
A failedRules attribute is present for each rule whose related check failed. The value of hcRule member is the relative distinguished name (RDN) of the failed rule. The value of reason member provides additional information in case the health check rule execution fails. The value of severity member is the severity of the failed rule.
An inputParameters attribute is present for each user-defined value for parameters used when health check rule is evaluated. The value of hcRule member is the identifier of the HcRule MO for which a user-defined parameter was set. The value of name member is the name of the rule parameter. The value of value member is the user-defined value of the rule parameter.
progressReport attribute holds details about last execution of the job as follows:
- actionName is last action performed.
- progressInfo attribute is a string representing the progress of last job execution. When the job execution is completed, it shows Job Execution completed.
- progressPercentage attribute represents the percentage of job execution. Once the job completed execution, progressPercentage=100 is shown.
- result attribute represents last result of job execution, in terms of success or failure. If the job completed execution successfully result=SUCCESS is shown, if an error occurred result=FAILURE is shown.
- state attribute represents last state of the job. When the job ended its execution successfully, state=FINISHED is shown. If the job terminated its execution because of an error state=CANCELLED and result=FAILURE are the provided printouts.
- timeActionCompleted attribute is the date time of last job execution completion.
- timeActionStarted attribute is the date time of last job execution start.
- timeOfLastStatusUpdate attribute is the date time of last update of state attribute.
HcJobScheduler=1 is the HcJobScheduler child MO holding information to manage automatic start of a job at a specified time. For further details about how to schedule jobs according to each available policy,refer to the following documents: