> Source: [sk120342](https://support.checkpoint.com/results/sk/sk120342)

# sk120342 - Exporting Check Point configuration from a Management Server into readable format using "Show Package Tool"

| Property | Value |
|----------|-------|
| Solution ID | sk120342 |
| Date Created | 2017-09-13 |
| Last Modified | 2025-01-22 |
| Technical Level | General |
| Products | Security Management Server, Multi-Domain Security Management Server |
| Versions | R82.10, R82, R81.20, R82.10, R81.10 (EOS), R81 (EOS), R81 (EOS), R81.10 (EOS), R81.20, R82 |
| OS | Gaia |

## Solution

**Table of Contents:**

* Background
* Installation
* Output
* CLI Syntax
* Related Tools/Options

Background {#Background}
------------------------

The **Show Package Tool** can export the Security Policy and the database with configured objects into a readable format. This exported information represents a snapshot of the management database.

The Show Package Tool replaces the **Web Visualization Tool** (see [sk64501](https://support.checkpoint.com/results/sk/sk64501)) which was supported for versions R77.30 and lower.

The Show Package Tool is an open source project. For more details refer to the [Check Point GitHub Page](https://github.com/CheckPoint-APIs-Team/ShowPolicyPackage).

Installation {#Installation}
----------------------------

This tool is already installed on Check Point Security Management Servers running version R80 and above.

For the latest version, refer to the [Check Point GitHub Page](https://github.com/CheckPoint-APIs-Team/ShowPolicyPackage).

Output {#Output}
----------------

The tool generates a compressed file (.tar.gz) that contains these files:

* HTML files - The objects and rules presented as html files. The "index.html" acts as a starting point and lists all the available items to display.

<!-- -->

* JSON files - The objects and rules exported as multiple JSON files.

<!-- -->

* Log file (e.g., *show_package-yyyy-mm-dd_HH-MM-ss.elg*) - A log file containing debug information.

CLI Syntax {#CLI Syntax}
------------------------

The `$MDS_FWDIR/scripts/web_api_show_package.sh` script is a wrapper that executes "`java -jar $MDS_FWDIR/api/samples/lib/web_api_show_package-jar-with-dependencies.jar`".

**Syntax in the Expert mode:**
> `$MDS_FWDIR/scripts/web_api_show_package.sh -h`
>
> `$MDS_FWDIR/scripts/web_api_show_package.sh [-d <Domain>] [-k <Policy Package>] [-n <API Port>] [-t <Path to Templates>] [-o <Output Path>]`

**Parameters:**

|--------------------------|----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Parameter                | Type     | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| `-h`                     | Optional | Shows the built-in help and exits                                                                                                                                                                                                                                                                                                                                                                                                                           |
| `-d <Domain>`            | Optional | On the Multi-Domain Security Management Server, specifies the Domain. You must enter one of these: * IP Address of the Domain Management Server (see the output of the "`mdsstat`" command) * Name of the Domain object as appears in SmartConsole (Name of the Domain Management Server is not supported) * UUID of the Domain object as appears in the SQL Management Database On a Multi-Domain Security Management Server, the default Domain is "MDS". |
| `-k <Policy Package>`    | Optional | Specifies the Security Policy Package. You must enter one of these: * Name of the Policy Package as appears in SmartConsole * UUID of the Policy Package as appears in the SQL Management Database If you do not specify this parameter, then the tool shows the information for all Security Policy Packages that are installed on the managed Security Gateways.                                                                                          |
| `-n <API Port>`          | Optional | Specifies the listening port of the API Server on the Management Server. The default port is TCP 443.                                                                                                                                                                                                                                                                                                                                                       |
| `-t <Path to Templates>` | Optional | Specifies the path to the directory with the required template files to create the output HTML pages out of JSON data. The default path is: `$MDS_FWDIR/api/samples/conf/`                                                                                                                                                                                                                                                                                  |
| `-o <Output Path>`       | Optional | Specifies the path to the output directory and the compressed output .tar.gz file. The default output directory is the current working directory, from which you executed this script. If you specify only the output directory, then the name of the output file is created automatically. To specify name of the output file, use this syntax: `-o /path/to/directory/<name_of_file>.tar.gz`                                                              |

Related Tools/Options {#Related Tools/Options}
----------------------------------------------

* It is possible to export a policy package in a way that can be used to import it later on a different Management server. For more details, see [ExportImportPolicyPackage](https://github.com/CheckPoint-APIs-Team/ExportImportPolicyPackage).

<!-- -->

* Exporting a rulebase in the CSV format is available in SmartConsole:
  1. Open SmartConsole and view the rulebase you wish to export.
  2. On the top toolbar, click 'Actions' \> 'Export'.

---

# Agent Instructions

This content is from the Check Point Support Center (https://support.checkpoint.com), the official knowledge base for Check Point cybersecurity products.

## Navigating This Knowledge Base

- **Complete index**: [llms.txt](https://support.checkpoint.com/llms.txt)
- **All SK articles**: [SecureKnowledge Sitemap](https://support.checkpoint.com/sitemaps/secureknowledge-sitemap-index.xml)
- **SK article URL pattern**: `https://support.checkpoint.com/results/sk/{skId}`
- **Markdown responses**: AI bot User-Agents automatically receive `text/markdown` content
