D-Link NetDefendOS User Manual page 47

configuration. The CLI is available either locally through the local console port (connection to this
is described below), or remotely via an Ethernet interface using the Secure Shell (SSH) protocol
from an SSH client.
The CLI provides a comprehensive set of commands that allow the display and modification of
configuration data as well as allowing runtime data to be displayed and system maintenance
tasks to be performed.
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.
This section only provides a summary for using the CLI. For a complete reference for all CLI
commands, see the separate D-Link CLI Reference Guide.
The most often used CLI commands are:
• add - Adds an object such as an IP address or a rule to a NetDefendOS configuration.
• set - Sets some property of an object to a value. For example, this might be used to set the
source interface on an IP rule.
• show - Displays the current categories or display the values of a particular object.
• delete - Deletes a specific object.
CLI Command Structure
CLI commands normally have the structure:
<command> <object_category> <object_type> <object_name>
For example, to display an IP address object called my_address, the command would be:
gw-world:/> show Address IP4Address my_address
The object category in this case is Address and the type within this category is IPAddress.
When typing commands, the object category can be left out where the command's meaning is
unambiguous. For example, the show command above could have been entered as:
gw-world:/> show IPAddress my_address
However, tab completion will always assume the category is included. For example, tab
completion would not be able to help complete the above command if the tab is pressed during
or after the IPAddress object type.
The same object name could be used within two different categories or types although this is
best avoided in order to avoid ambiguity when reading configurations.
Note: The terms Category and Context
When describing the CLI, the terms object category and object context are used
interchangeably.
A command like add can also include object properties. To add a new IP4Address object with an IP
address of 10.49.02.01, the command would be:
gw-world:/> add IP4Address my_address Address=10.49.02.01
Chapter 2: Management and Maintenance
47