Installing a CPUSE Software Package on Gaia

Part 1 of 3 - Download / Import the CPUSE Software Package

If the required package appears in Gaia Portal / Gaia Clish, you can download it.

If you do not see the required package in Gaia Portal / Gaia Clish, you can download and import it manually.

You can download / import a CPUSE package in Gaia Portal or in Gaia Clish / Gaia gClish.

Follow one of the available procedures below based on the CPUSE package location:

Where to Perform the Procedure?	Package Location	Procedure
In Gaia Portal	Check Point Cloud	Download only Import
	Local Directory	Import
In Gaia Clish / Gaia gClish	Check Point Cloud	Download only Import
	Local Directory	Import
	FTP Server	Import

Procedure in Gaia Portal to download a CPUSE package from the Check Point Cloud

This procedure applies only if the Gaia server is connected to the Internet, and you see the required package in Gaia Portal.

Step

Instructions

With a web browser, connect to Gaia Portal at:

https://<IP address of Gaia Management Interface>

If you changed the default port of Gaia Portal from 443, then you must also enter it (https://<IP address>:<Port>).

Important - On Scalable Platforms (Maestro and Chassis), you must connect to the Gaia Portal of the applicable Security Group.

In the left navigation tree, click Software Updates > Available Updates.

Expand the applicable section:

Major Versions
Jumbo Hotfix Accumulator Takes
Hotfix Packages

Best Practice - Before you download an online CPUSE package, make sure it is fully compatible with your Gaia version. If the CPUSE package is not compatible, this verification saves the download time and shows if some prerequisite package is missing.

In the applicable row, click Verify.

While the CPUSE Deployment Agent performs this action, you can click other pages in Gaia Portal.

When you return to this page and section, the applicable row shows the verification verdict.

In the applicable row, click Download (if this package is compatible).

You can click Pause (survives reboot) and Resume.

Procedure in Gaia Clish / Gaia gClish to download a CPUSE package from the Check Point Cloud

This procedure applies only if the Gaia server is connected to the Internet, and you see the required package in Gaia Clish / Gaia gClish.

Note - For the complete Gaia Clish syntax, see CPUSE Syntax in Gaia Clish / Gaia gClish.

Step

Instructions

Connect to the command line on the Gaia server.

Important - On Scalable Platforms (Maestro and Chassis), you must run the applicable commands in Gaia gClish of the applicable Security Group.

If your default shell is the Expert mode, then go to Gaia Clish:

clish

On Scalable Platforms, go to Gaia gClish:

Type gclish and press Enter.

If you enabled MDPS (sk138672) on the Security Gateway / Cluster Members / Scalable Platform, then go to the Management Plane:

set mdps environment mplane

Verify the required CPUSE package:

installer verify PRESS THE TAB KEY TO SEE ALL PACKAGES

installer verify <ID> [not-interactive]

"<ID>" is the package number in the list.

Download the required CPUSE package (if this package is compatible):

installer download PRESS THE TAB KEY TO SEE ALL PACKAGES

installer download <ID>

[not-interactive]

[pause]

[resume [not-interactive]]

"<ID>" is the package number in the list.

You can pause (survives reboot) and resume the download.

Examine the list of the available CPUSE packages:

show installer packages all

A new row appears in the corresponding section:

Major Versions
Gaia Fast Deployment Images
Jumbo Hotfix Accumulator Takes
Hotfix Packages

Procedure in Gaia Portal to import a CPUSE package from the Check Point Cloud

This procedure applies only if the Gaia server is connected to the Internet, and you do not see the required package in Gaia Portal.

Step

Instructions

With a web browser, connect to Gaia Portal at:

https://<IP address of Gaia Management Interface>

If you changed the default port of Gaia Portal from 443, then you must also enter it (https://<IP address>:<Port>).

Important - On Scalable Platforms (Maestro and Chassis), you must connect to the Gaia Portal of the applicable Security Group.

In the left navigation tree, click Software Updates > Available Updates.

In the top left, click Add package and click Find package view in cloud.

In the Add a package from cloud window:

Paste the CPUSE Identifier string (case-sensitive).

The "<CPUSE Identifier>" string is provided by Check Point Support, in SK articles, or in Administration Guides.
Click the magnifying glass icon to start the search.
When the package is found, this window shows the package size and the release date.

If such CPUSE package does not exist, if there is a mistake in the pasted CPUSE Identifier, or if this CPUSE package is not compatible with your Gaia version, then this window shows:
```
No package was found
```
```
Enter full and correct package name
```
Click Add Package to add it to the list of available packages.

This action only imports the package metadata (information about the package).

A new row appears in the corresponding section:

Major Versions
Jumbo Hotfix Accumulator Takes
Hotfix Packages

Procedure in Gaia Clish / Gaia gClish to import a CPUSE package from the Check Point Cloud

This procedure applies only if the Gaia server is connected to the Internet, and you do not see the required package in Gaia Clish / Gaia gClish.

Note - For the complete Gaia Clish syntax, see CPUSE Syntax in Gaia Clish / Gaia gClish.

Step

Instructions

Connect to the command line on the Gaia server.

Important - On Scalable Platforms (Maestro and Chassis), you must run the applicable commands in Gaia gClish of the applicable Security Group.

If your default shell is the Expert mode, then go to Gaia Clish:

clish

On Scalable Platforms, go to Gaia gClish:

Type gclish and press Enter.

If you enabled MDPS (sk138672) on the Security Gateway / Cluster Members / Scalable Platform, then go to the Management Plane:

set mdps environment mplane

Import the required CPUSE package:

installer import cloud CPUSE Identifier

The "<CPUSE Identifier>" string is provided by Check Point Support, in SK articles, or in Administration Guides.

If such CPUSE package does not exist, if there is a mistake in the pasted CPUSE Identifier, or if this CPUSE package is not compatible with your Gaia version, then this window shows:

No package was found

Enter full and correct package name

Examine the list of the available CPUSE packages:

show installer packages all

A new row appears in the corresponding section:

Major Versions
Gaia Fast Deployment Images
Jumbo Hotfix Accumulator Takes
Hotfix Packages

Procedure in Gaia Portal to import an Offline CPUSE package - from your computer

This procedure applies only if you do not see the required package in Gaia Portal.

You can perform this procedure on a Gaia server regardless its connection to the Internet.

Step

Instructions

Download the required Offline CPUSE package to your computer, from which you connect to Gaia Portal.

These packages are provided in SK articles, by Check Point Support, or in Administration Guides.

Important - Make sure the hash checksum of the downloaded package is the same as appears on its download page.

With a web browser, connect to Gaia Portal at:

https://<IP address of Gaia Management Interface>

If you changed the default port of Gaia Portal from 443, then you must also enter it (https://<IP address>:<Port>).

Important - On Scalable Platforms (Maestro and Chassis), you must connect to the Gaia Portal of the applicable Security Group.

In the left navigation tree, click Software Updates > Available Updates.

In the top left, click Add package > Upload package from local.

In the Import package window:

Click Browse for a file.
Select the CPUSE package and click Open.
Read the package name to make sure and click Import.

A new row appears in the corresponding section:

Major Versions
Jumbo Hotfix Accumulator Takes
Hotfix Packages

Procedure in Gaia Clish / Gaia gClish to import an Offline CPUSE package - from the Gaia local directory

This procedure applies only if you do not see the required package in Gaia Clish / Gaia gClish.

You can perform this procedure on a Gaia server regardless its connection to the Internet.

Note - For the complete Gaia Clish syntax, see CPUSE Syntax in Gaia Clish / Gaia gClish.

Step

Instructions

Download the required Offline CPUSE package to your computer, from which you connect to the Gaia server.

These packages are provided in SK articles, by Check Point Support, or in Administration Guides.

Important - Make sure the hash checksum of the downloaded package is the same as appears on its download page.

Transfer the Offline CPUSE package from your computer to the Gaia server to some directory (for example, /var/log/).

Note - See sk42178 - How to connect with WinSCP to Gaia OS.

Connect to the command line on the Gaia server.

Important - On Scalable Platforms (Maestro and Chassis), you must run the applicable commands in Gaia gClish of the applicable Security Group.

If your default shell is the Expert mode, then go to Gaia Clish:

clish

On Scalable Platforms, go to Gaia gClish:

Type gclish and press Enter.

If you enabled MDPS (sk138672) on the Security Gateway / Cluster Members / Scalable Platform, then go to the Management Plane:

set mdps environment mplane

Import the required CPUSE package from the local directory:

installer import local <Full Local Path> [not-interactive]

"<Full Local Path>" is the absolute path that includes the file name (for example, /var/log/Hotfix_Package.tgz).

Examine the list of the available CPUSE packages:

show installer packages all

A new row appears in the corresponding section:

Major Versions
Gaia Fast Deployment Images
Jumbo Hotfix Accumulator Takes
Hotfix Packages

Procedure in Gaia Clish / Gaia gClish to import an Offline CPUSE package - from an FTP server

This procedure applies only if you do not see the required package in Gaia Clish / Gaia gClish.

You can perform this procedure on a Gaia server regardless its connection to the Internet.

Note - For the complete Gaia Clish syntax, see CPUSE Syntax in Gaia Clish / Gaia gClish.

Step

Instructions

Download the required Offline CPUSE package to your computer.

These packages are provided in SK articles, by Check Point Support, or in Administration Guides.

Important - Make sure the hash checksum of the downloaded package is the same as appears on its download page.

Transfer the Offline CPUSE package from your computer to your FTP server.

Important - Make sure the hash checksum of the uploaded package is the same as appears on its download page.

Connect to the command line on the Gaia server.

Important - On Scalable Platforms (Maestro and Chassis), you must run the applicable commands in Gaia gClish of the applicable Security Group.

If your default shell is the Expert mode, then go to Gaia Clish:

clish

On Scalable Platforms, go to Gaia gClish:

Type gclish and press Enter.

If you enabled MDPS (sk138672) on the Security Gateway / Cluster Members / Scalable Platform, then go to the Management Plane:

set mdps environment mplane

Import the required CPUSE package from the FTP server:

installer import ftp <FTP IPv4 address> path <FTP Path> username <FTP Username> [password <FTP Password>] [not-interactive]

"<FTP Path>" is the relative path on the FTP server that includes the file name

(for example, Packages/Hotfix_Package.tgz).
You can specify the FTP password as part of the syntax.

Examine the list of the available CPUSE packages:

show installer packages all

A new row appears in the corresponding section:

Major Versions
Gaia Fast Deployment Images
Jumbo Hotfix Accumulator Takes
Hotfix Packages

Part 2 of 3 - Verify the CPUSE Software Package

Best Practice - Before you start the download or installation of a CPUSE package that appears in Gaia Portal or in Gaia Clish / Gaia gClish, make sure this CPUSE package is fully compatible with your Gaia Operating System.

If the CPUSE package is not compatible, this verification saves the download time and shows if some prerequisite package is missing.

If you start the installation of a CPUSE package that is not compatible, the installation fails with the corresponding message.

You can verify a CPUSE package in Gaia Portal or in Gaia Clish / Gaia gClish.

Follow one of the available procedures below.

Procedure in Gaia Portal to verify a CPUSE package

Important - On Scalable Platforms (Maestro and Chassis), you must connect to the Gaia Portal of the applicable Security Group.

Step

Instructions

With a web browser, connect to Gaia Portal at:

https://<IP address of Gaia Management Interface>

If you changed the default port of Gaia Portal from 443, then you must also enter it (https://<IP address>:<Port>).

Important - On Scalable Platforms (Maestro and Chassis), you must connect to the Gaia Portal of the applicable Security Group.

In the left navigation tree, click Software Updates > Available Updates.

Expand the applicable section:

Major Versions
Jumbo Hotfix Accumulator Takes
Hotfix Packages

Use the applicable option:

In the section Major Versions:

To verify if the CPUSE package is suitable for an upgrade:

In the applicable row, click the Verify button.

This action uses the current Gaia server role - Security Gateway, Security Management Server, or Multi-Domain Security Management Server.

Note - Support for different Gaia server roles in CPUSE packages is on the roadmap.

To verify if the CPUSE package is suitable for a clean install:

In the applicable row, click the 3-dot menu > click Verify clean install > click the desired Gaia server role:

As Security Gateway

Examines if this CPUSE package is suitable for a clean install as a Security Gateway
As Security Management

Examines if this CPUSE package is suitable for a clean install as a Security Management Server
As Multi-Domain Server

Examines if this CPUSE package is suitable for a clean install as a Multi-Domain Security Management Server

Note - Support for different Gaia server roles in CPUSE packages is on the roadmap.

In the section Jumbo Hotfix Accumulator Takes:

In the applicable row, click the Verify button.
In the section Hotfix Packages:

In the applicable row, click the Verify button.

While the CPUSE Deployment Agent performs this action, you can click other pages in Gaia Portal.

When you return to this page and section, the applicable row shows the verification verdict.

Procedure in Gaia Clish / Gaia gClish to verify a CPUSE package

Note - For the complete Gaia Clish syntax, see CPUSE Syntax in Gaia Clish / Gaia gClish.

Step

Instructions

Connect to the command line on the Gaia server.

Important - On Scalable Platforms (Maestro and Chassis), you must run the applicable commands in Gaia gClish of the applicable Security Group.

If your default shell is the Expert mode, then go to Gaia Clish:

clish

On Scalable Platforms, go to Gaia gClish:

Type gclish and press Enter.

If you enabled MDPS (sk138672) on the Security Gateway / Cluster Members / Scalable Platform, then go to the Management Plane:

set mdps environment mplane

Verify the required CPUSE package:

installer verify PRESS THE TAB KEY TO SEE ALL PACKAGES

installer verify <ID> [not-interactive]

"<ID>" is the package number in the list.

Part 3 of 3 - Install the CPUSE Software Package

Important - Before you install a CPUSE package on a Cluster or Scalable Platform, make sure to read the corresponding Administration Guide.

Installation of any software package on Clusters and Scalable Platforms is considered an upgrade.

Clusters and Scalable Platforms support several upgrade methods that have a different affect on your current connections.

Best Practices:

Before you install a CPUSE package, make sure it is fully compatible with your Gaia version. See Part 2 of 3 - Verify the CPUSE Software Package.
Before you perform an upgrade, read the Installation and Upgrade Guide for your version - the chapter for the product on your Gaia server.
Before you perform an upgrade, back up all files, in which you made manual changes.

After and upgrade, make the required manual changes again in the applicable files.

Do not overwrite the files with their backup copies.

The content of the files may change between the major versions and Jumbo Hotfix Accumulator Takes.

You can install a CPUSE package in Gaia Portal or in Gaia Clish / Gaia gClish.

Follow one of the available procedures below based on the CPUSE package type:

Where to Perform the Procedure?	Package Type	Procedure
In Gaia Portal	Higher Major Version	Clean Install Upgrade
	Jumbo Hotfix Accumulator, Hotfix	Install
In Gaia Clish / Gaia gClish	Higher Major Version	Clean Install Upgrade
	Jumbo Hotfix Accumulator, Hotfix	Install

Procedure in Gaia Portal to install a CPUSE package - a Clean Install of a higher Major Version

This procedure does not keep your settings or changes in files.

This procedure:

Creates a new disk partition.
Performs a Clean Install of the selected major version.
Reboots the Gaia server.
Boots from the new disk partition with the new major version.
Deletes the disk partition with the previous major version.

Step

Instructions

With a web browser, connect to Gaia Portal at:

https://<IP address of Gaia Management Interface>

If you changed the default port of Gaia Portal from 443, then you must also enter it (https://<IP address>:<Port>).

Important - On Scalable Platforms (Maestro and Chassis), you must connect to the Gaia Portal of the applicable Security Group.

In the left navigation tree, click Software Updates > Available Updates.

Expand the section Major Versions.

In the applicable row, click the 3-dot menu and click Clean install.

Procedure in Gaia Clish / Gaia gClish to install a CPUSE package - a Clean Install of a higher Major Version

Note - For the complete Gaia Clish syntax, see CPUSE Syntax in Gaia Clish / Gaia gClish.

This procedure does not keep your settings or changes in files.

This procedure:

Creates a new disk partition.
Performs a Clean Install of the selected major version.
Reboots the Gaia server.
Boots from the new disk partition with the new major version.
Deletes the disk partition with the previous major version.

Step

Instructions

Connect to the command line on the Gaia server.

Important - On Scalable Platforms (Maestro and Chassis), you must run the applicable commands in Gaia gClish of the applicable Security Group.

If your default shell is the Expert mode, then go to Gaia Clish:

clish

On Scalable Platforms, go to Gaia gClish:

Type gclish and press Enter.

If you enabled MDPS (sk138672) on the Security Gateway / Cluster Members / Scalable Platform, then go to the Management Plane:

set mdps environment mplane

Install the required CPUSE package (after you download or import it):

installer clean-install PRESS THE TAB KEY TO SEE ALL PACKAGES

installer clean-install <ID> [role <Server Role>] [not-interactive]

"<ID>" is the package number in the list.
The optional parameter "role" specifies how to configure this Gaia server after the package installation - as a Security Gateway, a Management Server, and so on.

Press the Tab key to see the available options that the specified software package supports.

Procedure in Gaia Portal to install a CPUSE package - an Upgrade to a higher Major Version

This procedure upgrades the current major version to the selected higher major version.

This procedure keeps your settings, except for Check Point configuration files.

Step

Instructions

With a web browser, connect to Gaia Portal at:

https://<IP address of Gaia Management Interface>

If you changed the default port of Gaia Portal from 443, then you must also enter it (https://<IP address>:<Port>).

Important - On Scalable Platforms (Maestro and Chassis), you must connect to the Gaia Portal of the applicable Security Group.

In the left navigation tree, click Software Updates > Available Updates.

Expand the section Major Versions.

In the applicable row, click Upgrade.

Procedure in Gaia Clish / Gaia gClish to install a CPUSE package - an Upgrade to a higher Major Version

Note - For the complete Gaia Clish syntax, see CPUSE Syntax in Gaia Clish / Gaia gClish.

This procedure upgrades the current major version to the selected higher major version.

This procedure keeps your settings, except for Check Point configuration files.

Step

Instructions

Connect to the command line on the Gaia server.

Important - On Scalable Platforms (Maestro and Chassis), you must run the applicable commands in Gaia gClish of the applicable Security Group.

If your default shell is the Expert mode, then go to Gaia Clish:

clish

On Scalable Platforms, go to Gaia gClish:

Type gclish and press Enter.

If you enabled MDPS (sk138672) on the Security Gateway / Cluster Members / Scalable Platform, then go to the Management Plane:

set mdps environment mplane

Install the required CPUSE package (after you download or import it):

installer upgrade PRESS THE TAB KEY TO SEE ALL PACKAGES

installer upgrade <ID> [not-interactive]

"<ID>" is the package number in the list.

Procedure in Gaia Portal to install a CPUSE package - a Jumbo Hotfix Accumulator or a Hotfix

Step

Instructions

With a web browser, connect to Gaia Portal at:

https://<IP address of Gaia Management Interface>

If you changed the default port of Gaia Portal from 443, then you must also enter it (https://<IP address>:<Port>).

Important - On Scalable Platforms (Maestro and Chassis), you must connect to the Gaia Portal of the applicable Security Group.

In the left navigation tree, click Software Updates > Available Updates.

Expand the applicable section:

Jumbo Hotfix Accumulator Takes
Hotfix Packages

In the applicable row, click Install.

Procedure in Gaia Clish / Gaia gClish to install a CPUSE package - a Jumbo Hotfix Accumulator or a Hotfix

Note - For the complete Gaia Clish syntax, see CPUSE Syntax in Gaia Clish / Gaia gClish.

Step

Instructions

Connect to the command line on the Gaia server.

Important - On Scalable Platforms (Maestro and Chassis), you must run the applicable commands in Gaia gClish of the applicable Security Group.

If your default shell is the Expert mode, then go to Gaia Clish:

clish

On Scalable Platforms, go to Gaia gClish:

Type gclish and press Enter.

If you enabled MDPS (sk138672) on the Security Gateway / Cluster Members / Scalable Platform, then go to the Management Plane:

set mdps environment mplane

Install the required CPUSE package if you already downloaded / imported it:

installer install PRESS THE TAB KEY TO SEE ALL PACKAGES

installer install <ID> [not-interactive]

Download and install the required CPUSE package from the Check Point cloud, if you did not downloaded / import it yet:

installer download-and-install PRESS THE TAB KEY TO SEE ALL PACKAGES

installer download-and-install <ID> [not-interactive]

"<ID>" is the package number in the list.