Table of Contents

1. Introduction
2. Supported Deployments
3. Documentation
4. Syntax
5. Usage
6. Limitations
7. Notes
8. What's new in R81.10
9. What's new in R80.30
10. What's new in R80.10
11. What's new in R77.30
12. Troubleshooting
13. Related solutions

(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:

(3) Documentation

• R80.20.M2 CPView Guide
• R77.20 CPView User Guide

(4) Syntax

• On Security Gateway R80.30 and higher:

  [Expert@HostName:0]# cpview {-h | --help}

  [Expert@HostName:0]# cpview {-t | --history}

  [Expert@HostName:0]# cpview {-s | --services} {on | off | stat | export}

  Where:

  Command	Description
  cpview -h cpview --help	Display this help and exit.
  cpview -t cpview --history	History mode. In CPview, press the t key and and enter the applicable date and time. The format is: [Jan...Dec] [01...31] [4-digit Year] [hh:mm:ss] In R81.10 and higher versions, you can enter a partial date. For example: Jan 02.
  cpview -s <option> cpview --services <option>	CPView administration: on Turn on CPView services off Turn off CPView services stat Show CPView services status export Export current CPView data base CPView services are responsible for the Database and SNMP activity.

• On Security Gateway R76SP.50, R77.10, R77.20, R77.30, R80, R80.10, and R80.20:

  [Expert@HostName:0]# cpview

  [Expert@HostName:0]# cpview --help

  [Expert@HostName:0]# cpview -b [-t <sec> [-i <count>] [-j] [-l <filesize>]]

  [Expert@HostName:0]# cpview -b -s

  [Expert@HostName:0]# cpview -c <conf_file>

  [Expert@HostName:0]# cpview history {on | off | stat | export}

  [Expert@HostName:0]# cpview -p

  [Expert@HostName:0]# cpview -t <timestamp>

  Where:

  Command	Description
  cpview --help	Prints the built-in help.
  cpview -b [-t <sec> [-i <count>] [-j] [-l <filesize>] ]	Prints batch statistics data. -t <sec> Sets time interval to <sec> seconds before the new dump info is generated. The value of <sec> must be greater than 30. -i <count> Limits dump info to <count> times. -j Compresses the generated logs after you run the "cpview -b -s" command to stop the instance. -l <filesize> Changes log file size limit to <filesize> MB (default = 1024 MB). In the background, data is dumped into logs saved in the /var/log/cpview/ directory.
  cpview -b -s	Stops the "cpview -b" instance that runs in the background.
  cpview -c <conf_file>	Loads configuration from <conf_file>.
  cpview history {on | off | stat | export}	Controls the CPView History daemon (cpview_historyd): on Starts the CPView History daemon. off Stops the CPView History daemon stat Checks whether the CPView History daemon is activated. export Exports the History database for archiving purposes only. In R77.30, it is available only when R77.30 Jumbo Hotfix is installed.
  cpview -p	Prints all CPView views one time.
  cpview -t <timestamp>	Shows the history content from the /var/log/CPView_history/CPViewDB.dat file. Shows either the oldest available content, or from a given <timestamp>, where <timestamp> format is: [Jan...Dec] [01...31] [4-digit Year] [hh:mm:ss]

• On Security Gateway R77 only / Security Management Server R77 and higher / Multi-Domain Security Management Server R77, R77.10, and R77.20 only:

  [Expert@HostName:0]# cpview

  [Expert@HostName:0]# cpview --help

  [Expert@HostName:0]# cpview -c <conf_file>

  [Expert@HostName:0]# cpview -d

  [Expert@HostName:0]# cpview -b [-t <sec> [-i <count>] [-j] [-l <filesize>]]

  [Expert@HostName:0]# cpview -b -s

  [Expert@HostName:0]# cpview -p

  Where:

  Command	Description
  cpview --help	Prints the built-in help.
  cpview -c <conf_file>	Loads configuration from <conf_file>.
  cpview -d	Turns on the CPView debug.
  cpview -b [-t <sec> [-i <count>] [-j] [-l <filesize>] ]	Prints batch statistics data. -t <sec> Sets time interval to <sec> seconds before the new dump info is generated. The value of <sec> must be greater than 30. -i <count> Limits dump info to <count> times. -j Compresses the generated logs after you run the "cpview -b -s" command to stop the instance. -l <filesize> Changes log file size limit to <filesize> MB (default = 1024 MB). In the background, data is dumped into logs saved in the /var/log/cpview/ directory.
  cpview -b -s	Stops the "cpview -b" instance that runs in the background.
  cpview -p	Prints all CPView views once.

(5) Usage

• The CPView Utility functionality is provided via /bin/cpview_start.sh shell script, which calls the main daemon cpviewd

  • In R76SP.50, R77.30 and higher:

    $CPDIR/bin/cpviewd

  • In R77, R77.10, and R77.20:

    • $FWDIR/bin/cpviewd
    • $CPDIR/bin/cpview_historyd
      (the history daemon on Security Gateway, if the history mode is set to "on")

• Output of the 'cpwd_admin list' command shows the CPView Utility as CPVIEWD.

  Example:

  [Expert@HostName]# cpwd_admin list | grep -E "PID|CPVIEWD"
  APP        PID    STAT  #START  START_TIME             MON  COMMAND
  CPVIEWD    9732   E     1       [10:43:08] 12/1/2015   N    cpviewd
  

• Output of the 'cpwd_admin list' command shows the CPView Utility History Daemon as HISTORYD (use the 'cpview history on | off | stat' commands).

  Example:

  [Expert@HostName]# cpwd_admin list | grep -E "PID|HISTORYD"
  APP        PID    STAT  #START  START_TIME             MON  COMMAND
  HISTORYD   8792   E     1       [10:42:05] 12/1/2015   N    cpview_historyd
  

• To stop the CPView Utility ('cpviewd') using the 'cpwd_admin' command:

  [Expert@HostName]# cpwd_admin stop -name CPVIEWD

• To start the CPView Utility ('cpviewd') using the 'cpwd_admin' command:

  • In R76SP.50, R77.30 and higher:

    [Expert@HostName]# cpwd_admin start -name CPVIEWD -path "$CPDIR/bin/cpviewd" -command "cpviewd"

  • In R77, R77.10, and R77.20:

    [Expert@HostName]# cpwd_admin start -name CPVIEWD -path "$FWDIR/bin/cpviewd" -command "cpviewd"

(6) Limitations

(7) Notes

• The History database is saved in:

  Version	Location
  R81.10 and higher	$CPDIR/cpview_services/cpview_services.dat
  R80.40 - R81	$CPDIR/log/cpview_services/cpview_services.dat
  R77.30 - R80.30	/var/log/CPView_history/CPViewDB.dat

• The History Mode saves the data for 30 days, unless the available space in /var/log/ is less than 512 MB

• Throughput displayed in Gaia Portal is much higher (approximately twice as much) than the throughput displayed in CPView Utility.

  • CPView Utility - Overview tab - section Traffic counters - counter Throughput

    The throughput data is obtained directly from the hardware.
    The total throughput is a sum of all throughput counters in each path (Fast Path, Medium Path, and Slow Path).

  • Gaia Portal - Overview pane - widget Throughput

    The throughput data is a sum of both Incoming and Outgoing traffic (sum of the RX packets and TX packets from /proc/net/dev).
    Packets are counted form all interfaces.
    If a packet passes through Slow Path (F2F), it will be counted twice.

  Example:

  

(8) What's new in R81.10

Added the option to disable CPView and enable it again from the command line:

• To disable CPView, run in the Expert mode:

  kill -SIGUSR1 $(pidof cpviewd)

• To enable the CPView again, run in the Expert mode:

  cpviewd enable

(9) What's new in R80.30

The syntax to work with the history database was changed from "cpview -t <timestamp>" to "cpview -t":

1. Run:
   cpview -t
2. In CPView history, press the t key.
3. Enter the applicable date and time and press Enter.

(10) What's new in R80.10

New view in CPView R80.10 is available - Mail Statistics related to Threat Emulation MTA:

• Number of e-mails in MTA queue (Software-blades -> Threat-Emulation -> MTA -> Queues)
• Mails Received / Processed / Modified / Deferred / Blocked / Skipped / Failed (Software-blades -> Threat-Emulation -> MTA -> Monitoring)

For details, refer to sk109699 - ATRG: Mail Transfer Agent (MTA) section "(7) CPView integration".

(11) What's new in R77.30

New views in CPView R77.30 are available, enabling more accurate and detailed analysis for Security Gateway:

• Top protocols by throughput (Network -> Top-Protocols)
• Top connections by throughput (Network -> Top-Connections)
• Top protocols by CPU (I/S -> CPU -> Top-Protocols)
• Top connections by CPU (I/S -> CPU -> Top-Connections)
  Note: The mode of the Firewall Priority Queues on Security Gateway should be set to "1" (CPU Connections Statistics) - refer to sk105762 - section "(IV-B) Monitoring - Evaluation of Heavy Connections"
• Software-blades package updates information (Software-blades -> Overview) - displays information on last update time and package number for IPS, Anti-Virus, Anti-Bot, and Application Control blades.
• Threat-Extraction blade overview (Software-blades -> Threat-Extraction)
• CPView daemon "cpviewd" was moved from $FWDIR/bin/ to $CPDIR/bin/

(12) Troubleshooting

[Expert@MyGW:0]# cpview -t

CPView: History is initializing
[Expert@MyGW:0]#

(13) Related solutions

• sk103496 - Number of concurrent connections shown in CPView Utility depends on the status of SecureXL
• sk98955 - When running CPView, the output in the "I/S - CPU - Contexts" section is empty
• sk116876 - Meaning of protocol 'TCP:1024' in CPView
• sk163804 - The "cpview -t [Jan...Dec] [01...31] [4-digit Year] [hh:mm:ss]" command does not result in the date and time specified by the user in R80.30 and higher
• sk97443 - Support Debug Tools