Contents

1   Introduction

This document describes how to list the installed health check rules available on a Managed Element (ME).

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 rules:

1. 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.

   
   
2. List hcRuleId, severity, and administrativeState attributes of the installed rules:

   (HealthCheckM=1)>show-table -m HcRule -p hcRuleId,severity,administrativeState,name,description

   The following is an example output:

   hcRuleId	description	severity	administrativeState
   PROVIDER_001	Check if some services generated a core dump.	CRITICAL	UNLOCKED
   PROVIDER_002	Check the status of the services.	CRITICAL	UNLOCKED
   PROVIDER_003	Check if there are unused software bundles on the node.	WARNING	UNLOCKED
   PROVIDER_004	Check that allocated memory is lower than a certain value.	CRITICAL	UNLOCKED
   PROVIDER_005	Check that the disk use is lower than a certain value.	CRITICAL	UNLOCKED

   The description of the shown attributes are as follows:

   • hcRuleId – the name used when identifying the MO representing the rule.
   • description –a clear description of the rule.
   • severity – the severity of the check result.
   • administrativeState – the administrative state of the rule. If the value is LOCKED, the rule is not executed by an associated health check job. If value is UNLOCKED the rule is executed by an associated health check job. Default value is UNLOCKED.
3. List recommendedAction for all installed rules:

   (HealthCheckM=1)>show-table -m HcRule -p hcRuleId,recommendedAction

   The following is an example output:

   hcRuleId	recommendedAction
   PROVIDER_001	Check the service that generated the core.
   PROVIDER_002	Check the not unhealthy service.
   PROVIDER_003	Delete the unused bundle.
   PROVIDER_004	A node reboot can help.
   PROVIDER_005	Free space on the disk by deleting useless files.

   The attribute recommendedAction provides suggestion about action to be performed in case of rule check failure.

4. View the rule categories for a specific rule, for example:

   (HealthCheckM=1)>show HcRule=PROVIDER_001,categories

   Note:  

   The name of the HcRule MO is expressed as HcRule=<hcRuleId> where hcRuleId is the value of hcRuleId attribute.

   
   

   The following is an example output:

   categories SHORT MANDATORY

5. View the accepted (if any) input parameters for a specific rule and default values, for example:

   (HealthCheckM=1)>show HcRule=PROVIDER_004,inputParameters

   Input parameters are to be used during the rule evaluation phase to customize the check. The command shows the list of accepted input parameters and default values. If the output of the command is empty, the rule is a simple rule not accepting input parameters.

   The following is an example output:

   inputParameters description="The memory threshold value." name="memoryThreshold" value="750"

   The description of the input parameters are as follows:

   • description – a brief description of the parameter.
   • name – the name of the input parameter to be used when setting user-defined value.
   • value – the default value for the input parameter used if no user-defined value is provided.

   To set, in the context of a job, user-defined value for a rule input parameter, refer to Modify Health Check Rule Parameter.

   To restore, in the context of a job, default values for a rule input parameter, refer to Restore Default Value for Health Check Rule Parameter.

6. Navigate to a HcRule MO, for example:

   (HealthCheckM=1)>HcRule=PROVIDER_005

7. List the rule attributes in verbose mode:

   (HcRule=PROVIDER_005)>show -v

   All the attributes for the specific rule are shown.

   The following is an example output:

   HcRule=PROVIDER_005 administrativeState=UNLOCKED <default> categories <read-only> SHORT MANDATORY description="Check that the disk usage is lower than a certain value." <read-only> name="DISK USAGE" <read-only> recommendedAction="Check what folder has been filled" <read-only> severity=CRITICAL <read-only> inputParameters[@1] description="The disk usage threshold value." <read-only> name="usageThreshold" <read-only> value="90" <read-only>