CPUSE Syntax in Gaia Clish / Gaia gClish

Important:

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

  • When you enable MDPS (sk138672) on the Security Gateway / Cluster Members / Scalable Platform, you must run the CPUSE commands only in the Management Plane:

    set mdps environment mplane

Syntax to View CPUSE Software Packages and CPUSE Deployment Agent Settings

show installer

      cpinfo

      mail-notifications <Email Address>

      package <ID>

            all

            contained-in

            contains

            description

            display-name

            downloaded-on

            imported-on

            installation-log

            installed-on

            recommended

            requires-reboot

            size

            status

            type

      packages

            all

            available-for-download

            downloaded

            imported

            installed

            recommended

      policy

            all

            auto-compress-snapshot

            check-for-updates-period

            downloads

            periodically-self-update

            self-test

                  all

                  install-policy

                  network-link-up

                  start-processes

      status

            agent

            all

            build

            connection

            license

            update-from-cloud

Command

Description

show installer cpinfo

Shows the installed software packages and Hotfixes.

Gaia Clish runs the command "cpinfo -y all".

show installer mail-notifications <Email Address>

Shows mail notifications for the specified email address.

Press the Tab key to see the configured email addresses.

show installer package <ID> <options>

Shows information about the specified CPUSE package.

  • Press the Tab key to see the available package identifiers.

    "<ID>" is the package number in the list, or the online CPUSE Identifier.

  • show installer package <ID> all

    Shows all information about the specified package.

  • show installer package <ID> contained-in

    Shows the packages, in which the specified package is contained.

  • show installer package <ID> contains

    Shows other packages that the specified package contains.

  • show installer package <ID> description

    Shows the description for the specified package.

  • show installer package <ID> display-name

    Shows the display name for the specified package.

  • show installer package <ID> downloaded-on

    Shows when the specified package was downloaded.

  • show installer package <ID> imported-on

    Shows when the specified package was imported.

  • show installer package <ID> installation-log

    Shows the path of the installation log for the specified package.

  • show installer package <ID> installed-on

    Shows when the specified package was installed.

  • show installer package <ID> recommended

    Shows if the specified package is recommended by Check Point for installation.

  • show installer package <ID> requires-reboot

    Shows if the specified package requires reboot after installation.

  • show installer package <ID> size

    Shows the size of the specified package.

  • show installer package <ID> status

    Shows the status of the specified package (available, downloaded, imported, or installed).

  • show installer package <ID> type

    Shows the type of the specified package.

show installer packages <options>

Shows information about all CPUSE packages for this Gaia operating system:

  • show installer packages all

    Shows all packages for this Gaia operating system (available, downloaded, imported, and installed).

  • show installer packages available-for-download

    Shows all packages that are available for download for this Gaia operating system.

  • show installer packages downloaded

    Shows all packages that were downloaded, but not installed yet.

  • show installer packages imported

    Shows all packages that were imported, but not installed yet.

  • show installer packages installed

    Shows all packages that were installed.

  • show installer packages recommended

    Shows all online packages that are recommended for this Gaia operating system.

show installer policy <options>

Shows the CPUSE Deployment Agent settings:

  • show installer policy all

    Shows all settings.

  • show installer policy auto-compress-snapshot

    Shows whether the Gaia snapshot auto-compress for Major Version installations is enabled or disabled.

    Note - This setting is not available in Gaia Portal.

  • show installer policy check-for-updates-period

    Shows how frequently to check for new available software packages.

  • show installer policy downloads

    Shows how the CPUSE Deployment Agent downloads the online packages (automatically, manually, or based on a schedule).

    Note - This setting is not available in Gaia Portal.

  • show installer policy periodically-self-update

    Shows whether the CPUSE Deployment Agent automatically updates itself if a new CPUSE Deployment Agent version is available.

  • show installer policy self-test all

    Shows which tests the CPUSE Deployment Agent perform after it installs a software package.

  • show installer policy self-test install-policy

    Shows whether after it installs a software package, the CPUSE Deployment Agent checks that the local security policy is installed successfully.

  • show installer policy self-test network-link-up

    Shows whether after it installs a software package, the CPUSE Deployment Agent checks that the link is up on the configured interfaces.

  • show installer policy self-test start-processes

    Shows whether after it installs a software package, the CPUSE Deployment Agent checks that the required Check Point processes are running.

show installer status <options>

Shows information about the CPUSE Deployment Agent:

  • show installer status agent

    Shows the CPUSE Deployment Agent status (enabled or disabled).

  • show installer status all

    Shows all information about the CPUSE Deployment Agent (status, build number, network connection to cloud, last update date, license status).

  • show installer status build

    Shows the build number of the CPUSE Deployment Agent.

  • show installer status connection

    Shows the status of the network connection of the CPUSE Deployment Agent to Check Point cloud.

  • show installer status license

    Shows the status of the license (whether it allows the CPUSE Deployment Agent to work).

  • show installer status update-from-cloud

    Shows the date and time of the last update from Check Point cloud.

Syntax to Work with CPUSE Software Packages and CPUSE Deployment Agent

installer agent

      disable

      enable

      install <Local Path to Deployment Agent Package>

      start

      stop

      update [not-interactive]

installer check-for-updates [not-interactive]

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

installer delete <ID> [not-interactive]

installer download <ID>

      [not-interactive]

      [pause]

      [resume [not-interactive]]

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

installer import

      cloud <CPUSE Identifier> [not-interactive]

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

      local <Full Local Path> [not-interactive]

installer install <ID> [not-interactive]

installer uninstall <ID>

      [completely]

      [last-take]

      [not-interactive]

installer upgrade <ID> [not-interactive]

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

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:

  1. Before you perform an upgrade, read the Installation and Upgrade Guide for your version - the chapter for the product on your Gaia server.

  2. Before you perform an upgrade, back up all files, in which you made manual changes.

  3. 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.

Command

Description

installer agent

Controls the CPUSE Deployment Agent:

  • installer agent disable

    Disables the CPUSE Deployment Agent service, if it was enabled.

  • installer agent enable

    Enables the CPUSE Deployment Agent service (this is the default).

  • installer agent install <Local Path to Deployment Agent Package>

    Specified the local path to the TGZ package with the newer CPUSE Deployment Agent.

  • installer agent start

    Starts the CPUSE Deployment Agent process, if it was stopped.

  • installer agent stop

    Stops the CPUSE Deployment Agent process.

  • installer agent update [not-interactive]

    Initiates the CPUSE Deployment Agent self update from Check Point cloud.

installer check-for-updates [not-interactive]

Checks for new available software packages in Check Point cloud.

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

Performs a Clean Install of a new major version.

  • Press the Tab key to see the available package identifiers.

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

  • The optional parameter "role" specifies how to configure this Gaia server during the clean install - as a Security Gateway, a Management Server, and so on.

    "<Server Role>" is one of these:

    • SecurityGateway

    • SecurityManagement

    • MultiDomainServer

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

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

    This procedure:

    1. Creates a new disk partition.

    2. Performs a Clean Install of the selected major version.

    3. Reboots the Gaia server.

    4. Boots from the new disk partition with the new major version.

    5. Deletes the disk partition with the previous major version.

installer delete <ID> [not-interactive]

Deletes the specified software package from the package repository.

You can delete a package only if it not installed.

Press the Tab key to see the available package identifiers.

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

installer download <ID> [<options>]

Downloads the specified software package from the Check Point cloud in the specified way:

  • Press the Tab key to see the available package identifiers.

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

  • No option

    Downloads the specified package in the foreground (shows the progress on the screen).

  • installer download <ID> not-interactive

    Downloads the specified package in the background.

  • installer download <ID> pause

    Pauses the download of the specified package in the background.

  • installer download <ID> resume

    Resumes the download of the specified package in the foreground (shows the progress on the screen), if it was paused.

  • installer download <ID> resume [not-interactive]

    Resumes the download of the specified package in the background, if it was paused.

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

Downloads (from the Check Point cloud) and immediately installs the specified package.

This command supports only Hotfixes and Jumbo Hotfix Accumulators.

(does not support Upgrade or Major Version packages).

Press the Tab key to see the available package identifiers.

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

installer import <options>

Imports the specified software package:

  • installer import cloud <CPUSE Identifier> [not-interactive]

    Imports the specified software package from Check Point cloud if the Gaia server is connected to the Internet.

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

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

    Imports the specified software package from an FTP server.

    • "<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.

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

    Imports the specified software package from a local directory.

    • Before you can run this command, you must transfer the package to the Gaia server to that local directory.

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

installer install <ID> [not-interactive]

Installs the specified software package.

This command supports only Hotfixes and Jumbo Hotfix Accumulators.

(does not support Upgrade or Major Version packages).

installer uninstall <ID> [<options>]

Uninstalls the specified software package in the specified way.

This command supports only Hotfixes and Jumbo Hotfix Accumulators.

  • Press the Tab key to see the available package identifiers.

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

  • No option

    Uninstalls the specified software package in the foreground (shows the progress on the screen).

  • installer uninstall <ID> completely

    Uninstalls all previously installed Builds / Takes of a Hotfix package (removes all files).

  • installer uninstall <ID> last-take

    Uninstalls only the last installed Take of the specified Jumbo Hotfix Accumulator package.

  • installer uninstall <ID> not-interactive

    Uninstalls the specified software package in the background.

installer upgrade <ID> [not-interactive]

Performs an upgrade to a new major version using the specified upgrade package.

Press the Tab key to see the available package identifiers.

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

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

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

Analyzes the specified software package and shows if this package is allowed for installation on this Gaia server.

  • Press the Tab key to see the available package identifiers.

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

  • The optional parameter "role" specifies how to configure this Gaia server during the clean install - as a Security Gateway, a Management Server, and so on.

    "<Server Role>" is one of these:

    • SecurityGateway

    • SecurityManagement

    • MultiDomainServer

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

Note - The parameter "not-interactive" is optional. When specified, the CPUSE Deployment Agent performs its actions in the background.

Syntax to Configure the CPUSE Deployment Agent Settings

set installer

      mail-notifications <Email Address>

            download-status {on | off}

            install-status {on | off}

            new-available-packages {on | off}

      policy

            auto-compress-snapshot {on | off}

            check-for-updates-period <0 | 1-240 hours>

            downloads

                  automatic

                  manual

                  scheduled

                        daily <HH:MM>

                        monthly <01-31> at <HH:MM>

                        once <DD-MMM-YYYY> at <HH:MM>

                        weekly {Monday | Tuesday | Wednesday | Thursday | Friday | Saturday | Sunday} at <HH:MM>

            periodically-self-update {on | off}

            self-test

                  install-policy {on | off}

                  network-link-up {on | off}

                  start-processes {on | off}

delete installer mail-notifications <Email Address>

Parameter

Description

set installer mail-notifications <Email Address> <options>

Configures which email notifications the CPUSE Deployment Agent needs to send to the specified recipient:

  • set installer mail-notifications <Email Address> download-status {on | off}

    Email notifications only for downloads of software packages.

    Note - This setting is not available in Gaia Portal.

  • set installer mail-notifications <Email Address> install-status {on | off}

    Email notifications only for installations of software packages.

    Note - This setting is not available in Gaia Portal.

  • set installer mail-notifications <Email Address> new-available-packages {on | off}

    Email notifications only for available online software packages.

    Note - This setting is not available in Gaia Portal.

set installer policy <options>

Configures the CPUSE Deployment Agent settings:

  • set installer policy auto-compress-snapshot {on | off}

    Configures whether to compress the Gaia snapshot for Major Version installations.

    Note - This setting is not available in Gaia Portal.

  • set installer policy check-for-updates-period <0 | 1-240 hours>

    Configures how frequently to check for new CPUSE Deployment Agent versions.

    Default: 6 hours

    Note - The value 0 disables this feature.

  • set installer policy downloads automatic

    Configures the CPUSE Deployment Agent to download automatically the available online packages.

    Note - This setting is not available in Gaia Portal.

  • set installer policy downloads manual

    Configures the CPUSE Deployment Agent to download the available online packages only manually.

    This is the default.

    Note - This setting is not available in Gaia Portal.

  • set installer policy downloads scheduled <options>

    Configures the CPUSE Deployment Agent to download the available online packages based on a schedule (daily, weekly. monthly, or only once).

    Note - This setting is not available in Gaia Portal.

  • set installer policy periodically-self-update {on | off}

    Configures the CPUSE Deployment Agent to check for new CPUSE Deployment Agent versions.

    Default: Enabled

  • set installer policy self-test install-policy {on | off}

    Configures the CPUSE Deployment Agent to check that the local security policy is installed successfully, after it installs a software package.

    Default: Disabled

    Note - When enabled, in rare cases this test may report a failure, even though the policy is installed.

  • set installer policy self-test network-link-up {on | off}

    Configures the CPUSE Deployment Agent to check that the link is up on the configured interfaces, after it installs a software package.

    Default: Disabled

    Note - When enabled, in rare cases this test may report a failure, even though the link is up.

  • set installer policy self-test start-processes {on | off}

    Configures the CPUSE Deployment Agent to check that the required Check Point processes are running, after it installs a software package.

    Default: Enabled

delete installer mail-notifications <Email Address>

Deletes email notifications from the specified recipient.

Press the Tab key to see the configured email addresses.