sk101878 - CPView Utility
CPView Utility
Solution
Table of Contents
- Introduction
- Supported Deployments
- Syntax
- Usage
- Limitations
- Notes
- What's New
- Logging Metrics
- 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 - R76SP.50 |
| Operating Systems | - Gaia OS R77 and higher - SecurePlatform OS R77, R77.10, R77.20, R77.30 |
| Products | - Security Gateway: - R76SP.50, R77, and higher - full monitoring of system resources, software blades, etc. - R77.10 and higher - history mode was added - R76SP.50 - history mode is not supported - Security Management Server: - R77 and higher - only monitoring of CPU, Memory and Disk Space - R77 and higher - history mode is not supported - Multi-Domain Security Management Server: - R80.20 - supported from R80.20 Jumbo HFA Take_43 - R80.10 - supported from R80.10 Jumbo HFA Take_203 - R77.30 - CPView is not supported - R77, R77.10, and R77.20 - only monitoring of CPU, Memory, and Disk Space - R77, R77.10, and R77.20 - history mode is not supported - StandAlone: - R77.10 and higher - history mode was added - R77 and higher - full monitoring of system resources, software blades, etc. |
(3) Syntax
cpview |
cpview --help |
| `cpview --api_service {on |
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 |
cpview --history [<Timestamp>] |
Where:
| Command | Description |
cpview |
Opens the interactive tool interface. |
cpview -hcpview --help |
Shows the built-in help and exits. |
| `cpview -a {on | off |
cpview -m [-e <Source>] [-r <Name>] [-f <Filter>]cpview --metric [--request_source <Source>] [--request_name <Name>] [--filter <Filter>] |
Raw print mode (JSON). Shows all CPView metrics one time, in the Metric format for Skyline Telemetry ( sk178566). ... (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. It is updated every time the statistics are refreshed. |
| View | This section shows the statistics that are gathered in the specific view. 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.- 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. |
(6) Notes
- The History database is saved in:
| Version | Location | Note |
| R80.40 and higher | Main active history file:$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. - Shows additional metrics. |
(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. |
(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
- sk116876 - Meaning of protocol 'TCP:1024' in CPView
Article Properties
Access Level: General
Status: Approved
Date Created: 2014-07-31
Last Modified: 2026-05-26