About This Guide

Use this Command Reference for Digi One RealPort and PortServer TS products.

Commands are listed in alphabetical order. Each command description contains the following topics:

Introduction, which describes the
— Purpose of the command
— Privileges required to execute the command
— Related information
Command Syntax, which describes how you issue the command. Often Command Syntax is divided into separate discussions on how you use the command to accomplish a specific purpose. For example, the syntax discussion on the set logins command is divided into separate discussion on
— Using the command to display the logins table
— Using the command to configure login parameters
Command Fields, which provides a description of each command field.
Command Examples, which are examples of how the command is used.

In addition, when necessary, some command descriptions provide

Additional information on the purpose of the command or some aspect of the command that cannot adequately be discussed elsewhere. The heading that identifies these discussions starts with the word "About." For example, the discussion on the set route command includes a topic called "About the Route Table."
A description of the output that results from issuing the command. These descriptions are provided when the description of output fields is not the same as the description of command (input) fields. The info command is a good example.

Presentation of command syntax in this manual follows these conventions:

Brackets ([]) surround optional material.
Braces ({}) surround entries that require you to choose one of several options, which are separated by the UNIX pipe (|).
Non-italicized text indicates literal values, that is, fields or values that must be typed exactly as they appear. Yes and no options are examples of literals.
Italicized text indicates that a type of information is required in that field. For example, filename, means that the name of a file is required in the field.