Snapshot Management in Gaia Clish - Scheduled Snapshots

Important: On Scalable Platforms (ElasticXL, Maestro, and Chassis), you must run the applicable commands in Gaia gClish of the applicable Security Group. Maestro Security Groups that contain different Security Appliance models do not support Gaia Snapshot operations (in the Global Gaia Portal or Global Gaia Clish). To collect or import a Gaia Snapshot in such a Security Group, connect directly to Gaia Portal or Gaia Clish on each Security Appliance in the Security Group.

Before you create a snapshot image, make sure the appliance or storage destination meets the prerequisites.

Description

Manage system images (snapshots).

From R81, you can also configure scheduled system images (snapshots).

Notes: R82 supports only one scheduled snapshot task. It is not possible to change any of the settings in the scheduled snapshot task. You must configure the task from scratch. To configure scheduled snapshots in Gaia Portal, see Snapshot Management in Gaia Portal.

Syntax

set snapshot-scheduled activation {enabled | disabled}

set snapshot-scheduled recurrence       daily time <HH:MM>       hourly hours {<Hours> | all} at <0-59>       interval minutes <1-59>       monthly month {<Months> | all} days <Days> time <HH:MM>       weekly days {<Days> | all} time <HH:MM>

set snapshot-scheduled retention-policy       keep-disk-space-above-in-GB <Limit>       max-snapshots-to-keep <1-9999>       min-snapshots-to-keep <1-9999>

set snapshot-scheduled settings snapshot-name-prefix <Prefix of Snapshot Name> description <Description of Snapshot>       target ftp ip <IPv4 Address of FTP Server> path <Path on FTP Server> username <User Name on FTP Server> {password <Password in Plain Text> | password-hash <Password Hash>}       target lvm       target scp ip <IPv4 Address of SCP Server> path <Path on SCP Server> username <User Name on SCP Server> {password <Password in Plain Text> | password-hash <Password Hash>}

show snapshot-scheduled <Prefix of Snapshot Name>

Procedure

1. Configure the scheduled snapshot task

   R82 supports only one of these scheduled snapshot tasks.

   You can only configure one task for a local LVM volume, one task for an FTP server, or one task for an SCP server.

   Creating a new snapshot image as a local LVM volume

   set snapshot-scheduled settings snapshot-name-prefix <Prefix of Snapshot Name> [description "<Description of Snapshot>"] target lvm

   Note - Gaia Snapshots are not files, but Logical Volume Management (LVM) volumes. Gaia stores these snapshots as a disk partition. To show the list of virtual drives, run the "lvs" command in the Expert mode.

   Creating a new snapshot image as a file and uploading it to an SCP server

   set snapshot-scheduled settings snapshot-name-prefix <Prefix of Snapshot Name> [description "<Description of Snapshot>"] target scp ip <IPv4 Address of SCP Server> path <Path on SCP Server> username <User Name on SCP Server> {password <Password in Plain Text> | password-hash <Password Hash>}

   Important: First, you must follow sk164234 to configure the SCP server as a trusted host on Gaia. The username must have permissions to delete files on the SCP server.

   Creating a new snapshot image as a file and uploading it to an FTP server

   set snapshot-scheduled settings snapshot-name-prefix <Prefix of Snapshot Name> [description "<Description of Snapshot>"] target ftp ip <IPv4 Address of FTP Server> path <Path on FTP Server> username <User Name on FTP Server> {password <Password in Plain Text> | password-hash <Password Hash>}

   Important -The username must have permissions to delete files on the FTP server.

2. Configure the recurrence for the snapshot schedule

   Running one time on each day at specified time

   set snapshot-scheduled recurrence daily time <HH:MM>

   Running several times each day at specified times

   set snapshot-scheduled recurrence hourly hours {<Hours> | all} at <0-59>

   Running several times each day at specified intervals

   set snapshot-scheduled recurrence interval minutes <1-59>

   Running in specified months on specified days and at specified time

   set snapshot–scheduled recurrence monthly month {<Months> | all} days <Days> time <HH:MM>

   Running each week on specified days of week and at specified time

   set snapshot-scheduled recurrence weekly days {<Days> | all} time <HH:MM>

3. Configure the snapshot retention policy

   Important: This step applies only if you save the new snapshot image as a local LVM volume. The retention policy applies only to the new snapshots (and does not apply to existing snapshots). When Gaia creates new snapshots, it deletes the oldest snapshot that exceeds the configured policy parameters.

   Configuring the maximum number of snapshot images to save

   set snapshot-scheduled retention-policy max-snapshots-to-keep <1-9999>

   Configuring the minimum number of snapshot images to save

   set snapshot-scheduled retention-policy min-snapshots-to-keep <1-9999>

   Configuring the amount of free disk space to maintain

   This command lets you configure how much of the disk space must remain free at all times:

   set snapshot-scheduled retention-policy keep-disk-space-above-in-GB <Limit>

   The limit you need to configure with this command is:

   Limit = (Available free disk space for all snapshot images) - (Free disk space to maintain)

   Where:

   Available free disk space for all snapshot images = = (Output of: vgdisplay | grep Free) - 1.1*(Output of: lvs | egrep "LSize|lv_current")

   Example

   For more information, see sk80260.

   1. Log in to the Expert mode.

   2. Get the free disk space in volume groups:

      [Expert@MyGaia:0]# vgdisplay | grep Free Free PE / Size 4090 / 127.81 GiB [Expert@MyGaia:0]#

   3. Get the free disk space in the "lv_current" partition:

      [Expert@MyGaia:0]# lvs | egrep "LSize|lv_current" LV VG Attr LSize Pool Origin Data% Meta% Move Log Cpy%Sync Convert lv_current vg_splat -wi-ao---- 40g [Expert@MyGaia:0]#

   4. Calculate the free disk space available for snapshot images:

      Available free disk space for all snapshot images = = (Output of "vgdisplay" command) - 1.1*(Output of "lvs" command) = = (127.81) - 1.1*(40) = 83.81 GB

   5. Calculate the limit for the scheduled snapshot task:

      For example, you need to maintain 30 GB of free disk space at all times.

      Limit = (Available free disk space for all snapshot images) - (Free disk space to maintain) = = (83.81 GB) - (30 GB) = 53.81 GB

   6. Log in to Gaia Clish.

   7. Configure the limit (round up or round down the limit you calculated in the previous step):

      set snapshot-scheduled retention-policy keep-disk-space-above-in-GB 54 save config

4. Enable the scheduled snapshot feature

   • To control this feature in Gaia Clish:

     • To enable the snapshot schedule:

       set snapshot-scheduled activation enabled

       Important: You must run this command after you configure a scheduled snapshot for the first time. You must run this command after any change in the existing configuration of a scheduled snapshot.

     • To disable the snapshot schedule:

       set snapshot-scheduled activation disabled

   • To control this feature in Gaia Portal:

     1. In the navigation tree, click Maintenance > Snapshot Management.

     2. In the section Scheduled Snapshots:

        • To enable the snapshot schedule, select Activate / Deactivate.

        • To disable the snapshot schedule, clear Activate / Deactivate.

     3. Click Apply.

5. Examine the scheduled snapshot configuration

   show snapshot-scheduled

Important - After you add, configure, or delete features, run the "save config" command to save the settings permanently. Scalable Platforms save the changes automatically.