HP TippingPoint Next Generation Firewall manual Using the Command Line Interface

1 Using the Command Line Interface

The command line interface (CLI) can be used to configure many aspects of the SMS. It includes wizards, high level commands, and low level commands.

Overview

This chapter explains how to use the SMS CLI.

NOTE: To use the SMS CLI, you must be logged in with an account that has SuperUser rights.

This section includes the following topics:

•”Usage” on page 1

•”The help Command” on page 3

Usage

Most SMS commands consist of the following elements:

•command — the name of the command you want to issue

•object — the name of a collection of related attributes (attribs)

•attrib — the name of a data variable or parameter on which you want to run the command

[=value] — optional syntax you can use with the set command and other writable commands to define the value of the attrib you specify. If you do not use this syntax, the system goes into interactive mode and prompts you for the value. See ”Command Types” on page 1 for more information about interactive commands.

NOTE: To clear the value of any attribute type a period (.) after the equal sign (=) or when prompted.

These elements are case-sensitive. You can use any of the following syntax to run an SMS command:

command

command object

command object.attrib

command object.attrib=value

Other SMS commands use a syntax similar to standard UNIX commands, as shown in the following example:

command -option value

Command Types

SMS commands are either read, write, or read and write. In addition, commands are either interactive, non-interactive, or might support both options.

•Interactive commands — automatically prompt you for attribute values if you use the appropriate syntax. Interactive commands also provide you with the current values of their attributes.

•Non-interactive commands — are either read-only or require you to specify the values you want to set. For example, the get command is non-interactive because it is read-only. As another example, the date command is non-interactive. If you want to set the date, you must type date value.

Security Management System CLI Reference 1