# CPView Utility

## Solution

**Table of Contents**

01. Introduction  
02. Supported Deployments  
03. Syntax  
04. Usage  
05. Limitations  
06. Notes  
07. What's New  
08. Logging Metrics  
09. Troubleshooting

## (1) Introduction

CPView Utility is a text based _built-in_ utility that can be run ("`cpview`" command) on Security Gateway / Security Management Server / Multi-Domain Security Management Server.

CPView Utility shows statistical data that contain both general system information (CPU, Memory, Disk space) and information for different Software Blades (only on Security Gateway).

The data is continuously updated in easy to access views.

On Security Gateway, this statistical data can be used to monitor machine's performance.

## (2) Supported Deployments

CPView Utility is _built-in_ and supported _only_ on:

|     |     |
| --- | --- |
| Versions | - R77 GA and higher<br>- R76SP.50 |
| Operating Systems | - Gaia OS R77 and higher<br>- SecurePlatform OS R77, R77.10, R77.20, R77.30 |
| Products | - Security Gateway:<br>  - R76SP.50, R77, and higher - full monitoring of system resources, software blades, etc.<br>  - R77.10 and higher - history mode was added<br>  - R76SP.50 - history mode is **not** supported<br>- Security Management Server:<br>  - R77 and higher - only monitoring of CPU, Memory and Disk Space<br>  - R77 and higher - history mode is **not** supported<br>- Multi-Domain Security Management Server:<br>  - R80.20 - supported from [R80.20 Jumbo HFA](https://support.checkpoint.com/results/sk/sk137592) Take_43<br>  - R80.10 - supported from [R80.10 Jumbo HFA](https://support.checkpoint.com/results/sk/sk116380) Take_203<br>  - R77.30 - CPView is **not** supported<br>  - R77, R77.10, and R77.20 - only monitoring of CPU, Memory, and Disk Space<br>  - R77, R77.10, and R77.20 - history mode is **not** supported<br>- StandAlone:<br>  - R77.10 and higher - history mode was added<br>  - R77 and higher - full monitoring of system resources, software blades, etc. |

## (3) Syntax

|     |
| --- |
| `cpview` |
| `cpview --help` |
| `cpview --api_service {on | off | stat}` |
| `cpview --metric [--request_source <Source>] [--request_name <Name>] [--filter <Filter>]` |
| `cpview --print [--ignoreWarnings] [--showDesc] [--request_source <Source>] [--request_name <Name>] [--filter <Filter>]` |
| `cpview --services {on | off | stat | export}` |
| `cpview --history [<Timestamp>]` |

### Where:

|     |     |
| --- | --- |
| Command | Description |
| `cpview` | Opens the interactive tool interface. |
| `cpview -h`<br>`cpview --help` | Shows the built-in help and exits. |
| `cpview -a {on | off | stat}`<br>`cpview --api_service {on | off | stat}` | Administration of the CPView API service (to query the data with API):<br>- `on` - Enables the CPView API service (this is the default)<br>- `off` - Disables the CPView API service<br>- `stat` - Shows the status of the CPView API service<br>  <br>Example Output:<br>`[Expert@R82:0]# cpview --api_service stat<br>CPView api service running<br>[Expert@R82:0]#`<br>For information about the CPView API commands, see [Gaia API Reference v1.8 (or higher)](https://sc1.checkpoint.com/documents/latest/GaiaAPIs/index.html#introduction~v1.8%20) \> Chapter "Diagnostics" > Section "CPView". |
| `cpview -m [-e <Source>] [-r <Name>] [-f <Filter>]`<br>`cpview --metric [--request_source <Source>] [--request_name <Name>] [--filter <Filter>]` | Raw print mode (JSON).<br>Shows all CPView metrics one time, in the Metric format for Skyline Telemetry ( [sk178566](https://support.checkpoint.com/results/sk/sk178566)).<br>... (Continuation of examples and descriptions of commands.)

## (4) Usage

- The CPView interface has these sections:

|     |     |
| --- | --- |
| Section | Description |
| Header | Shows the time the statistics shown in the third section (view) were gathered.<br>It is updated every time the statistics are refreshed. |
| View | This section shows the statistics that are gathered in the specific view.<br>These statistics update at an adjustable refresh rate (default refresh rate is 2 seconds). |

## (5) Limitations

| Configuration / View | Limitations |
| --- | --- |
| All servers running Gaia OS | - When the `cpview` command is executed several times in parallel, data inconsistency may occur.<br>- If you query the CPView Utility (in CLI or with API) immediately after a reboot, then it might take several minutes before it returns data.| ... (Additional limitations and details) |

## (6) Notes

- The History database is saved in:

|     |     |     |
| --- | --- | --- |
| Version | Location | Note |
| R80.40 and higher | Main active history file:<br>`$CPDIR/log/cpview_services/cpview_services.dat`  | ... (Additional notes and details) |

## (7) What's New

| Version | What's New |
| --- | --- |
| R82.10 | - Ability to show Hide NAT statistics for up to 200 top NAT IP Pools. |
| R82 | - Additional CLI options.<br>- Shows additional metrics. | ... (Additional updates for each version) |

## (8) Logging Metrics

### Output on a Management Server

| Metric | Type | Refresh Rate | Comment |
| --- | --- | --- | --- |
| Log Receive Rate (Log Rate) | Number | 10 seconds | Average log rate received by a Log Server. |
| Log Send Rate | Number | 10 seconds | Average number of logs sent from this Security Gateway. | ... (Further logging metrics)

## (9) Troubleshooting

| # | Symptoms | Root Cause | Next Steps |
| --- | --- | --- | --- |
| 1 | Output of the `cpview -t` command shows `CPView: History is initializing`. | Old history database causing CPView service to fail to start. | ... (Steps to resolve issues) |

## (10) Related Solutions

- [sk103496 - Number of concurrent connections shown in CPView Utility depends on the status of SecureXL](https://support.checkpoint.com/results/sk/sk103496)  
- [sk116876 - Meaning of protocol 'TCP:1024' in CPView](https://support.checkpoint.com/results/sk/sk116876)

## Article Properties

Access Level: General  
Status: Approved  
Date Created: 2014-07-31  
Last Modified: 2026-05-26