Scheduling Operations

CCKM allows you to periodically refresh keys in the background. To refresh keys, you need to create schedule configuration. A schedule configuration defines when to run a refresh job. You can use either basic format or cron format to specify the time when the refresh job will run.

Specify basic format in the following order:

[Repeats, at]

Where,

• Repeats: frequency of the scheduler. Possible values are daily, weekly, monthly, and yearly.

• at: specific time at which the refresh operation will be performed. Possible value lies between 12:00-11:00 AM/PM UTC.

Specify cron format in the following order:

"* * * * *"

These five values indicate when the job should be executed. These values are mandatory and must be specified in order of minute, hour, day of month, month, and day of week.

The following table lists the accepted values:

Adding Key Refresh Schedule

To add a key refresh schedule:

1. Open the Cloud Key Manager application.

2. In the left pane, click Schedules. The list of available schedules is displayed.

3. Click Add Schedule. The Add New Schedule wizard is displayed.

4. Under Select Schedule Type, select Key Refresh.

5. Click Next.

6. On the General Info screen, enter or select following details:

   • Enter a unique Scheduler Name.

   • Select DSM from the Cloud Name drop-down list.

   • (Optional) Add Description for the scheduler in a maximum of 250 characters.

   • Select Enable Schedule to enable the schedule.

   • Click Next.

7. On the Schedule Config screen, enter or select the following details.

   1. Configure DURATION for the scheduler. Specify the following values:

      • Schedule Starts

      • Schedule Ends

      If you select the Never check box, the scheduler configuration will never expire, and the Schedule Ends field becomes unavailable.

   2. Configure FREQUENCY of the scheduler. The frequency determines how often the scheduler will refresh keys. Select either Basic or Raw (Cron) format to specify the value.

   3. Click Next.

8. On the Add Domains screen:

   1. Select the domain name from the Refresh Keys from Selected Domain(s) drop-down list.

   2. Click the + button.

      Similarly, you can add more domains.

   3. Select the Refresh All Domains option if you want to refresh all the existing domains.

   4. Click Save.

A message Schedule successfully created is displayed on the screen.

Viewing/Editing Schedules

To view/edit a schedule:

1. Open the Cloud Key Manager application.

2. In the left pane, click Schedules. The Schedules page displays following details:

   Field	Description
   Name	Unique name of the scheduler configuration.
   Schedule Type	Type of the schedule. Possible types are: • Key Rotation • Key Refresh • Add KMS Container (GCP and Azure only) For DSM, only Key Refresh is supported.
   Cloud Name	Name of the cloud. For DSM schedules, it is DSM.
   Last Modified	Time when the schedule is modified.
   Frequency	Frequency of the scheduler configuration.
   Start Date	Start time of the scheduler configuration.
   End Date	Expiry time of the scheduler configuration.
   Status	Status of the scheduler configuration. Possible values are: • Enabled • Disabled

3. Click the overflow icon () corresponding to the desired schedule and click View/Edit.

4. Edit or configure the following fields:

   GENERAL INFO: Update the general information about the schedule:

   • Update Description of the schedule.

   • Enable or disable the scheduler configuration. Select or clear the Enable Schedule check box.

   SCHEDULE CONFIG: Update the scheduler configuration parameters such as:

   • DURATION: Specify the period in which a schedule actively runs its jobs. Specify Schedule Starts and Schedule Ends dates. If you select Never, the schedule never expires.

   • FREQUENCY: Specify how often the schedule refreshes domains. Use Basic or RAW (Cron) option to specify the frequency.

   DOMAINS: Under Refresh Keys from Selected Domain(s):

   • Add a new domain to the key refresh schedule.

   • Remove an existing domain from the key refresh schedule.

5. Click Update under each modified section.

The Schedules page also contains a section named JOB HISTORY that contains all the related information about a schedule such as Run Date, Job ID, Status, and Errors.

Disabling Schedules

To disable a schedule configuration:

1. Open the Cloud Key Manager application.

2. In the left pane, click Schedules. The list of available schedules is displayed.

3. Click the overflow icon () corresponding to the desired schedule and click Disable. The Disable Schedule message is displayed.

4. Click Disable Schedule.

A message Successfully disabled the schedule is displayed on the screen.

Enabling Schedules

To enable a schedule configuration:

1. Open the Cloud Key Manager application.

2. In the left pane, click Schedules. The list of available schedules is displayed.

3. Click the overflow icon () corresponding to the desired schedule and click Enable. The Enable Schedule message is displayed.

4. Click Enable Schedule.

A message Successfully enabled the schedule is displayed on the screen.

Manually Running Schedules

To manually run a schedule:

1. Open the Cloud Key Manager application.

2. In the left pane, click Schedules. The list of available schedules is displayed.

3. Click the overflow icon () corresponding to the desired schedule and click Run Now.

The Run Now schedule is started in the background. A message Schedule is running now. It will take a few seconds to finish. is displayed on the screen. After the schedule is run successfully, a message Successfully finished running the schedule is displayed.

Deleting Schedules

1. Open the Cloud Key Manager application.

2. In the left pane, click Schedules. The list of available schedules is displayed.

3. Click the overflow icon () corresponding to the desired schedule and click Delete Schedule. The Delete Schedule message is displayed.

4. Click Delete.

A message Successfully deleted schedule is displayed on the screen.