How to view and analyze a CPInfo output file in DiagnosticsView
Table of Contents:
To download DiagnosticsView, click here.
DiagnosticsView is a Windows desktop tool for Check Point Support Engineers. It replaces the InfoView application.
DiagnosticsView offers a graphical representation of collected data from CPInfo.
After completing the DiagnosticsView package installation, launch DiagnosticsView:
- Start -> DiagnosticsView
- Double click on .info/.cpinfo file
DiagnosticsView acts as a docking manager and consists of panels. Panels can be re-sized, dragged and re-arranged.
The default DiagnosticsView layout has two panels: General Information and Info Navigator.
CPInfo File Open
Open the CPInfo file in Menu:
Click on the menu icon -> Open
Click on the menu icon -> Recent Files
- Drag and drop
- Double-click on .info/.cpinfo file
- DiagnosticsView supports the automatic opening of the CPInfo compressed output files (.info.gz and .info.tar.gz).
- When you open a file while another file is still open, DiagnosticsView will ask for your confirmation to close the previous file:
Pressing OK will close the previous file and open a requested file.
Pressing CANCEL will keep the previous file and cancel another file open request.
CPInfo Sections Navigation
The Info Navigator panel includes a sections navigation tree. Navigate to the required section in the tree. Double-clicking on the section name will open this section in the appropriate Viewer:
Note: If the appropriate viewer is not found, double click on this section will not perform any action.
To search inside the CPInfo file, type your search text in the search text box (e.g., "policy") and press ENTR.
Note: The search is not case sensitive and matches the whole word.
If you are investigating a memory issue, you may want to see only memory sections in the navigation tree.
For this purpose, DiagnosticsView has pre-defined filters. Choose the required filters to filter the navigation tree:
Filters and their content are completely configurable by xml file and can be adjusted by each group.
1. Create Categories.user.xml in the 'Config' folder inside your Local Application Data folder:(C:\Users\%UserName%\AppData\Local\DiagnosticsView\Config\Categories.user.xml)
2. Add your filters or modify the existing one in the Categories.user.xml.
Note: The predefined configuration can be found in the file Categories.xml (typically in C:\Program Files (x86)\CheckPoint\DiagnosticsView\Config\Categories.xml).
Filter content is defined by section elements. A section element has the following attributes:
- name - exact section name or regular expression
- regex - set to true when name is regular expression
Default Sections Data Viewer
The Data Viewer that will open when you double-click the section name in the navigation tree can be defined in xml file:
Create or modify a SectionDefaults.user.xml file in the 'Config' folder inside your Local Application Data folder (typically C:\Users\%UserName%\AppData\Local\DiagnosticsView\Config\SectionDefaults.user.xml).
The XML file must match the following pattern:
<?xml version="1.0" encoding="UTF-8"?>
<section name="FireWall-1 Status" dataViewer="Table Viewer" />
<section name="\.(?:sqlite|SQLITE|db|DB)\.UUE$" dataViewer="Sqlite Viewer" regex="true" />
- The 'name' attribute is the CPInfo section name
- The 'dataViewer' attribute is the Data Viewer name ('Text Viewer' or 'Table Viewer' or 'Sqlite Viewer')
- The 'regex' attribute - when is set to true, indicates that the 'name' attribute is the regular expression to apply on the cpinfo section names
The predefined configuration file can be found in the file SectionDefaults.xml (typically in C:\Program Files (x86)\CheckPoint\DiagnosticsView\Config\SectionDefaults.xml).
DiagnosticsView consists of panels. Each panel hosts Data Viewer. DiagnosticsView supports the following Data Viewers: General Information, Info Navigator, Text Viewer, Table Viewer and Sqlite Viewer.
Data Viewer can be activated/deactivated by
- Double-clicking on the section name in the navigation tree will activate the appropriate viewer
For your convenience, you can re-size, drag and change the panels' location.
To save your layout for the next DiagnosticsView launch, open the Layouts listbox (located at the upper-right corner) and choose "New Custom Layout ...":
A new Layout window will open. Type the name of your layout and press the SAVE button:
You can save several layouts and switch among them by using the Layouts listbox.
During the next launch, DiagnosticsView will use the last layout.
If the CPInfo output file is from the Security Management server or Standalone, DiagnosticsView lets you view the Security Gateway's set-up, and especially the policies in the Smart Console.
Make sure you have the appropriate version of SmartConsole installed on your desktop.
Note: Policy View is not supported for CPinfo files collected on the Multi-Domain Security Management server.
To view the policy, click on the Policy View button located on the upper bar near the menu:
R80 and above
To view the policy on an R80 and above machine, prepare a Virtual Machine (VM) with the following requirements:
- The VM should have the same machine version as the one on which the CPinfo data was collected.
- The SFTP server should be enabled on the VM.
- The VM should have an eth1 interface, which is not the main interface (eth1 can be down).
CPinfo on an R80 and above Management machine creates two files: *.info file (CPinfo file) and *_ migrate_export_out.tgz file (Database export file).
To view the policy, click on the Policy View button located at the upper bar near the menu. When you click on the Policy View button, the Policy View preparation window will be displayed and will specify the VM credentials and Database export file.
Note: If the Database export file is located in the same folder as the CPinfo file, DiagnosticsView will automatically detect it.
Specify your VM credentials, Database export file and press START. Pressing the START button will start the VM preparation by importing the specified Database file. This might take a long time to complete.
When the VM is ready, SmartConsole will be launched.
Instead of creating the VM manually, there is an option to work with Pool Manager based on the MySQL server that manages VMs created in advance (regional TAC is responsible for VM Pool creation).
To enable this option, go to menu -> click on "Preferences...":
Select Policy View and check the box "VM Pool Manager Active". Specify the Pool Manager credentials and press the Save button:
Now, when the VM Pool Manager is active, by clicking on the Policy View icon you will not be asked to provide the VM credentials. DiagnosticsView will automatically obtain the VM credentials from the Pool Manager:
Specify the Database export file and press START. Pressing the START button will start the VM preparation by importing the specified Database file. This might take a long time to complete.
Once the VM is ready, SmartConsole will be launched.
Export VM from Pool Manager
When you close the CPInfo file, the pool VM is released. If you want to keep it, you have the option to export this VM. Click on the Export VM icon before closing the CPInfo file.
Note: The maximal VM usage is 24 hours (Pool Manager configuration). This means that even if the CPInfo file is open for more than 24 hours, the VM will be released by the Pool Manager. You will be informed of this by email.
Press OK to start the export:
Now you can close CPInfo file.
Text Viewer is a built-in viewer and editor of CPInfo sections.
It can be activated by
- Double-click on the section name in the navigation tree (only suitable sections will be displayed by the Text Viewer)
- Right-click on the section name in the navigation tree and select "Open with Text Viewer"
- Double-click on the search result inside the section's content
- Double-click on the search result inside the section's name (if the section is suitable for viewing by the Text Viewer)
By default, all sections inside Text Viewer have a tabbed view:
You can drag the section and change its location:
TextViewer allows you to edit the CPInfo section. The original CPInfo file will not be changed.
If you want to save an edited section, click on the Export button to save it as a separate file.
To search inside the section, type the search text in the search text box and press ENTR. The search is cyclic. Pressing ENTR will find the next search text appearance.
Note: Pressing CTRL + F will locate the cursor in the search text box.
Table Viewer is a built-in viewer of the CPInfo sections.
Table Viewer will try to detect table structures within the section data based on separators and predefined patterns.
Section data that is not recognized as a table will be presented as 'Unstructured Text'.
If the section contains tables that are not recognized by the Table Viewer, the table format can be defined in the configuration file as described below.
Table Viewer can be activated by
- Double-click on the section name in the navigation tree (only suitable sections will be displayed by the Table Viewer)
- Right-click on the section name in the navigation tree and select "Open with Table Viewer"
- Double-click on the search result inside the section name (if the section is suitable for viewing by the Table Viewer)
Table Viewer has a tabbed view like Text Viewer.
Table format data will be presented as tables. Section data that is not recognized as a table will be presented as 'Unstructured Text' and can be expanded with a mouse click:
Sections that contain tables and are not recognized by the Table Viewer can be defined in xml file:
Create or modify TableViewPrefs.user.xml file in the 'Config' folder inside your Local Application Data folder (typically C:\Users\%UserName%\AppData\Local\DiagnosticsView\Config\TableViewPrefs.user.xml).
XML file must match the following pattern :
<?xml version="1.0" encoding="UTF-8"?>
<section name="SIM Notifications">
<regex value="^([^\s]*)\s+([^\s]*)\s+([^\s]*)\s+([^\s]*)" />
<section name="EXEC versions">
<item value=";" />
<item value="File" />
<item value="Version" />
<item value="Internal_Name" />
<item value="Module" />
<item value="Comment" />
- The 'name' attribute is the CPInfo section name.
- Every section can be parsed using a separators list or a regex.
- When the headers sector is defined, these headers will be attached to all the tables in the section. If no headers are defined, the first table line will be used as headers.
The predefined configuration file can be found in the file TableViewPrefs.xml (typically in C:\Program Files (x86)\CheckPoint\DiagnosticsView\Config\TableViewPrefs.xml).
General Information contains a machine overview. By default, it has a tabbed view:
You can drag the tab and change its location:
General Information tabs and their content are completely configurable by xml file and can be adjusted by each group (typically C:\Program Files (x86)\CheckPoint\DiagnosticsView\Config\GeneralInfo.xml).
Tab content is defined by item elements. An item element has the following attributes:
- label - title that will be displayed in the tab
- section - CPInfo section name that contains title value
- line - section line number that contains title value. This attribute is optional. If line is not specified, then the value will be searched within the whole section. Note: Line number includes section title
- regex - regular expression to apply on the section line to find the title value
- append - set to false when the item can have only one value; otherwise, set to true. Example: Type value in Device tab may have several values: Gateway, Management, VSX, MDS. Each value is located in a different location. Therefore Type item sets append attribute to true.
An item element may have a condition element that is applied to the regex match value. The condition element is used when another text should be displayed instead of the match value.
Example: If "CP components" section contains PROVIDER-1, we want to display MDS and not the value itself, which is PROVIDER-1.
The condition element has the following attributes:
- type - can be Exactly, Contains, NotContains
- value - value to check by specified type (Exactly, Contains, NotContains)
- text - text to display instead of regex match value when the condition is true
Apply regular expression "(.*)" on line 7 of "date" section. Display regex match value as Date value.
Apply regular expression "(^PROVIDER-1 .+)" on each line of "CP components" section (the search will be stopped on the first match). Apply specified condition on the regex match, i.e. if regex match Contains PROVIDER-1 then append Mds to the Type.
Sqlite Viewer is a built-in viewer of the CPInfo Sqlite sections and external Sqlite files as CPView history.
Note: Sqlite tables/viewes can contain a large number of records. Use LIMIT in your queries to avoid running out of memory.
Sqlite Viewer can be activated by
- Double-click on the Sqlite section name in the navigation tree
- Right-click on the section name in the navigation tree and select "Open with Sqlite Viewer"
- Double-click on the search result inside the section name
- Click on the Database button located on the upper bar near the menu and choose an external Sqlite file
After you click on the Database button, the "Open Sqlite DB" window will be displayed. Specify the Sqlite file and click on the OPEN button. Pressing the OPEN button will activate Sqlite Viewer.
- If the CPView history file is located in the same folder as the CPinfo file, DiagnosticsView will automatically detect it.
- DiagnosticsView supports the automatic opening of the compressed sqlite files (.gz and .tar.gz).
Sqlite Viewer consists of the Structure and New query (+) tabs. The Structure tab displays database content (Tables, Indices, Views, Triggers).
Double clicking on the table/view name in the structure tree will display its content:
Clicking on the '+' tab will open the new query tab:
To close the database, right-click on the database name in the structure tree and select "Close":
Sqlite Viewer tabs can be dragged to change the location:
DiagnosticsView automatically detects if a new version is available and provides a notification on the bottom-right side of the application window:
Clicking on the update notification will show the available version:
Pressing the UPDATE button will start a new package download:
When the new package download is completed, the following message is displayed for installation approval:
Pressing the OK button will close DiagnosticsView and launch a new package installation wizard.
Pressing the CANCEL button will stop the auto-update process. When this happens, you will be able to install the new package on application exit:
Note: After a new package installation, DiagnosticsView is not launched automatically.
Click on the menu icon -> About to see the DiagnosticsView application and API versions:
To suggest a new feature, enter your suggestion and press the SUBMIT button.
This will send an email to firstname.lastname@example.org
- When dragging a panel over General Information or Text Viewer panels, two dock placeholders are displayed instead of one. Use the placeholder with the arrows inside:
This solution has been verified for the specific scenario, described by the combination of Product, Version and Symptoms. It may not work in other scenarios.