You are on page 1of 2

Check Point CLI Reference Card & Cheat Sheet v 1.

2 Basic firewall information gathering by Jens Roesen email www - twitter fw ctl arp [-n] Display proxy arp table. -n disables name resolution.
Preface and small warning This small cheat sheet is intended as a brief reference with some practical examples for your daily work. Although most of the commands mentioned are meant for information gathering purposes or troubleshooting rather than configuration issues you should be careful and know what you are doing. A full reference to the Check Point CLI can be found at the Check Point Support Center: http://www.checkpoint.com/support/technical/documents I've sorted the commands and examples mostly by purpose and not by product or alphabetically. Some may reoccur. Environment variables It's useful to know some of the environment variables set and needed by FW-1. Below are some of the most commonly used. Depending on your installation there will be more. Check the env output for more information. $FWDIR $CPDIR $CPMDIR $FGDIR $MDSDIR $FW_BOOT_DIR FW-1 installation directory, with f.i. the conf, log, lib, bin and spool directories. You will mostly work in this tree. SVN Foundation / cpshared tree. Management server installation directory. FloodGate-1 installation directory. MDS installation directory. Same as $FWDIR on MDS level. Directory with files needed at boot time. cp_conf sic state cp_conf lic get cp_conf finger get cp_conf client get fwm -p cp_conf admin get cp_conf auto get all cpinfo -z -o <file> fw hastat cphaprob state vpn overlap_encdom fw tab t <tbl> [s] avsu_client [-app <app>] get_version fw ctl pstat fw ctl chain fw ctl zdebug drop cpstat <app_flag> [-f flavour] Display internal statistics including information about memory, inspect, connections and NAT. Displays in and out chain of CP Modules. Useful for placing fw monitor into the chain with the -p option. Real time listing of dropped packets. Display status of the CP applications. Command has to be used with a application flag app_flag and an optional flavour. Issue cpstat without any options to see all possible application flags and corresponding flavours. Examples: cpstat fw -f policy verbose policy info cpstat fw -f sync Synchronisation statistics cpstat os -f cpu CPU utilization statistics cpstat os -f memory Memory usage info cpstat os -f ifconfig Interface table Display current SIC trust state. View licenses. Display fingerprint on the management module. Display GUI clients list. List administrator accounts. Display admin accounts and permissions. Display auto state of all products. Also works with fw1, fg1 and rm instead of all. Create a compressed cpinfo file to open with the InfoView utility or to send to Check Point support. View HA state of local machine. View HA state of all cluster members. Show, if any, overlapping VPN domains. View kernel table contents. Make output short with -s switch. List all available tables with fw tab -s. E.g. fw tab -t connections -s Connections table. Get local signature version and status of content security <app> where <app> can be Edge AV, URL Filtering and ICS. Without the -app <app> option Anti Virus is used by default. Check if signature for <app> is up-to-date. See previous command for the possible values of <app>. View hw info like serial numbers in Nokia clish. See also ipsctl -a and cat /var/etc/.nvram. View Edge Appliance information (hw, fwl, license..) List active devices behind Edge Appliance. View a list of available fw logfiles and their size. Export/display current fw.log to stdout. Write the current (audit) logfile to YY-MM-DDHHMMSS.log and start a new fw.log. Fetch a logfile from a remote CP module. NOTICE: The log will be moved, hence deleted from the remote module. Does not work with current fw.log. Tail the actual log file from the end of the log.

View and manage logfiles Without the -t switch it starts from the beginning. fw log -b <starttime> <endtime> View today's log entries between <starttime> and <endtime> with time format being HH:MM:SS. Example: fw log -b 09:00:00 09:15:00. Show only records with action <action>, e.g. accept, drop, reject etc. Starts from the top of the log, use -t to start a tail at the end. Export logfile in.log to file out.csv, use , (comma) as delimiter (CSV) and do not resolve services or hostnames.

fw log -c <action>

fwm logexport -i in.log -o out.csv -d ',' -p -n

Display and manage licenses cp_conf lic get View licenses. Same info as cplic db_print -all -x. cplic print fw lichosts dtps lic cplic del <sig> <obj> cplic get <ip host|all> cplic put <-l file> cplic put <obj> <-l file> cprlic Display more detailed license information. List protected hosts with limited hosts licenses. SecureClient Policy Server license summary. Delete CP license with signature sig from object obj. Retrieve all licenses from a certain gateway or all gateways in order to synchronize license repository on the SmartCenter server with the gateway(s). Install local license from file to an local machine. Attach one or more central or local licenses from file remotely to obj. Remote license management tool.

Basic starting and stopping cpstop Stop all Check Point services except cprid. You can also stop specific services by issuing an option with cpstop. For instance cpstop FW1 stops FW-1/VPN-1 or use cpstop WebAccess to stop WebAccess. cpstart cprestart cpridstop cpridstart cpridrestart fw kill [-t sig] proc_name fw unloadlocal Start all Check Point services except cprid. cpstart works with the same options as cpstop. Combined cpstop and cpstart. Complete restart. Stop cprid, the Check Point Remote installation Daemon. Start cprid, the Check Point Remote installation Daemon. Combined cpridstop and cpridstart. Kill a Firewall process. PID file in $FWDIR/tmp/ must be present. Per default sends signal 15 (SIGTERM). Example: fw kill -t 9 fwm Uninstall local security policy.

avsu_client [-app <app>] fetch_remote -fi show asset hardware info device info computers View and manage logfiles fw lslogs fwm logexport

Basic firewall information gathering fw ver Check FW-1/VPN-1 major and minor version as well as build number and latest installed hotfix. fwm ver Check management module major and minor version as well as build number and latest installed hotfix. vpn ver Check VPN-1 major and minor version as well as build number and latest installed hotfix. Use the switch -k for additional kernel version. cpshared_ver Show the version of the SVN Foundation. fw stat Show the name of the currently installed policy as well as a brief interface list. Can be used with the -long or -short switch for more information. Display process information about CP processes monitored by the CP WatchDog. Display interface list.

Basic configuration tasks, Admins, Users, SIC cpconfig Menu based configuration tool for the most common tasks like adding/removing admin accounts or GUI clients, managing licenses, SIC and so on. Options depend on the installed products and packages. cp_conf -h Display cp_conf help. Options depend on the installed products and packages. cp_conf admin add <user> Add admin user with password pass and <pass> <perm> permissions perm where w is read/write access and r is read only. Note: permission w does not allow administration of admin accounts. cp_admin_convert Export admin definitions created in cpconfig to SmartDashboard. cp_conf admin del <user> Delete the admin account user. fwm expdate <dd-mmm-yyy> [-f <dd-mmm-yyyy>] cp_conf client get cp_conf client add <ip> cp_conf client del <ip> cp_conf sic state cp_conf sic reset cp_conf sic init <key> Set new expiration date for all users or with -f for all users matching the expiration date filter:
fwm expdate 31-Dec-2020 -f 31-Dec-2010.

Display GUI clients list. Add GUI client with IP ip. Delete the GUI client with IP ip. You can delete multiple clients at once. Display current SIC trust state. Reset SIC. Initialize SIC.

fw logswitch [-audit] fw fetchlogs -f file module

cpwd_admin list fw ctl iflist

fw log -f -t

The latest version of this PDF is available at http://bit.ly/fw1cli. Licensed under Creative Commons BY NC SA License. SecurePlatform, SofaWare, SmartCenter, ClusterXL, Provider-1, VSX, IPSO and VPN-1/UTM-1 Edge are a registered trademarks of Check Point Software Technologies, Ltd.

fw monitor fw monitor, Check Points packet sniffing tool, is part of every FW-1 installation, independent from the underlying platform. Also the syntax is the same for all available platforms. Read the Check Point guide (http://bit.ly/fwmonref) or see my fw monitor cheat sheet (http://bit.ly/cpfwmon) for detailed info on this topic. fw monitor Examples:
# packets with IP 192.168.1.12 as SRC or DST fw monitor -e 'accept host(192.168.1.12);' # all packets from 192.168.1.12 to 192.168.3.3 fw monitor -e 'accept src=192.168.1.12 and dst=192.168.3.3;' # UDP port 53 (DNS) packets, pre-in position is before 'ippot_strip' fw monitor -pi ipopt_strip -e 'accept udpport(53);' # UPD traffic from or to unprivileged ports, only show post-out fw monitor -m O -e 'accept udp and (sport>1023 or dport>1023);' # Windows traceroute (ICMP, TTL<30) from and to 192.168.1.12 fw monitor -e 'accept host(192.168.1.12) and tracert;' # Capture web traffic for VSX virtual system ID 23 fw monitor -vs 23 -e 'accept tcpport(80);' # Capture traffic on a SecuRemote/SecureClient client into a file. # srfw.exe in $SRDIR/bin (C:\Program Files\CheckPoint\SecuRemote\bin) srfw monitor -o output_file.cap

SecurePlatform sysconfig

Menu based SecurePlatform OS configuration tool.

Provider-1 mds_backup

webui <enable| Enable the WebUI on HTTPS port 443 or port [port] or disable> [port] disable the WebUI. showusers Display a list of configured SecurePlatform administrators. adduser <user> backup Add an admin account. Delete with deluser <user>. Backup system config to /var/CPbackup/backups file backup_host.domain_DD_MM_YYYY_hh_mm.tgz. backup also works with the following switches: --scp <ip> <user> <pass> -path <path> <file> --tftp <ip> -path <tftpboot/subdir> file --ftp <ip> <user> <pass> -path <path> <file> If you do not specify file or path the default naming scheme and/or the homedir of the account will be used. A relative path results in a backup to a subdirectory of home. Restores a backup from file <file>. Pretty much works with the same switches as backup. Take a snapshot of the entire system. Without options it's menu based. Note: cpstop is issued! Examples: snapshot --file <file> snapshot --tfpt <ip> <file> snapshot --scp <ip> <user> <pass> <file> snapshot --ftp <ip> <user> <pass> <file> Reboot system from a snapshot file. Same switches as snapshot. Install the patch <patch> from CD. View SecurePlatform build number. Add a static ARP entry for ip. Survives a reboot. Use delarp with the same syntax to delete a ARP entry. View DNS server setting or add/delete DNS servers. Show index of available system and error log files. View log file number <nr> from the log list index. Change login password. In expert mode it changes the expert pass, in standard mode it changes the admin pass. Use /usr/bin/passwd <user> in expert mode.

Backup binaries and data to current directory. You can exclude files by specifying them in $MDSDIR/conf/mds_exclude.dat. Restore MDS backup from file. Notice: you may need to copy mds_backup from $MDSDIR/scripts/ as well as gtar and gzip from $MDS_SYSTEM/shared/ to the directory with the backup file. Normally, mds_backup does this during backup.

mds_restore <file>

VPN & VPN Debugging vpn ver [-k] Check VPN-1 major and minor version as well as build number and latest hotfix. Use -k for kernel version. vpn tu vpn shell vpn debug ikeon| ikeoff vpn debug on|off vpn debug trunc vpn drv stat Start a menu based VPN TunnelUtil program where you can list and delete Security Associations (SAs) for peers. Start the VPN shell. Debug IKE into $FWDIR/log/ike.elg. Debug VPN into $FWDIR/log/vpnd.elg. Truncate and stamp logs, enable IKE & VPN debug.

restore <file> snapshot

VSX vsx stat [-v] [-l] [id]

revert Display VSX status. Verbose output with -v, interface list with -l or status of single system with VS ID <id>. View current shell context. Set context to VS with the ID <id>. Reset SIC for VS ID <id>. View driver interface list for a VS. You can also use the VS name instead of -vs <id>. View state tables for virtual system <id>. View traffic for virtual system with ID <id>. patch add cd <patch> cd_ver or ver addarp <ip> <MAC> dns [add|del <ip>] log list log show <nr> passwd

Show status of VPN-1 kernel module. vpn overlap_encdom Show, if any, overlapping VPN domains. vpn macutil <user> Show MAC for Secure Remote user <user>. IPSO clish (Better go and read the docu. Clish is mighty ;) You can enter clish commands either in the clish itself or from the shell using clish [-s] -c "<command>". The -s option runs save config afterwards. show summary show asset hardware show images show image current show package all|active set package name <name> <on|off> Show system configuration summary. Show hardware information. See also output of ipsctl -a and cat /var/etc/.nvram . Show available IPSO images. Show current IPSO image. Show all available/active packages. Activate or deactivate a package.

vsx get vsx set <id> vsx sic reset <id> fw -vs <id> getifs fw tab -vs <id> -t <table> fw monitor -vs <id> -e 'accept;'

In general, a lot of Check Point's commands do understand the -vs <id> switch. ClusterXL cp_conf ha enable| disable [norestart] cphastop

Enable or disable HA. Disable ClusterXL on the cluster member. Issued on a cluster member running in HA Legacy Mode cphastop might stop the entire cluster. Activate ClusterXL on this cluster member. View HA state of local machine. View HA state of all cluster members. View interface status. View list and state of critical cluster devices. View sync transport layer statistics. Reset with -reset. Configure Cluster Control Protocol (CCP) to use unicast or multicast messages. By default set to multicast. Setting survives reboot.

Provider-1 mdsenv [cma_name] mdsstart [-m|-s]

set ssh server log-level Set sshd log verbosity to quiet, fatal, error, <level> info (default), verbose or debug. show vrrp [interfaces] reboot image <img> save rm /config/active set voyager daemonenable <1|0> ssl-port 8443 ssl-level 168 View VRRP (interface) status. Reboot into <img> and run save before booting. Kind of factory default reset. Reboot afterwards. Enable (or disable) Voyager on SSL port 8443 using 3DES crypto. Also works with true, false, on or off. save config afterwards.

Set the environment variables for MDS oder CMA level. Starts the MDS and all CMAs (10 at a time). Start only the MDS with -m or the CMAs subsequently with -s. Stop MDS and all CMAs or with -m just the MDS. Show status of the MDS and all CMAs or a certain customer's CMA. Use -m for only MDS status. Create a cpinfo for the customer cma <cma>. Remember to run mdsenv <cma> in advance. Quick cd to $FWDIR/<directory> of the current CMA. Stop CMA. Run mdsenv <cma> in advance. Start CMA. Run mdsenv <cma> in advance. MDS replacement for cpconfig.

cphastart fw hastat cphaprob state cphaprob -a if cphaprob -ia list cphaprob syncstat cphaconf set_ccp <broadcast| multicast>

mdsstop [-m] mdsstat [cma_name]|[-m]

Edge Appliances CLI and Sofaware SmartCenter Commands* help [command] Show help topics. Also works with all commands. info fw [rules] info nat info device show net wan export swcmd Reboot <edge> smsstart and smsstop Show firewall statistics (in/out packets) or policy. Display active nat policy. Show hardware information. Show configuration of wan device. Export complete system configuration. Reboot <edge> from SmartCenter Console.* Start/stop the Sofaware Management Server.*

cpinfo -c <cma> mcd <directory> mdsstop_customer <cma> mdsstart_customer <cma> mdsconfig

Note: DO NOT run any cphaconf commands other than set_ccp.

The latest version of this PDF is available at http://bit.ly/fw1cli. Licensed under Creative Commons BY NC SA License. SecurePlatform, SofaWare, SmartCenter, ClusterXL, Provider-1, VSX, IPSO and VPN-1/UTM-1 Edge are a registered trademarks of Check Point Software Technologies, Ltd.