Your suggested change has been received. Thank you.

close

Suggest A Change

https://thales.na.market.dpondemand.io/docs/dpod/services/kmo….

Thales Logo

All

  • All
back

Azure Resources

Scheduling Operations

search

Please Note:

Scheduling Operations

CCKM allows you to periodically refresh keys, rotate keys, or add KMS containers in the background. To refresh keys, rotate keys, or add KMS containers, you need to create schedule configuration. A schedule configuration defines when to run a refresh, rotation, or KMS container job. You can use either the basic or cron format to specify when the rotation, refresh, or KMS container 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 rotation or 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:

FieldAllowed valuesAllowed special characters
Minute0-59* / , -
Hour0-23* / , -
Day of month1-31* / , - ?
Month1-12 or JAN-DEC* / , -
Day of week0-6 or SUN-SAT* / , - ?

Adding Key Rotation Schedule

A key rotation schedule replaces selected keys with new cryptographic keys at the specified time.

To add key rotation 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. Select Schedule Type as Key Rotation.

  5. Click Next.

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

    • Enter a unique Scheduler Name.

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

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

    • Select Enable Schedule to enable the schedule.

    • Click Next.

  7. Set the values on the Schedule Config screen.

    You can schedule configuration for:

Configuring Rotation Schedule for All Keys

To configure rotation schedule for all keys:

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

    1. Schedule Starts

    2. 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 rotate keys. Select either the Basic or the Raw (Cron) format to specify the value.

  3. (Optional) Set the expiry of the new key that will be created through rotation. If not specified, the new key material never expires. For example, if you set the expiry time to 6 Hours, the key material of the new key will expire in 6 hours.

  4. Click Save.

A message Schedule successfully created is displayed on the screen.

Configuring Rotation Schedule for Expiring Keys

To configure rotation schedule for expiring keys:

  1. In the SELECTION section, select the keys to be rotated based on their expiry time. In the Only rotate keys within _ of material expiration field, select or enter the key expiry time. For example, if the value of Only rotate keys within _ of material expiration field is set to 4 Days, then the rotation schedule is created for all the keys that will expire in 4 days.

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

    1. Schedule Starts

    2. Schedule Ends

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

  3. (Optional) Set the expiry of the new key that will be created through rotation. If not specified, the new key material never expires. For example, if you set the expiry time to 6 Hours, the key material of the new key will expire in 6 hours.

  4. Click Save.

A message Schedule successfully created is displayed on the screen.

Configuring Rotation Schedule for All Keys Based on Creation or Last Rotation Date

To configure rotation schedule for all keys based on their creation or last rotation date:

  1. In the SELECTION section, select the keys to be rotated based on their creation or last rotation date.

    In the Only rotate keys after _ of creation/last rotation date field, select or enter the number of days, weeks, months, or years. For example, if the value of Only rotate keys after _ of creation/last rotation date field is set to 4 Days, then all the keys will rotate after 4 days of their creation or last rotation date. The default duration is 7 Days.

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

    1. Schedule Starts

    2. Schedule Ends

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

  3. (Optional) Set the expiry of the new key that will be created through rotation. If not specified, the new key material never expires. For example, if you set the expiry time to 6 Hours, the key material of the new key will expire in 6 hours.

  4. Click Save.

A message Schedule successfully created is displayed on the screen.

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. Select Schedule Type as Key Refresh.

  5. Click Next.

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

    • Enter a unique Scheduler Name.

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

    • 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 rotate keys. Select either Basic or Raw (Cron) format to specify the value.

    3. Click Next.

  8. On the Add Vaults screen:

    1. Select the vault name from the Refresh Keys, Certificates and Secrets from Selected Vault(s) drop-down list. The list shows the available Azure key vaults with their types specified in parenthesis. The Azure key vault types can be Standard, Premium, and ManagedHSM.

    2. Click + button.

      Similarly, you can add more vaults.

    3. Select the Refresh All Vaults option if you want to refresh all the existing vaults.

    4. Click Save.

A message Schedule successfully created is displayed on the screen.

Automatic Cloud Key Discovery

A KMS container schedule automatically detects the KMS containers based on the Azure Cloud connection and adds them to the CipherTrust Cloud Key Manager.

Adding a KMS container (vault or subscription) to CCKM consumes one CCKM license count.

To add a KMS container 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 Select Schedule Type screen of the Add New Schedule wizard is displayed.

Schedule Type

  1. Select Schedule Type as Add KMS Container.

  2. Click Next. The General Info screen is displayed.

General Info

  1. Enter a unique Schedule Name.

  2. Select Azure from the Cloud Name drop-down list.

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

  4. (Optional) Select Enable Schedule to enable the schedule.

  5. Select a Define Job Type. You can select either Discover Only or Discover and Add.

    Note

    Discover Only lists all the discovered containers. Discover and Add adds all the discovered containers to the CCKM.

  6. Click Next. The Connection & ACL Info screen is displayed.

Connection & ACL Info

  1. Select a Connection.

  2. In the ACCESS CONTROL section.

    1. Click Keys, Certificates, Secrets, or Reports tab.

    2. Click Assign User/Group. The Assign User/Group dialog box is displayed.

    3. Select the desired user or group from the User/Group drop-down list.

    4. Click Save. The newly added user/group is displayed under Name in the ACCESS CONTROL section.

    5. Grant the permissions to the user/group, as appropriate.

      Granting additional permisions

      To grant the additional permissions, select the check box under the desired operation corresponding to the desired users or groups. The following permissions can be granted.

      • Keys: View, Add Key, Edit Key, Recover Key, Purge Key, Upload Key, Restore Key, Soft Delete Key, Delete Key Backup, Refresh Key

      • Certificates: View, Add, Upload, Edit, Soft Delete, Recover, Purge, Restore, Delete Backup, Refresh

      • Secrets: View, Add, Edit, Soft Delete, Recover, Purge, Restore, Delete Backup, Refresh

      • Reports: View Report, Add Report, Download Report, Delete Report

      To remove a permission, clear the check box under the desired operation.

    6. Remove a user or group.

      1. Under Unassign, click X corresponding to the desired user/group. The Remove Group dialog box is displayed.

      2. Click Remove.

  3. Click Next. The Schedule Config screen is displayed.

Schedule Config

  1. Configure DURATION for the scheduler. Specify the schedule start and end time:

    • Schedule Starts: Specify time when the schedule starts.

    • Schedule Ends: Unavailable by default, that is, the scheduler never expires.

    • Never: Selected by default, that is, the scheduler configuration never expires.

    To set an end time for the scheduler, clear the Never check box, and specify the Scheduler Ends time.

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

  3. Click Save.

A message Schedule successfully created is displayed on the screen. The newly created schedule is displayed in the schedules list.

After the schedule is run successfully, Azure Key Vaults and Azure Subscriptions will be added to the CCKM. You can see them in the Vaults and Subscriptions sections, of the Azure Key Vaults page in the CCKM.

Adding Key Backup (Azure only) Schedule

A key backup schedule downloads and saves encrypted cloud key backup blobs at specified time intervals. These backups can be used to restore keys.

Warning

  • Ensure that you have sufficient storage before enabling schedule backup. The Physical and Virtual storage appliances have storage limits.

  • If you do have the sufficient storage, you can extend the storage, refer to Resizing the Virtual Hard Disk After Deployment for details.

To add a Key Backup (Azure only) 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 Select Schedule Type screen of the Add New Schedule wizard is displayed.

Schedule Type

  1. Select Schedule Type as Key Backup (Azure only).

  2. Click Next. The General Info screen is displayed.

General Info

  1. Enter a unique Schedule Name.

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

  3. (Optional) Select Enable Schedule to enable the schedule.

  4. Click Next. The Schedule Config screen is displayed.

Schedule Config

Note

Backup Limit: If the sum of Scheduled and Manual Backups exceeds the maximum allowance of 30 instances, older backups will be deleted automatically.

  1. Configure DURATION for the scheduler. Specify the schedule start and end time:

    • Schedule Starts: Specify time when the schedule starts.

    • Schedule Ends: Unavailable by default, that is, the scheduler never expires.

    • Never: Selected by default, that is, the scheduler configuration never expires.

    To set an end time for the scheduler, clear the Never check box, and specify the Scheduler Ends time.

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

  3. Click Save.

A message Schedule successfully created is displayed on the screen. The newly created schedule is displayed in the schedules list.

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:

    FieldDescription
    NameUnique name of the scheduler configuration.
    Schedule TypeType of the schedule. Possible types are:
    • Key Rotation
    • Key Refresh
    • Add KMS Container (GCP and Azure only)
    • Cloud Key Backup
    Cloud NameName of the cloud.
    Last ModifiedTime when the schedule is modified.
    FrequencyFrequency of the scheduler configuration.
    Start DateCreation time of the scheduler configuration.
    End DateExpiry time of the scheduler configuration.
    StatusStatus of the scheduler configuration. Possible values are:
    • Enabled
    • Disabled

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

  4. Edit or configure the following fields:

  5. Click Update to save the changes.

JOB HISTORY

The Schedules page also contains a section named JOB HISTORY. This section displays information related to a schedule such as Run Date, Job ID, Status, and Errors. For the KMS Container schedule, this section allows you to download the CSV report containing the list of Vaults or Subscriptions.

To download the report, click the overflow icon (ellipsis) corresponding to the desired schedule and click Download Vaults Only or Download Subscriptions Only.

Note

You can download the report after the schedule has run successfully.

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 (ellipsis) 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 (ellipsis) 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 (ellipsis) 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 (ellipsis) 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.

On this page