Forcepoint Appliances Command Line Interface (CLI) Guide

Forcepoint Appliances

Command Line Interface (CLI) Guide

V Series, X Series, & Virtual Appliances

v8 .4 .x

?2018, Forcepoint

All rights reserved.

10900-A Stonelake Blvd, Quarry Oaks 1, Suite 350, Austin TX 78759

Published 2018

Forcepoint and the FORCEPOINT logo are trademarks of Forcepoint. Raytheon is a registered trademark of Raytheon Company. All other

trademarks used in this document are the property of their respective owners.

This document may not, in whole or in part, be copied, photocopied, reproduced, translated, or reduced to any electronic medium or machinereadable form without prior consent in writing from Forcepoint. Every effort has been made to ensure the accuracy of this manual. 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.

Contents

Topic 1

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

Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

Logon and authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

CLI modes and account privileges . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

Basic account management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

Command syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

Help for CLI commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

System configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

Time and date . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Host name and description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

User certificates. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

Filestore definition and file save commands. . . . . . . . . . . . . . . . . . . . . . . . . . 16

Appliance interface configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

Appliance vswitch configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

Content Gateway Decryption Port Mirroring (DPM) . . . . . . . . . . . . . . . . . . . 29

Static routes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

Appliance status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

SNMP monitoring (polling) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

SNMP traps and queries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

Module-specific commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

Email module commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

Linux settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46

Maintenance and support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46

Starting and stopping services. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

Module status and version details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

Setting the Web policy mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

Appliance hotfixes and upgrades . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

Backup and restore . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

Collecting a configuration summary for analysis . . . . . . . . . . . . . . . . . . . . . . 59

Log files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60

Diagnose . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63

Topic 2

Copyrights and Trademarks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69

Trademarks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69

Other acknowledgments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70

Define Book Name Variable

??1

Contents

2

??Define

Product Name Variable

1

Forcepoint Appliances

Command Line Interface

CLI Guide | Forcepoint Appliances | v8.4.x

The command line interface (CLI) is a text-based user interface for configuring,

monitoring, and troubleshooting Forcepoint? 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 10

¡ñ

Maintenance and support, page 46

¡ñ

Diagnose, page 63

Use the Forcepoint Appliances API to write scripts to execute configuration changes

and perform updates across multiple appliances.

Forcepoint Appliances Copyrights and Trademarks statements are included in this

document.

Conventions

CLI Guide | Forcepoint Appliances | v8.4.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 9

¡ñ

Help for CLI commands, page 9

Forcepoint Appliances: CLI Guide ? 1

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

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

Google Online Preview   Download