Forcepoint Appliances Command Line Interface (CLI) Guide

Forcepoint Appliances Command Line Interface (CLI) Guide

V Series, X Series, & Virtual Appliances

v8.5.x

?2020 Forcepoint Forcepoint and the FORCEPOINT logo are trademarks of Forcepoint. All other trademarks used in this document are the property of their respective owners. Published 2020 Every effort has been made to ensure the accuracy of this document. However, Forcepoint makes no warranties with respect to this documentation and disclaims any implied warranties of merchantability and fitness for a particular purpose. Forcepoint shall not be liable for any error or for incidental or consequential damages in connection with the furnishing, performance, or use of this manual or the examples herein. The information in this documentation is subject to change without notice. Last modified 08-Jun-2020

Contents

Topic 1 Topic 2

Forcepoint Appliances Command Line Interface . . . . . . . . . . . . . . . . . . . . . . . 1

Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 Logon and authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 CLI modes and account privileges . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 Basic account management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 URL parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 Command syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 Help for CLI commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

System configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 Time and date . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 Host name and description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15 User certificates. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16 Filestore definition and file save commands. . . . . . . . . . . . . . . . . . . . . . . . . . 17 Appliance interface configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 Appliance vswitch configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32 Content Gateway Decryption Port Mirroring (DPM) . . . . . . . . . . . . . . . . . . . 33 Static routes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35 Appliance status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41 SNMP monitoring (polling) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42 SNMP traps and queries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45 Module-specific commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50 Forcepoint Email Security module commands . . . . . . . . . . . . . . . . . . . . . . . . 51 Forcepoint DLP Analytics Engine module commands . . . . . . . . . . . . . . . . . . 59 Linux settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60

Maintenance and support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60 Starting and stopping services. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62 Module status and version details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63 Setting the Web policy mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63 Appliance hotfixes and upgrades . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64 Backup and restore . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71 Log files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76

Diagnose . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80

Copyrights and Trademarks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87

Trademarks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87 Other acknowledgments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88

Define Book Name Variable 1

Contents 2 Define Product Name Variable

1

Forcepoint Appliances Command Line Interface

CLI Guide | Forcepoint Appliances | v8.5.x

The command line interface (CLI) is a text-based user interface for configuring, monitoring, and troubleshooting ForcepointTM Appliances. For more information about Forcepoint Appliances, see the Forcepoint Appliances Getting Started Guide. This guide describes the syntax and usage of each CLI command, including: Conventions, page 1 System configuration, page 29 Maintenance and support, page 132 Diagnose, page 158 Use the Forcepoint Appliances API to write scripts to execute configuration changes and perform updates across multiple appliances. Forcepoint Appliances Trademarks statements are included in this document.

Conventions

CLI Guide | Forcepoint Appliances | v8.5.x

Administrators who are new to the appliance CLI may benefit from these quick summaries: Logon and authentication, page 2 CLI modes and account privileges, page 2 Basic account management, page 3 Command syntax, page 4 Help for CLI commands, page 4

Forcepoint Appliances: CLI Guide 1

 ................
................

In order to avoid copyright disputes, this page is only a partial summary.

Google Online Preview   Download