cOS Core 15.00.01 CLI Reference Guide  Next

Chapter 1: Introduction

[Note] Note: This document is also available in other formats

A PDF version of this document along with all current and older documentation in PDF format can be found at https://my.clavister.com.

It is also available as a single HTML page.

This guide is a reference for all commands and configuration object types that are available in the command line interface for Clavister cOS Core.

The CLI is case-sensitive. However, the tab-completion feature of the CLI does not require the correct case to perform completion and will alter the typed case if it is required.

1.1. Notation and Conventions

The following notation is used throughout this reference guide when specifying the options of a command:

Angle brackets <name> or
-option=<description>
Used for specifying the name of an option or a description of a value.
Square brackets [option] or
-option[=value]
Used for specifying that an option or a value for an option is optional and can be omitted.
Curly brackets {value1 | value2 | value3}
Used for specifying the available values for an option.
Ellipsis ...
Used for specifying that more than one value can be specified for the option.

Example 1.1. Command Option Notation

One of the usages for the help command looks like this: 

help -category={COMMANDS | TYPES} [<Topic>]

This means that help has an option called category which has two possible values which are COMMANDS and TYPES. There is also an optional option called Topic which in this case is a search string used to specify what help topic to display. Since the topic is optional, it is possible to exclude it when running the command.

Both of the following examples are valid for the usage described above: 

Device:/> help -category=COMMANDS
Device:/> help -category=COMMANDS activate

The usage for the routes command is: 

routes [-all] [-switched] [-flushl3cache[=<percent>]] [-num=<n>]
       [-nonhost] [-tables] [-lookup=<ip address>] [-verbose]
       [-setmtu=<mtu>] [-cacheinfo] [<table name>]...

None of the options of this command are mandatory. The flushl3cache option also has an optional value. This is because that option has a default value, 100, which will be used if no value is specified.

The following two examples will yield the same result: 

Device:/> routes -flushl3cache=100
Device:/> routes -flushl3cache

Because the table name option is followed by ellipses it is possible to specify more than one routing table. Since table name is optional as well, the user can specify zero or more policy-based routing tables. 

Device:/> routes Virroute Virroute2

   Next