The Advanced Routing Suite

The Advanced Routing Suite CLI is available as part of the Advanced Networking Software Blade.

For organizations looking to implement scalable, fault-tolerant, secure networks, the Advanced Networking blade enables them to run industry-standard dynamic routing protocols including BGP, OSPF, RIPv1, and RIPv2 on security gateways. OSPF, RIPv1, and RIPv2 enable dynamic routing over a single autonomous system—like a single department, company, or service provider—to avoid network failures. BGP provides dynamic routing support across more complex networks involving multiple autonomous systems—such as when a company uses two service providers or divides a network into multiple areas with different administrators responsible for the performance of each.

Advanced Routing is supported on the Check Point SecurePlatform operating system. For information about SecurePlatform, see the R76 SecurePlatform Administration Guide.

The Advanced Routing Suite CLI accepts user entered text commands and sends them to Advanced Routing Suite. These commands can encode a configuration change as well as queries for configuration information and dynamic protocol state.

About this Guide

This guide describes the basic, protocol-independent functionality of the Advanced Routing Suite Command Line Interface (CLI), including command-line completion, logging, and history.

Advanced Routing Suite commands are listed alphabetically within protocol sections. For example, if you are looking for the query-authentication command in RIP, look in the Routing Information Protocol (RIP) chapter, then look for the command under the letter A. You can also use the Index to quickly search for a command.

Documentation of Commands

Most chapters in this guide have these sections:

Overview of ... (one per chapter)
Name
Syntax
Mode
Parameters
Description
Default
Command History
Examples
See Also

Name

The Name section lists the name and a short description of the command. For example, the key command in RIP:

key - sets a RIP MD5 key

Syntax

The Syntax section lists the valid syntax configuration, including the no configuration (where applicable). For example, configure the IGMP robustness to be 4 using the following syntax:

ip igmp robustness 4

Notation for parameters

In this manual, the allowed values for each parameter are listed similar to below:

Parameter: [ max-size size [ k | m ] ] ?

Parameter: address-family [ ipv4 | ipv6 ] {0,2}

The words in italics are user-entered commands that must be typed exactly as shown. The words in italics give a type of value. Some common types are size, time, or interface-name.

A pipe in a syntax (|) separates alternatives: one of them must occur. A double pipe (A || B) means that either A or B or both must occur, in any order. Brackets ([]) are for grouping. Juxtaposition is stronger than the double bar, and the double bar is stronger than the bar. Thus "a b | c || d e" is equivalent to "[ a b ] | [ c || [ d e ]]".

A pair of numbers in curly braces ({A,B}) indicates that the preceding type, word or group is repeated at least A and at most B times.

Note: A question mark (?) indicates that the preceding type, word or group is optional.

Therefore, in the preceding example, specifying a max-size is optional. However, if you do specify a max-size, you must enter a value for the size and specify either k or m.

Mode

The Mode section shows the modes in which the command is valid. Some commands are valid in multiple modes. For those, the Description section details how the effects of those configurations differ in Advanced Routing Suite.

Parameters

The Parameters section lists the information that is accepted in the referenced configuration. It includes a description of what sort of parameter Advanced Routing Suite expects (for example, the number of seconds for a query), and the range of values Advanced Routing Suite expects. (For example, the startup-query interval in IGMP accepts a value between 0 and 31744.)

Note: If the parameter is a value that is user-define, such as a time or a name, then the parameter is displayed in italics (for example, time or value). If the parameter is one of several predetermined options, such as version 1, 2, or 3 in IGMP, then that parameter is displayed in bold courier new format (for example, version 3).

Description

The Description section includes a detailed description of the configuration.

Default

The Default section includes the default value(s) of the command and its content.

Command History

The Command History section indicates when the command was first introduced. It can also indicate whether the command, its defaults, or any of its parameters have changed.

Examples

The Examples section lists valid configurations for a specified command.