> Source: [sk101878](https://support.checkpoint.com/results/sk/sk101878) # sk101878 - CPView Utility | Property | Value | |----------|-------| | Solution ID | sk101878 | | Date Created | 2014-07-31 | | Last Modified | 2026-05-26 | | Technical Level | General | | Products | Security Gateway, Security Management Server, Multi-Domain Security Management Server | | Versions | R82.10, R82, R81.20, R81.10 (EOS), R82.10, R82, R81.20, R82.10, R81 (EOS), R81.10 (EOS), R81 (EOS), R81 (EOS), R81.10 (EOS), R81.20, R82 | | OS | Gaia | ## Solution **Table of Contents** 1. Introduction 2. Supported Deployments 3. Syntax 4. Usage 5. Limitations 6. Notes 7. What's New 8. Logging Metrics 9. Troubleshooting 10. Related Solutions Click Here to Show the Entire Article (1) Introduction {#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 {#Supported_Deployments} -------------------------------------------------- Show / Hide this section > 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](https://support.checkpoint.com/results/sk/sk137592) Take_43 * R80.10 - supported from [R80.10 Jumbo HFA](https://support.checkpoint.com/results/sk/sk116380) 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 {#Syntax} -------------------- Show / Hide the syntax for Security Gateway R82 and higher > > |--------------------------------------------------------------------------------------------------------------------------| > | `cpview` | > | `cpview --help` | > | `cpview --api_service {on | off | stat}` | > | `cpview --metric [--request_source ] [--request_name ] [--filter ]` | > | `cpview --print [--ignoreWarnings] [--showDesc] [--request_source ] [--request_name ] [--filter ]` | > | `cpview --services {on | off | stat | export}` | > | `cpview --history []` | > > Where: > > Enter the string to filter this table: > > |-----------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| > | Command | Description | > | `cpview` | Opens the interactive tool interface. | > | `cpview -h` `cpview --help` | Shows the built-in help and exits. | > | `cpview -a {on | off | stat}` `cpview --api_service {on | off | stat}` | Administration of the CPView API service (to query the data with API): * `on` - Enables the CPView API service (this is the default) * `off` - Disables the CPView API service * `stat` - Shows the status of the CPView API service Example Output: `[Expert@R82:0]# cpview --api_service stat` ` CPView api service running` ` [Expert@R82:0]#` 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 ] [-r ] [-f ]` `cpview --metric [--request_source ] [--request_name ] [--filter ]` | Raw print mode (JSON). Shows all CPView metrics one time, in the Metric format for Skyline Telemetry ([sk178566](https://support.checkpoint.com/results/sk/sk178566)). * `cpview -m` `cpview --metric` Shows all CPView metrics, in the Metric format for Skyline Telemetry. * `cpview -m -e ` `cpview --metric --request_source ` Shows CPView metrics only the specified sources, in the Metric format for Skyline Telemetry. * `cpview -m -r ` `cpview --metric --request_name ` For internal Check Point use only. Shows CPView metrics only from the specified data producer, in the Metric format for Skyline Telemetry. In the `$CPDIR/conf/cpview_api_service_conf.xml` file, refer to the values in the parameter "`requests_name`". Example values: `TP_ONLY`, `SDWAN_ONLY`, `SDWAN_AND_TP`. * `cpview -m -f ` `cpview --metric --filter ` Shows only the specified CPView metrics, in the Metric format for Skyline Telemetry. You must specify the filter string that matches one of these - **Metric ID** , **Statistics ID** , or **Internal Metric Label**. To specify several filter strings, separate them with commas without spaces (a maximum of 512 characters). You must enclose the filter strings in quotes - each filter string (**"String1","String2",...,"StringN"** ) or all filter strings together (**"String1,String2,...,StringN"** ). Example: `-f "UM_STAT.UM_CPU.num_of_cores","UM_STAT.UM_CPU.ds_status"` * **Metric ID** Refer to one of these: * The "`metric-id`" value in the output of the "`cpview -m`" / "`cpview --metric`" command. * The [Skyline Administration Guide](https://sc1.checkpoint.com/documents/Appliances/Skyline/Default.htm) \> Chapter "**Skyline Metrics Repository** " \> column "**Metric ID**". **Important** - In front of the filter string that matches a Metric ID, you must add the prefix "**M:**". Example Output - Formatted as pretty JSON: ``` [Expert@R82:0]# cpview -m -f M:"system.cpu.count" | jq '.' { "metrics": [ { "data": [ { "value": 4 } ], "description": "The number of CPU cores on this machine.", "metric-id": "system.cpu.count", "metric-type": "Gauge", "metric-unit": "{cpu}", "metric-value-type": "double" } ], "timestamp": 1730744843 } ``` * **Statistics ID** Refer to the "`stat-id`" value in the output of the "`cpview -p`" / "`cpview --print`" command. Example Output - Formatted as pretty JSON: ``` [Expert@R82:0]# cpview -m -f "UM_STAT.UM_CPU.num_of_cores" | jq '.' { "metrics": [ { "data": [ { "value": 4 } ], "description": "The number of CPU cores on this machine.", "metric-id": "system.cpu.count", "metric-type": "Gauge", "metric-unit": "{cpu}", "metric-value-type": "double" } ], "timestamp": 1730737683 } ``` * **Internal Metric Label** In the `$CPDIR/conf/cpview_api_service_conf.xml` file, refer to the values of the "`labels=`" parameters. Examples of Internal Metric Labels: * `labels="CPU,Dynamic_Split,OS,Configuration"` * `labels="Hardware,Interfaces,Drops,Errors"` In the CLI syntax, you can use any of these labels - one or several: * `-f "CPU"` * `-f "Dynamic_Split"` * `-f "CPU,Dynamic_Split"` * `-f "Drops,Errors"` * and so on Example Output - Formatted as pretty JSON: ``` [Expert@R82:0]# cpview -m -f "Dynamic_Split" | jq '.' { "metrics": [ { "data": [ { "value": 0 } ], "description": "The state of the CoreXL Dynamic Balancing (On/Off).", "metric-id": "system.cpu.dynamic_balancing.state", "metric-type": "Gauge", "metric-unit": "{state}", "metric-value-type": "double" } ], "timestamp": 1730737802 } [Expert@R82:0]# ``` | > | `cpview -p [-i] [-d] [-f ]` `cpview --print [--ignoreWarnings] [--showDesc] [--filter ]` | Simple print mode (JSON). Shows all CPView metrics one time. * `cpview -p` `cpview --print` Shows all CPView metrics. * `cpview -p -e ` `cpview --print --request_source ` For internal Check Point use only. Specifies the source/entity of the data request that is sent to Check Point Cloud. * `cpview -p -r ` `cpview --print --request_name ` Shows only the specified CPView requests. * `cpview -p -i` `cpview --print --ignoreWarnings` Reserved for future use. Ignores warnings and continues to execute. * `cpview -p -d` `cpview --print --showDesc` Shows the additional "`name`" and "`description`" strings for each metric. * `cpview -p -f ` `cpview --print --filter ` Shows only the specified CPView metrics, together with the description, name, and type of each metric. You must specify the filter string that matches one of these - **Statistics ID** or **Internal Metric Label**. To specify several filter strings, separate them with commas without spaces (a maximum of 512 characters). You must enclose the filter strings in quotes - each filter string (**"String1","String2",...,"StringN"** ) or all filter strings together (**"String1,String2,...,StringN"** ). Example: `-f "UM_STAT.UM_CPU.num_of_cores","UM_STAT.UM_CPU.ds_status"` * **Statistics ID** Refer to the "`stat-id`" value in the output of the "`cpview -p`" / "`cpview --print`" command. Example Output - Formatted as pretty JSON: ``` [Expert@R82:0]# cpview -p -f "UM_STAT.UM_CPU.num_of_cores" | jq '.' { "next-cursor": null, "data": [ { "stat-id": "UM_STAT.UM_CPU.num_of_cores", "records": [ { "timestamp": { "posix": 1730729512, "iso-8601": "2024-11-04T16:11+0200" }, "value": 4 } ] } ] } ``` * **Internal Metric Label** In the `$CPDIR/conf/cpview_api_service_conf.xml` file, refer to the values of the "`labels=`" parameters. Examples of Internal Metric Labels: * `labels="CPU,Dynamic_Split,OS,Configuration"` * `labels="Hardware,Interfaces,Drops,Errors"` In the CLI syntax, you can use any of these labels - one label or several labels: * `-f "CPU"` * `-f "Dynamic_Split"` * `-f "CPU,Dynamic_Split"` * `-f "Drops,Errors"` * and so on Example Output - Formatted as pretty JSON: ``` [Expert@R82:0]# cpview -p -f "Dynamic_Split" | jq '.' { "next-cursor": null, "data": [ { "stat-id": "UM_STAT.UM_CPU.ds_status", "records": [ { "timestamp": { "posix": 1730736137, "iso-8601": "2024-11-04T18:02+0200" }, "value": "Off" } ] } ] } [Expert@R82:0]# ``` | > | `cpview -s {on | off | stat}` `cpview --services {on | off | stat}` | Administration of the CPView services that are responsible for the Database and SNMP activity: * `on` - Enables the CPView services (this is the default) * `off` - Disables the CPView services * `stat` - Shows the status of the CPView services * `export` - Exports the current CPView database Example Output: `[Expert@R82:0]# cpview --services stat` ` CPView services running` ` [Expert@R82:0]#` | > | `cpview -t []` `cpview --history []` | Shows the data in the History mode - either the oldest available data, or the data for the specified timestamp. In CPview, press the "**t**" key and enter the applicable date and time. The \ format is: `[Jan...Dec] [01...31] [4-digit Year] [hh:mm:ss]` In versions R81.10 and higher, you can enter a partial date. For example: `Jan 02` | > {#Unique_ID_Syntax_R8200Table} Show / Hide the syntax for Security Gateway R80.30 - R81.20 > > |------------------------------------------------| > | `cpview` | > | `cpview --help` | > | `cpview --print` | > | `cpview --services {on | off | stat | export}` | > | `cpview --history` | > > Where: > > |---------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| > | Command | Description | > | `cpview` | Opens the interactive tool interface. | > | `cpview -h` `cpview --help` | Shows the built-in help and exits. | > | `cpview -t` `cpview --history` | History mode. In CPview, press the "**t**" key and enter the applicable date and time. The format is: `[Jan...Dec] [01...31] [4-digit Year] [hh:mm:ss]` In versions R81.10 and higher, you can enter a partial date. For example: `Jan 02` | > | `cpview -s