Snapshot Management in Gaia Clish - Regular Snapshots

Important:

On Scalable Platforms (Maestro and Chassis), you must connect to the Gaia Portal 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 - see Snapshot Prerequisites.

Description

Manage system images (snapshots).

Syntax

Creating a new snapshot image

These commands only create a new snapshot image.

Creating a new snapshot image as a local LVM volume

add snapshot-onetime name <Name of Snapshot> [description "<Description of Snapshot>"]

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 and exporting it to a local file

add snapshot-onetime name <Name of Snapshot> [description "<Description of Snapshot>"] target local path <Local Path>

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

add snapshot-onetime name <Name of Snapshot> [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>

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

add snapshot-onetime name <Name of Snapshot> [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>

Exporting an existing snapshot image

These commands only export an existing snapshot image from a local LVM volume.

Exporting an existing snapshot image and saving it as a local file

set snapshot-onetime export <Name of Exported Snapshot> target local path <Local Path>

Exporting an existing snapshot image as a file and uploading it to an FTP server

set snapshot-onetime export <Name of Exported Snapshot> target ftp path <Path on FTP Server> ip <IPv4 Address of FTP Server> username <User Name on FTP Server> password <Password in Plain Text>

Exporting an existing snapshot image as a file and uploading it to an SCP server

set snapshot-onetime export <Name of Exported Snapshot> target scp path <Path on SCP Server> ip <IPv4 Address of SCP Server> username <User Name on SCP Server> password <Password in Plain Text>

Importing an existing snapshot image

These commands only import an existing snapshot image file and store it on Gaia as a local LVM volume.

Importing an existing snapshot image from a local file

set snapshot-onetime import <Name of Imported Snapshot> target local path <Local Path>

Importing an existing snapshot image from an FTP server

set snapshot-onetime import <Name of Imported 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>

Importing an existing snapshot image from an SCP server

set snapshot-onetime import <Name of Imported 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>

Importing and reverting to an existing snapshot image

These commands import an existing snapshot image, store it on Gaia as a local LVM volume, and then revert to that imported snapshot image.

Important:

When Gaia reverts to a snapshot, it overwrites the existing running configuration and settings. Make sure you know credentials of the snapshot, to which you revert.
Before you revert to a snapshot on a new appliance, or after a reset to factory defaults, you must run the Gaia First Time Configuration Wizard and configure the same settings as before you created the snapshot.
If you reverted a snapshot on a Security Gateway / Cluster Member, install the Security Policy.

Importing and reverting an existing snapshot image from a local LVM volume

set snapshot-onetime revert target lvm name <External Name of Snapshot>

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

Importing and reverting an existing snapshot image from a local file

set snapshot-onetime revert target local name <Imported Name of Snapshot> path <Local Path>

Importing and reverting an existing snapshot image from an FTP server

set snapshot-onetime revert target ftp name <Imported Name of Snapshot> path <Path on FTP Server> ip <IPv4 Address of FTP Server> username <User Name on FTP Server> password <Password in Plain Text>

Import and reverting an existing snapshot image from an SCP server

set snapshot-onetime revert target scp name <Imported Name of Snapshot> path <Path on SCP Server> ip <IPv4 Address of SCP Server> username <User Name on SCP Server> password <Password in Plain Text>

Viewing existing snapshot images

show snapshots

show snapshot <Name of Snapshot>

all

      date

      description

      size

Deleting a local snapshot image

delete snapshot <Name of Snapshot>

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

Parameters

Parameter	Description
`name <Name of Snapshot>`	Configures the name of the new snapshot image. You must enter a string that does not contain spaces.
`name <Name of Exported Snapshot>`	Configures the name, under which the exported snapshot image file is stored. You must enter a string that does not contain spaces. You must not add an extension. The maximum length is 255 characters.
`name <Name of Imported Snapshot>`	Configures the name, under which the imported snapshot image is stored on this Gaia. You must enter a string that does not contain spaces.
`description "<Description of Snapshot>"`	Optional. Configures the description of the snapshot image. You must enclose the text in double quotes, or enter the string that does not contain spaces.
`export <Name of Snapshot>`	Exports the snapshot image by the specified name. You must enter a string that does not contain spaces.
`import <Name of Snapshot>`	Imports the snapshot image by the specified name. You must enter a string that does not contain spaces.
`target`	When you create or export a snapshot, specifies the destination for the snapshot image. When you import a snapshot, specifies the source of the snapshot image. `target lvm` - Local LVM volume on this Gaia `target local` - Local file on this Gaia `target ftp` - Remote FTP server `target scp` - Remote SCP server
`ip`	Specifies the IPv4 address of the remote server: `ip <IPv4 Address of FTP Server>` Specifies the IPv4 address of the remote FTP server. `ip <IPv4 Address of SCP Server>` Specifies the IPv4 address of the remote SCP server.
`path`	Specifies the path to the snapshot image file. When you export, this is the path to the directory (`/path_to/directory/`). When you import, this is the path to the directory and the snapshot image (`/path_to/directory/snapshot`). `path <Local Path>` Specifies the local absolute path on this Gaia. `path <Path on FTP Server>` Specifies the path on the remote FTP server. `path <Path on SCP Server>` Specifies the path on the remote SCP server.
`username`	Specifies the login username on the remote server: `username <User Name on FTP Server>` Specifies the user name required to log in to the remote FTP server. `username <User Name on SCP Server>` Specifies the user name required to log in to the remote SCP server.
`password <Password in Plain Text>`	Specifies the password (in plain text) required to log in to the remote server.

Examples

Creating a new snapshot image locally as a file:

gaia> add snapshot-onetime name 1st_image_after_install description "First image after installation" target local path /var/log/

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

gaia> add snapshot-onetime name 1st_image_after_install description "First image after installation" target scp ip 192.168.20.30 path /var/log/ username scp_admin password 123456

Importing an existing snapshot image from an SCP server:

gaia> set snapshot-onetime import 1st_image_after_install target scp ip 192.168.20.30 path /var/log/ username scp_admin password 123456

Troubleshooting

If a snapshot was not created, examine these files:

/var/log/messages*

If a snapshot was created, but there were some issues, examine this file:

/var/log/CPsnapshot/<Snapshot Name>_<Timestamp>