Contents

1   Introduction

This document describes how to schedule a regularly occurring health check job execution during a time slice, using a calendar-based periodic event.

By default, the time slice starts at the current system time when defining the periodic event and ends at the end of the century but can be configured by the user. The event is defined specifying the time and, optionally, the day of month, day of week, day of week occurrence, and month.

The scheduled job execution becomes effective and takes place only if the HcJobScheduler Managed Object (MO) has an administrativeState set to UNLOCKED.

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 job to be scheduled is known. For a description of how to create the job, refer to Create Health Check Job.
• The calendar-based periodic event values are known.
• An Ericsson Command-Line Interface (ECLI) session in Exec mode is in progress.

2   Procedure

To schedule a health check job based on a calendar event:

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 Managed Element (ME).

   
   
2. Navigate to the HcJob MO representing the health check job to schedule, for example:

   (HealthCheckM=1)>HcJob=jobName

3. Enter Config mode:

   (HcJob=jobName)>configure

4. Navigate to the HcJobScheduler MO:

   (config-HcJob=jobName)>HcJobScheduler=1

5. Enter the event name, for example:

   (config-HcJobScheduler=1)>HcCalendarBasedPeriodicEvent=C_EVENT_20150415_2

6. Create the calendar-based periodic event by setting the relevant attributes, for example:

   Note:  

   The only mandatory attribute to be set is time.

   
   
   • (config-HcCalendarBasedPeriodicEvent=C_EVENT_20150415_2)>dayOfWeek=SUNDAY

     dayOfWeek defines what day of the week the event is triggered, in this case Sunday.

   • (config-HcCalendarBasedPeriodicEvent=C_EVENT_20150415_2)>dayOfWeekOccurrence=SECOND

     dayOfWeekOccurence further specifies the value entered for dayOfWeek. In this case, the event is to be triggered only the second Sunday of the month.

   • (config-HcCalendarBasedPeriodicEvent=C_EVENT_20150415_2)>startTime=2015-04-17T15:15:30

     startTime defines the start time for the time slice during which the event is triggered. It is the time in the future when the event becomes effective.

   • (config-HcCalendarBasedPeriodicEvent=C_EVENT_20150415_2)>stopTime=2016-05-20T20:30:00

     stopTime defines the stop time for the time slice during which the event is triggered. It is the time in future when the event stops to be effective.

   • (config-HcCalendarBasedPeriodicEvent=C_EVENT_20150415_2)>time=03:00:00

     time defines the time when the event is triggered. This is the only mandatory attribute to be set.

   Note:  

   startTime and stopTime are not mandatory values. If not specified, the default values are applied. Default value for startTime is current date time when the MO creation is committed. Default value for stopTime is the end of the century.

   
   
7. Commit the calendar-based periodic event:

   (config-HcCalendarBasedPeriodicEvent=C_EVENT_20150415_2)>commit

8. Verify that the calendar-based periodic event was created:

   (HcCalendarBasedPeriodicEvent=C_EVENT_20150415_2)>show

   The following is an example output of a calendar-based periodic event where health check job is executed every second Sunday of the month at 03:00 from 2015-04-17, 15:15:30 until 2016-05-20, 20:30:00.

   HcCalendarBasedPeriodicEvent=C_EVENT_20150415_2 dayOfWeek=SUNDAY dayOfWeekOccurrence=SECOND startTime="2015-04-17T15:15:30" stopTime="2016-05-20T20:30:00" time="03:00:00"

9. Unlock the administrativeState of HcJobScheduler to make the job execution effective, refer to Unlock Health Check Job Scheduler.