D-Link NetDefend DFL-260E User manual

Network Security Solution http://www.dlink.com
NetDefendOS
Ver.11.04.01
Network Security Firewall
CLI Reference Guide
Security
Security

CLI Reference Guide
DFL-260E/860E/870/1660/2560/2560G
NetDefendOS version 11.04.01
D-Link Corporation
No. 289, Sinhu 3rd Rd, Neihu District, Taipei City 114, Taiwan R.O.C.
http://www.DLink.com
Published 2016-10-03
Copyright ©2016

CLI Reference Guide
DFL-260E/860E/870/1660/2560/2560G
NetDefendOS version 11.04.01
Published 2016-10-03
Copyright ©2016
Copyright Notice
This publication, including all photographs, illustrations and software, is protected under
international copyright laws, with all rights reserved. Neither this manual, nor any of the material
contained herein, may be reproduced without the written consent of D-Link.
Disclaimer
The information in this document is subject to change without notice. D-Link makes no
representations or warranties with respect to the contents hereof and specifically disclaims any
implied warranties of merchantability or fitness for a particular purpose. D-Link reserves the right
to revise this publication and to make changes from time to time in the content hereof without
any obligation to notify any person or parties of such revision or changes.
Limitations of Liability
UNDER NO CIRCUMSTANCES SHALL D-LINK OR ITS SUPPLIERS BE LIABLE FOR DAMAGES OF ANY
CHARACTER (E.G. DAMAGES FOR LOSS OF PROFIT, SOFTWARE RESTORATION, WORK STOPPAGE,
LOSS OF SAVED DATA OR ANY OTHER COMMERCIAL DAMAGES OR LOSSES) RESULTING FROM
THE APPLICATION OR IMPROPER USE OF THE D-LINK PRODUCT OR FAILURE OF THE PRODUCT,
EVEN IF D-LINK IS INFORMED OF THE POSSIBILITY OF SUCH DAMAGES. FURTHERMORE, D-LINK
WILL NOT BE LIABLE FOR THIRD-PARTY CLAIMS AGAINST CUSTOMER FOR LOSSES OR DAMAGES.
D-LINK WILL IN NO EVENT BE LIABLE FOR ANY DAMAGES IN EXCESS OF THE AMOUNT D-LINK
RECEIVED FROM THE END-USER FOR THE PRODUCT.

Table of Contents
Preface...............................................................................................................11
1.Introduction ....................................................................................................13
1.1.Runningacommand ..............................................................................13
1.2.Help .....................................................................................................14
1.2.1.Helpforcommands......................................................................14
1.2.2.Helpforobjecttypes ....................................................................14
1.3.Functionkeys ........................................................................................15
1.4.Commandlinehistory.............................................................................16
1.5.Tabcompletion .....................................................................................17
1.5.1.Inlinehelp ..................................................................................17
1.5.2. Autocompleting Current and Default value ...................................... 18
1.5.3.Configurationobjecttypecategories ..............................................18
1.6.Userroles ..............................................................................................20
2.CommandReference ........................................................................................22
2.1.Configuration ........................................................................................22
2.1.1.activate ......................................................................................22
2.1.2.add............................................................................................22
2.1.3.cancel ........................................................................................24
2.1.4.cc ..............................................................................................24
2.1.5.commit ......................................................................................25
2.1.6.delete ........................................................................................25
2.1.7.pskgen .......................................................................................26
2.1.8.reject .........................................................................................27
2.1.9.reset ..........................................................................................28
2.1.10.set ...........................................................................................29
2.1.11.show ........................................................................................30
2.1.12.undelete ...................................................................................31
2.2.Runtime ...............................................................................................33
2.2.1. about .........................................................................................33
2.2.2.alarm .........................................................................................33
2.2.3.appcontrol..................................................................................33
2.2.4.arp ............................................................................................34
2.2.5.arpsnoop....................................................................................35
2.2.6.ats .............................................................................................36
2.2.7.authagent ..................................................................................36
2.2.8.authagentsnoop ..........................................................................37
2.2.9.avcache......................................................................................38
2.2.10.blacklist ....................................................................................38
2.2.11.buffers .....................................................................................39
2.2.12.cam .........................................................................................40
2.2.13.certcache ..................................................................................41
2.2.14.cfglog ......................................................................................41
2.2.15.connections ..............................................................................41
2.2.16.cpuid .......................................................................................42
2.2.17.crashdump ...............................................................................43
2.2.18.cryptostat .................................................................................43
2.2.19.dcc ..........................................................................................43
2.2.20.dconsole...................................................................................44
2.2.21.dhcp ........................................................................................44
2.2.22.dhcprelay .................................................................................45
2.2.23. dhcpserver ................................................................................45
2.2.24.dhcpv6 .....................................................................................46
2.2.25.dhcpv6server ............................................................................47
2.2.26.dns ..........................................................................................48
2.2.27.dnsbl .......................................................................................49
2.2.28.dynroute ..................................................................................49
4

2.2.29.frags ........................................................................................50
2.2.30.ha ............................................................................................51
2.2.31. hostmon ...................................................................................51
2.2.32.httpalg .....................................................................................51
2.2.33.httpposter ................................................................................52
2.2.34.hwm ........................................................................................53
2.2.35.idppipes ...................................................................................53
2.2.36.ifstat ........................................................................................54
2.2.37.igmp ........................................................................................54
2.2.38.ihs ...........................................................................................55
2.2.39.ike ...........................................................................................55
2.2.40.ikesnoop ..................................................................................57
2.2.41.ippool ......................................................................................57
2.2.42.ipsec ........................................................................................58
2.2.43.ipsecdefines ..............................................................................59
2.2.44.ipsecglobalstats .........................................................................59
2.2.45.ipsechastat ...............................................................................60
2.2.46.ipsecstats..................................................................................60
2.2.47.ipsectunnels..............................................................................61
2.2.48.killsa ........................................................................................62
2.2.49.l2tp ..........................................................................................63
2.2.50.languagefiles .............................................................................63
2.2.51.ldap .........................................................................................64
2.2.52. license ......................................................................................65
2.2.53.linkmon ....................................................................................65
2.2.54.logout ......................................................................................65
2.2.55.lwhttp ......................................................................................66
2.2.56.macstorage ...............................................................................66
2.2.57.memory ...................................................................................66
2.2.58.natpool ....................................................................................67
2.2.59.nd ...........................................................................................67
2.2.60.ndsnoop ...................................................................................68
2.2.61.netobjects ................................................................................69
2.2.62.ospf .........................................................................................69
2.2.63.pcapdump ................................................................................71
2.2.64. pipes ........................................................................................73
2.2.65.pptp ........................................................................................74
2.2.66.pptpalg ....................................................................................74
2.2.67.reconfigure ...............................................................................75
2.2.68.rekeysa .....................................................................................75
2.2.69.route ........................................................................................76
2.2.70.routemon .................................................................................76
2.2.71.routes ......................................................................................77
2.2.72.rtmonitor ..................................................................................78
2.2.73.rules ........................................................................................78
2.2.74.selftest .....................................................................................79
2.2.75.services ....................................................................................81
2.2.76. sessionmanager .........................................................................82
2.2.77.settings ....................................................................................83
2.2.78.shutdown .................................................................................83
2.2.79.sipalg .......................................................................................84
2.2.80.smtp ........................................................................................86
2.2.81.sshserver ..................................................................................87
2.2.82.sslvpn ......................................................................................88
2.2.83.stats .........................................................................................88
2.2.84.sysmsgs ....................................................................................88
2.2.85.techsupport ..............................................................................89
2.2.86.time .........................................................................................89
2.2.87.uarules .....................................................................................90
2.2.88.updatecenter ............................................................................90
2.2.89.userauth ...................................................................................91
CLI Reference Guide
5

2.2.90.vlan .........................................................................................92
2.2.91.vpnstats ...................................................................................93
2.2.92.zonedefense .............................................................................93
2.3.Utility ...................................................................................................94
2.3.1.geoip .........................................................................................94
2.3.2.ping ..........................................................................................94
2.3.3.traceroute ..................................................................................95
2.4.Misc .....................................................................................................97
2.4.1.echo ..........................................................................................97
2.4.2.help ...........................................................................................97
2.4.3.history .......................................................................................98
2.4.4.logsnoop ....................................................................................98
2.4.5.ls ............................................................................................. 100
2.4.6.script ....................................................................................... 101
3.ConfigurationReference .................................................................................. 105
3.1.Access ................................................................................................ 109
3.2.Address .............................................................................................. 111
3.2.1.AddressFolder ........................................................................... 111
3.2.2.EthernetAddress ........................................................................ 114
3.2.3.EthernetAddressGroup ............................................................... 114
3.2.4.IP4Address ............................................................................... 114
3.2.5.IP4Group .................................................................................. 115
3.2.6.IP4HAAddress ........................................................................... 115
3.2.7.IP6Address ............................................................................... 115
3.2.8.IP6Group .................................................................................. 115
3.2.9.IP6HAAddress ........................................................................... 115
3.3.AdvancedScheduleProfile...................................................................... 116
3.3.1.AdvancedScheduleOccurrence .................................................... 116
3.4.ALG.................................................................................................... 117
3.4.1.ALG_FTP .................................................................................. 117
3.4.2.ALG_H323 ................................................................................ 118
3.4.3.ALG_HTTP ................................................................................ 118
3.4.4.ALG_POP3 ................................................................................ 120
3.4.5.ALG_PPTP ................................................................................ 121
3.4.6.ALG_SIP ................................................................................... 121
3.4.7.ALG_SMTP ................................................................................ 122
3.4.8.ALG_TFTP ................................................................................. 124
3.4.9.ALG_TLS ................................................................................... 125
3.5.AntiVirusPolicy .................................................................................... 126
3.6.AppControlSettings .............................................................................. 127
3.7.ApplicationRuleSet ............................................................................... 128
3.7.1.ApplicationRule ......................................................................... 128
3.8.ARPND ............................................................................................... 130
3.9.ARPNDSettings .................................................................................... 131
3.10.AuthAgent ........................................................................................ 134
3.11.AuthenticationSettings ....................................................................... 135
3.12.BlacklistWhiteHost .............................................................................. 136
3.13.Certificate ......................................................................................... 137
3.14.COMPortDevice ................................................................................. 138
3.15.ConfigModePool ................................................................................ 139
3.16.ConnTimeoutSettings ......................................................................... 140
3.17.CRLDistPointList ................................................................................. 141
3.17.1.CRLDistPoint ........................................................................... 141
3.18.DateTime .......................................................................................... 142
3.19.DefaultInterface ................................................................................. 144
3.20.Device .............................................................................................. 145
3.21.DHCPRelay ........................................................................................ 146
3.22.DHCPRelaySettings ............................................................................. 148
3.23.DHCPServer ....................................................................................... 149
3.23.1.DHCPServerPoolStaticHost ........................................................ 150
3.23.2.DHCPServerCustomOption ........................................................ 150
CLI Reference Guide
6

3.24.DHCPServerSettings ........................................................................... 152
3.25.DHCPv6Server ................................................................................... 153
3.25.1. DHCPv6ServerPoolStaticHost ..................................................... 154
3.26.DHCPv6ServerSettings ........................................................................ 155
3.27.DiagnosticsSettings ............................................................................ 156
3.28.DNS.................................................................................................. 157
3.29.DynamicRoutingRule .......................................................................... 158
3.29.1.DynamicRoutingRuleExportOSPF ............................................... 159
3.29.2.DynamicRoutingRuleAddRoute .................................................. 159
3.30.DynDnsClientCjbNet ........................................................................... 161
3.31.DynDnsClientDLink ............................................................................ 162
3.32.DynDnsClientDLinkChina .................................................................... 163
3.33.DynDnsClientDyndnsOrg .................................................................... 164
3.34.DynDnsClientDynsCx .......................................................................... 165
3.35.DynDnsClientPeanutHull ..................................................................... 166
3.36.EmailControlProfile ............................................................................. 167
3.36.1.EmailFilter............................................................................... 170
3.37.Ethernet ............................................................................................ 171
3.38.EthernetDevice .................................................................................. 173
3.39.EthernetSettings ................................................................................ 174
3.40.EventReceiverSNMP2c ........................................................................ 176
3.40.1.LogReceiverMessageException .................................................. 176
3.41.FileControlPolicy ................................................................................ 177
3.42.FragSettings ...................................................................................... 178
3.43.GeolocationFilter ................................................................................ 180
3.44.GotoRule ........................................................................................... 181
3.45.GRETunnel ........................................................................................ 182
3.46.HighAvailability .................................................................................. 183
3.47.HTTPALGBanners ............................................................................... 184
3.48.HTTPAuthBanners .............................................................................. 185
3.49.HTTPPoster ........................................................................................ 186
3.50.HWM ................................................................................................ 187
3.51.HWMSettings ..................................................................................... 188
3.52.ICMPSettings ..................................................................................... 189
3.53.IDList ................................................................................................ 190
3.53.1.ID .......................................................................................... 190
3.54.IDPRule ............................................................................................. 191
3.54.1.IDPRuleAction ......................................................................... 191
3.55.IGMPRule .......................................................................................... 193
3.56.IGMPSetting ...................................................................................... 195
3.57.IKEAlgorithms .................................................................................... 196
3.58.InterfaceGroup ................................................................................... 198
3.59.IP6in4Tunnel ..................................................................................... 199
3.60.IPPolicy ............................................................................................. 200
3.61.IPPool ............................................................................................... 204
3.62.IPRule ............................................................................................... 205
3.63.IPRuleFolder ...................................................................................... 208
3.63.1.IPPolicy .................................................................................. 208
3.63.2.SLBPolicy ................................................................................ 208
3.63.3.MulticastPolicy ........................................................................ 211
3.63.4.StatelessPolicy ......................................................................... 212
3.63.5.GotoRule ................................................................................ 214
3.63.6.ReturnRule .............................................................................. 214
3.63.7.IPRule..................................................................................... 215
3.64.IPRuleSet........................................................................................... 216
3.64.1.IPPolicy .................................................................................. 216
3.64.2.SLBPolicy ................................................................................ 216
3.64.3.MulticastPolicy ........................................................................ 216
3.64.4.StatelessPolicy ......................................................................... 216
3.64.5.GotoRule ................................................................................ 216
3.64.6.ReturnRule .............................................................................. 216
CLI Reference Guide
7

3.64.7.IPRuleFolder ............................................................................ 216
3.64.8.IPRule..................................................................................... 216
3.65.IPsecAlgorithms ................................................................................. 217
3.66.IPsecTunnel ....................................................................................... 219
3.67.IPsecTunnelSettings ............................................................................ 222
3.68.IPSettings .......................................................................................... 224
3.69.L2TPClient ......................................................................................... 227
3.70.L2TPServer ........................................................................................ 229
3.71.L2TPServerSettings ............................................................................. 231
3.72.L2TPv3Client ..................................................................................... 232
3.73.L2TPv3Server ..................................................................................... 234
3.74.LDAPDatabase ................................................................................... 235
3.75.LDAPServer ....................................................................................... 236
3.76.LengthLimSettings ............................................................................. 237
3.77.LinkAggregation ................................................................................ 238
3.78.LinkMonitor ....................................................................................... 241
3.79.LocalReassSettings ............................................................................. 242
3.80.LocalUserDatabase ............................................................................. 243
3.80.1.User ....................................................................................... 243
3.81.LogReceiverMemory ........................................................................... 244
3.81.1.LogReceiverMessageException .................................................. 244
3.82.LogReceiverSMTP ............................................................................... 245
3.82.1.LogReceiverMessageException .................................................. 246
3.83.LogReceiverSyslog .............................................................................. 247
3.83.1.LogReceiverMessageException .................................................. 247
3.84.LogSettings ....................................................................................... 248
3.85.LoopbackInterface .............................................................................. 249
3.86.MiscSettings ...................................................................................... 250
3.87.MulticastPolicy ................................................................................... 251
3.88.MulticastSettings................................................................................ 252
3.89.NATPool ........................................................................................... 253
3.90.OSPFProcess ...................................................................................... 254
3.90.1.OSPFArea ............................................................................... 255
3.91.Pipe ................................................................................................. 259
3.92.PipeRule ........................................................................................... 262
3.93.PPPoETunnel ..................................................................................... 263
3.94.PPPSettings ....................................................................................... 265
3.95.PSK .................................................................................................. 266
3.96.RadiusAccounting .............................................................................. 267
3.97.RadiusRelay ....................................................................................... 268
3.98.RadiusServer ...................................................................................... 270
3.99.RealTimeMonitorAlert ......................................................................... 271
3.100.RemoteMgmtHTTP ........................................................................... 272
3.101.RemoteMgmtREST ............................................................................ 273
3.102.RemoteMgmtSettings ....................................................................... 274
3.103.RemoteMgmtSNMP .......................................................................... 276
3.104.RemoteMgmtSSH ............................................................................. 277
3.105.RouteBalancingInstance .................................................................... 279
3.106.RouteBalancingSpilloverSettings ......................................................... 280
3.107.RouterAdvertisement ........................................................................ 281
3.107.1.RA_PrefixInformation .............................................................. 282
3.108.RoutingRule ..................................................................................... 283
3.109.RoutingSettings ............................................................................... 284
3.110.RoutingTable ................................................................................... 285
3.110.1.Route ................................................................................... 285
3.110.2.Route6.................................................................................. 287
3.110.3.SwitchRoute .......................................................................... 288
3.111.ScheduleProfile ................................................................................ 289
3.112.ServiceGroup ................................................................................... 290
3.113.ServiceICMP ..................................................................................... 291
3.114.ServiceICMPv6 ................................................................................. 293
CLI Reference Guide
8

3.115.ServiceIPProto .................................................................................. 295
3.116.ServiceTCPUDP ................................................................................ 296
3.117. SLBPolicy ......................................................................................... 297
3.118.SSHClientKey ................................................................................... 298
3.119.SSLSettings ...................................................................................... 299
3.120.SSLVPNInterface ............................................................................... 301
3.121.SSLVPNInterfaceSettings .................................................................... 302
3.122.StatelessPolicy ................................................................................. 303
3.123.StateSettings ................................................................................... 304
3.124.TCPSettings ..................................................................................... 305
3.125.ThresholdRule .................................................................................. 307
3.125.1.ThresholdAction .................................................................... 307
3.126.UpdateCenter .................................................................................. 309
3.127.UserAuthRule ................................................................................... 310
3.128.VLAN .............................................................................................. 313
3.129.VLANSettings ................................................................................... 315
3.130.VoIPProfile ....................................................................................... 316
3.131.WebProfile ....................................................................................... 318
3.131.1.URLFilterPolicy_URL ............................................................... 318
3.132.ZoneDefenseBlock ............................................................................ 320
3.133.ZoneDefenseExcludeList .................................................................... 321
3.134.ZoneDefenseSwitch .......................................................................... 322
3.135.ZoneDefenseSwitchSettings ............................................................... 323
Index ............................................................................................................... 325
CLI Reference Guide
9

List of Examples
1.Commandoptionnotation ................................................................................11
1.1.Helpforcommands ........................................................................................14
1.2.Helpforobjecttypes ......................................................................................14
1.3.Commandlinehistory.....................................................................................16
1.4.Tabcompletion .............................................................................................17
1.5.Inlinehelp .....................................................................................................17
1.6.Editanexistingpropertyvalue .........................................................................18
1.7.Usingcategorieswithtabcompletion ...............................................................18
2.1.Createanewobject ........................................................................................23
2.2.Changecontext .............................................................................................24
2.3.Deleteanobject ............................................................................................26
2.4.Rejectchanges ..............................................................................................27
2.5.Setpropertyvalues ........................................................................................29
2.6.Showobjects .................................................................................................30
2.7.Undeleteanobject .........................................................................................32
2.8.Blockhosts ....................................................................................................38
2.9.frags ............................................................................................................50
2.10. List network objects which have names containing "net". ................................... 69
2.11. Show all monitored objects in the alg/http category .......................................... 78
2.12.Showarangeofrules ....................................................................................78
2.13.Interfacepingtestbetweenallinterfaces .........................................................79
2.14. Interface ping test between interfaces 'if1' and 'if2' ............................................ 80
2.15. Start 30 min burn-in, testing RAM, storage media and crypto accelerator .............. 80
2.16.Listallservices whichnamesbeginwith"http" ..................................................81
2.17.Showarangeofrules ....................................................................................90
2.18.HelloWorld .................................................................................................97
2.19. Show log message having 'warning' followed by 'udp' somewhere in the message . 98
2.20.Ratelimitlogflowtofivelogspersecond.........................................................99
2.21.Showlogsfromthememlogbuffer .................................................................99
2.22.ShowlogshavingasourceIPvalue .................................................................99
2.23. Show logs having a severity of warning or higher .............................................. 99
2.24.Transferscriptfilestoand fromthe device ..................................................... 100
2.25.Uploadlicensedata .................................................................................... 101
2.26.Uploadcertificate data ................................................................................ 101
2.27.Uploadsshpublickeydata .......................................................................... 101
2.28.Executescript ............................................................................................ 101
10

Preface
Audience
The target audience for this reference guide is:
• Administrators that are responsible for configuring and managing the D-Link Firewall.
• Administrators that are responsible for troubleshooting the D-Link Firewall.
This guide assumes that the reader is familiar with the D-Link Firewall, and has the necessary
basic knowledge in network security.
Notation
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. 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:
gw-world:/> help -category=COMMANDS
gw-world:/> 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
11

is specified.
The following two examples will yield the same result:
gw-world:/> routes -flushl3cache=100
gw-world:/> 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.
gw-world:/> routes Virroute Virroute2
Notation Preface
12

Chapter 1: Introduction
• Running a command, page 13
• Help, page 14
• Function keys, page 15
• Command line history, page 16
• Tab completion, page 17
• User roles, page 20
This guide is a reference for all commands and configuration object types that are available in
the command line interface for NetDefendOS.
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. Running a command
The commands described in this guide can be run by typing the command name and then
pressing the return key. Many commands require options to be set to run. If a required option is
missing a brief syntax help will be displayed.
13

1.2. Help
1.2.1. Help for commands
There are two ways of getting help about a command. A brief help is displayed if the command
name is typed followed by -? or -h. This applies to all commands and is therefore not listed in
the option list for each command in this guide. Using the help command gives a more detailed
help corresponding to the information found in this guide. In most cases it is possible to simply
type help followed by the command name to get the full help. See Section 2.4.2, “help” for a
more detailed description. To list the available commands, just type help and press return.
Example 1.1. Help for commands
Brief help for the activate command:
gw-world:/> activate -?
gw-world:/> activate -h
Full help for activate:
gw-world:/> help activate
Help for the arp command. Arp is also the name of a configuration object type, so it is necessary
to specify that the help text for the command should be displayed:
gw-world:/> help -category=COMMANDS arp
List all available commands:
gw-world:/> help
1.2.2. Help for object types
To get help about configuration object types, use the help command. It is also possible to get
information about each property in an object type, such as data type, default value, etc. by
entering the ?character when entering the value of a property and pressing tab. More on this in
Section 1.5.1, “Inline help”.
Example 1.2. Help for object types
Full help for IP4Address:
gw-world:/> help IP4Address
Help for the ARP configuration object type, which collides with the arp command:
gw-world:/> help -category=TYPES ARP
Chapter 1: Introduction
14

1.3. Function keys
In addition to the return key there are a number of function keys that are used in the CLI.
Backspace Delete the character to the left of the cursor.
Tab Complete current word.
Ctrl-A or Home Move the cursor to the beginning of the line.
Ctrl-B or Left Arrow Move the cursor one character to the left.
Ctrl-C Clear line or cancel page view if more than one page of
information is shown.
Ctrl-D or Delete Delete the character to the right of the cursor.
Ctrl-E or End Move the cursor to the end of the line.
Ctrl-F or Right Arrow Move the cursor one character to the right.
Ctrl-K Delete from the cursor to the end of the line.
Ctrl-N or Down Arrow Show the next entry in the command history.
Ctrl-P or Up Arrow Show the previous entry in the command history.
Ctrl-T Transpose the current and the previous character.
Ctrl-U Delete from the cursor to the beginning of line.
Ctrl-W Delete word backwards.
Chapter 1: Introduction
15

1.4. Command line history
Every time a command is run, the command line is added to a history list. The up and down
arrow keys are used to access previous command lines (up arrow for older command lines and
down arrow to move back to a newer command line). See also Section 2.4.3, “history”.
Example 1.3. Command line history
Using the command line history via the arrow keys:
gw-world:/> show Address
gw-world:/> (up arrow)
gw-world:/> show Address (the previous commandline is displayed)
Chapter 1: Introduction
16

1.5. Tab completion
By using the tab function key in the CLI the names of commands, options, objects and object
properties can be automatically completed. If the text entered before pressing tab only matches
one possible item, e.g. "activate" is the only match for "acti", and a command is expected, the
name will be autocompleted. Should there be more than one match the part common to all
matches will be completed. At this point the user can either enter more characters or press tab
again, which will display a list of the possible completions. This can also be done without
entering any characters, but the resulting list might be long if there are many possible
completions, e.g. all commands.
Example 1.4. Tab completion
An example of tab completion when using the add command:
gw-world:/> add Add (tab)
gw-world:/> add Address ("ress" was autocompleted)
gw-world:/> add Address i (tab)
gw-world:/> add Address IP4 ("IP4" was autocompleted)
gw-world:/> add Address IP4
(tab, or double tab if IP4 were entered manually)
A list of all types starting with IP4 is listed.
gw-world:/> add Address IP4a (tab)
gw-world:/> add Address IP4Address ("Address" was autocompleted)
gw-world:/> add Address IP4Address example_ip a (tab)
gw-world:/> add Address IP4Address example_ip Address=
("Address=" was autocompleted)
gw-world:/> add Address IP4Address example_ip Address=1.2.3.4
Tab completion of references:
gw-world:/> set Address IP4Group examplegroup Members= (tab, tab)
A list of valid objects is displayed.
gw-world:/> set Address IP4Group examplegroup Members=e (tab)
gw-world:/> set Address IP4Group examplegroup Members=example_ip
("example_ip" was autocompleted)
1.5.1. Inline help
It is possible to get help about available properties of configuration objects while a command
line is being typed by using the ?character. Write ?instead of a property name and press tab
and a help text for the available properties is shown. If ?is typed in stead of a property value and
tab is pressed a help text for that property which contains more information such as data type,
default value, etc. is displayed.
Example 1.5. Inline help
Get inline help for all properties of an IP4Address:
gw-world:/> set IP4Address example_ip ? (tab)
A help text describing all available properties is displayed.
Getting inline help for the Address property:
gw-world:/> set IP4Address example_ip Address=? (tab)
Chapter 1: Introduction
17

A more detailed help text about Address is displayed.
1.5.2. Autocompleting Current and Default value
Another special character that can be used together with tab completion is the period "."
character. If "." is entered instead of a property value and tab is pressed it will be replaced by the
current value of that property. This is useful when editing an existing list of items or a long text
value.
The "<" character before a tab can be used to automatically fill in the default value for a
parameter if no value has yet been set. If the "." character is used, all possible values will be
shown and these can then be edited with the back arrrow and backspace keys.
Example 1.6. Edit an existing property value
Edit the current value:
gw-world:/> add IP4Address example_ip Address=1.2.3.4
gw-world:/> set IP4Address example_ip Address=. (tab)
gw-world:/> set IP4Address example_ip Address=1.2.3.4
(the value was inserted)
The value can now be edited by using the arrow keys or backspace.
gw-world:/> set IP4Group examplegroup Members=ip1,ip2,ip3,ip5
gw-world:/> set IP4Group examplegroup Members=. (tab)
gw-world:/> set IP4Group examplegroup Members=ip1,ip2,ip3,ip5
(the value was inserted)
It is now possible to add or remove a member to the list without
having to enter all the other members again.
Edit the default value:
gw-world:/> add LogReceiverSyslog example Address=example_ip
LogSeverity=. (tab)
gw-world:/> add LogReceiverSyslog example Address=example_ip
LogSeverity=Emergency,Alert,Critical,Error,Warning,Notice,Info
Now it is easy to remove a log severity.
1.5.3. Configuration object type categories
Some object types are grouped together in a category in the CLI. This only matters when using
tab completion as they are used to limit the number of possible completions when tab
completing object types. The category can always be omitted when running commands if the
type name is entered manually.
Example 1.7. Using categories with tab completion
Accessing an IP4Address object with the use of categories:
gw-world:/> show ad (tab)
gw-world:/> show Adress (the category is autocompleted)
gw-world:/> show Adress ip4a (tab)
gw-world:/> show Adress IP4Address (the type is autocompleted)
gw-world:/> show Adress IP4Address example_ip
Chapter 1: Introduction
18

Accessing an IP4Address object without the use of categories:
gw-world:/> show IP4Address example_ip
Chapter 1: Introduction
19

1.6. User roles
Some commands and options cannot be used unless the logged-in user has administrator
privileges. This is indicated in this guide by a note following the command or Admin only
written next to an option.
Chapter 1: Introduction
20