Deployment Plan

In This Section: Supported Actions Example Deployment Plan Files

In the CDT Advanced Mode, you can define a sequence of actions for the remote Security Gateways.

Supported Actions

import_package

• Sends a package to the remote Security Gateway (to the /var/log/upload/ directory) and imports it with CPUSE. If the package was already sent with the send_package, this only imports it on the remote Security Gateway.
• Required before installing the package.
• Attributes:

  path - The full path on the Management Server to the package file you send.

send_package

• Sends a package to the remote Security Gateway (to the /var/log/upload/ directory) without importing it with CPUSE.
• Required before installing the package.
• Attributes:

  path - The full path on the Management Server to the package file you send.

verify_package

• Examines an imported package with CPUSE if it is possible ti install it on the remote Security Gateway.
• You must import the package on the remote Security Gateway.
• Attribute:

  path - The full path on the Management Server to the package file you examine.

install_package

• Installs a package with CPUSE and validates that security policy is installed.
• When you upgrade one Security Gateway, runs the Prepare New Policy stage before the package installation to make sure there is an updated policy for the Security Gateway to fetch.
• When you install a Hotfix in a cluster, runs the Cluster Validation stage after policy validation.
• Attribute:

  path - The full path on the Management Server to the package file you install.

uninstall_cpuse_package

• Uninstalls a package with CPUSE.
• Attributes:

  filename - The file name (not full path) of the package file you uninstall.

uninstall_legacy_package

• Uninstalls a legacy package (a package that was installed with the Legacy Installation method in Expert mode CLI).
• Attributes:

  filename - The Hotfix name you uninstall.

execute_command

• Runs a command on the Security Gateway in Bash shell (Expert mode).
  Note - Do not use special characters in your command (">", "|", "*", or other Bash-specific characters).
• Attributes:

  command - The command you run.

execute_script

• Runs a user shell script on the Security Gateway.
• Note - All user scripts defined for the CDT to run, must contain full paths for each instance of a file.
• Note - Reboot is not allowed in the user script. The script must exit with a return code. To reboot the Security Gateway, use exit code 222.
• Attribute:

  path - The full local path on the remote Security Gateway to the user script file you run.

pull_file

• Downloads a file from the remote Security Gateway to the Management Server.
• The file is saved with a prefix of the Security Gateway's object name (for example, cluster01a_myfile.txt).
• Attributes:

  remote_path - The full remote path and filename you download on the remote Security Gateway. Use a full path with a file name, not only a directory.

  local_dir - The full path on the Management Server to the directory, where you save the downloaded file.

• Limitation:

  The size of the file must be less than 1 GB.

push_file

• Uploads a file from the Management Server to the remote Security Gateway.
• Attributes:

  local_path - The full local path and filename on the Management Server to the file you upload.

  remote_path - The full remote path and filename on the remote Security Gateway, where you upload the file.

send_email

• Send an email message.
• Attributes:

  to - The email recipient.

  subject - The email subject.

  body - The email body.

log

• Generates a log message.
• Attributes:

  level - The logging level of this message (DEBUG, NORMAL, ERROR, ALWAYS).

  value - The message text.

reboot

• Reboots the remote Security Gateway.
• Attributes:

  None.

download_from_cloud

• Download a package from the Check Point Cloud with CPUSE.
• Attributes:

  path - Path to the package file on the Management Server (you must provide the package on the Management Server, even if the Security Gateways download it directly from the Check Point Cloud).

create_snapshot

• Creates a Gaia snapshot.
• Attributes:

  name - The name of the snapshot to create.

  description - The description of the snapshot.