Updating a disk snapshot schedule

If you do not have the Yandex Cloud CLI installed yet, install and initialize it.

By default, the CLI uses the folder specified when creating the profile. To change the default folder, use the yc config set folder-id <folder_ID> command. You can also set a different folder for any specific command using the --folder-name or --folder-id parameter.

1. See the description of the CLI commands for managing schedules:

   yc compute snapshot-schedule --help
   yc compute snapshot-schedule update --help
   

2. Get a list of schedules in the default folder:

   yc compute snapshot-schedule list --format yaml
   

   Result:

   - id: fc852cvb1ipd5********
     folder_id: e1ea8s8l71li********
     created_at: "2022-09-28T13:25:02Z"
   ...
       expression: 10 19 ? * *
     snapshot_count: "7"
     snapshot_spec: {}
   

3. Update the parameters of the selected schedule:

   yc compute snapshot-schedule update <schedule_name_or_ID> \
     --new-name <new_name_for_schedule> \
     --description <description> \
     --expression <cron_expression> \
     --retention-period <disk_snapshot_retention_period> \
     --snapshot-count <number_of_disk_snapshots> \
     --start-at <start_date_and_time> \
     --labels <labels>
   

   Where:

   • --new-name: New name for the schedule.
   • --description: Description.
   • --expression: Cron expression.
   • --retention-period: Disk snapshot retention period in seconds (s), minutes (m), or hours (h).
   • --snapshot-count: Number of retained disk snapshots. Use either --snapshot-count or --retention-period. Learn more about disk snapshot retention policies here.
   • --start-at: Start date and time. You can also specify a period relative to the current time point, e.g., "2022-12-31T16:39:00+05:00" or "2h".
   • --labels: List of labels in key=value format.

   For more information about the yc compute snapshot-schedule update command, see this CLI reference.

   Result:

   done (3s)
   id: fc8e52mvchb2********
   folder_id: e1ea8s8l71li********
   ...
     expression: 36 14 */1 * *
   snapshot_count: "3"
   snapshot_spec: {}
   

If you do not have Terraform yet, install it and configure the Yandex Cloud provider.

1. Open the Terraform configuration file and edit the section specifying the schedule:

   Example of specifying a schedule in Terraform configuration

   resource "yandex_compute_snapshot_schedule" "default" {
     name = "my-name"
   
     schedule_policy {
       expression = "0 0 * * *"
     }
   
     snapshot_count = 1
   
     snapshot_spec {
       description = "snapshot-description"
       labels = {
         snapshot-label = "my-snapshot-label-value"
       }
     }
   
     disk_ids = ["test_disk_id", "another_test_disk_id"]
   }
   

2. Apply the changes:

   1. In the terminal, go to the directory where you edited the configuration file.

   2. Make sure the configuration file is correct using this command:

      terraform validate
      

      If the configuration is correct, you will get this message:

      Success! The configuration is valid.
      

   3. Run this command:

      terraform plan
      

      You will see a detailed list of resources. No changes will be made at this step. If the configuration contains any errors, Terraform will show them.

   4. Apply the changes:

      terraform apply
      

   5. Type yes and press Enter to confirm the changes.

You can check the schedule update and settings using the management console or this CLI command:

yc compute snapshot-schedule get <schedule_name>

1. Get a list of schedules using the list REST API method for the SnapshotSchedule resource or the SnapshotScheduleService/List gRPC API call.

   You can create snapshots of network disks and drives, such as HDDs, SSDs, and non-replicated SSDs, as well as ultra high-speed network storages with three replicas (SSD).

   For non-replicated SSDs and ultra high-speed network storages with three replicas (SSD), the snapshot time is not determined.

   To create snapshots of local disks residing on dedicated hosts, use Yandex Cloud Backup. This service supports Ubuntu, CentOS, CentOS Stream, and Windows Server.

2. Update a disk snapshot schedule using the update REST API method for the SnapshotSchedule resource or the SnapshotScheduleService/Update gRPC API call.

If you do not have the Yandex Cloud CLI installed yet, install and initialize it.

By default, the CLI uses the folder specified when creating the profile. To change the default folder, use the yc config set folder-id <folder_ID> command. You can also set a different folder for any specific command using the --folder-name or --folder-id parameter.

Add or remove disks using the add-disks and remove-disks commands.

To add disks:

1. See the description of the CLI commands for managing schedules:

   yc compute snapshot-schedule --help
   yc compute snapshot-schedule add-disks --help
   

2. Get a list of schedules in the default folder:

   yc compute snapshot-schedule list --format yaml
   

   Result:

   - id: fc852cvb1ipd5********
     folder_id: e1ea8s8l71li********
     created_at: "2022-09-28T13:25:02Z"
   ...
       expression: 10 19 ? * *
     snapshot_count: "7"
     snapshot_spec: {}
   

3. Get disk IDs to add them to the schedule:

   yc compute disk list --format yaml
   

   Result:

   - id: epdcq9g3co9s********
     folder_id: e1ea8s8l71li********
     created_at: "2022-10-13T14:37:44Z"
   ...
     instance_ids:
       - fhm1c7u23aiq********
     disk_placement_policy: {}
   

4. Add disks to the schedule:

   yc compute snapshot-schedule add-disks <schedule_name_or_ID> \
     --disk-id <disk_1_ID>,<disk_2_ID>
   

   Result:

   done (3s)
   id: fc8e52mvchb2********
   folder_id: e1ea8s8l71li********
   ...
     expression: 36 14 */1 * *
   snapshot_count: "3"
   snapshot_spec: {}
   

To remove disks:

1. See the description of the CLI commands for managing schedules:

   yc compute snapshot-schedule --help
   yc compute snapshot-schedule remove-disks --help
   

2. Get a list of schedules in the default folder:

   yc compute snapshot-schedule list --format yaml
   

   Result:

   - id: fc852cvb1ipd5********
     folder_id: e1ea8s8l71li********
     created_at: "2022-09-28T13:25:02Z"
   ...
       expression: 10 19 ? * *
     snapshot_count: "7"
     snapshot_spec: {}
   

3. Get a list of disks in the current schedule:

   yc compute snapshot-schedule list-disks <schedule_name_or_ID> \
     --format yaml
   

   Result:

   - id: epdcq9g3co9s********
     folder_id: e1ea8s8l71li********
     created_at: "2022-10-13T14:37:44Z"
   ...
     instance_ids:
       - fhm1c7u23aiq********
     disk_placement_policy: {}
   

4. Remove disks from the schedule:

   yc compute snapshot-schedule remove-disks <schedule_name_or_ID> \
     --disk-id <disk_1_ID>,<disk_2_ID>
   

   Result:

   done (3s)
   id: fc8e52mvchb2********
   folder_id: e1ea8s8l71li********
   ...
     expression: 36 14 */1 * *
   snapshot_count: "3"
   snapshot_spec: {}
   

1. Get a list of schedules using the list REST API method for the SnapshotSchedule resource or the SnapshotScheduleService/List gRPC API call.
2. Get a list of disks using the list REST API method for the Disk resource or the DiskService/List gRPC API call.
3. Update the list of disks in a schedule using the updateDisks REST API method for the SnapshotSchedule resource or the SnapshotScheduleService/UpdateDisks gRPC API call.