Schedule Health Check Job Based on Periodic Event

1	Introduction
1.1	Prerequisites
2	Procedure

1 Introduction

This document describes how to schedule a health check job execution to occur at regular intervals during a time slice.

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 time interval is defined based on the number of hours and optionally months, weeks, days, and minutes between two consecutive health check job executions.

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 periodic event to schedule is 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 periodic event:

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).
Navigate to the HcJob MO representing the health check job to schedule, for example:
(HealthCheckM=1)>HcJob=jobName
Enter Config mode:
(HcJob=jobName)>configure
Navigate to the HcJobScheduler MO:
(config-HcJob=jobName)>HcJobScheduler=1
Enter the event name, for example:
(config-HcJobScheduler=1)>HcPeriodicEvent=P_EVENT_20150415_1
Create the periodic event by setting proper attributes, for example:
Note:
Not all attributes must be set, default values are used if not specified. The only mandatory attribute is hours.

(config-HcPeriodicEvent=P_EVENT_20150415_1)>days=1

(config-HcPeriodicEvent=P_EVENT_20150415_1)>hours=10

(config-HcPeriodicEvent=P_EVENT_20150415_1)>minutes=30

(config-HcPeriodicEvent=P_EVENT_20150415_1)>weeks=2

(config-HcPeriodicEvent=P_EVENT_20150415_1)>months=3

(config-HcPeriodicEvent=P_EVENT_20150415_1)>startTime=2015-04-16T10:10:00

(config-HcPeriodicEvent=P_EVENT_20150415_1)>stopTime=2016-03-15T20:30:00

Note:
The default value for startTime is assumed to be the current system time if not differently set by the user.
The default value for stopTime is assumed to be the end of century if not differently set by the user.
Commit the periodic event creation:
(config-HcPeriodicEvent=P_EVENT_20150415_1)>commit

Verify that the periodic event was created:

(HcPeriodicEvent=P_EVENT_20150415_1)>show -v

In the following example, the health check job is executed every three months, two weeks, 1 day, 10 hours, and 30 minutes between 2015-04-16 at 10:10:00 and 2016-03-15 at 20:30:00:

HcPeriodicEvent=P_EVENT_20150415_1
   days=1
   hcPeriodicEventId="P_EVENT_20150415_1"
   hours=10
   minutes=30
   months=3
   startTime="2015-04-16T10:10:00"
   stopTime="2016-03-15T20:30:00"
   weeks=2

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