Contents

1   Introduction

This document describes how to modify values for parameters used when a health check rule is evaluated. The modification can be done before executing a specific health check job, and it applies only for that job. Default values are used if no user-defined values are set. The possibility to modify the criteria used for a rule evaluation is defined at node installation time.

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, for which a parameter (to be used during rule evaluation phase) must be modified, is known. For a description of how to create the job, refer to Create Health Check Job.
• The name of parameters and the new values to assign them are known. For instructions on how to retrieve customizable parameters, refer to List Health Check Rules.

  Note:  

  For a complete list of health check rule parameters, refer to the node-specific Health Check document.

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

2   Procedure

To set a value for a parameter to use at rule evaluation phase:

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. Navigate to the HcJob MO representing the health check job for which a customizable parameter value must be modified, for example:

   (HealthCheckM=1)>HcJob=jobName

3. Enter Config mode:

   (HcJob=jobName)>configure

4. List all the already set rule parameters:

   (config-HcJob=jobName)>show -v inputParameters

   The following is an example output:

   inputParameters[@1] hcRule="HcRule=HealthCheckFramework_003" name="idleCpuThreshold" value="99"

5. Is the parameter to be modified already present in the inputParameters list?

   Yes: Proceed with Step 13.

   No: Continue with the next step.

6. Add an inputParameters attribute:

   (config-HcJob=jobName)>inputParameters

   The system returns output:

   (config-inputParameters[@<n>])>

   Where n is the index, in the inputParameters list, of the item currently adding.

   Note:  

   The inputParameters attribute has the following three mandatory members to be set:

   • hcRule: the identifier of HcRule MO for which the parameter must be used.
   • name: the name of the parameter for which a user-defined value is to be set.
   • value: the user-defined value to be assigned to the parameter.

   
   
7. Set the hcRule member:

   (config-inputParameters[@<n>])>hcRule="<rule_id>"

   Note:  

   The string rule_id identifies the HcRule MO for which the parameter must be set. It is expressed in the form of HcRule=<hcRuleId> where hcRuleId is the value of hcRuleId attribute of the HcRule MO. The rule_id must be in quotation marks.

   
   

   The following is an example:

   (config-inputParameters[@2])>hcRule="HcRule=HealthCheckFramework_002"

8. Set the name member:

   (config-inputParameters[@n])>name=<parameter_name>

   Note:  

   The parameter_name is the name of the parameter for which a user-defined value is to be set.

   
   

   The following is an example:

   (config-inputParameters[@2])>name=usageThreshold

9. Set the value member:

   (config-inputParameters[@<n>])>value=<parameter_value>

   Note:  

   The parameter_value is the user-defined value to be set.

   
   

   The following is an example:

   (config-inputParameters[@2])>value=70

10. Commit the operation:

    (config-inputParameters[@<n>])>commit

    If the commit is unsuccesful, an error message is shown. Possible causes of failure are the following:

    • rule_id is not a valid rule identifier.
    • parameter_name is not the name of a parameter for the rule specified by rule_id.
    • The job for which the parameter is set is currently ongoing. It is not possible to set parameter for a job while it is executing.
11. Check the inputParameters creation:

    (inputParameters[@<n>])>show

    The following is an example output:

    (inputParameters[@2])> hcRule="HcRule=HealthCheckFramework_002" name="usageThreshold" value="70"

12. The procedure is complete.
13. Enter the inputParameters attribute holding values to be changed:

    (config-HcJob=jobName)>inputParameters[@<n>]

    Where n is the index, in the inputParameters list, of the item to be modified.

    The following is an example output:

    (config-inputParameters[@1])>

    Note:  

    In this case, the value to be changed is in the first element of inputParameters attribute list.

    
    
14. Set new values for members:

    (config-inputParameters[@<n>])><member_name>="<new_member_value>"

    The string member_name assumes one of the following values: hcRule, name, or value, according to which member must be modified. It is possible to modify all members, only some of them or just one. The new_member_value is the new value to set.

    The following is an example output:

    (config-inputParameters[@1])>value=67

15. Commit the operation:

    (config-inputParameters[@<n>])>commit

    If the commit is unsuccesful, an error message is shown. Possible error causes are the following:

    • Modifying the name attribute: a name value not valid for the rule specified by hcRule member is detected.
    • Modifying the hcRule member: a not valid rule identifier is detected.
    • The job for which the parameter member value is modified, is currently ongoing. It is not possible to modify parameter values for a job while it is executing.
16. Show the modified rule parameter:

    (inputParameters[@<n>])>show

    The input parameter as modified is shown.

    The following is an example output:

    (inputParameters[@1])> hcRule="HcRule=HealthCheckFramework_003" name="idleCpuThreshold" value="67"