DFL-210_260_800_860_1600_2500 CLI Reference Guide - D-Link

CLI Reference Guide
DFL-210/260/800/860/1600/2500
NetDefendOS version 2.10
D-Link Corporation
No. 289, Sinhu 3rd Rd, Neihu District, Taipei City 114, Taiwan R.O.C.
http://www.DLink.com
Published 2006-10-24
Copyright © 2006
CLI Reference Guide
DFL-210/260/800/860/1600/2500
NetDefendOS version 2.10
Published 2006-10-24
Copyright © 2006
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 written consent of the author.
Disclaimer
The information in this document is subject to change without notice. The manufacturer makes no
representations or warranties with respect to the contents hereof and specifically disclaim any implied warranties of merchantability or fitness for any particular purpose. The manufacturer reserves
the right to revise this publication and to make changes from time to time in the content hereof
without obligation of the manufacturer to notify any person 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 ................................................................................................................ x
1. Introduction ...................................................................................................... 1
1.1. Running a command ................................................................................ 1
1.2. Help ..................................................................................................... 2
1.2.1. Help for commands ....................................................................... 2
1.2.2. Help for object types ..................................................................... 2
1.3. Function keys ......................................................................................... 3
1.4. Command line history .............................................................................. 4
1.5. Tab completion ....................................................................................... 5
1.5.1. Inline help ................................................................................... 5
1.5.2. Autocompleting current value and default value .................................. 5
1.5.3. Configuration object type categories ................................................. 6
1.6. User roles .............................................................................................. 7
2. Command Reference .......................................................................................... 9
2.1. Configuration ......................................................................................... 9
2.1.1. activate ....................................................................................... 9
2.1.2. add ............................................................................................. 9
2.1.3. cancel ........................................................................................10
2.1.4. cc .............................................................................................11
2.1.5. cd .............................................................................................12
2.1.6. commit ......................................................................................12
2.1.7. delete ........................................................................................12
2.1.8. enter ..........................................................................................13
2.1.9. reject .........................................................................................13
2.1.10. set ...........................................................................................14
2.1.11. show ........................................................................................15
2.1.12. undelete ...................................................................................17
2.2. Runtime ...............................................................................................18
2.2.1. about .........................................................................................18
2.2.2. arp ............................................................................................18
2.2.3. arpsnoop ....................................................................................19
2.2.4. ats .............................................................................................19
2.2.5. avupdate ....................................................................................20
2.2.6. bigpond .....................................................................................20
2.2.7. blacklist .....................................................................................20
2.2.8. buffers .......................................................................................22
2.2.9. cam ...........................................................................................22
2.2.10. certcache ..................................................................................23
2.2.11. cfglog ......................................................................................23
2.2.12. connections ...............................................................................23
2.2.13. cpuid .......................................................................................24
2.2.14. crashdump ................................................................................25
2.2.15. customlog .................................................................................25
2.2.16. dhcp ........................................................................................25
2.2.17. dhcprelay ..................................................................................26
2.2.18. dhcpserver ................................................................................27
2.2.19. dns ..........................................................................................27
2.2.20. dynroute ...................................................................................28
2.2.21. frags ........................................................................................28
2.2.22. ha ............................................................................................29
2.2.23. httpposter .................................................................................30
2.2.24. idpupdate ..................................................................................30
2.2.25. ifstat ........................................................................................30
2.2.26. ikesnoop ...................................................................................31
2.2.27. ippool ......................................................................................32
2.2.28. ipsecglobalstats ..........................................................................32
2.2.29. ipseckeepalive ...........................................................................32
v
CLI Reference Guide
2.2.30. ipsecstats ..................................................................................33
2.2.31. killsa .......................................................................................33
2.2.32. license .....................................................................................34
2.2.33. linkmon ....................................................................................34
2.2.34. lockdown ..................................................................................35
2.2.35. logout ......................................................................................35
2.2.36. memory ....................................................................................36
2.2.37. ospf .........................................................................................36
2.2.38. pipes ........................................................................................38
2.2.39. routemon ..................................................................................38
2.2.40. routes .......................................................................................38
2.2.41. rules ........................................................................................39
2.2.42. sessionmanager ..........................................................................40
2.2.43. shutdown ..................................................................................41
2.2.44. sshserver ..................................................................................42
2.2.45. stats .........................................................................................43
2.2.46. time .........................................................................................43
2.2.47. urlcache ...................................................................................44
2.2.48. userauth ...................................................................................44
2.2.49. vlan .........................................................................................45
2.2.50. vpnstats ....................................................................................45
2.2.51. zonedefense ..............................................................................45
2.3. Utility ..................................................................................................47
2.3.1. ping ..........................................................................................47
2.4. Misc ....................................................................................................48
2.4.1. help ...........................................................................................48
2.4.2. history .......................................................................................48
3. Configuration Reference ....................................................................................50
3.1. Access .................................................................................................51
3.2. Address ................................................................................................53
3.2.1. EthernetAddress ..........................................................................53
3.2.2. EthernetAddressGroup ..................................................................53
3.2.3. IP4Address .................................................................................53
3.2.4. IP4Group ...................................................................................54
3.2.5. IP4HAAddress ............................................................................54
3.3. ALG ....................................................................................................56
3.3.1. ALG_FTP ..................................................................................56
3.3.2. ALG_H323 ................................................................................56
3.3.3. ALG_HTTP ...............................................................................57
3.3.4. ALG_SMTP ...............................................................................58
3.4. ARP ....................................................................................................60
3.5. BlacklistWhiteHost .................................................................................61
3.6. Certificate .............................................................................................62
3.7. Client ...................................................................................................63
3.7.1. DynDnsClientCjbNet ...................................................................63
3.7.2. DynDnsClientDyndnsOrg ..............................................................63
3.7.3. DynDnsClientDynsCx ..................................................................63
3.7.4. DynDnsClientPeanutHull ..............................................................64
3.7.5. LoginClientBigPond .....................................................................64
3.7.6. LoginClientTelia .........................................................................65
3.8. COMPortDevice ....................................................................................66
3.9. DateTime ..............................................................................................67
3.10. Device ................................................................................................68
3.11. DHCPRelay .........................................................................................69
3.12. DHCPServer ........................................................................................70
3.12.1. DHCPServerCustomOption .........................................................70
3.13. DNS ...................................................................................................72
3.14. Driver ................................................................................................73
3.14.1. IXP4NPEEthernetDriver .............................................................73
3.14.2. MarvellEthernetPCIDriver ...........................................................73
3.14.3. R8139EthernetPCIDriver .............................................................73
3.15. DynamicRoutingRule ............................................................................75
3.15.1. DynamicRoutingRuleExportOSPF ................................................75
vi
CLI Reference Guide
3.15.2. DynamicRoutingRuleAddRoute ....................................................76
3.16. EthernetDevice ....................................................................................78
3.17. HighAvailability ...................................................................................79
3.18. HTTPPoster .........................................................................................80
3.19. IDList ................................................................................................81
3.19.1. ID ...........................................................................................81
3.20. IDPFactorySignatureGroups ...................................................................82
3.20.1. IDPFactorySignatureGroup ..........................................................82
3.20.2. IDPFactorySignatureGroupWildcard .............................................83
3.21. IDPRule ..............................................................................................84
3.21.1. IDPRuleAction ..........................................................................84
3.22. IKEAlgorithms ....................................................................................86
3.23. Interface .............................................................................................87
3.23.1. DefaultInterface .........................................................................87
3.23.2. Ethernet ...................................................................................87
3.23.3. InterfaceGroup ..........................................................................88
3.23.4. IPSecTunnel .............................................................................88
3.23.5. L2TPClient ...............................................................................90
3.23.6. L2TPServer ..............................................................................91
3.23.7. PPPoETunnel ............................................................................92
3.23.8. VLAN .....................................................................................93
3.24. IPRule ................................................................................................95
3.25. IPSecAlgorithms ..................................................................................97
3.26. LDAPServer ........................................................................................98
3.27. LocalUserDatabase ...............................................................................99
3.27.1. User ........................................................................................99
3.28. LogReceiver ...................................................................................... 100
3.28.1. LogReceiverMemory ................................................................ 100
3.28.2. LogReceiverSMTP ................................................................... 100
3.28.3. LogReceiverSyslog .................................................................. 101
3.29. OSPFProcess ..................................................................................... 102
3.29.1. OSPFArea .............................................................................. 103
3.30. Pipe ................................................................................................. 106
3.31. PipeRule ........................................................................................... 109
3.32. PSK ................................................................................................. 110
3.33. RadiusServer ..................................................................................... 111
3.34. RemoteManagement ........................................................................... 112
3.34.1. RemoteMgmtHTTP .................................................................. 112
3.34.2. RemoteMgmtSNMP ................................................................. 112
3.34.3. RemoteMgmtSSH .................................................................... 112
3.35. RoutingRule ...................................................................................... 115
3.36. RoutingTable ..................................................................................... 116
3.36.1. Route ..................................................................................... 116
3.36.2. SwitchRoute ........................................................................... 117
3.37. ScheduleProfile .................................................................................. 118
3.38. Service ............................................................................................. 119
3.38.1. ServiceGroup .......................................................................... 119
3.38.2. ServiceICMP ........................................................................... 119
3.38.3. ServiceIPProto ........................................................................ 120
3.38.4. ServiceTCPUDP ...................................................................... 120
3.39. Settings ............................................................................................ 122
3.39.1. ARPTableSettings .................................................................... 122
3.39.2. ConnTimeoutSettings ............................................................... 122
3.39.3. DHCPRelaySettings ................................................................. 123
3.39.4. DHCPServerSettings ................................................................ 124
3.39.5. FragSettings ............................................................................ 124
3.39.6. ICMPSettings .......................................................................... 125
3.39.7. IPSecTunnelSettings ................................................................. 125
3.39.8. IPSettings ............................................................................... 126
3.39.9. L2TPServerSettings .................................................................. 127
3.39.10. LengthLimSettings ................................................................. 127
3.39.11. LocalMgmtSettings ................................................................. 128
3.39.12. LocalReassSettings ................................................................. 128
vii
CLI Reference Guide
3.39.13. LogSettings ........................................................................... 129
3.39.14. RemoteMgmtSettings .............................................................. 129
3.39.15. RoutingSettings ...................................................................... 130
3.39.16. SSLSettings ........................................................................... 131
3.39.17. StateSettings .......................................................................... 132
3.39.18. TCPSettings .......................................................................... 132
3.39.19. VLANSettings ....................................................................... 134
3.40. SSHClientKey ................................................................................... 135
3.41. ThresholdRule ................................................................................... 136
3.41.1. ThresholdAction ...................................................................... 136
3.42. UpdateCenter ..................................................................................... 138
3.43. UserAuthRule .................................................................................... 139
3.44. WebContentFilteringCategories ............................................................. 141
3.45. ZoneDefenseBlock ............................................................................. 142
3.46. ZoneDefenseExcludeList ..................................................................... 143
3.47. ZoneDefenseSwitch ............................................................................ 144
Index ............................................................................................................... 146
viii
List of Examples
1. Command option notation ................................................................................... x
1.1. Help for commands ......................................................................................... 2
1.2. Help for object types ........................................................................................ 2
1.3. Command line history ...................................................................................... 4
1.4. Tab completion ............................................................................................... 5
1.5. Inline help ..................................................................................................... 5
1.6. Edit an existing property value ........................................................................... 6
1.7. Using categories with tab completion .................................................................. 6
2.1. Create a new object ........................................................................................10
2.2. Change context ..............................................................................................11
2.3. Delete an object .............................................................................................12
2.4. Reject changes ...............................................................................................13
2.5. Set property values .........................................................................................14
2.6. Show objects .................................................................................................16
2.7. Undelete an object ..........................................................................................17
2.8. Block hosts ...................................................................................................21
2.9. frags ............................................................................................................29
2.10. Show a range of rules ....................................................................................40
ix
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}
Ellipsis ...
Used for specifying the available values for an option.
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 is specified.
The following two examples will yield the same result:
gw-world:/> routes -flushl3cache=100
gw-world:/> routes -flushl3cache
x
Notation
Preface
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
xi
Chapter 1. Introduction
• Running a command, page 1
• Help, page 2
• Function keys, page 3
• Command line history, page 4
• Tab completion, page 5
• User roles, page 7
This guide is a reference for all commands and configuration object types that are available in the
command line interface for NetDefendOS.
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.
1
1.2. Help
Chapter 1. Introduction
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.1, “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
2
1.3. Function keys
Chapter 1. Introduction
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.
3
1.4. Command line history
Chapter 1. Introduction
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.2, “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)
4
1.5. Tab completion
Chapter 1. Introduction
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" if 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
("xample_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)
A more detailed help text about Address is displayed.
1.5.2. Autocompleting current value and default value
Another special character that can be used together with tab completion is <. 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
5
1.5.3. Configuration object type categories
Chapter 1. Introduction
useful when editing an existing list of items or a long text value. If no value has been set yet for the
property in question the default value, if one exists, will be used. Some values, such as binary data,
cannot be autocompleted in this way.
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
gw-world:/> set IP4Group examplegroup
gw-world:/> set IP4Group examplegroup
(the value was inserted)
It is now possible to add or remove a
the other members again.
Members=ip1,ip2,ip3,ip5
Members=< (tab)
Members=ip1,ip2,ip3,ip5
member to the list without having to enter all
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 (the default value was inserted)
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:/>
gw-world:/>
gw-world:/>
gw-world:/>
gw-world:/>
show
show
show
show
show
ad (tab)
Adress (the category is autocompleted)
Adress ip4a (tab)
Adress IP4Address (the type is autocompleted)
Adress IP4Address example_ip
Accessing an IP4Address object without the use of categories:
gw-world:/> show IP4Address example_ip
6
1.6. User roles
Chapter 1. Introduction
1.6. User roles
Some commands and options cannot be used unless the logged in user has administrator priviege.
This is indicated in this guide by a note following the command or "Admin only" written next to an
option.
7
1.6. User roles
Chapter 1. Introduction
8
Chapter 2. Command Reference
• Configuration, page 9
• Runtime, page 18
• Utility, page 47
• Misc, page 48
2.1. Configuration
2.1.1. activate
Activate changes.
Description
Activate the latest changes.
This will issue a reconfiguration, using the new configuration. If the reconfiguration is successful a
commit command must be issued within the configured timeout interval in order to save the
changes to media. If not, the system will revert to using the previous version of the configuration.
Usage
activate
Note
Requires Administrator privilege.
2.1.2. add
Create a new object.
Description
Create a new object and add it to the configuration.
Specify the type of object you want to create and the identifier, if the type has one, unless the object
is identified by an index. Set the properties of the object by writing the propertyname equals (=) and
then the value. An optional category can be specified for some object types when using tab completion.
If a mandatory property isn't specified a list of errors will be shown after the object is created. If an
invalid property or value type is specified or if the identifier is missing the command will fail and
not create an object.
Adjustments can be made after the object is created by using the set command.
9
2.1.3. cancel
Chapter 2. Command Reference
Example 2.1. Create a new object
Add objects with an identifier property (not index):
gw-world:/> add Address IP4Address example_ip Address=1.2.3.4
Comments="This is an example"
gw-world:/> add IP4Address example_ip2 Address=2.3.4.5
Add an object with an index:
gw-world:/main> add Route Interface=lan
Add an object without identifier:
gw-world:/> add DynDnsClientDyndnsOrg DNSName=example Username=example
Usage
add [<Category>] <Type> [<Identifier>] [<key-value pair>]...
Options
<Category>
Category that groups object types.
<Identifier>
The property that identifies the configuration object. May not be applicable depending on the specified <Type>.
<key-value pair>
One or more property-value pairs, i.e. <property name>=<value> or
<property name>="<value>".
<Type>
Type of configuration object to perform operation on.
Note
Requires Administrator privilege.
2.1.3. cancel
Cancel ongoing commit.
Description
Cancel commit operation immediately, without waiting for the timeout.
Usage
cancel
Note
Requires Administrator privilege.
10
2.1.4. cc
Chapter 2. Command Reference
2.1.4. cc
Change the current context.
Description
Change the current configuration context.
A context is a group of objects that are dependent on and grouped by a parent object. Many objects
lie in the "root" context and do not have a specific parent. Other objects, e.g. User objects lie in a
sub-context (or child context) of the root - in this case in a LocalUserDatabase. In order to add or
modify users you have to be in the correct context, e.g. a LocalUserDatabase called "exampledb".
Only objects in the current context can be accessed.
Example 2.2. Change context
Change to a sub/child context:
gw-world:/> cc LocalUserDatabase exampledb
gw-world:/exampledb>
Go back to the parent context:
gw-world:/ospf1/area1> cc ..
gw-world:/ospf1> cc ..
gw-world:/>
Go back to the root context:
gw-world:/ospf1/area1> cc
gw-world:/>
or
gw-world:/ospf1/area1> cc /
gw-world:/>
Usage
cc [<Category>] <Type> <Identifier>
Change the current context.
cc -print
Print the current context.
cc
Change to root context (same as "cc /").
Options
-print
Print the current context.
<Category>
Category that groups object types.
<Identifier>
The property that identifies the configuration object. May not be applicable
depending on the specified <Type>.
<Type>
Type of configuration object to perform operation on.
11
2.1.6. commit
Chapter 2. Command Reference
2.1.5. cd
Alias for cc.
2.1.6. commit
Save new configuration to media.
Description
Save the new configuration to media. This command can only be issued after a successful activate
command.
Usage
commit
Note
Requires Administrator privilege.
2.1.7. delete
Delete specified objects.
Description
Delete the specified object, removing it from the configuration.
Add the force flag to delete the object even if it is referenced by other objects or if it is a context that
has child objects that aren't deleted. This may cause objects referring to the specified object or one
of its children to get errors that must be corrected before the configuration can be activated.
See also: undelete
Example 2.3. Delete an object
Delete an unreferenced object:
gw-world:/> delete Address IP4Address example_ip
Delete a referenced object:
(will cause error in examplerule)
gw-world:/> set IPRule examplerule SourceNetwork=examplenet
gw-world:/> delete Address IP4Address examplenet -force
Usage
delete [<Category>] <Type> [<Identifier>] [-force]
12
2.1.8. enter
Chapter 2. Command Reference
Options
-force
Force object to be deleted even if it's used by other objects or has children.
<Category>
Category that groups object types.
<Identifier>
The property that identifies the configuration object. May not be applicable
depending on the specified <Type>.
<Type>
Type of configuration object to perform operation on.
Note
Requires Administrator privilege.
2.1.8. enter
Alias for cc.
2.1.9. reject
Reject changes.
Description
Reject the changes made to the specified object by reverting to the values of the last committed configuration.
All changes made to the object will be lost. If the object is added after the last commit, it will be removed.
To reject the changes in more than one object, use either the -recursive flag to delete a context
and all its children recursively or the -all flag to reject the changes in all objects in the configuration.
See also: activate, commit
Example 2.4. Reject changes
Reject changes in individual objects:
gw-world:/> set Address IP4Address example_ip
Comments="This comment will be rejected"
gw-world:/> reject Address IP4Address example_ip
gw-world:/> add Address IP4Address example_ip2 Address=1.2.3.4
Comments="This whole object will be removed"
gw-world:/> reject Address IP4Address example_ip2
Reject changes recursively:
(will reject changes in the user database and all users)
gw-world:/exampledb> set User user1 Comments="Something"
gw-world:/exampledb> set User user2 Comments="that will be"
gw-world:/exampledb> set User user3 Comments="rejected"
gw-world:/exampledb> cc ..
gw-world:/> reject LocalUserDatabase exampledb -recursive
Reject all changes:
gw-world:/anycontext> reject -all
All changes since the last commit will be rejected:
(example_ip will be removed since it is newly added)
13
2.1.10. set
Chapter 2. Command Reference
gw-world:/> add IP4Address example_ip Address=1.2.3.4
gw-world:/> delete IP4Address example_ip
gw-world:/> reject IP4Address example_ip
Usage
reject [<Category>] <Type> [<Identifier>] [-recursive]
Reject changes made to the specified object.
reject -all
Reject all changes in the configuration.
Options
-all
Reject all changes in the configuration.
-recursive
Recursively reject changes.
<Category>
Category that groups object types.
<Identifier>
The property that identifies the configuration object. May not be applicable
depending on the specified <Type>.
<Type>
Type of configuration object to perform operation on.
Note
Requires Administrator privilege.
2.1.10. set
Set property values.
Description
Set property values of configuration objects.
Specify the type of object you want to modify and the identifier, if the type has one. Set the properties of the object by writing the propertyname equals (=) and then the value. An optional category
can be specified for some object types when using tab completion.
If a mandatory property hasn't been specified or if a property has an error a list of errors will be
shown after the specified properties have been set. If an invalid property or value type is specified
the command will fail and not modify the object.
See also: add
Example 2.5. Set property values
14
2.1.11. show
Chapter 2. Command Reference
Set properties for objects that have an identifier property:
gw-world:/> set Address IP4Address example_ip Address=1.2.3.4
Comments="This is an example"
gw-world:/> set IP4Address example_ip2 Address=2.3.4.5
Comments=comment_without_whitespace
gw-world:/main> set Route 1 Comment="A route"
gw-world:/> set IPRule 12 Index=1
Set properties for an object without identifier:
gw-world:/> set DynDnsClientDyndnsOrg Username=example
Usage
set [<Category>] <Type> [<Identifier>] [<key-value pair>]...
Options
<Category>
Category that groups object types.
<Identifier>
The property that identifies the configuration object. May not be applicable depending on the specified <Type>.
<key-value pair>
One or more property-value pairs, i.e. <property name>=<value> or
<property name>="<value>".
<Type>
Type of configuration object to perform operation on.
Note
Requires Administrator privilege.
2.1.11. show
Show objects.
Description
Show objects.
Show the properties of a specified object. There are a number of flags that can be specified to show
otherwise hidden properties. To show a list of object types and categories available in the current
context, just type show. Show a table of all objects of a type by specifying a type or a category. Use
the -errors or -changes flags to show what objects have been changed or have errors in the
configuration.
When showing a table of all objects of a certain type, the status of each object since the last time the
configuration was committed is indicated by a flag. The flags used are:
-
The object is deleted.
!
The object has errors.
+
The object is newly created.
15
2.1.11. show
*
Chapter 2. Command Reference
The object is modified.
Unchanged objects are not indicated by a flag.
When listing categories and object types, categories are indicated by [] and types where objects may
be contexts by /.
Example 2.6. Show objects
Show the properties of an individual object:
gw-world:/> show Address IP4Address example_ip
gw-world:/main> show Route 1
gw-world:/> show Client DynDnsClientDyndnsOrg
Show a table of all objects of a type and a selection of their
properties as well as their status:
gw-world:/> show Address IP4Address
gw-world:/> show IP4Address
Show a table of all objects for each type in a category:
gw-world:/> show Address
Show objects with changes and errors:
gw-world:/> show -changes
gw-world:/> show -errors
Show what objects use (refer to) a certain object:
gw-world:/> show Address IP4Address example_ip -references
Usage
show
Show the types and categories available in the current context.
show [<Category>] [<Type> [<Identifier>]] [-disabled] [-references]
Show an object or list a type or category.
show -errors [-verbose]
Show all errors.
show -changes
Show all changes.
Options
-changes
Show all changes in the current configuration.
-disabled
Show disabled properties.
-errors
Show all errors in the current configuration.
-references
Show all references to this object from other objects.
16
2.1.12. undelete
Chapter 2. Command Reference
-verbose
Show error details.
<Category>
Category that groups object types.
<Identifier>
The property that identifies the configuration object. May not be applicable
depending on the specified <Type>.
<Type>
Type of configuration object to perform operation on.
2.1.12. undelete
Restore previously deleted objects.
Description
Restore a previously deleted object.
This is possible as long as the activate command has not been called.
See also: delete
Example 2.7. Undelete an object
Undelete an unreferenced object:
gw-world:/> delete Address IP4Address example_ip
gw-world:/> undelete Address IP4Address example_ip
Undelete a referenced object:
(will remove the error in examplerule)
gw-world:/> set IPRule examplerule SourceNetwork=examplenet
gw-world:/> delete Address IP4Address examplenet -force
gw-world:/> undelete Address IP4Address examplenet
Usage
undelete [<Category>] <Type> [<Identifier>]
Options
<Category>
Category that groups object types.
<Identifier>
The property that identifies the configuration object. May not be applicable
depending on the specified <Type>.
<Type>
Type of configuration object to perform operation on.
Note
Requires Administrator privilege.
17
2.2. Runtime
Chapter 2. Command Reference
2.2. Runtime
2.2.1. about
Show copyright/build information.
Description
Show copyright and build information.
Usage
about [-verbose]
Options
-verbose
Verbose.
2.2.2. arp
Show ARP entries for given interface.
Description
List the ARP cache entries of specified interfaces.
If no interface is given the ARP cache entries of all interfaces will be presented.
The presented list can be filtered using the ip and hw options.
Usage
arp [-ip=<pattern>] [-hw=<pattern>] [-num=<n>] [-hashinfo] [-flush]
[<Interface>]...
Options
-flush
Flush ARP cache of all specified interfaces.
-hashinfo
Show information on hash table health.
-hw=<pattern>
Show only hardware addresses matching pattern.
-ip=<pattern>
Show only IP addresses matching pattern.
-num=<n>
Show only the first <n> entries per interface. (Default: 20)
18
2.2.3. arpsnoop
Chapter 2. Command Reference
<Interface>
Interface name.
2.2.3. arpsnoop
Toggle snooping and displaying of ARP requests.
Description
Toggle snooping and displaying of ARP queries and responses on-screen.
The snooped messages are displayed before the access section validates the sender IP addresses in
the ARP data.
Usage
arpsnoop
Show snooped interfaces.
arpsnoop -all [-verbose]
Snoop all interfaces.
arpsnoop <interface> [-verbose]
Snoop specified interface.
arpsnoop -disable
Disable all snooping.
Options
-all
Snoop all interfaces.
-disable
Disable all snooping.
-verbose
Verbose.
<interface>
Interface name.
2.2.4. ats
Show active ARP Transaction States.
Description
Show active ARP Transaction States.
Usage
19
2.2.5. avupdate
Chapter 2. Command Reference
ats [-num=<n>]
Options
-num=<n>
Limit list to <n> entries. (Default: 20)
2.2.5. avupdate
Show AV update mechanism status.
Description
Show AV update mechanism status or force an update.
Usage
avupdate [-update]
Options
-update
Force an update now. (Admin only)
2.2.6. bigpond
Show BigPond information.
Description
Show the BigPond information about specified interface.
Usage
bigpond [<interface>]
Options
<interface>
Interface to show BigPond information.
2.2.7. blacklist
20
2.2.7. blacklist
Chapter 2. Command Reference
Blacklist.
Description
Block and unblock hosts on the black and white list.
Note: Static blacklist hosts cannot be unblocked.
If -force is not specified, only the exact host with the service, protocol/port and destiny specified
is unblocked.
Example 2.8. Block hosts
blacklist -show -black -listtime -info
blacklist -block 100.100.100.0/24 -serv=FTP -dest=50.50.50.1 -time=6000
Usage
blacklist -show [-creationtime] [-dynamic] [-listtime] [-info]
[-black] [-white] [-all]
Show information about the blacklisted hosts.
blacklist -block <host> [-serv=<service>] [-prot={TCP | UDP | ICMP
| OTHER | TCPUDP | ALL}] [-port=<port number>]
[-dest=<ip address>] [-time=<seconds>]
Block specified netobject.
blacklist -unblock <host> [-serv=<service>] [-prot={TCP | UDP |
ICMP | OTHER | TCPUDP | ALL}] [-port=<port number>]
[-dest=<ip address>] [-time=<seconds>] [-force]
Unblock specified netobject.
Options
-all
Show all the information.
-black
Show blacklist hosts only.
-block
Block specified netobject. (Admin only)
-creationtime
Show creation time.
-dest=<ip address>
Destination address to block/unblock (ExceptExtablished flag
is set on).
-dynamic
Show dynamic hosts only.
-force
Unblock all services for the host that matches to options.
-info
Show detailed information.
-listtime
Show time in list (for dynamic hosts).
21
2.2.8. buffers
Chapter 2. Command Reference
-port=<port number>
Number of the port to block/unblock.
-prot={TCP | UDP | ICMP |
OTHER | TCPUDP | ALL}
-serv=<service>
Protocol to block/unblock.
-show
Show information about the blacklisted hosts.
-time=<seconds>
The time that the host will remain blocked.
-unblock
Unblock specified netobject. (Admin only)
-white
Show whitelist hosts only.
<host>
IP address range.
Service to block/unblock.
2.2.8. buffers
List packet buffers or the contents of a buffer.
Description
Lists the 20 most recently freed packet buffers, or in-depth information about a specific buffer.
Usage
buffers
List the 20 most recently freed buffers.
buffers -recent
Decode the most recently freed buffer.
buffers <Num>
Decode buffer number <Num>.
Options
-recent
Decode most recently freed buffer.
<Num>
Decode given buffer number.
2.2.9. cam
CAM table information.
Description
Show information about the CAM table(s) and their entries.
22
2.2.10. certcache
Chapter 2. Command Reference
Usage
cam [-num=<n>] [<Interface>] [-flush]
Options
-flush
Flush CAM table. If interface is specified, only entries using this interface are
flushed. (Admin only)
-num=<n>
Limit list to <n> entries per CAM table. (Default: 20)
<Interface>
Interface.
2.2.10. certcache
Show the contents of the certificate cache.
Description
Show all certificates in the certificate cache.
Usage
certcache
2.2.11. cfglog
Display configuration log.
Description
Display the log of the last configuration read attempt.
Usage
cfglog
2.2.12. connections
List current state-tracked connections.
Description
23
2.2.13. cpuid
Chapter 2. Command Reference
List current state-tracked connections.
Usage
connections -show [-num=<n>] [-verbose] [-srciface=<interface>]
[-destiface=<interface>] [-protocol=<name/num>]
[-srcport=<port>] [-destport=<port>] [-srcip=<ip addr>]
[-destip=<ip addr>]
List connections.
connections
Same as "connections -show".
connections -hashinfo
Show information on hash table health.
connections -close [-all] [-srciface=<interface>]
[-destiface=<interface>] [-protocol=<name/num>]
[-srcport=<port>] [-destport=<port>] [-srcip=<ip addr>]
[-destip=<ip addr>]
Close connections.
Options
-all
Mark all connections.
-close
Close all connections that match the filter expression. (Admin
only)
-destiface=<interface>
Filter on destination interface.
-destip=<ip addr>
Filter on destination IP address.
-destport=<port>
Show only given destination TCP/UDP port.
-hashinfo
Show information on hash table health.
-num=<n>
Limit list to <n> connections. (Default: 20)
-protocol=<name/num>
Show only given IP protocol.
-show
Show connections.
-srciface=<interface>
Filter on source interface.
-srcip=<ip addr>
Filter on source IP address.
-srcport=<port>
Show only given source TCP/UDP port.
-verbose
Verbose (more information).
2.2.13. cpuid
24
2.2.14. crashdump
Chapter 2. Command Reference
Display info about the cpu.
Description
Display the make and model of the machine's CPU.
Usage
cpuid
2.2.14. crashdump
Show the contents of the crash.dmp file.
Description
Show the contents of the crash.dmp file, if it exists.
Usage
crashdump
2.2.15. customlog
Show custom configured log messages.
Description
Show list of custom configured log messages.
Usage
customlog [-num=<num>]
Options
-num=<num>
Maximum number of items to list. (Default: 10)
2.2.16. dhcp
Display information about a DHCP-enabled interface.
25
2.2.17. dhcprelay
Chapter 2. Command Reference
Description
Display information about a DHCP-enabled interface.
Usage
dhcp <interface> [-lease={RENEW | RELEASE}]
Options
-lease={RENEW | RELEASE}
Modify interface's lease.
<interface>
DHCP Interface.
2.2.17. dhcprelay
Show DHCP/BOOTP relayer ruleset.
Description
Display the content of the DHCP/BOOTP relayer ruleset and the current routed DHCP relays.
Display filter filters relays based on interface/ip (example: if1 192.168.*)
Usage
dhcprelay -show [-rules] [-routes] [<display filter>]...
Show DHCP/BOOTP relayer ruleset.
dhcprelay -release <ip address> [-interface=<Interface>]
Terminate relayed session.
Options
-interface=<Interface>
Interface.
-release
Terminate relayed session <[interface:]ip>. (Admin only)
-routes
Show the currently relayed DHCP sessions.
-rules
Show the DHCP/BOOTP relayer ruleset.
-show
Show ruleset.
<display filter>
Display filter, filters relays based on interface/ip.
<ip address>
IP address.
26
2.2.19. dns
Chapter 2. Command Reference
2.2.18. dhcpserver
Show content of the DHCP server ruleset.
Description
Show the content of the DHCP server ruleset and various information about active/inactive leases.
Display filter filters leases based on interface/mac/ip (example: if1 192.168.*)
Usage
dhcpserver -show [-rules] [-leases] [-mappings]
[<display filter>]...
Show DHCP server ruleset.
dhcpserver -release={STATIC | BLACKLIST}
Release static or blacklisted IP.
dhcpserver -releaseip <interface> <ip address>
Release an active IP.
Options
-leases
Show dhcp server leases.
-mappings
Show dhcp server IP->MAC mappings.
-release={STATIC | BLACKLIST}
-releaseip
Release static or blacklisted IP. (Admin only)
-rules
Show dhcp server rules.
-show
Show ruleset.
<display filter>
Display filters for leases based on interface/mac/ip (eg. if1
192.168.*).
<interface>
Interface.
<ip address>
IP address.
Release an active IP. (Admin only)
2.2.19. dns
DNS client and queries.
Description
Show status of the DNS client and manage pending DNS queries.
27
2.2.20. dynroute
Chapter 2. Command Reference
Usage
dns [-query=<domain name>] [-list] [-remove]
Options
-list
List pending DNS queries.
-query=<domain name>
Resolve domain name.
-remove
Remove all pending DNS queries.
2.2.20. dynroute
Show dynamic routing policy.
Description
Show the dynamic routing policy filter ruleset and current exports.
In the "Flags" field of the dynrouting exports, the following letters are used:
o
Route describe the optimal path to the network
u
Route is unexported
Usage
dynroute [-rules] [-exports]
Options
-exports
Show current exports.
-rules
Show dynamic routing, filter ruleset.
2.2.21. frags
Show active fragment reassemblies.
Description
List active fragment reassemblies.
28
2.2.22. ha
Chapter 2. Command Reference
More detailed information can optionally be obtained for specific reassemblies:
NEW
Newest reassembly
ALL
All reassemblies
0..1023
Assembly 'N'
Example 2.9. frags
frags NEW
frags 254
Usage
frags [{NEW | ALL | <reassembly id>}] [-free] [-done] [-num=<n>]
Options
-done
List done (lingering) reassemblies.
-free
List free instead of active.
-num=<n>
List <n> entries. (Default: 20)
{NEW | ALL | <reassembly id>}
Show in-depth info about reassembly <n>. (Default: all)
2.2.22. ha
Show current HA status.
Description
Show current HA status.
Usage
ha [-activate] [-deactivate]
Options
-activate
Go active.
-deactivate
Go inactive.
29
2.2.24. idpupdate
Chapter 2. Command Reference
2.2.23. httpposter
Display HTTPPoster_URLx status.
Description
Display configuration and status of configured HTTPPoster_URLx targets.
Usage
httpposter [-repost] [-display]
Options
-display
Display status.
-repost
Re-post all URLs now. (Admin only)
2.2.24. idpupdate
Show IDP update mechanism status.
Description
Show IDP update mechanism status or force an update.
Usage
idpupdate [-update]
Options
-update
Force an update now. (Admin only)
2.2.25. ifstat
Show interface statistics.
Description
Show list of attached interfaces, or in-depth information about a specific interface.
Usage
30
2.2.26. ikesnoop
Chapter 2. Command Reference
ifstat [<Interface>] [-filter=<expr>] [-pbr=<table name>]
[-num=<n>] [-restart] [-allindepth]
Options
-allindepth
Show in-depth information about all interfaces.
-filter=<expr>
Filter list of interfaces.
-num=<n>
Limit list to <n> lines. (Default: 20)
-pbr=<table name>
Only list members of given PBR table(s).
-restart
Stop and restart the interface. (Admin only)
<Interface>
Name of interface.
2.2.26. ikesnoop
Enable or disable IKE-snooping.
Description
Turn IKE on-screen snooping on/off. Useful for troubleshooting IPsec connections.
Usage
ikesnoop
Show IKE snooping status.
ikesnoop -on [<ip address>] [-verbose]
Enable IKE snooping.
ikesnoop -off
Disable IKE snooping.
Options
-off
Turn IKE snooping off.
-on
Turn IKE snooping on.
-verbose
Enable IKE snooping with verbose output.
<ip address>
IP address to snoop.
31
2.2.28. ipsecglobalstats
Chapter 2. Command Reference
2.2.27. ippool
Show IP pool information.
Description
Show information about the current state of the configured IP pools.
Usage
ippool -release [<ip address>] [-all]
Forcibly free IP assigned to subsystem.
ippool -show [-verbose]
Show IP pool information.
Options
-all
Free all IP addresses.
-release
Forcibly free IP assigned to subsystem. (Admin only)
-show
Show IP pool information.
-verbose
Verbose output.
<ip address>
IP address to free.
2.2.28. ipsecglobalstats
Show global ipsec statistics.
Description
List global IPsec statistics.
Usage
ipsecglobalstats [-verbose]
Options
-verbose
Show all statistics.
32
2.2.30. ipsecstats
Chapter 2. Command Reference
2.2.29. ipseckeepalive
Show status of the IPsec ping keepalives.
Description
Show status of the IPsec ping keepalives.
Usage
ipseckeepalive [-num=<n>]
Options
-num=<n>
Maximum number of entries to display (default: 48).
2.2.30. ipsecstats
Show the SAs in use.
Description
List the currently active IKE and IPsec SAs, optionally only showing SAs matching the pattern given for the argument "tunnel".
Usage
ipsecstats [-ike] [-ipsec] [-u] [-verbose] [-num={ALL | <Integer>}]
[<tunnel>]...
Options
-ike
Show IKE SAs.
-ipsec
Show IPsec SAs.
-num={ALL | <Integer>}
Maximum number of entries to show (default: 40/8).
-u
Show detailed SA statistics information.
-verbose
Show verbose information.
<tunnel>
Only show SAs matching pattern.
2.2.31. killsa
33
2.2.32. license
Chapter 2. Command Reference
Kill all SAs belonging to the given remote SG/peer.
Description
Kill all (IPsec and IKE) SAs associated with a given remote IKE peer IP or optional all SA:s in the
system. IKE delete messages are sent.
Usage
killsa <ip address>
Delete SAs belonging to provided remote SG/peer.
killsa -all
Delete all SAs.
Options
-all
Kill all SAs.
<ip address>
IP address of remote SG/peer.
Note
Requires Administrator privilege.
2.2.32. license
Show contents of the license file.
Description
Show contents of the license file.
Usage
license
2.2.33. linkmon
Display link montitoring stats.
Description
When enabled linkmon will monitor host reachability to detect link/NIC problems. It will ping a list
of hosts and take action (currently only reconfigure) if too many are unreachable.
34
2.2.34. lockdown
Chapter 2. Command Reference
Display statistics by not providing any options.
Usage
linkmon [-on] [-off]
Options
-off
Temporarily disable linkmon. (Admin only)
-on
Reenable linkmon. (Admin only)
2.2.34. lockdown
Enable / disable lockdown.
Description
During local lockdown, only traffic from admin nets to the security gateway itself is allowed.
Everything else is dropped.
Lockdown will not affect traffic that does not actually pass through the ruleset, e.g. traffic allowed
by IPsecBeforeRules, NetconBeforeRules, SNMPBeforeRules, if such settings are enabled.
Note: If local lockdown has been set by the core itself due to licensing / configuration problems, this
command will NOT remove such a lock.
Usage
lockdown
Show lockdown status.
lockdown {ON | OFF}
Enable / disable lockdown.
Options
{ON | OFF}
Enable / disable lockdown.
Note
Requires Administrator privilege.
2.2.35. logout
35
2.2.36. memory
Chapter 2. Command Reference
Logout user.
Description
Logout current user.
Usage
logout
2.2.36. memory
Show memory information.
Description
Show core memory consumption. Also show detailed memory use of some components and lists.
Usage
memory
2.2.37. ospf
Show runtime OSPF information.
Description
Show runtime information about the OSPF router process(es).
Note: -process is only required if there are >1 OSPF router processes.
Usage
ospf -iface [<interface>] [-process=<OSPF router process>]
Show interface information.
ospf -area [-process=<OSPF router process>] [<OSPF area>]...
Show area information.
ospf -neighbor [-process=<OSPF router process>]
[<OSPF neighbor>]...
Show neighbor information.
36
2.2.37. ospf
Chapter 2. Command Reference
ospf -route [{HA | ALT}] [-process=<OSPF router process>]
Show the internal OSPF process routingtable.
ospf -database [-verbose] [-process=<OSPF router process>]
Show the LSA database.
ospf -lsa <lsaID> [-process=<OSPF router process>]
Show details for a specified LSA.
ospf -snoop={ON | OFF} [-process=<OSPF router process>]
Show troubleshooting messages on the console.
ospf -ifacedown <interface> [-process=<OSPF router process>]
Take specified interface offline.
ospf -ifaceup <interface> [-process=<OSPF router process>]
Take specified interface online.
ospf -execute={STOP | START | RESTART}
[-process=<OSPF router process>]
Start/stop/restart OSPF process.
Options
-area
Show area information.
-database
Show the LSA database.
-execute={STOP | START | RESTART}
-iface
Start/stop/restart OSPF process. (Admin only)
-ifacedown
Take specified interface offline. (Admin only)
-ifaceup
Take specified interface online. (Admin only)
-lsa
Show details for a specified LSA <lsaID>.
-neighbor
Show neighbor information.
-process=<OSPF router process>
Required if there are >1 OSPF router processes.
-route
Show the internal OSPF process routingtable.
-snoop={ON | OFF}
Show troubleshooting messages on the console.
-verbose
Increase amount of information to display.
<interface>
OSPF enabled interface.
<interface>
OSPF enabled interface.
<lsaID>
LSA ID.
Show interface information.
37
2.2.38. pipes
Chapter 2. Command Reference
<OSPF area>
OSPF Area.
<OSPF neighbor>
Neighbor.
{HA | ALT}
Show HA routingtable.
2.2.38. pipes
Show pipes information.
Description
Show list of configured pipes / pipe details / pipe users.
Note: The "pipes" command is not executed right away; it is queued until the end of the second,
when pipe values are calculated.
Usage
pipes [-users] [<Pipe>]
Options
-users
List users of a given pipe.
<Pipe>
Show pipe details.
2.2.39. routemon
List the currently monitored interfaces and gateways.
Description
List the currently monitored interfaces and/or gateways.
Usage
routemon
2.2.40. routes
Display routing lists.
Description
38
2.2.41. rules
Chapter 2. Command Reference
Display information about the routing table(s):
-
Contents of a (named) routing table.
-
The list of routing tables, along with a total count of route entries in each table, as well as how
many of the entries are single-host routes.
Note that "core" routes for interface IP addresses are not normally shown. Use the -all switch to
show core routes also.
Use the -switched switch to show only switched routes.
Explanation of Flags field of the routing tables:
O
Learned via OSPF
X
Route is Disabled
M
Route is Monitored
A
Published via Proxy ARP
D
Dynamic (from e.g. DHCP relay, IPsec, L2TP/PPP servers, etc.)
Usage
routes [-all] [-switched] [-flushl3cache] [-num=<n>] [-nonhost]
[-tables] [-lookup=<ip address>] [-verbose]
[<table name>]...
Options
-all
Also show routes for interface addresses.
-flushl3cache
Flush Layer 3 Cache.
-lookup=<ip address>
Lookup the route for the given IP address.
-nonhost
Do not show single-host routes.
-num=<n>
Limit display to <n> entries. (Default: 20)
-switched
Only show switched routes and L3C entries.
-tables
Display list of named (PBR) routing tables.
-verbose
Verbose.
<table name>
Name of routing table.
2.2.41. rules
Show rules lists.
39
2.2.42. sessionmanager
Chapter 2. Command Reference
Description
Show the contents of the various rulesets, i.e. main ruleset, pipe ruleset, etc.
Example 2.10. Show a range of rules
rules -verbose 1-5 7-9
Usage
rules [-ruleset={MAIN | PBR | PIPE | INTRUSION | THRESHOLD}]
[-verbose] [-schedule] [<rules>]...
Options
-ruleset={MAIN | PBR | PIPE |
INTRUSION | THRESHOLD}
-schedule
Ruleset to display. (Default: main)
-verbose
Verbose: show all parameters of the rules.
<rules>
Range of rules to display. (default: all rules).
Filter out rules that are not currently allowed by selected
schedules.
2.2.42. sessionmanager
Session Manager.
Description
Show information about the Session Manager, and list currently active users.
Explanation of Timeout flags for sessions:
D
Session is disabled
S
Session uses a timeout in its subsystem
-
Session does not use timeout
Usage
sessionmanager
Show Session Manager status.
40
2.2.43. shutdown
Chapter 2. Command Reference
sessionmanager -status
Show Session Manager status.
sessionmanager -list [-num=<n>]
List active sessions.
sessionmanager -info <session name> <database>
Show in-depth information about session.
sessionmanager -message <session name> <database> <message text>
Send message to session with console.
sessionmanager -disconnect <session name> <database>
Forcibly terminate session.
Options
-disconnect
Forcibly terminate session. (Admin only)
-info
Show in-depth information about session.
-list
List active sessions.
-message
Send message to session.
-num=<n>
List <n> number of session.
-status
Show Session Manager status.
<database>
Name of user database.
<message text>
Message to send.
<session name>
Name of session.
2.2.43. shutdown
Initiate core shutdown.
Description
Initiate shutdown of the core. The core will normally be restarted by an external script/application.
Usage
shutdown [<seconds>]
41
2.2.44. sshserver
Chapter 2. Command Reference
Options
<seconds>
Seconds until shutdown. (Default: 5)
Note
Requires Administrator privilege.
2.2.44. sshserver
SSH Server.
Description
Show SSH Server status, or start/stop/restart SSH Server.
Usage
sshserver -status [-verbose]
Show server status and list all connected clients.
sshserver -keygen [-b=<bits>] [-t={RSA | DSA}]
Generate SSH Server private keys.
sshserver -start <ssh server>
Start SSH Server.
sshserver -stop <ssh server>
Stop SSH Server.
sshserver -restart <ssh server>
Restart SSH Server.
Options
-b=<bits>
Bitsize. (Default: 1024)
-keygen
Generate SSH Server private keys. This operation may take a long time to
finish, up to several minutes!
-restart
Stop and start the SSH Server.
-start
Start the SSH Server.
-status
Show server status and list all connected clients.
-stop
Stop the SSH Server.
42
2.2.45. stats
Chapter 2. Command Reference
-t={RSA | DSA}
Type, (default: both RSA and DSA keys will be created).
-verbose
Verbose output.
<ssh server>
SSH Server.
Note
Requires Administrator privilege.
2.2.45. stats
Display various general firewall statistics.
Description
Display general information about the firewall, such as uptime, CPU load, resource consumption
and other performance data.
Usage
stats
2.2.46. time
Display current system time.
Description
Display/set the system date and time.
Usage
time
Display current system time.
time -set <date> <time>
Set system local time: <YYYY-MM-DD> <HH:MM:SS>.
time -sync [-force]
Synchronize time with timeserver(s) (specified in settings).
Options
-force
Force synchronization regardless of the MaxAdjust setting.
43
2.2.47. urlcache
Chapter 2. Command Reference
-set
Set system local time: <YYYY-MM-DD> <HH:MM:SS>.
-sync
Synchronize time with timeserver(s) (specified in settings).
<date>
Date YYYY-MM-DD.
<time>
Time HH:MM:SS.
2.2.47. urlcache
List contents of the URL cache.
Description
List contents of the URL cache. Used for testing during development of HTTPALG.
Usage
urlcache [-verbose] [-count] [-num=<n>] [-server[={STATUS | CONNECT
| DISCONNECT}]]
Options
-count
Only display cache count.
-num=<n>
Limit list to <n> entries. (Default: 20)
-server[={STATUS | CONNECT |
DISCONNECT}]
-verbose
Web Content Filtering Server options. (Default: status)
Verbose.
2.2.48. userauth
Show logged-on users.
Description
Show currently logged-on users and other information. Also allows logged-on users to be forcibly
logged out.
Note: In the user listing -list, only privileges actually used by the policy are displayed.
Usage
userauth -list [-num=<n>]
List all authenticated users.
userauth -privilege
44
2.2.49. vlan
Chapter 2. Command Reference
List all known privileges (usernames and groups).
userauth -user <user ip>
Show all information for user(s) with this IP address.
userauth -remove <user ip> <Interface>
Forcibly log out an authenticated user.
Options
-list
List all authenticated users.
-num=<n>
Limit list of authenticated users. (Default: 20)
-privilege
List all known privileges (usernames and groups).
-remove
Forcibly log out an authenticated user. (Admin only)
-user
Show all information for user(s) with this IP address.
<Interface>
Interface.
<user ip>
IP address for user(s).
2.2.49. vlan
Show information about VLAN.
Description
Show list of attached Virtual LAN Interfaces, or in-depth information about a specified VLAN.
Usage
vlan [-vlan=<vlan>] [-interface=<Interface>]
Options
-interface=<Interface>
List VLANs connected to physical interface <Interface>.
-vlan=<vlan>
VLAN to show information about.
2.2.50. vpnstats
Alias for ipsecstats.
2.2.51. zonedefense
45
2.2.51. zonedefense
Chapter 2. Command Reference
Zonedefense.
Description
Block/unblock IP addresses/net and ethernet addresses.
Usage
zonedefense [-save] [-blockip=<ip address>]
[-blockenet=<ethernet address>] [-eraseip=<ip address>]
[-eraseenet=<ethernet address>] [-status] [-show]
Options
-blockenet=<ethernet address>
Block the specified ethernet address.
-blockip=<ip address>
Block the specified IP address/net.
-eraseenet=<ethernet address>
Unblock the specified ethernet address.
-eraseip=<ip address>
Unblock the specified IP address/net.
-save
Save the current zonedefense state on all switches.
-show
Show the current block database.
-status
Show the current status of the zonedefense state machine.
46
2.3. Utility
Chapter 2. Command Reference
2.3. Utility
2.3.1. ping
Ping host.
Description
Sends one or more ICMP ECHO datagrams to the specified host. All datagrams are sent preloadedstyle (all at once).
The data size -length given is the ICMP data size. 1472 bytes of ICMP data results in a
1500-byte IP datagram (1514 bytes ethernet).
Usage
ping <host> [-recvif=<interface>] [-srcip=<ip address>]
[-pbr=<table>] [-count=<1...10>] [-length=<Integer>]
[-verbose]
Options
-count=<1...10>
Number of packets to send. (Default: 1)
-length=<Integer>
Packet size. (Default: 4)
-pbr=<table>
Route using PBR Table.
-recvif=<interface>
Pass packet through the rule set, simulating that the packet was received by <recvif>.
-srcip=<ip address>
Use this source IP.
-verbose
Verbose (more information).
<host>
Host to ping.
47
2.4. Misc
Chapter 2. Command Reference
2.4. Misc
2.4.1. help
Show help for selected topic.
Description
The help system contains information about commands and configuration object types.
The fastest way to get help is to simply type help followed by the topic that you want help with. A
topic can be for example a command name (e.g. set) or the name of a configuration object type (e.g.
User).
When you don't know the name of what you are looking for you can specify the category of the
wanted topic with the -category option and use tab-completion to display a list of matching topics.
Usage
help
List commands alphabetically.
help <Topic>
Display help about selected topic from any category.
help -category={COMMANDS | TYPES} [<Topic>]
Display help from a specific topic category.
Options
-category={COMMANDS |
TYPES}
<Topic>
Topic category.
Help topic.
2.4.2. history
Dump history to screen.
Description
List recently typed commands that have been stored in the command history.
Usage
history
48
2.4.2. history
Chapter 2. Command Reference
49
Chapter 3. Configuration Reference
• Access, page 51
• Address, page 53
• ALG, page 56
• ARP, page 60
• BlacklistWhiteHost, page 61
• Certificate, page 62
• Client, page 63
• COMPortDevice, page 66
• DateTime, page 67
• Device, page 68
• DHCPRelay, page 69
• DHCPServer, page 70
• DNS, page 72
• Driver, page 73
• DynamicRoutingRule, page 75
• EthernetDevice, page 78
• HighAvailability, page 79
• HTTPPoster, page 80
• IDList, page 81
• IDPFactorySignatureGroups, page 82
• IDPRule, page 84
• IKEAlgorithms, page 86
• Interface, page 87
• IPRule, page 95
• IPSecAlgorithms, page 97
• LDAPServer, page 98
• LocalUserDatabase, page 99
• LogReceiver, page 100
• OSPFProcess, page 102
• Pipe, page 106
• PipeRule, page 109
50
3.1. Access
Chapter 3. Configuration Reference
• PSK, page 110
• RadiusServer, page 111
• RemoteManagement, page 112
• RoutingRule, page 115
• RoutingTable, page 116
• ScheduleProfile, page 118
• Service, page 119
• Settings, page 122
• SSHClientKey, page 135
• ThresholdRule, page 136
• UpdateCenter, page 138
• UserAuthRule, page 139
• WebContentFilteringCategories, page 141
• ZoneDefenseBlock, page 142
• ZoneDefenseExcludeList, page 143
• ZoneDefenseSwitch, page 144
3.1. Access
Description
Use an access rule to allow or block specific source IP addresses on a specific interface.
Properties
Index
The index of the object, starting at 1. (Identifier)
Name
Specifies a symbolic name for the object.
Action
Accept, Expect or Drop. (Default: Drop)
Interface
The interface the packet must arrive on for this rule to be carried out. Exception: the Expect rule.
Network
The IP span that the sender must belong to for this rule to be carried out.
LogEnabled
Enable logging. (Default: No)
LogSeverity
Specifies with what severity log events will be sent to the specified log receivers. (Default: Default)
Comments
Text describing the current object. (Optional)
51
3.1. Access
Chapter 3. Configuration Reference
Note
If no Index is specified when creating an instance of this type, the object will be
placed last in the list and the Index will be equal to the length of the list.
52
3.2. Address
Chapter 3. Configuration Reference
3.2. Address
This is a category that groups the following object types.
3.2.1. EthernetAddress
Description
Use an Ethernet Address item to define a symbolic name for an Ethernet MAC address.
Properties
Name
Specifies a symbolic name for the network object. (Identifier)
Address
Ethernet MAC address, e.g. "12-34-56-78-ab-cd".
UserAuthGroups
Groups and user names that belong to this object. Objects that filter on credentials can only be used as source networks and destinations networks in rules. (Optional)
NoDefinedCredentials
If this property is enabled the object requires user authentication,
but has no credentials (user names or groups) defined. This means
that the object only requires that a user is authenticated, but ignores any kind of group membership. (Default: No)
Comments
Text describing the current object. (Optional)
3.2.2. EthernetAddressGroup
Description
An Ethernet Address Group is used for combining several Ethernet Address objects for simplified
management.
Properties
Name
Specifies a symbolic name for the network object. (Identifier)
Members
Group members.
UserAuthGroups
Groups and user names that belong to this object. Objects that filter on credentials can only be used as source networks and destinations networks in rules. (Optional)
NoDefinedCredentials
If this property is enabled the object requires user authentication,
but has no credentials (user names or groups) defined. This means
that the object only requires that a user is authenticated, but ignores any kind of group membership. (Default: No)
Comments
Text describing the current object. (Optional)
3.2.3. IP4Address
53
3.2.4. IP4Group
Chapter 3. Configuration Reference
Description
Use an IP4 Address item to define a name for a specific IP4 host, network or range.
Properties
Name
Specifies a symbolic name for the network object. (Identifier)
Address
IP address, e.g. "172.16.50.8", "192.168.30.7,192.168.30.11",
"192.168.7.0/24" or "172.16.25.10-172.16.25.50".
UserAuthGroups
Groups and user names that belong to this object. Objects that filter on credentials can only be used as source networks and destinations networks in rules. (Optional)
NoDefinedCredentials
If this property is enabled the object requires user authentication,
but has no credentials (user names or groups) defined. This means
that the object only requires that a user is authenticated, but ignores any kind of group membership. (Default: No)
Comments
Text describing the current object. (Optional)
3.2.4. IP4Group
Description
An IP4 Address Group is used for combining several IP4 Address objects for simplified management.
Properties
Name
Specifies a symbolic name for the network object. (Identifier)
Members
Group members.
UserAuthGroups
Groups and user names that belong to this object. Objects that filter on credentials can only be used as source networks and destinations networks in rules. (Optional)
NoDefinedCredentials
If this property is enabled the object requires user authentication,
but has no credentials (user names or groups) defined. This means
that the object only requires that a user is authenticated, but ignores any kind of group membership. (Default: No)
Comments
Text describing the current object. (Optional)
3.2.5. IP4HAAddress
Description
Use an IP4 HA Address item to define a name for a specific IP4 host, network or range for each
node in a high availability cluster.
54
3.2.5. IP4HAAddress
Chapter 3. Configuration Reference
Properties
Name
Specifies a symbolic name for the network object. (Identifier)
Address
An IP address with one instance for each node in the high availability cluster.
UserAuthGroups
Groups and user names that belong to this object. Objects that filter on credentials can only be used as source networks and destinations networks in rules. (Optional)
NoDefinedCredentials
If this property is enabled the object requires user authentication,
but has no credentials (user names or groups) defined. This means
that the object only requires that a user is authenticated, but ignores any kind of group membership. (Default: No)
Comments
Text describing the current object. (Optional)
55
3.3. ALG
Chapter 3. Configuration Reference
3.3. ALG
This is a category that groups the following object types.
3.3.1. ALG_FTP
Description
Use an FTP Application Layer Gateway to manage FTP traffic through the system.
Properties
Name
Specifies a symbolic name for the ALG. (Identifier)
AllowServerPassive
Allow server to use passive mode (unsafe for server). (Default:
No)
ServerPorts
Server data ports. (Default: 1024-65535)
AllowClientActive
Allow client to use active mode (unsafe for client). (Default: No)
ClientPorts
Client data ports. (Default: 1024-65535)
AllowUnknownCommands
Allow unknown commands. (Default: No)
AllowSITEEXEC
Allow SITE EXEC. (Default: No)
MaxLineLength
Maximum line length in control channel. (Default: 256)
MaxCommandRate
Maximum number of commands per second. (Default: 20)
Allow8BitStrings
Allow 8-bit strings in control channel. (Default: Yes)
Antivirus
Disabled, Audit or Protect. (Default: Disabled)
VerifyContentMimetype
Verify that file extentions correspond to the MIME type.
(Default: No)
MaxDownloadSize
The maximal allowed file size. (Optional)
FailModeBehavior
Standard behaviour on error: Allow or Deny. (Default: Deny)
FileListType
Specifies if the file list contains files to allow or deny. (Default:
Block)
File
List of file types to allow or deny. (Optional)
ScanExclude
List of files to exclude from antivirus scanning. (Optional)
Comments
Text describing the current object. (Optional)
3.3.2. ALG_H323
Description
Use an H.323 Application Layer Gateway to manage H.323 multimedia traffic.
56
3.3.3. ALG_HTTP
Chapter 3. Configuration Reference
Properties
Name
Specifies a symbolic name for the ALG. (Identifier)
AllowTCPDataChannels
Allow TCP data channels (T.120). (Default: Yes)
MaxTCPDataChannels
Maximum number of TCP data channels per call. (Default:
10)
TranslateAddresses
Automatic or Specific. (Default: Automatic)
TranslateLogicalChannelAddresses
MaxGKRegLifeTime
Translate logical channel addresses. (Default: Yes)
Comments
Text describing the current object. (Optional)
Max Gatekeeper Registration Lifetime. (Default: 1800)
3.3.3. ALG_HTTP
Description
Use an HTTP Application Layer Gateway to filter HTTP traffic.
Properties
Name
Specifies a symbolic name for the ALG. (Identifier)
RemoveCookies
Remove cookies. (Default: No)
RemoveScripts
Remove Javascript/VBScript. (Default: No)
RemoveApplets
Remove Java applets. (Default: No)
RemoveActiveX
Remove ActiveX objects (including Flash). (Default: No)
VerifyUTF8URL
Verify that URL's does not contain invalid UTF8 encoding.
(Default: No)
BlackURLDisplayReason
Message to show when there is an attempt to access a blacklisted site. (Optional)
MaxFileSizeToCache
If a file is smaller than this size it will always be cached.
(Optional)
Antivirus
Disabled, Audit or Protect. (Default: Disabled)
VerifyContentMimetype
Verify that file extentions correspond to the MIME type.
(Default: No)
MaxDownloadSize
The maximal allowed file size. (Optional)
FailModeBehavior
Standard behaviour on error: Allow or Deny. (Default: Deny)
FileListType
Specifies if the file list contains files to allow or deny.
(Default: Block)
File
List of file types to allow or deny. (Optional)
57
3.3.4. ALG_SMTP
Chapter 3. Configuration Reference
ScanExclude
List of files to exclude from antivirus scanning. (Optional)
WebContentFilteringMode
Disabled, Audit or Enable. (Default: Disabled)
FilteringCategories
Web content categories to block. (Optional)
AllowFilteringOverride
Allow the user to display a blocked site. (Default: No)
AllowFilteringReclassification
Allow reclassification of sites. (Default: No)
Comments
Text describing the current object. (Optional)
3.3.3.1. ALG_HTTP_URL
Description
Blacklist URLs to deny access to complete sites, to file types by extension, or to URLs with certain
words in them.
Properties
Index
The index of the object, starting at 1. (Identifier)
Action
Whitelist or Blacklist. (Default: Blacklist)
URL
Specifies the URL to blacklist or whitelist.
Comments
Text describing the current object. (Optional)
Note
If no Index is specified when creating an instance of this type, the object will be
placed last in the list and the Index will be equal to the length of the list.
3.3.4. ALG_SMTP
Description
Use an SMTP Application Layer Gateway to manage SMTP traffic through the system.
Properties
Name
Specifies a symbolic name for the ALG. (Identifier)
VerifySenderEmail
Enable to verify sender E-mail address. (Default: No)
MaxEmailPerMinut
Specifies the maximum amount of E-mails per minute.
(Optional)
Antivirus
Disabled, Audit or Protect. (Default: Disabled)
VerifyContentMimetype
Verify that file extentions correspond to the MIME type.
(Default: No)
58
3.3.4. ALG_SMTP
Chapter 3. Configuration Reference
MaxDownloadSize
The maximal allowed file size. (Optional)
FailModeBehavior
Standard behaviour on error: Allow or Deny. (Default: Deny)
FileListType
Specifies if the file list contains files to allow or deny. (Default:
Block)
File
List of file types to allow or deny. (Optional)
ScanExclude
List of files to exclude from antivirus scanning. (Optional)
Comments
Text describing the current object. (Optional)
59
3.4. ARP
Chapter 3. Configuration Reference
3.4. ARP
Description
Use an ARP entry to publish additional IP addresses and/or MAC addresses on a specified interface.
Properties
Index
The index of the object, starting at 1. (Identifier)
Mode
Static, Publish or XPublish. (Default: Publish)
Interface
Indicates the interface to which the ARP entry applies; e.g. the interface the address shall be published on.
IP
The IP address to be published or statically bound to a hardware address.
MACAddress
The hardware address
00:00:00:00:00:00)
Comments
Text describing the current object. (Optional)
associated
with
the
IP
address.
(Default:
Note
If no Index is specified when creating an instance of this type, the object will be
placed last in the list and the Index will be equal to the length of the list.
60
3.5. BlacklistWhiteHost
Chapter 3. Configuration Reference
3.5. BlacklistWhiteHost
Description
Manually configured whitelist hosts are used to prevent from blocking a host/network on either by
default or based on a schedule.
Properties
Index
The index of the object, starting at 1. (Identifier)
Addresses
Specifies the addresses that will be whitelisted.
Service
Specifies the service that will be whitelisted.
Schedule
The schedule when the whitelist should be active. (Optional)
Comments
Text describing the current object. (Optional)
Note
If no Index is specified when creating an instance of this type, the object will be
placed last in the list and the Index will be equal to the length of the list.
61
3.6. Certificate
Chapter 3. Configuration Reference
3.6. Certificate
Description
An X. 509 certificate is used to authenticate a VPN client or gateway when establishing an IPsec
tunnel.
Properties
Name
Specifies a symbolic name for the certificate. (Identifier)
Type
Local, Remote or Request.
CertificateData
Certificate data.
PrivateKey
Private key.
Comments
Text describing the current object. (Optional)
62
3.7. Client
Chapter 3. Configuration Reference
3.7. Client
This is a category that groups the following object types.
3.7.1. DynDnsClientCjbNet
Description
Configure the parameters used to connect to the Cjb.net DynDNS service.
Properties
Username
Username.
Password
The password for the specified username. (Optional)
Comments
Text describing the current object. (Optional)
Note
This object type does not have am identifier and is identified by the name of the type
only. There can only be one instance of this type.
3.7.2. DynDnsClientDyndnsOrg
Description
Configure the parameters used to connect to the dyndns.org DynDNS service.
Properties
DNSName
The DNS name excluding the .dyndns.org suffix.
Username
Username.
Password
The password for the specified username. (Optional)
Comments
Text describing the current object. (Optional)
Note
This object type does not have am identifier and is identified by the name of the type
only. There can only be one instance of this type.
3.7.3. DynDnsClientDynsCx
Description
Configure the parameters used to connect to the dyns.cx DynDNS service.
63
3.7.4. DynDnsClientPeanutHull
Chapter 3. Configuration Reference
Properties
DNSName
The DNS name excluding the .dyns.cx suffix.
Username
Username.
Password
The password for the specified username. (Optional)
Comments
Text describing the current object. (Optional)
Note
This object type does not have am identifier and is identified by the name of the type
only. There can only be one instance of this type.
3.7.4. DynDnsClientPeanutHull
Description
Configure the parameters used to connect to the Peanut Hull DynDNS service.
Properties
Index
The index of the object, starting at 1. (Identifier)
DNSNames
Specifies the DNS names separated by ";".
Username
Username.
Password
The password for the specified username. (Optional)
Comments
Text describing the current object. (Optional)
Note
If no Index is specified when creating an instance of this type, the object will be
placed last in the list and the Index will be equal to the length of the list.
3.7.5. LoginClientBigPond
Description
Configure the parameters used to provide automatic logon to BigPond Internet service.
Properties
Username
Username.
Password
The password for the specified username. (Optional)
64
3.7.6. LoginClientTelia
Comments
Chapter 3. Configuration Reference
Text describing the current object. (Optional)
Note
This object type does not have am identifier and is identified by the name of the type
only. There can only be one instance of this type.
3.7.6. LoginClientTelia
Description
Configure the parameters used to provide automatic logon to Telia Internet service.
Properties
Username
Username.
Password
The password for the specified username. (Optional)
Comments
Text describing the current object. (Optional)
Note
This object type does not have am identifier and is identified by the name of the type
only. There can only be one instance of this type.
65
3.8. COMPortDevice
Chapter 3. Configuration Reference
3.8. COMPortDevice
Description
A serial communication port, that is used for accessing the CLI.
Properties
Port
Port. (Identifier)
BitsPerSecond
Bits per second. (Default: 9600)
DataBits
Data bits. (Default: 8)
Parity
Parity. (Default: None)
StopBits
Stop bits. (Default: 1)
FlowControl
Flow control. (Default: None)
Comments
Text describing the current object. (Optional)
66
3.9. DateTime
Chapter 3. Configuration Reference
3.9. DateTime
Description
Set the date, time and time zone information for this system.
Properties
TimeZone
Specifies the time zone. (Default: GMT)
DSTEnabled
Enable daylight saving time. (Default: Yes)
DSTOffset
Daylight saving time offset in minutes. (Default: 60)
DSTStartMonth
What month daylight saving time starts. (Default: April)
DSTStartDay
What day of month daylight saving time starts. (Default: 1)
DSTEndMonth
What month daylight saving time ends. (Default: October)
DSTEndDay
What day of month daylight saving time ends. (Default: 1)
TimeSyncEnable
Enable time synchronization. (Default: No)
TimeSyncServerType
Type of server for time synchronization, UDPTime or SNTP
(Simple Network Time Protocol). (Default: SNTP)
TimeSyncServer1
DNS hostname or IP Address of Timeserver 1.
TimeSyncServer2
DNS hostname or IP Address of Timeserver 2. (Optional)
TimeSyncServer3
DNS hostname or IP Address of Timeserver 3. (Optional)
TimeSyncInterval
Seconds between each resynchronization. (Default: 86400)
TimeSyncMaxAdjust
Maximum time drift in seconds that a server is allowed to adjust. (Default: 36000)
TimeSyncGroupIntervalSize
Interval according to which server responses will be grouped.
(Default: 10)
Comments
Text describing the current object. (Optional)
Note
This object type does not have am identifier and is identified by the name of the type
only. There can only be one instance of this type.
67
3.10. Device
Chapter 3. Configuration Reference
3.10. Device
Description
Global parameters of this device.
Properties
Name
Name of the device. (Default: Device)
ConfigVersion
Version number of the configuration. (Default: 1)
Comments
Text describing the current object. (Optional)
Note
This object type does not have am identifier and is identified by the name of the type
only. There can only be one instance of this type.
68
3.11. DHCPRelay
Chapter 3. Configuration Reference
3.11. DHCPRelay
Description
Use a DHCP Relay to dynamically alter the routing table according to relayed DHCP leases.
Properties
Name
Specifies a symbolic name for the relay rule. (Identifier)
Action
Ignore, Relay or BootpFwd. (Default: Ignore)
SourceInterface
The source interface of the DHCP packet. (Optional)
TargetDHCPServer
Specifies the IP of the server to send the relayed DHCP packets
to.
IPOfferFilter
Specifies the span of IP addresses that are allowed to be relayed
from the DHCP server. (Default: 1)
AddRoute
Enable dynamic adding of routes as leases are added and removed. (Default: No)
AddRouteLocalIP
The IP Address specified here will automatically be published
on the interfaces where a route is added. (Optional)
AddRouteGatewayIP
The IP used as gateway to reach hosts on this route. (Optional)
RoutingTable
Specifies the routing table the clients host route should be added
to. (Default: main)
MaxRelaysPerInterface
Specifies how many relays are allowed per interface, that means,
how many DHCP clients are allowed to be relayed through each
interface. (Optional)
AgentIP
Define what IP the relay should use as gateway IP when passing
the requests to the DHCP server. (Default: Recv)
AllowNULLOffers
Accept server responses offering IP address "0.0.0.0" (no IP address offered). (Default: No)
ProxyARPAllInterfaces
Always select all interfaces, including new ones, for publishing
routes needed for the relay via Proxy ARP. (Default: No)
ProxyARPInterfaces
Specifies the interface/interfaces on which the security gateway
should publish routes needed for the relay via Proxy ARP.
(Optional)
LogEnabled
Enable logging. (Default: No)
LogSeverity
Specifies with what severity log events will be sent to the specified log receivers. (Default: Default)
Comments
Text describing the current object. (Optional)
69
3.12. DHCPServer
Chapter 3. Configuration Reference
3.12. DHCPServer
Description
A DHCP Server determines a set of IP addresses and host configuration parameters to hand out to
DHCP clients attached to a given interface.
Properties
Name
Specifies a symbolic name for the DHCP Server rule. (Identifier)
Interface
The source interface to listen for DHCP requests on. This can be a single
interface or a group of interfaces.
IPAddressPool
A range, group or network that the DHCP Server will use as IP address
pool to give out DHCP leases from.
Netmask
Netmask sent to the DHCP Client.
DefaultGateway
Specifies what IP should be sent to the client for use as default gateway. If
unspecified or if 0.0.0.0 is specified, the IP given to the client will be sent
as gateway. (Optional)
Domain
Domain name used for DNS resolution. (Optional)
LeaseTime
The time, in seconds, that a DHCP lease should be provided to a host after
this the client have to renew the lease. (Default: 86400)
DNS1
IP of the primary DNS server. (Optional)
DNS2
IP of the secondary DNS server. (Optional)
NBNS1
IP of the primary Windows Internet Name Service (WINS) server that is
used in Microsoft environments which uses the NetBIOS Name Servers
(NBNS) to assign IP addresses to NetBIOS names. (Optional)
NBNS2
IP of the primary Windows Internet Name Service (WINS) server that is
used in Microsoft environments which uses the NetBIOS Name Servers
(NBNS) to assign IP addresses to NetBIOS names. (Optional)
NextServer
IP address of next server in the boot process. (Optional)
LogEnabled
Enable logging. (Default: No)
LogSeverity
Specifies with what severity log events will be sent to the specified log receivers. (Default: Default)
Comments
Text describing the current object. (Optional)
3.12.1. DHCPServerCustomOption
Description
Extend the DHCP Server functionality by adding custom options that will be handed out to the DHCP clients.
70
3.12.1. DHCPServerCustomOption
Chapter 3. Configuration Reference
Properties
Code
The DHCP option code. (Identifier)
Type
What type the option is, i.e. STRING, IP4 and so on. (Default: UINT8)
Param
The parameter sent with the code, this can be one parameter or a comma separated
list. (Optional)
Comments
Text describing the current object. (Optional)
71
3.13. DNS
Chapter 3. Configuration Reference
3.13. DNS
Description
Configure the DNS (Domain Name System) client settings.
Properties
DNSServer1
IP of the primary DNS Server. (Optional)
DNSServer2
IP of the secondary DNS Server. (Optional)
DNSServer3
IP of the tertiary DNS Server. (Optional)
Comments
Text describing the current object. (Optional)
Note
This object type does not have am identifier and is identified by the name of the type
only. There can only be one instance of this type.
72
3.14. Driver
Chapter 3. Configuration Reference
3.14. Driver
This is a category that groups the following object types.
3.14.1. IXP4NPEEthernetDriver
Description
Intel (IXP4xxNPE) Fast Ethernet Adaptor.
Properties
Comments
Text describing the current object. (Optional)
Note
This object type does not have am identifier and is identified by the name of the type
only. There can only be one instance of this type.
3.14.2. MarvellEthernetPCIDriver
Description
Marvell (88E8001,88E8053,88E8062) Fast and Gigabit Ethernet Adaptor.
Properties
Comments
Text describing the current object. (Optional)
Note
This object type does not have am identifier and is identified by the name of the type
only. There can only be one instance of this type.
3.14.3. R8139EthernetPCIDriver
Description
RealTek (8139) Fast Ethernet Adaptor.
Properties
Comments
Text describing the current object. (Optional)
73
3.14.3. R8139EthernetPCIDriver
Chapter 3. Configuration Reference
Note
This object type does not have am identifier and is identified by the name of the type
only. There can only be one instance of this type.
74
3.15. DynamicRoutingRule
Chapter 3. Configuration Reference
3.15. DynamicRoutingRule
Description
A Dynamic Routing Policy rule creates a filter to catch statically configured or OSPF learned routes.
The matched routes can be controlled by the action rules to be either exported to OSPF processes or
to be added to one or more routing tables.
Properties
Index
The index of the object, starting at 1. (Identifier)
Name
Specifies a symbolic name for the rule. (Optional)
From
OSPF or Routing table. (Default: OSPF)
OSPFProcess
Specifies from which OSPF process the route should be imported from into either a routing table or another OSPF process.
RoutingTable
Specifies from which routing table a route should be imported
into the OSPF AS or copied into another routing table.
DestinationInterface
The interface that the policy has to match. (Optional)
DestinationNetworkExactly
Specifies if the route needs to match a specific network exactly. (Optional)
DestinationNetworkIn
Specifies if the route just needs to be within a specific network. (Optional)
NextHop
The next hop (router) on the route that this policy has to
match. (Optional)
MetricRange
Specifies an interval that the metric of the routes needs to be
within. (Optional)
RouterID
Specifies if the policy should filter on router ID. (Optional)
OSPFRouteType
Specifies if the policy should filter on OSPF router type.
(Optional)
OSPFTagRange
Specifies an interval that the tag of the routers need to be
within. (Optional)
LogEnabled
Enable logging. (Default: No)
LogSeverity
Specifies with what severity log events will be sent to the specified log receivers. (Default: Default)
Comments
Text describing the current object. (Optional)
Note
If no Index is specified when creating an instance of this type, the object will be
placed last in the list and the Index will be equal to the length of the list.
75
3.15.2. DynamicRoutingRuleAddRoute
Chapter 3. Configuration Reference
3.15.1. DynamicRoutingRuleExportOSPF
Description
An OSPF action is used to manipulate and export new or changed routes to an OSPF Router Process.
Properties
Index
The index of the object, starting at 1. (Identifier)
ExportToProcess
Specifies to which OSPF Process the route change should be exported.
SetTag
Specifies a tag for this route. This tag can be used in other routers for
filtering. (Optional)
SetRouteType
The external route type. (Optional)
OffsetMetric
Increases the metric of the imported route by this value. (Optional)
LimitMetricRange
Limits the metrics for these routes to a minimum and maximum value, if
a route has a higher or lower value then specified it will be set to the
specified value. (Optional)
SetForward
IP to route over. (Optional)
Comments
Text describing the current object. (Optional)
Note
If no Index is specified when creating an instance of this type, the object will be
placed last in the list and the Index will be equal to the length of the list.
3.15.2. DynamicRoutingRuleAddRoute
Description
A routing action is used to manipulate and insert new or changed routes to one or more local routing
tables.
Properties
Index
The index of the object, starting at 1. (Identifier)
Destination
Specifies to which routing table the route changes to the OSPF
Process should be exported.
OverrideStatic
Allow override of static routes. (Default: No)
OverwriteDefault
Allow overwrite of default route. (Default: No)
OffsetMetric
Increases the metric by this value. (Optional)
OffsetMetricType2
Increases the for Type2 routers metric by this value. (Optional)
76
3.15.2. DynamicRoutingRuleAddRoute
Chapter 3. Configuration Reference
LimitMetricRange
Limits the metrics for these routes to a minimum and maximum
value, if a route has a higher or lower value then specified it will
be set to the specified value. (Optional)
ProxyARPAllInterfaces
Always select all interfaces, including new ones, for publishing
routes via Proxy ARP. (Default: No)
ProxyARPInterfaces
Specifies the interfaces on which the security gateway should
publish routes via Proxy ARP. (Optional)
Comments
Text describing the current object. (Optional)
Note
If no Index is specified when creating an instance of this type, the object will be
placed last in the list and the Index will be equal to the length of the list.
77
3.16. EthernetDevice
Chapter 3. Configuration Reference
3.16. EthernetDevice
Description
Hardware settings for an Ethernet interface.
Properties
Name
Specifies a symbolic name for the device. (Identifier)
EthernetDriver
The Ethernet PCI driver that should be used by the interface.
PCIBus
PCI bus number where the Ethernet adapter is installed.
PCISlot
PCI slot number used by the Ethernet adapter.
PCIPort
Some Ethernet adapters have multiple ports that share the same bus and
slot number. This parameter specifies what port to be used.
Media
Specifies if the link speed should be auto-negotiated or locked to a static
speed. (Default: Auto)
Duplex
Specifies if the duplex should be auto-negotiated or locked to full or half
duplex. (Default: Auto)
MACAddress
The hardware address for the interface. (Optional)
Comments
Text describing the current object. (Optional)
78
3.17. HighAvailability
Chapter 3. Configuration Reference
3.17. HighAvailability
Description
Configure the High Availability cluster parameters for this system.
Properties
Enabled
Enable high availability. (Default: No)
ClusterID
A (locally) unique cluster ID to use in identifying this group of HA security gateways. (Default: 0)
SyncIface
Specifies the interface used for state synchronization.
NodeID
Master or Slave. (Default: Master)
HASyncBufSize
How much sync data, in KB, to buffer while waiting for acknowledgments from the cluster peer. (Default: 1024)
HASyncMaxPktBurst
The maximum number of state sync packets to send in a burst.
(Default: 20)
HAInitialSilence
The time to stay silent on startup or after reconfiguration. (Default: 5)
Note
This object type does not have am identifier and is identified by the name of the type
only. There can only be one instance of this type.
79
3.18. HTTPPoster
Chapter 3. Configuration Reference
3.18. HTTPPoster
Description
Use the HTTP poster for dynamic DNS or automatic logon to services using web-based authentication.
Properties
URL1
The first URL that will be posted when the security gateway is loaded. (Optional)
URL2
The second URL that will be posted when the security gateway is loaded. (Optional)
URL3
The third URL that will be posted when the security gateway is loaded. (Optional)
RepDelay
Delay in seconds until all URLs are refetched. (Default: 1200)
Comments
Text describing the current object. (Optional)
Note
This object type does not have am identifier and is identified by the name of the type
only. There can only be one instance of this type.
80
3.19. IDList
Chapter 3. Configuration Reference
3.19. IDList
Description
An ID list contains IDs, which are used within the authentication process when establishing an IPsec
tunnel.
Properties
Name
Specifies a symbolic name for the ID list. (Identifier)
Comments
Text describing the current object. (Optional)
3.19.1. ID
Description
An ID is used to define parameters that are matched against the subject field in an X.509 certificate
when establishing an IPsec tunnel.
Properties
Name
Specifies a symbolic name for the object. (Identifier)
Type
IP, DNS, E-Mail or Distinguished name.
IP
IP address.
Hostname
Host name.
CommonName
Common name of the owner of the certificate. (Optional)
OrganizationName
Organization name of the owner of the certificate. (Optional)
OrganizationalUnit
Organizational unit of the owner of the certificate. (Optional)
Country
Specifies the country. (Optional)
LocalityName
Locality. (Optional)
EMailAddress
E-mail address. (Optional)
Comments
Text describing the current object. (Optional)
81
3.20. IDPFactorySignatureGroups
Chapter 3. Configuration Reference
3.20. IDPFactorySignatureGroups
Description
View the present Intrusion Detection & Prevention Signature groups.
Properties
Comments
Text describing the current object. (Optional)
Note
Objects of this type cannot be created or modified by the user.
3.20.1. IDPFactorySignatureGroup
Description
Intrusion Detection & Prevention Signature Groups combine several closely-related IDP Signatures.
Properties
Name
Specifies a symbolic name for the object. (Identifier)
Description
A description of the object. (Optional)
Note
Objects of this type cannot be created or modified by the user.
3.20.1.1. IDPFactorySignature
Description
Intrusion Detection & Prevention Signatures are patterns used to identify network traffic.
Properties
Index
The index of the object, starting at 1. (Identifier)
Name
Specifies a symbolic name for the signature.
ID
ID number of the signature. (Optional)
IDPSeverity
Signature severity group. (Default: Attack)
LogMessage
The log message for this signature. (Optional)
82
3.20.2. IDPFactorySignatureGroupWil
dcard
Chapter 3. Configuration Reference
Note
Objects of this type cannot be created or modified by the user.
3.20.2. IDPFactorySignatureGroupWildcard
Description
Intrusion Detection & Prevention Signatures that are grouped based on a wildcard string (containing
'*' and '?'). The wildcard are matched against individual signature names, and also ordinary signature
group names.
Properties
Name
Specifies a symbolic name for the object. (Identifier)
WildcardSelection
Specifies a wildcard string that groups IDP signatures.
Description
A description of the object. (Optional)
Note
Objects of this type cannot be created or modified by the user.
83
3.21. IDPRule
Chapter 3. Configuration Reference
3.21. IDPRule
Description
An IDP Rule defines a filter for matching specific network traffic. When the filter criteria is met, the
IDP Rule Actions are evaluated and possible actions taken.
Properties
Index
The index of the object, starting at 1. (Identifier)
Name
Specifies a symbolic name for the rule. (Optional)
SourceInterface
Specifies the name of the receiving interface to be compared to
the received packet.
SourceNetwork
Specifies the sender span of IP addresses to be compared to the received packet.
DestinationInterface
Specifies the the destination interface to be compared to the received packet.
DestinationNetwork
Specifies the span of IP addresses to be compared to the destination IP of the received packet.
Service
Specifies a service that will be used as a filter parameter when
matching traffic with this rule.
Schedule
By adding a schedule to a rule, the security gateway will only allow that rule to trigger at those designated times. (Optional)
AlwaysInspect
Enable to also inspect dropped packets. (Default: Yes)
Comments
Text describing the current object. (Optional)
Note
If no Index is specified when creating an instance of this type, the object will be
placed last in the list and the Index will be equal to the length of the list.
3.21.1. IDPRuleAction
Description
An IDP Rule Action specifies what signatures to search for in the network traffic, and what action to
take if those signatures are found.
Properties
Index
The index of the object, starting at 1. (Identifier)
Action
Specifies what action to take if the given signature is found.
(Default: Audit)
84
3.21.1. IDPRuleAction
Chapter 3. Configuration Reference
IDPSeverity
Signature severity group. (Default: Attack)
Signatures
Specifies what signature(s) to search for in the network
traffic. (Optional)
ZoneDefense
Activate ZoneDefense. (Default: No)
BlackList
Activate BlackList. (Default: No)
BlackListTimeToBlock
The number of seconds that the dynamic black list should remain. (Optional)
BlackListBlockOnlyService
Only block the service that triggered the blacklisting.
(Default: No)
BlackListIgnoreEstablished
Do not drop existing connection. (Default: No)
LogEnabled
Enable logging. (Default: No)
LogSeverity
Specifies with what severity log events will be sent to the specified log receivers. (Default: Default)
Comments
Text describing the current object. (Optional)
Note
If no Index is specified when creating an instance of this type, the object will be
placed last in the list and the Index will be equal to the length of the list.
85
3.22. IKEAlgorithms
Chapter 3. Configuration Reference
3.22. IKEAlgorithms
Description
Configure algorithms which are used in the IKE phase of an IPsec session.
Properties
Name
Specifies a symbolic name for the object. (Identifier)
NULLEnabled
Enable plaintext. (Default: No)
DESEnabled
Enable DES encryption algorithm. (Default: No)
DES3Enabled
Enable DES3 encryption algorithm. (Default: No)
AESEnabled
Enable AES encryption algorithm. (Default: No)
BlowfishEnabled
Enable Blowfish encryption algorithm. (Default: No)
TwofishEnabled
Enable Twofish encryption algorithm. (Default: No)
CAST128Enabled
Enable CAST128 encryption algorithm. (Default: No)
AESKeySize
Specifies the AES key size in bits. (Default: 128)
BlowfishKeySize
Specifies the Blowfish key size in bits. (Default: 128)
TwofishKeySize
Specifies the Twofish key size in bits. (Default: 128)
MD5Enabled
Enable MD5 integrity algorithm. (Default: No)
SHA1Enabled
Enable SHA1 integrity algorithm. (Default: No)
Comments
Text describing the current object. (Optional)
86
3.23. Interface
Chapter 3. Configuration Reference
3.23. Interface
This is a category that groups the following object types.
3.23.1. DefaultInterface
Description
A special interface used to represent internal mechanisms in the system as well as an abstract "any"
interface.
Properties
Name
Specifies a symbolic name for the interface. (Identifier)
MTU
Specifies the size (in bytes) of the largest packet that can be passed onward.
(Default: 1500)
Comments
Text describing the current object. (Optional)
3.23.2. Ethernet
Description
An Ethernet interface represents a logical endpoint for Ethernet traffic.
Properties
Name
Specifies a symbolic name for the interface. (Identifier)
IP
The IP address of the interface.
Network
The network of the interface.
DefaultGateway
The default gateway of the interface. (Optional)
Broadcast
The broadcast address of the connected network. (Optional)
PrivateIP
The private IP address of this high availability node.
(Optional)
Metric
Specifies the metric for the auto-created route. (Default: 100)
DHCPEnabled
Specifies that DHCP should be enabled on this interface.
(Default: No)
DHCPDNS1
IP of the primary DNS server. (Optional)
DHCPDNS2
IP of the secondary DNS server. (Optional)
EthernetDevice
Hardware settings for the Ethernet interface.
AutoSwitchRoute
Enable transparent mode, which means that a switch route is
added automatically for this interface. (Default: No)
87
3.23.3. InterfaceGroup
Chapter 3. Configuration Reference
AutoInterfaceNetworkRoute
Automatically add a route for this interface using the given
network. (Default: Yes)
AutoDefaultGatewayRoute
Automatically add a default route for this interface using the
given default gateway. (Default: Yes)
MTU
Specifies the size (in bytes) of the largest packet that can be
passed onward. (Default: 1500)
Comments
Text describing the current object. (Optional)
3.23.3. InterfaceGroup
Description
Use an interface group to combine several interfaces for a simplified security policy.
Properties
Name
Specifies a symbolic name for the interface. (Identifier)
Equivalent
Specifies if the interfaces should be considered security equivalent, that means
that if enabled the interface group can be used as a destination interface in rules
where connections might need to be moved between the two interfaces. (Default:
No)
Members
Specifies the interfaces that are included in the interface group.
Comments
Text describing the current object. (Optional)
3.23.4. IPSecTunnel
Description
An IPsec tunnel item is used to define IPsec endpoint and will appear as a logical interface in the
system.
Properties
Name
Specifies a symbolic name for the interface. (Identifier)
LocalNetwork
The network on "this side" of the IPsec tunnel. The IPsec tunnel will be established between this network and the remote
network.
RemoteNetwork
The network connected to the remote gateway. The IPsec tunnel will be established between the local network and this network.
RemoteEndpoint
Specifies the IP address of the remote endpoint. This is the
address the security gateway will establish the IPsec tunnel
to. It also dictates from where inbound IPsec tunnels are allowed. (Optional)
88
3.23.4. IPSecTunnel
Chapter 3. Configuration Reference
IKEAlgorithms
Specifies the IKE Proposal list used with the tunnel.
IPSecAlgorithms
Specifies the IPsec Proposal list used with the tunnel.
IKELifeTimeSeconds
The lifetime of the IKE connection in seconds. Whenever it
expires, a new phase-1 exchange will be performed. (Default:
28800)
IPSecLifeTimeSeconds
The lifetime of the IPsec connection in seconds. Whenever
it's exceeded, a re-key will be initiated, providing new IPsec
encryption and authentication session keys. (Default: 3600)
IPSecLifeTimeKilobytes
The lifetime of the IPsec connection in kilobytes. (Default: 0)
EncapsulationMode
Specifies if the IPsec tunnel should use Tunnel or Transport
mode. (Default: Tunnel)
AuthMethod
Certificate or Pre-shared key. (Default: PSK)
PSK
Selects the Pre-shared key to use with this IPsec Tunnel.
GatewayCertificate
Selects the certificate the security gateway uses to authenticate itself to the other IPsec peer.
RootCertificates
Selects one or more root certificates to use with this IPsec
Tunnel.
IDList
Selects the identification list to use with this IPsec Tunnel. An
identification list is a list of the identities that are allowed to
establish a IPsec tunnel. (Optional)
XAuth
Off, Required for inbound or Pass to peer gateway. (Default:
Off)
XAuthUsername
Specifies the username to pass to the remote gateway vie IKE
XAuth.
XAuthPassword
Specifies the password to pass to the remote gateway vie IKE
XAuth.
DHCPOverIPSec
Allow DHCP over IPsec from single-host clients. (Default:
No)
AddRouteToRemoteNet
Dynamically add route to the remote networks when a tunnel
is established. (Default: No)
PlaintextMTU
Specifies the size in bytes at which to fragment plaintext
packets (rather than fragmenting IPsec). (Default: 1424)
OriginatorIPType
Specifies what IP address to use as source IP in e.g. NAT.
(Default: LocalInterface)
OriginatorIP
Manually specified originator IP address to use as source IP
in e.g. NAT.
IKEMode
Specifies which IKE mode to use: main or aggressive.
(Default: Main)
DHGroup
Specifies the Diffie-Hellman group to use when doing key exchanges in IKE. (Default: 2)
PFS
Specifies whether PFS should be used or not. (Default: None)
PFSDHGroup
Specifies which Diffie-Hellman group to use with PFS.
89
3.23.5. L2TPClient
Chapter 3. Configuration Reference
(Default: 2)
SetupSAPer
Setup security association per network, host or port. (Default:
Net)
DontVerifyPadding
Do not verify the padding added to the packets. (Default: No)
NATTraversal
Enable or disable NAT traversal. (Default: OnIfNeeded)
KeepAlive
Disabled, Auto or Manual. (Default: Disabled)
KeepAliveSourceIP
Source IP address used when sending keep-alive ICMP pings.
KeepAliveDestinationIP
Destination IP address used when sending keep-alive ICMP
pings.
Metric
Specifies the metric for the auto-created route. (Default: 90)
AutoInterfaceNetworkRoute
Automatically add a route for this interface using the given
remote network. (Default: Yes)
MTU
Specifies the size (in bytes) of the largest packet that can be
passed onward. (Default: 1500)
Comments
Text describing the current object. (Optional)
3.23.5. L2TPClient
Description
A PPTP/L2TP client interface is a PPP (Point-to-Point Protocol) tunnel over an existing IP network.
Its IP address and DNS servers are dynamically assigned.
Properties
Name
Specifies a symbolic name for the interface. (Identifier)
IP
The host name to store the assigned IP address in, if this network object exists and have a value other then 0.0.0.0 the
PPTP/L2TP client will try to get that one from the PPTP/
L2TP server as preferred IP. (Optional)
Network
The network from which traffic should be routed into the tunnel.
RemoteEndpoint
The IP address of the L2TP/PPTP server.
TunnelProtocol
Specifies if PPTP or L2TP should be used for this tunnel.
(Default: PPTP)
OriginatorIPType
Specifies what IP address to use as source IP in e.g. NAT.
(Default: LocalInterface)
OriginatorIP
Manually specified originator IP address to use as source IP
in e.g. NAT.
DNS1
IP of the primary DNS server. (Optional)
DNS2
IP of the secondary DNS server. (Optional)
90
3.23.6. L2TPServer
Chapter 3. Configuration Reference
Username
Specifies the username to use for this PPTP/L2TP interface.
Password
The password to use for this PPTP/L2TP interface.
PPPAuthNoAuth
Allow no authentication for this tunnel. (Default: No)
PPPAuthPAP
Use PAP authentication protocol for this tunnel. User name
and password are sent in plaintext. (Default: Yes)
PPPAuthCHAP
Use CHAP authentication protocol for this tunnel. (Default:
Yes)
PPPAuthMSCHAP
Use MS-CHAP authentication protocol for this tunnel.
(Default: Yes)
PPPAuthMSCHAPv2
Use MS-CHAP v2 authentication protocol for this tunnel.
(Default: Yes)
MPPENone
Allow authentication without Microsoft Point-to-Point Encryption (MPPE). (Default: Yes)
MPPERC440
Use an RC4 40 bit MPPE session key with MS-CHAP or MSCHAP v2 authentication protocol. (Default: Yes)
MPPERC456
Use an RC4 56 bit MPPE session key with MS-CHAP or MSCHAP v2 authentication protocol. (Default: Yes)
MPPERC4128
Use an RC4 128 bit MPPE session key with MS-CHAP or
MS-CHAP v2 authentication protocol. (Default: Yes)
DialOnDemand
Enable Dial-on-demand which means that the L2TP/PPTP
tunnel will not be setup until traffic is sent on the interface.
(Default: No)
ActivitySensing
Specifies if the dial-on-demand should trigger on inbound or
outbound traffic or both. (Default: BiDirectional)
IdleTimeout
Idle timeout in seconds for dial-on-demand. (Default: 3600)
Metric
Specifies the metric for the auto-created route. (Default: 90)
AutoInterfaceNetworkRoute
Automatically add a route for this interface using the given
remote network. (Default: Yes)
MTU
Specifies the size (in bytes) of the largest packet that can be
passed onward. (Default: 1500)
Comments
Text describing the current object. (Optional)
3.23.6. L2TPServer
Description
A PPTP/L2TP server interface terminates PPP (Point to Point Protocol) tunnels set up over existing
IP networks.
Properties
Name
Specifies a symbolic name for the interface. (Identifier)
91
3.23.7. PPPoETunnel
Chapter 3. Configuration Reference
IP
The IP address of the PPTP/L2TP server interface.
TunnelProtocol
Specifies if PPTP or L2TP should be used for this tunnel.
(Default: PPTP)
Interface
The interface that the PPTP/L2TP Server should be listening on.
ServerIP
Specifies the IP that the PPTP/L2TP server should listen on, this
can be an IP of a interface, or for example an ARP published IP.
UseUserAuth
Enable the use of user authentication rules on this server.
(Default: Yes)
MPPENone
Allow no authentication for this tunnel. (Default: Yes)
MPPERC440
Use an RC4 40 bit MPPE session key with MS-CHAP or MSCHAP v2 authentication protocol. (Default: Yes)
MPPERC456
Use an RC4 56 bit MPPE session key with MS-CHAP or MSCHAP v2 authentication protocol. (Default: Yes)
MPPERC4128
Use an RC4 128 bit MPPE session key with MS-CHAP or MSCHAP v2 authentication protocol. (Default: Yes)
IPPool
A range, group or network that the PPTP/L2TP server will use as
IP address pool to give out IP addresses to the clients from.
DNS1
IP of the primary DNS server. (Optional)
DNS2
IP of the secondary DNS server. (Optional)
NBNS1
IP of the primary Windows Internet Name Service (WINS) server that is used in Microsoft environments which uses the NetBIOS Name Servers (NBNS) to assign IP addresses to NetBIOS
names. (Optional)
NBNS2
IP of the primary Windows Internet Name Service (WINS) server that is used in Microsoft environments which uses the NetBIOS Name Servers (NBNS) to assign IP addresses to NetBIOS
names. (Optional)
AllowedRoutes
Restricts networks for which routes may automatically be added.
(Default: all-nets)
MTU
Specifies the size (in bytes) of the largest packet that can be
passed onward. (Default: 1500)
ProxyARPAllInterfaces
Always select all interfaces, including new ones, for publishing
routes via Proxy ARP. (Default: No)
ProxyARPInterfaces
Specifies the interfaces on which the security gateway should
publish routes via Proxy ARP. (Optional)
Comments
Text describing the current object. (Optional)
3.23.7. PPPoETunnel
Description
A PPPoE interface is a PPP (point-to-point protocol) tunnel over an existing physical Ethernet interface. Its IP address is dynamically assigned.
92
3.23.8. VLAN
Chapter 3. Configuration Reference
Properties
Name
Specifies a symbolic name for the interface. (Identifier)
EthernetInterface
The physical Ethernet interface that connects to the PPPoE
server network.
IP
The host name to store the assigned IP address in. (Optional)
Network
The network from which traffic should be routed into the tunnel.
DNS1
IP of the primary DNS server. (Optional)
DNS2
IP of the secondary DNS server. (Optional)
Username
Specifies the username to use for this PPPoE tunnel.
Password
The password to use for this PPPoE tunnel.
ServiceName
Specifies the PPPoE server service name used to distinguish
between two or more PPPoE servers attached to the same network. (Optional)
PPPAuthNoAuth
Allow no authentication for this tunnel. (Default: No)
PPPAuthPAP
Use PAP authentication protocol for this tunnel. User name
and password are sent in plaintext. (Default: Yes)
PPPAuthCHAP
Use CHAP authentication protocol for this tunnel. (Default:
Yes)
PPPAuthMSCHAP
Use MS-CHAP authentication protocol for this tunnel.
(Default: Yes)
PPPAuthMSCHAPv2
Use MS-CHAP v2 authentication protocol for this tunnel.
(Default: Yes)
DialOnDemand
Enable Dial-on-demand which means that the PPPoE tunnel
will not be setup until traffic is sent on the interface. (Default:
No)
ActivitySensing
Specifies if the dial-on-demand should trigger on inbound or
outbound traffic or both. (Default: BiDirectional)
IdleTimeout
Idle timeout in seconds for dial-on-demand. (Default: 3600)
Metric
Specifies the metric for the auto-created route. (Default: 90)
AutoInterfaceNetworkRoute
Automatically add a route for this interface using the given
remote network. (Default: Yes)
MTU
Specifies the size (in bytes) of the largest packet that can be
passed onward. (Default: 1500)
Comments
Text describing the current object. (Optional)
3.23.8. VLAN
93
3.23.8. VLAN
Chapter 3. Configuration Reference
Description
Use a VLAN to define a virtual interface compatible with the IEEE 802.1Q Virtual LAN standard.
Properties
Name
Specifies a symbolic name for the interface. (Identifier)
Ethernet
Specifies on which Ethernet interface the virtual LAN is
defined.
VLANID
Specifies the virtual LAN ID used for this virtual LAN interface. Two virtual LANs cannot have the same VLAN ID if
they are defined on the same Ethernet interface. (Default: 0)
IP
Specifies the IP address of the virtual LAN interface, if other
than the IP of the Ethernet interface. (Optional)
Network
Specifies the network address of the virtual LAN interface.
DefaultGateway
The default gateway of the virtual LAN interface. (Optional)
Broadcast
Specifies the broadcast address of the virtual LAN interface.
(Optional)
PrivateIP
The private IP address of this high availability node.
(Optional)
Metric
Specifies the metric for the auto-created route. (Default: 100)
AutoSwitchRoute
Enable transparent mode, which means that a switch route is
added automatically for this virtual LAN interface. (Default:
No)
AutoInterfaceNetworkRoute
Automatically add a route for this virtual LAN interface using
the given network. (Default: Yes)
AutoDefaultGatewayRoute
Automatically add a default route for this virtual LAN interface using the given default gateway. (Default: Yes)
MTU
Specifies the size (in bytes) of the largest packet that can be
passed onward. (Default: 1500)
Comments
Text describing the current object. (Optional)
94
3.24. IPRule
Chapter 3. Configuration Reference
3.24. IPRule
Description
An IP rule specifies what action to perform on network traffic that matches the specified filter criteria.
Properties
Index
The index of the object, starting at 1. (Identifier)
Name
Specifies a symbolic name for the rule. (Optional)
Action
Reject, Drop, FwdFast, Allow, NAT, SAT or SLB_SAT.
SourceInterface
Specifies the name of the receiving interface to be compared to
the received packet.
SourceNetwork
Specifies the sender span of IP addresses to be compared to the received packet.
DestinationInterface
Specifies the the destination interface to be compared to the received packet.
DestinationNetwork
Specifies the span of IP addresses to be compared to the destination IP of the received packet.
Service
Specifies a service that will be used as a filter parameter when
matching traffic with this rule.
Schedule
By adding a schedule to a rule, the security gateway will only allow that rule to trigger at those designated times. (Optional)
NATAction
Specify sender address or Use interface address. (Default: UseInterfaceAddress)
NATSenderAddress
Specifies which sender address will be used.
SATTranslate
Specifies whether to translate source IP or destination IP.
(Default: DestinationIP)
SATTranslateToIP
Translate to this IP address.
SATTranslateToPort
Translate to this port. (Optional)
SATAllToOne
Rewrite all destination IPs to a single IP. (Default: No)
SLBStickiness
Specifies stickiness mode. (Default: None)
SLBIdleTimeOut
New connections that arrive within the idle timeout are assigned
to the same real server as previous connections from that address.
The timeout is refreshed after each new connection. (Default: 30)
SLBMaxSlots
Specifies maximum number of slots for IP and network stickiness.
(Default: 2048)
SLBNetSize
Specifies network size for network stickiness. (Default: 24)
SLBMonitorPing
Enable monitoring using ICMP Ping packets. (Default: No)
95
3.24. IPRule
Chapter 3. Configuration Reference
SLBMonitorTCP
Enable monitoring using TCP packets. (Default: No)
SLBPingUseSharedIP
Use the shared IP of a HA cluster instead of the private IP of the
node. (Default: Yes)
SLBTCPUseSharedIP
Use the shared IP of a HA cluster instead of the private IP of the
node. (Default: Yes)
SLBPingInterval
Ping interval in milliseconds. (Default: 10000)
SLBPingMaxLoss
Ping maximum packet loss. (Default: 5)
SLBTCPInterval
TCP interval in milliseconds. (Default: 10000)
SLBTCPMaxLoss
TCP maximum packet loss. (Default: 5)
SLBTCPPorts
Specifies which ports will be monitored.
SLBDistribution
Specifies the algorithm used for the load distribution tasks.
(Default: RoundRobin)
SLBWindowTime
Specifies the window time used for counting the number of
seconds back in time to summarize the number of new connections for connection-rate algorithm. (Default: 10)
SLBAddresses
The IP addresses of the servers in the server farm.
LogEnabled
Enable logging. (Default: No)
LogSeverity
Specifies with what severity log events will be sent to the specified log receivers. (Default: Default)
Comments
Text describing the current object. (Optional)
Note
If no Index is specified when creating an instance of this type, the object will be
placed last in the list and the Index will be equal to the length of the list.
96
3.25. IPSecAlgorithms
Chapter 3. Configuration Reference
3.25. IPSecAlgorithms
Description
Configure algorithms which are used in the IPsec phase of an IPsec session.
Properties
Name
Specifies a symbolic name for the object. (Identifier)
NULLEnabled
Enable plaintext. (Default: No)
DESEnabled
Enable DES encryption algorithm. (Default: No)
DES3Enabled
Enable DES3 encryption algorithm. (Default: No)
AESEnabled
Enable AES encryption algorithm. (Default: No)
BlowfishEnabled
Enable Blowfish encryption algorithm. (Default: No)
TwofishEnabled
Enable Twofish encryption algorithm. (Default: No)
CAST128Enabled
Enable CAST128 encryption algorithm. (Default: No)
AESKeySize
Specifies the AES key size in bits. (Default: 128)
BlowfishKeySize
Specifies the Blowfish key size in bits. (Default: 128)
TwofishKeySize
Specifies the Twofish key size in bits. (Default: 128)
MD5Enabled
Enable MD5 integrity algorithm. (Default: No)
SHA1Enabled
Enable SHA1 integrity algorithm. (Default: No)
Comments
Text describing the current object. (Optional)
97
3.26. LDAPServer
Chapter 3. Configuration Reference
3.26. LDAPServer
Description
An LDAP server is used as a central repository of certificates and CRLs that the security gateway
can download when necessary.
Properties
Index
The index of the object, starting at 1. (Identifier)
Host
Specifies the IP address or hostname of the LDAP server.
Username
Specifies the username to use when accessing the LDAP server. (Optional)
Password
Specifies the password to use when accessing the LDAP server. (Optional)
Port
Specifies the LDAP service port number. (Default: 389)
Comments
Text describing the current object. (Optional)
Note
If no Index is specified when creating an instance of this type, the object will be
placed last in the list and the Index will be equal to the length of the list.
98
3.27. LocalUserDatabase
Chapter 3. Configuration Reference
3.27. LocalUserDatabase
Description
A local user database contains user accounts used for authentication purposes.
Properties
Name
Specifies a symbolic name for the object. (Identifier)
Comments
Text describing the current object. (Optional)
3.27.1. User
Description
User credentials may be used in User Authentication Rules, which in turn are used in e.g. PPP, IPsec
XAuth, Web Authentication, etc
Properties
Name
Specifies the username to add into the user database. (Identifier)
Password
The password for this user.
Groups
Specifies the user groups that this user is a member of, e.g. Administrators. (Optional)
IPPool
If the user is logging in over PPTP/L2TP it will be assigned this static IP. (Optional)
AutoAddRouteNet
PPTP/L2TP networks behind the user. (Optional)
AutoAddRouteMetric
Metric for the network. (Optional)
SSHKeys
Public keys used to log in via SSH. (Optional)
Comments
Text describing the current object. (Optional)
99
3.28. LogReceiver
Chapter 3. Configuration Reference
3.28. LogReceiver
This is a category that groups the following object types.
3.28.1. LogReceiverMemory
Description
A memory log receiver is used to receive and keep log events in system RAM.
Properties
Name
Specifies a symbolic name for the log receiver. (Identifier)
LogSeverity
Specifies with what severity log events will be sent to the specified log receivers. (Optional; Default: Emergency,Alert,Critical,Error,Warning,Notice,Info)
Comments
Text describing the current object. (Optional)
3.28.2. LogReceiverSMTP
Description
An SMTP event receiver is used for receiving e-mails for IDP events.
Properties
Name
Specifies a symbolic name for the log receiver. (Identifier)
IPAddress
The IP address of the SMTP server.
Port
Specifies the which port to use to connect to the SMTP server. (Default:
25)
Receiver1
The E-mail address that the event information is sent to.
Receiver2
Alternate e-mail receiver. (Optional)
Receiver3
Alternate e-mail receiver. (Optional)
Sender
Specifies which sender the E-mail will have. (Default: hostmaster)
Identity
Specifies which identity to write in the E-mail header. (Default: hostmaster)
XMailer
Specifies the X-mailer information to write in the E-mail header.
(Optional)
Subject
The subject of the E-mail. (Default: "Log event from D-Link DFL Firewall")
HoldTime
The hold time in seconds during which the log threshold must be reached
for an E-mail to be sent. (Default: 120)
100
3.28.3. LogReceiverSyslog
Chapter 3. Configuration Reference
MinRepeatDelay
The amount of seconds the security gateway will wait before sending another E-mail. (Default: 600)
LogThreshold
The number of events that have to occur within the hold time for an E-mail
to be sent. (Default: 2)
Comments
Text describing the current object. (Optional)
3.28.3. LogReceiverSyslog
Description
A Syslog receiver is used to receive log events from the system in the standard Syslog format.
Properties
Name
Specifies a symbolic name for the log receiver. (Identifier)
IPAddress
Specifies the IP address of the log receiver.
Port
Specifies the port number of the log service. (Default: 514)
Facility
Specifies what facility is used when logging. (Default: local0)
LogSeverity
Specifies with what severity log events will be sent to the specified log receivers. (Optional; Default: Emergency,Alert,Critical,Error,Warning,Notice,Info)
Comments
Text describing the current object. (Optional)
3.28.3.1. LogReceiverMessageException
Description
A log message exception is used to override the severity filter in the log receiver.
Properties
LogID
The ID number of the log message. (Identifier)
LogType
EXCLUDE or INCLUDE. (Default: EXCLUDE)
LogSeverity
Specifies with what severity log events will be sent to the specified log receivers. (Default: Default)
Comments
Text describing the current object. (Optional)
101
3.29. OSPFProcess
Chapter 3. Configuration Reference
3.29. OSPFProcess
Description
An OSPF Router Process defines a group of routers exchanging routing information via the Open
Shortest Path First routing protocol.
Properties
Name
Specifies a symbolic name for the OSPF process. (Identifier)
RouterID
Specifies the IP address that is used to identify the router. If no router
ID is configured, it will be computed automatically based on the
highest IP address of any interface participating in the OSPF process.
(Optional)
PrivRouterID
The private router ID of this high availability node. (Optional)
RFC1583
Enable this if the security gateway will be used in a environment that
consists of routers that only support RFC 1583. (Default: No)
SPFHoldTime
Specifies the minimum time, in seconds, between two SPF calculations. (Default: 10)
SPFDelayTime
Specifies the delay time, in seconds, between when OSPF receives a
topology change and when it starts a SPF calculation. (Default: 5)
LSAGroupPacing
This specifies the time in seconds at which interval the OSPF LSAs
are collected into a group and refreshed. (Default: 10)
RoutesHoldtime
This specifies the time in seconds that the routing table will be kept
unchanged after a reconfiguration of OSPF entries or a HA failover.
(Default: 45)
RefBandwidthValue
Set the reference bandwidth that is used when calculating the default
interface cost for routes. (Default: 1)
RefBandwidthUnit
Sets the reference bandwidth unit. (Default: Gbps)
MemoryMaxUsage
Maximum amount in kilobytes of RAM that the OSPF process is allowed to use. The default is 1% of installed RAM. Specifying 0 indicates that the OSPF process is allowed to use all available RAM.
(Optional)
DebugPacket
Enables or disabled logging of general packet parsing events and also
specifies the details of the log. (Default: Off)
DebugHello
Enables or disabled logging of hello packets and also specifies the details of the log. (Default: Off)
DebugDDesc
Enables or disabled logging of database description packets and also
specifies the details of the log. (Default: Off)
DebugExchange
Enables or disabled logging of exchange packets and also specifies the
details of the log. (Default: Off)
DebugLSA
Enables or disabled logging of LSA events and also specifies the details of the log. (Default: Off)
DebugSPF
Enables or disabled logging of SPF calculation events and also spe102
3.29.1. OSPFArea
Chapter 3. Configuration Reference
cifies the details of the log. (Default: Off)
DebugRoute
Enables or disabled logging of routing table manipulation events and
also specifies the details of the log. (Default: Off)
AuthType
Specifies the authentication type for the OSPF protocol exchanges.
(Default: Null)
AuthPassphrase
Specifies the passphrase used for authentication. (Optional)
AuthMD5ID
Specifies the MD5 key ID used for MD5 digest authentication.
AuthMD5Key
A 128-bit key used to produce the MD5 digest. (Optional)
LogEnabled
Enable logging. (Default: No)
LogSeverity
Specifies with what severity log events will be sent to the specified log
receivers. (Default: Default)
Comments
Text describing the current object. (Optional)
3.29.1. OSPFArea
Description
An OSPF area is a sub-domain within the OSPF process which collects OSPF interfaces, neighbors,
aggregates and virtual links.
Properties
Name
Specifies a symbolic name for the area. (Identifier)
AreaID
Specifies the area id, if 0.0.0.0 is specified this is the backbone area.
Stub
Enable to make the router automatically advertises a default route so that
routers in the stub area can reach destinations outside the area. (Default:
No)
StubSummarize
Become a default router for stub area (Summarize). (Default: Yes)
StubMetric
Route metric for stub area. (Optional)
FilterExternal
Specifies the network addresses allowed to be imported into this area
from external routing sources. (Optional)
FilterInterArea
Specifies the network addresses allowed to be imported from other
routers inside the area. (Optional)
Comments
Text describing the current object. (Optional)
3.29.1.1. OSPFInterface
Description
Select and define the properties of an interface that should be made a member of the Router Process.
103
3.29.1. OSPFArea
Chapter 3. Configuration Reference
Properties
Interface
Specifies which interface in the security gateway will be used for this OSPF interface. (Identifier)
Type
Auto, Broadcast, Point-to-point or Point-to-multipoint. (Default: Auto)
MetricType
Metric value or Bandwidth. (Default: MetricValue)
Metric
Specifies the routing metric for this OSPF interface.
BandwidthValue
Specifies the bandwidth for this OSPF interface.
BandwidthUnit
Specifies the bandwidth unit. (Default: Mbps)
UseDefaultAuth
Use the authentication configuration specified in the OSPF process.
(Default: Yes)
AuthType
Specifies the authentication type for the OSPF protocol exchanges.
(Default: Null)
AuthPassphrase
Specifies the passphrase used for authentication. (Optional)
AuthMD5ID
Specifies the MD5 key ID used for MD5 digest authentication.
AuthMD5Key
A 128-bit key used to produce the MD5 digest. (Optional)
HelloInterval
Specifies the number of seconds between HELLO packets sent from the
interface. (Default: 10)
RtrDeadInterval
If no HELLO packets are received from a neighbor within this interval (in
seconds), that neighbor router will be declared to be down. (Default: 40)
RxmtInterval
Specifies the number of seconds between retransmissions of LSAs to
neighbors on this interface. (Default: 5)
RtrPrio
Specifies the router priority, a higher number increases this routers
chance of becoming DR or BDR, if 0 is specified this router will not be
eligible in the DR/BDR election. (Default: 1)
InfTransDelay
Specifies the estimated transmit delay for the interface in seconds. This
value represents the maximum time it takes to forward a LSA packet
trough the router. (Default: 1)
WaitInterval
Specifies the number of seconds between the time when the interface
brought up and the election of the DR and BDR. This value should be
higher than the hello interval. (Default: 40)
Passive
Enable to make it possible to include networks into the OSPF routing process, without running OSPF on the interface connected to that network.
(Default: No)
IgnoreMTU
Enable to allow OSPF MTU mismatches. (Default: No)
Comments
Text describing the current object. (Optional)
3.29.1.2. OSPFNeighbor
Description
104
3.29.1. OSPFArea
Chapter 3. Configuration Reference
For point-to-point and point-to-multipoint networks, specify the IP addresses of directly connected
routers.
Properties
Interface
Specifies the OSPF interface of the neighbor. (Identifier)
IPAddress
IP Address of the neighbor.
Metric
Specifies the metric of the neighbor. (Optional)
Comments
Text describing the current object. (Optional)
3.29.1.3. OSPFAggregate
Description
An aggregate is used to replace any number of smaller networks belonging to the local (intra) area
with one contiguous network which may then be advertised or hidden.
Properties
Network
The aggregate network used to combine several small routes. (Identifier)
Advertise
Advertise the aggregate. (Default: Yes)
Comments
Text describing the current object. (Optional)
3.29.1.4. OSPFVLink
Description
An area that does not have a direct connection to the backbone must have at least one area border
router with a virtual link to a backbone router, or to another router with a link to the backbone.
Properties
Name
Specifies a symbolic name for the virtual link. (Identifier)
RouterID
The ID of the router on the other side of the virtual link.
UseDefaultAuth
Use the authentication configuration specified in the OSPF process.
(Default: Yes)
AuthType
Specifies the authentication type for the OSPF protocol exchanges.
(Default: Null)
AuthPassphrase
Specifies the passphrase used for authentication. (Optional)
AuthMD5ID
Specifies the MD5 key ID used for MD5 digest authentication.
AuthMD5Key
A 128-bit key used to produce the MD5 digest. (Optional)
Comments
Text describing the current object. (Optional)
105
3.30. Pipe
Chapter 3. Configuration Reference
3.30. Pipe
Description
A pipe defines basic traffic shaping parameters. The pipe rules then determines which traffic goes
through which pipes.
Properties
Name
Specifies a symbolic name for the pipe. (Identifier)
LimitKbpsTotal
Total bandwidth limit for this pipe in kilobits per second. (Optional)
LimitPPSTotal
Total packet per second limit for this pipe. (Optional)
LimitKbps0
Specifies the bandwidth limit in kbps for precedence 0 (the lowest
precedence). (Optional)
LimitPPS0
Specifies the packet per second limit for precedence 0 (the lowest
precedence). (Optional)
LimitKbps1
Specifies the bandwidth limit in kbps for precedence 1. (Optional)
LimitPPS1
Specifies the packet per second limit for precedence 1. (Optional)
LimitKbps2
Specifies the bandwidth limit in kbps for precedence 2. (Optional)
LimitPPS2
Specifies the packet per second limit for precedence 2. (Optional)
LimitKbps3
Specifies the bandwidth limit in kbps for precedence 3. (Optional)
LimitPPS3
Specifies the packet per second limit for precedence 3. (Optional)
LimitKbps4
Specifies the bandwidth limit in kbps for precedence 4. (Optional)
LimitPPS4
Specifies the packet per second limit for precedence 4. (Optional)
LimitKbps5
Specifies the bandwidth limit in kbps for precedence 5. (Optional)
LimitPPS5
Specifies the packet per second limit for precedence 5. (Optional)
LimitKbps6
Specifies the bandwidth limit in kbps for precedence 6. (Optional)
LimitPPS6
Specifies the packet per second limit for precedence 6. (Optional)
LimitKbps7
Specifies the bandwidth limit in kbps for precedence 7 (the highest
precedence). (Optional)
LimitPPS7
Specifies the packet per second limit for precedence 7 (the highest
precedence). (Optional)
UserLimitKbpsTotal
Total bandwidth limit per group in the pipe in kilobits per second.
(Optional)
UserLimitPPSTotal
Total throughput limit per group in the pipe in packets per second.
(Optional)
UserLimitKbps0
Specifies the bandwidth limit per group in kbps for precedence 0
(the lowest precedence). (Optional)
106
3.30. Pipe
Chapter 3. Configuration Reference
UserLimitPPS0
Specifies the throughput limit per group in PPS for precedence 0
(the lowest precedence). (Optional)
UserLimitKbps1
Specifies the bandwidth limit per group in kbps for precedence 1.
(Optional)
UserLimitPPS1
Specifies the throughput limit per group in PPS for precedence 1.
(Optional)
UserLimitKbps2
Specifies the bandwidth limit per group in kbps for precedence 2.
(Optional)
UserLimitPPS2
Specifies the throughput limit per group in PPS for precedence 2.
(Optional)
UserLimitKbps3
Specifies the bandwidth limit per group in kbps for precedence 3.
(Optional)
UserLimitPPS3
Specifies the throughput limit per group in PPS for precedence 3.
(Optional)
UserLimitKbps4
Specifies the bandwidth limit per group in kbps for precedence 4.
(Optional)
UserLimitPPS4
Specifies the throughput limit per group in PPS for precedence 4.
(Optional)
UserLimitKbps5
Specifies the bandwidth limit per group in kbps for precedence 5.
(Optional)
UserLimitPPS5
Specifies the throughput limit per group in PPS for precedence 5.
(Optional)
UserLimitKbps6
Specifies the bandwidth limit per group in kbps for precedence 6.
(Optional)
UserLimitPPS6
Specifies the throughput limit per group in PPS for precedence 6.
(Optional)
UserLimitKbps7
Specifies the bandwidth limit per group in kbps for precedence 7
(the highest precedence). (Optional)
UserLimitPPS7
Specifies the throughput limit per group in PPS for precedence 7
(the highest precedence). (Optional)
Grouping
Grouping enables per-port/IP/network static bandwidth limits as
well as dynamic balancing between groups. (Default: None)
GroupingNetworkSize
If users are grouped according to source or destination network, the
size of the network has to be specified by this setting. (Default: 0)
Dynamic
Enable dynamic balancing of groups. (Default: No)
PrecedenceMin
Specifies the lowest allowed precedence for traffic in this pipe. If a
packet with a lower precedence enters, its precedence is raised to
this value. (Default: 0)
PrecedenceDefault
Specifies the default precedence for the pipe. If a packet enters this
pipe without a set precedence, it gets assigned this value. Should be
higher than or equal to the minimum precedence. (Default: 0)
PrecedenceMax
Specifies the highest allowed precedence for traffic in this pipe. If a
packet with a higher precedence enters, its precedence is lowered to
this value. Should be higher than or equal to the default precedence.
107
3.30. Pipe
Chapter 3. Configuration Reference
(Default: 7)
Comments
Text describing the current object. (Optional)
108
3.31. PipeRule
Chapter 3. Configuration Reference
3.31. PipeRule
Description
A Pipe Rule determines traffic shaping policy - which Pipes to use - for one or more types of traffic
with the same granularity as the standard ruleset.
Properties
Index
The index of the object, starting at 1. (Identifier)
Name
Specifies a symbolic name for the object. (Optional)
SourceInterface
Specifies the name of the receiving interface to be compared to
the received packet.
SourceNetwork
Specifies the sender span of IP addresses to be compared to the received packet.
DestinationInterface
Specifies the the destination interface to be compared to the received packet.
DestinationNetwork
Specifies the span of IP addresses to be compared to the destination IP of the received packet.
Service
Specifies a service that will be used as a filter parameter when
matching traffic with this rule.
Schedule
By adding a schedule to a rule, the security gateway will only allow that rule to trigger at those designated times. (Optional)
ForwardChain
Specifies one or more pipes to be used for forward traffic.
(Optional)
ReturnChain
Specifies one or more pipes to be used for return traffic.
(Optional)
Precedence
Specifies what precedence should be assigned to the packets before sent into a pipe. (Default: MapIPDSCP)
FixedPrecedence
Specifies the fixed precedence.
Comments
Text describing the current object. (Optional)
Note
If no Index is specified when creating an instance of this type, the object will be
placed last in the list and the Index will be equal to the length of the list.
109
3.32. PSK
Chapter 3. Configuration Reference
3.32. PSK
Description
PSK (Pre-Shared Key) authentication is based on a shared secret that is known only by the parties
involved.
Properties
Name
Specifies a symbolic name for the pre-shared key. (Identifier)
Type
Specifies the type of the shared key.
PSKAscii
Specifies the PSK as a passphrase.
PSKHex
Specifies the PSK as a hexadecimal key.
Comments
Text describing the current object. (Optional)
110
3.33. RadiusServer
Chapter 3. Configuration Reference
3.33. RadiusServer
Description
External RADIUS server used to verify user names and passwords.
Properties
Name
Specifies a symbolic name for the server. (Identifier)
IPAddress
The IP address of the server.
Port
The UDP port of the server. (Default: 1812)
RetryTimeout
The retry timeout, in seconds, used when trying to contact the RADIUS accounting server. If no response has been given after for example 2 seconds,
the security gateway will try again by sending a new AccountingRequest
packet. (Default: 2)
SharedSecret
The shared secret phrase for the Authenticator generation.
Comments
Text describing the current object. (Optional)
111
3.34. RemoteManagement
Chapter 3. Configuration Reference
3.34. RemoteManagement
This is a category that groups the following object types.
3.34.1. RemoteMgmtHTTP
Description
HTTP/HTTPS management.
Properties
Name
Specifies a symbolic name for the object. (Identifier)
AccessLevel
The access level to grant the user that logs in. (Default: Admin)
LocalUserDatabase
Specifies the local user database to use for login.
HTTP
Enable remote management via HTTP. (Default: No)
HTTPS
Enable remote management via HTTPS. (Default: No)
Interface
Specifies the interface for which remote access is granted.
Network
Specifies the network for which remote access is granted.
Comments
Text describing the current object. (Optional)
3.34.2. RemoteMgmtSNMP
Description
SNMP management.
Properties
Name
Specifies a symbolic name for the object. (Identifier)
SNMPGet
Enable monitoring via SNMP. (Default: No)
SNMPGetCommunity
Specifies the name of the community to be granted rights to remotely
monitor the security gateway.
Interface
Specifies the interface for which remote access is granted.
Network
Specifies the network for which remote access is granted.
Comments
Text describing the current object. (Optional)
3.34.3. RemoteMgmtSSH
Description
112
3.34.3. RemoteMgmtSSH
Chapter 3. Configuration Reference
Secure Shell (SSH) Server.
Properties
Name
Specifies a symbolic name for the SSH server. (Identifier)
Port
The listening port for the SSH server. (Default: 22)
AllowAuthMethodPassword
Allow password client authentication. (Default: Yes)
AllowAuthMethodPublicKey
Allow public key client authentication. (Default: Yes)
AllowHostKeyDSA
Allow DSA public key algorithm. (Default: Yes)
AllowHostKeyRSA
Allow RSA public key algorithm. (Default: Yes)
AllowKexDH14
Allow Diffie-Hellman Group 1 key exchange algorithm.
(Default: Yes)
AllowKexDH1
Allow Diffie-Hellman Group 14 key exchange algorithm.
(Default: Yes)
AllowAES128
Allow AES-128 encryption algorithm. (Default: Yes)
AllowAES192
Allow AES-192 encryption algorithm. (Default: Yes)
AllowAES256
Allow AES-256 encryption algorithm. (Default: Yes)
AllowBlowfish
Allow Blowfish encryption algorithm. (Default: Yes)
Allow3DES
Allow 3DES encryption algorithm. (Default: Yes)
AllowMACSHA1
Allow SHA1 integrity algorithm. (Default: Yes)
AllowMACMD5
Allow MD5 integrity algorithm. (Default: Yes)
AllowMACSHA196
Allow SHA1-96 integrity algorithm. (Default: Yes)
AllowMACMD596
Allow MD5-96 integrity algorithm. (Default: Yes)
Banner
Specifies the greeting message to display when the user logs
in. (Optional)
MaxSessions
The maximum number of clients that can be connected at the
same time. (Default: 5)
SessionIdleTime
The number of seconds a user can be idle before the session is
closed. (Default: 1800)
LoginGraceTime
When the user has supplied the username, the password has to
be provided within this number of seconds or the session will
be closed. (Default: 30)
AuthenticationRetries
The number of retires allowed before the session is closed.
(Default: 5)
AccessLevel
The access level to grant the user that logs in. (Default: Admin)
LocalUserDatabase
Specifies the local user database to use for login.
Interface
Specifies the interface for which remote access is granted.
113
3.34.3. RemoteMgmtSSH
Chapter 3. Configuration Reference
Network
Specifies the network for which remote access is granted.
Comments
Text describing the current object. (Optional)
114
3.35. RoutingRule
Chapter 3. Configuration Reference
3.35. RoutingRule
Description
A Routing Rule forces the use of a routing table in the forward and/or return direction of traffic on a
connection. The ordering parameter of the routing table determines if it is consulted before or after
the main routing table.
Properties
Index
The index of the object, starting at 1. (Identifier)
Name
Specifies a symbolic name for the rule. (Optional)
ForwardRoutingTable
The forward routing table will be used for packets from the connection originator to the connection endpoint.
ReturnRoutingTable
The return routing table will be used for packets traveling in the
reverse direction.
SourceInterface
Specifies the name of the receiving interface to be compared to
the received packet.
SourceNetwork
Specifies the sender span of IP addresses to be compared to the received packet.
DestinationInterface
Specifies the the destination interface to be compared to the received packet.
DestinationNetwork
Specifies the span of IP addresses to be compared to the destination IP of the received packet.
Service
Specifies a service that will be used as a filter parameter when
matching traffic with this rule.
Schedule
By adding a schedule to a rule, the security gateway will only allow that rule to trigger at those designated times. (Optional)
LogEnabled
Enable logging. (Default: No)
LogSeverity
Specifies with what severity log events will be sent to the specified log receivers. (Default: Default)
Comments
Text describing the current object. (Optional)
Note
If no Index is specified when creating an instance of this type, the object will be
placed last in the list and the Index will be equal to the length of the list.
115
3.36. RoutingTable
Chapter 3. Configuration Reference
3.36. RoutingTable
Description
The system has a predefined main routing table. Alternate routing tables can be defined by the user.
Properties
Name
Specifies a symbolic name for the routing table. (Identifier)
Ordering
Specifies how a route lookup is done in a named routing table. (Default: Only)
RemoveInterfaceIPRoutes
Removes the interface routes. Makes the security gateway
completely transparent. (Default: No)
Comments
Text describing the current object. (Optional)
3.36.1. Route
Description
A route defines what interface and gateway to use in order to reach a specified network.
Properties
Index
The index of the object, starting at 1. (Identifier)
Name
Specifies a symbolic name for the object. (Optional)
Interface
Specifies which interface packets destined for this route shall
be sent through.
Gateway
Specifies the IP address of the next router hop used to reach
the destination network. If the network is directly connected
to the security gateway interface, no gateway address is specified. (Optional)
LocalIP
The IP address specified here will be automatically published
on the corresponding interface. This address will also be used
as the sender address in ARP queries. If no address is specified, the security gateway's interface IP address will be
used. (Optional)
RouteMonitor
Specifies if this route should be monitored for route changes
for route failover purposes. (Default: No)
MonitorLinkStatus
Mark the route as down if the interface link status changes to
down. (Default: No)
MonitorGateway
Mark the route as down if the next hop does not answer on
ARP lookups during a specified time. (Default: No)
MonitorGatewayManualARP
Enable a manually specified ARP lookup interval. (Default:
No)
116
3.36.2. SwitchRoute
Chapter 3. Configuration Reference
MonitorGatewayARPInterval
Specifies the ARP lookup interval in milliseconds. (Default:
1000)
Network
Specifies the network address for this route.
Metric
Specifies the metric for this route. (Default: 0)
ProxyARPAllInterfaces
Always select all interfaces, including new ones, for publishing routes via Proxy ARP. (Default: No)
ProxyARPInterfaces
Specifies the interfaces on which the security gateway should
publish routes via Proxy ARP. (Optional)
Comments
Text describing the current object. (Optional)
Note
If no Index is specified when creating an instance of this type, the object will be
placed last in the list and the Index will be equal to the length of the list.
3.36.2. SwitchRoute
Description
A switch route defines which interfaces the specified network can be reached on. Proxy ARP
defines between which interfaces ARP is allowed.
Properties
Index
The index of the object, starting at 1. (Identifier)
Name
Specifies a symbolic name for the object. (Optional)
Interface
Specifies which interface packets destined for this route shall be
sent through.
Network
Specifies the network address for this route.
Metric
Specifies the metric for this route. (Default: 0)
ProxyARPAllInterfaces
Always select all interfaces, including new ones, for publishing
routes via Proxy ARP. (Default: No)
ProxyARPInterfaces
Specifies the interfaces on which the security gateway should
publish routes via Proxy ARP. (Optional)
Comments
Text describing the current object. (Optional)
Note
If no Index is specified when creating an instance of this type, the object will be
placed last in the list and the Index will be equal to the length of the list.
117
3.37. ScheduleProfile
Chapter 3. Configuration Reference
3.37. ScheduleProfile
Description
A Schedule Profile defines days and dates and are then used by the various policies in the system.
Properties
Name
Specifies a symbolic name for the schedule profile. (Identifier)
Mon
Specifies during which intervals the schedule profile is active on Mondays.
(Optional)
Tue
Specifies during which intervals the schedule profile is active on Tuesdays.
(Optional)
Wed
Specifies during which intervals the schedule profile is active on Wednesdays.
(Optional)
Thu
Specifies during which intervals the schedule profile is active on Thursdays.
(Optional)
Fri
Specifies during which intervals the schedule profile is active on Fridays.
(Optional)
Sat
Specifies during which intervals the schedule profile is active on Saturdays.
(Optional)
Sun
Specifies during which intervals the schedule profile is active on Sundays.
(Optional)
StartDate
The date after which this Schedule should be active. (Optional)
EndDate
The date after which this Schedule is not active anymore. (Optional)
Comments
Text describing the current object. (Optional)
118
3.38. Service
Chapter 3. Configuration Reference
3.38. Service
This is a category that groups the following object types.
3.38.1. ServiceGroup
Description
A Service Group is a collection of service objects, which can then be used by different policies in
the system.
Properties
Name
Specifies a symbolic name for the service. (Identifier)
Members
Group members.
Comments
Text describing the current object. (Optional)
3.38.2. ServiceICMP
Description
An ICMP Service is an object definition representing ICMP traffic with specific parameters.
Properties
Name
Specifies a symbolic name for the service. (Identifier)
MessageTypes
Specifies the ICMP message types that are applicable to this
service. (Default: All)
EchoRequest
Enable matching of Echo Request messages. (Default: No)
EchoRequestCodes
Specifies which Echo Request message codes should be
matched. (Default: 0-255)
DestinationUnreachable
Enable matching of Destination Unreachable messages.
(Default: No)
DestinationUnreachableCodes
Specifies which Destination Unreachable message codes
should be matched. (Default: 0-255)
Redirect
Enable matching of Redirect messages. (Default: No)
RedirectCodes
Specifies which Redirect message codes should be matched.
(Default: 0-255)
ParameterProblem
Enable matching of Parameter Problem messages. (Default:
No)
ParameterProblemCodes
Specifies which Parameter Problem message codes should be
matched. (Default: 0-255)
119
3.38.3. ServiceIPProto
Chapter 3. Configuration Reference
EchoReply
Enable matching of Echo Reply messages. (Default: No)
EchoReplyCodes
Specifies which Echo Reply message codes should be
matched. (Default: 0-255)
SourceQuenching
Enable matching of Source Quenching messages. (Default:
No)
SourceQuenchingCodes
Specifies which Source Quenching message codes should be
matched. (Default: 0-255)
TimeExceeded
Enable matching of Time Exceeded messages. (Default: No)
TimeExceededCodes
Specifies which Time Exceeded message codes should be
matched. (Default: 0-255)
PassICMPReturn
Enable passing an ICMP error message only if it is related to
an existing connection using this service. (Default: No)
ALG
An Application Layer Gateway (ALG), capable of managing
advanced protocols, can be specified for this service.
(Optional)
MaxSessions
Specifies how many concurrent sessions that are permitted
using this service. (Default: 200)
Comments
Text describing the current object. (Optional)
3.38.3. ServiceIPProto
Description
An IP Protocol Service is a definition of an IP protocol with specific parameters.
Properties
Name
Specifies a symbolic name for the service. (Identifier)
IPProto
IP protocol number or range, e.g. "1-4,7" will match the protocols ICMP,
IGMP, GGP, IP-in-IP and CBT. (Default: 0-255)
PassICMPReturn
Enable passing an ICMP error message only if it is related to an existing
connection using this service. (Default: No)
ALG
An Application Layer Gateway (ALG), capable of managing advanced protocols, can be specified for this service. (Optional)
MaxSessions
Specifies how many concurrent sessions that are permitted using this service. (Default: 200)
Comments
Text describing the current object. (Optional)
3.38.4. ServiceTCPUDP
Description
120
3.38.4. ServiceTCPUDP
Chapter 3. Configuration Reference
A TCP/UDP Service is a definition of an TCP or UDP protocol with specific parameters.
Properties
Name
Specifies a symbolic name for the service. (Identifier)
DestinationPorts
Specifies the destination port or the port ranges applicable to this service.
Type
Specifies whether this service uses the TCP or UDP protocol or both.
(Default: TCP)
SourcePorts
Specifies the source port or the port ranges applicable to this service.
(Default: 0-65535)
SYNRelay
Enable SYN flood protection (SYN Relay). (Default: No)
PassICMPReturn
Enable passing an ICMP error message only if it is related to an existing
connection using this service. (Default: No)
ALG
An Application Layer Gateway (ALG), capable of managing advanced
protocols, can be specified for this service. (Optional)
MaxSessions
Specifies how many concurrent sessions that are permitted using this
service. (Default: 200)
Comments
Text describing the current object. (Optional)
121
3.39. Settings
Chapter 3. Configuration Reference
3.39. Settings
This is a category that groups the following object types.
3.39.1. ARPTableSettings
Description
Advanced ARP-table settings.
Properties
ARPMatchEnetSender
The Ethernet Sender address matching the hardware address in
the ARP data. (Default: DropLog)
ARPQueryNoSenderIP
If the IP source address of an ARP query (NOT response!) is
"0.0.0.0". (Default: DropLog)
ARPSenderIP
The IP Source address in ARP packets. (Default: Validate)
UnsolicitedARPReplies
Unsolicited ARP replies. (Default: DropLog)
ARPRequests
Specifies whether or not the ARP requests should automatically
be added to the ARP table. (Default: Drop)
ARPChanges
ARP packets that would cause an entry to be changed. (Default:
AcceptLog)
StaticARPChanges
ARP packets that would cause static entries to be changed.
(Default: DropLog)
ARPExpire
Lifetime of an ARP entry in seconds. (Default: 900)
ARPExpireUnknown
Lifetime of an "unknown" ARP entry in seconds. (Default: 3)
ARPMulticast
ARP packets claiming to be multicast addresses; may need to be
enabled for some load balancers/redundancy solutions. (Default:
DropLog)
ARPBroadcast
ARP packets claiming to be broadcast addresses; should never
need to be enabled. (Default: DropLog)
ARPCacheSize
Number of ARP entries in cache, total. (Default: 4096)
ARPHashSize
Number of ARP hash buckets per physical interface. (Default:
512)
ARPHashSizeVLAN
Number of ARP hash buckets per VLAN interface. (Default: 64)
Note
This object type does not have am identifier and is identified by the name of the type
only. There can only be one instance of this type.
3.39.2. ConnTimeoutSettings
122
3.39.3. DHCPRelaySettings
Chapter 3. Configuration Reference
Description
Timeout settings for various protocols.
Properties
ConnLife_TCP_SYN
Connection idle lifetime for TCP connections being formed. (Default:
60)
ConnLife_TCP
Connection idle lifetime for TCP. (Default: 262144)
ConnLife_TCP_FIN
Connection idle lifetime for TCP connections being closed. (Default:
80)
ConnLife_UDP
Connection idle lifetime for UDP. (Default: 130)
ConnLife_Ping
Connection timeout for Ping. (Default: 8)
ConnLife_Other
Idle lifetime for other protocols. (Default: 130)
Note
This object type does not have am identifier and is identified by the name of the type
only. There can only be one instance of this type.
3.39.3. DHCPRelaySettings
Description
Advanced DHCP relay settings.
Properties
MaxTransactions
Maximum number of concurrent BOOTP/DHCP transactions.
(Default: 32)
TransactionTimeout
Timeout for each transaction (in seconds). (Default: 10)
MaxPPMPerIface
Maximum packets per minute that are relayed from clients to the
server, per interface. (Default: 500)
MaxHops
Requests/responses that have traversed more than this many relays will not be relayed. (Default: 5)
MaxLeaseTime
Maximum lease time (seconds) allowed from the DHCP server
(too high times will be lowered silently). (Default: 10000)
MaxAutoRoutes
Maximum number of DHCP client IPs automatically added to
the routing table. (Default: 256)
AutoSaveRelayPolicy
Policy for saving the relay list to disk. (Default: ReconfShut)
AutoSaveRelayInterval
Seconds between auto saving the relay list to disk. (Default:
86400)
123
3.39.4. DHCPServerSettings
Chapter 3. Configuration Reference
Note
This object type does not have am identifier and is identified by the name of the type
only. There can only be one instance of this type.
3.39.4. DHCPServerSettings
Description
Advanced DHCP server settings.
Properties
AutoSaveLeasePolicy
Policy for saving the lease database to disk. (Default: ReconfShut)
AutoSaveLeaseInterval
Seconds between auto saving the lease database to disk.
(Default: 86400)
Note
This object type does not have am identifier and is identified by the name of the type
only. There can only be one instance of this type.
3.39.5. FragSettings
Description
Settings related to fragmented packets.
Properties
PseudoReass_MaxConcurrent
Maximum number of concurrent fragment reassemblies. Set
to 0 to drop all fragments. (Default: 1024)
IllegalFrags
Illegaly constructed fragments; partial overlaps, bad sizes,
etc. (Default: DropLog)
DuplicateFragData
On receipt of duplicate fragments, verify matching data...
(Default: Check8)
FragReassemblyFail
Failed packet reassembly attempts - due to timeouts or packet
losses. (Default: LogSuspectSubseq)
DroppedFrags
Fragments of packets dropped due to rule base. (Default:
LogSuspect)
DuplicateFrags
Duplicate fragments received. (Default: LogSuspect)
FragmentedICMP
Fragmented ICMP messages other than Ping; normally invalid. (Default: DropLog)
MinimumFragLength
Minimum allowed length of non-last fragments. (Default: 8)
124
3.39.6. ICMPSettings
Chapter 3. Configuration Reference
ReassTimeout
Timeout of a reassembly, since previous received fragment.
(Default: 65)
ReassTimeLimit
Maximum lifetime of a reassembly, since first received fragment. (Default: 90)
ReassDoneLinger
How long to remember a completed reassembly (watching for
old dups). (Default: 20)
ReassIllegalLinger
How long to remember an illegal reassembly (watching for
more fragments). (Default: 60)
Note
This object type does not have am identifier and is identified by the name of the type
only. There can only be one instance of this type.
3.39.6. ICMPSettings
Description
Settings related to the ICMP protocol.
Properties
ICMPSendPerSecLimit
Maximum number of ICMP responses that will be sent each
second. (Default: 500)
SilentlyDropStateICMPErrors
Silently drop ICMP errors regarding statefully tracked open
connections. (Default: Yes)
Note
This object type does not have am identifier and is identified by the name of the type
only. There can only be one instance of this type.
3.39.7. IPSecTunnelSettings
Description
Settings for the IPsec tunnel interfaces used for establishing IPsec VPN connections to and from this
system.
Properties
IKESendInitialContact
Send 'initial contact' messages. (Default: Yes)
IKESendCRLs
Send CRLs in the IKE exchange. (Default: Yes)
IKECRLValidityTime
Maximum number of seconds a CRL is considered valid
(0=obey the 'next update' field in the CRL). (Default: 86400)
125
3.39.8. IPSettings
Chapter 3. Configuration Reference
IKEMaxCAPath
Maximum number of CA certificates in a certificate path.
(Default: 15)
IPsecCertCacheMaxCerts
Maximum number of entries in the certificate cache. (Default:
1024)
IPsecBeforeRules
Pass IKE & IPsec (ESP/AH) traffic sent to the security gateway directly to the IPsec engine without consulting the ruleset.
(Default: Yes)
IPsecGWNameCacheTime
Amount of time to keep an IPsec tunnel open when the remote
DNS name fails to resolve. (Default: 14400)
Note
This object type does not have am identifier and is identified by the name of the type
only. There can only be one instance of this type.
3.39.8. IPSettings
Description
Settings related to the IP protocol.
Properties
LogCheckSumErrors
Log IP packets with bad checksums. (Default: Yes)
LogNonIP4
Log occurrences of non-IPv4 packets. (Default: Yes)
LogReceivedTTL0
Log received packets with TTL=0; this should never happen!
(Default: Yes)
Block0000Src
Block 0.0.0.0 as source address. (Default: Drop)
Block0Net
Block 0.* source addresses. (Default: DropLog)
Block127Net
Block 127.* source addresses. (Default: DropLog)
BlockMulticastSrc
Block
multicast
source
addresses
(224.0.0.0--255.255.255.255). (Default: DropLog)
TTLMin
The minimum IP Time-To-Live value accepted on receipt.
(Default: 3)
TTLOnLow
What action to take on too low TTL values. (Default:
DropLog)
DefaultTTL
The default IP Time-To-Live of packets originated by the security gateway (32-255). (Default: 255)
LayerSizeConsistency
TCP/UDP/ICMP/etc layer data and header sizes matching
lower layer size information. (Default: ValidateLogBad)
SecuRemoteUDPEncapCompat
Allow IP data to contain eight bytes more than the UDP total
length field specifies -- Checkpoint SecuRemote violates
NAT-T drafts. (Default: No)
126
3.39.9. L2TPServerSettings
Chapter 3. Configuration Reference
IPOptionSizes
Validity of IP header option sizes. (Default: ValidateLogBad)
IPOPT_SR
How to handle IP packets with contained source or return
routes. (Default: DropLog)
IPOPT_TS
How to handle IP packets with contained Timestamps.
(Default: DropLog)
IPOPT_RTRALT
How to handle IP packets with contained route alert. (Default:
ValidateLogBad)
IPOPT_OTHER
How to handle IP options not specified above. (Default:
DropLog)
DirectedBroadcasts
How to handle directed broadcasts being passed from one interface to another. (Default: DropLog)
IPRF
How to handle the IP Reserved Flag, if set; it should never be.
(Default: DropLog)
StripDFOnSmall
Strip the "DontFragment" flag for packets of this size or smaller. (Default: 65535)
Note
This object type does not have am identifier and is identified by the name of the type
only. There can only be one instance of this type.
3.39.9. L2TPServerSettings
Description
PPTP/L2TP server settings.
Properties
L2TPBeforeRules
Pass L2TP connections sent to the security gateway directly to the L2TP
engine without consulting the ruleset. (Default: Yes)
PPTPBeforeRules
Pass PPTP connections sent to the security gateway directly to the PPTP
engine without consulting the ruleset. (Default: Yes)
Note
This object type does not have am identifier and is identified by the name of the type
only. There can only be one instance of this type.
3.39.10. LengthLimSettings
Description
Length limitations for various protocols.
127
3.39.11. LocalMgmtSettings
Chapter 3. Configuration Reference
Properties
MaxTCPLen
TCP; Sometimes has to be increased if tunneling protocols are used.
(Default: 1480)
MaxUDPLen
UDP; Many interactive applications use large UDP packets, may
otherwise be decreased to 1480. (Default: 60000)
MaxICMPLen
ICMP; May be decreased to 1480 if desired. (Default: 10000)
MaxGRELen
Encapsulated (tunneled transport), used by PPTP. (Default: 2000)
MaxESPLen
IPsec ESP; Encrypted communication. (Default: 2000)
MaxAHLen
IPsec AH; Authenticated communication. (Default: 2000)
MaxSKIPLen
SKIP; Simple Key management for IP, VPN protocol. (Default:
2000)
MaxOSPFLen
OSPF; Open Shortest Path First, routing protocol. (Default: 1480)
MaxIPIPLen
IPIP/FWZ; Encapsulated (tunneled) transport, used by VPN-1.
(Default: 2000)
MaxIPCompLen
IPsec IPComp; Compressed communication. (Default: 2000)
MaxL2TPLen
L2TP; Layer 2 Tunneling Protocol. (Default: 2000)
MaxOtherSubIPLen
Others; sometimes has to be increased if unknown tunneling protocols are used. (Default: 1480)
LogOversizedPackets
Log occurrences of oversized packets. (Default: Yes)
Note
This object type does not have am identifier and is identified by the name of the type
only. There can only be one instance of this type.
3.39.11. LocalMgmtSettings
Description
Settings for local console.
Properties
IdleTimeout
Number of seconds of inactivity until the local console user is automatically
logged out. (Default: 900)
Note
This object type does not have am identifier and is identified by the name of the type
only. There can only be one instance of this type.
128
3.39.13. LogSettings
Chapter 3. Configuration Reference
3.39.12. LocalReassSettings
Description
Parameters use for local fragment reassembly.
Properties
LocalReass_MaxConcurrent
Maximum number of concurrent local reassemblies. (Default:
256)
LocalReass_MaxSize
Maximum size of a locally reassembled packet. (Default:
10000)
LocalReass_NumLarge
Number of large (>2K) local reassembly buffers (of the above
size). (Default: 32)
Note
This object type does not have am identifier and is identified by the name of the type
only. There can only be one instance of this type.
3.39.13. LogSettings
Description
Advanced log settings.
Properties
LogSendPerSecLimit
Limits how many log packets the security gateway may send out per
second. (Default: 2000)
UsageLogInterval
Specifies an interval in seconds which states how often information
about open connections and network load is sent to the log receivers.
(Default: 3600)
Note
This object type does not have am identifier and is identified by the name of the type
only. There can only be one instance of this type.
3.39.14. RemoteMgmtSettings
Description
Setup and configure methods and permissions for remote management of this system.
Properties
129
3.39.15. RoutingSettings
Chapter 3. Configuration Reference
NetconBiDirTimeout
Specifies the amount of seconds to wait for the administrator to log
in before reverting to the previous configuration. (Default: 30)
WebUIBeforeRules
Enable HTTP(S) traffic to the security gateway regardless of configured IP Rules. (Default: Yes)
WWWSrv_HTTPPort
Specifies the HTTP port for the web user interface. (Default: 80)
WWWSrv_HTTPSPort
Specifies the HTTP(S) port for the web user interface. (Default: 443)
SSHBeforeRules
Enable SSH traffic to the security gateway regardless of configured
IP Rules. (Default: Yes)
HTTPSCertificate
Specifies which certificate to use for HTTPS traffic. (Optional)
NetconBeforeRules
Enable netcon traffic to the security gateway regardless of configured
IP Rules. (Default: Yes)
SNMPBeforeRules
Enable SNMP traffic to the security gateway regardless of configured
IP Rules. (Default: Yes)
SNMPRequestLimit
Maximum number of SNMP packets that will be processed each
second. (Default: 100)
SNMPSysContact
The contact person for this managed node. (Default: N/A)
SNMPSysName
The name for this managed node. (Default: N/A)
SNMPSysLocation
The physical location of this node. (Default: N/A)
SNMPIfDescription
What to display in the SNMP MIB-II ifDescr variables. (Default:
Name)
SNMPIfAlias
What to display in the SNMP ifMIB ifAlias variables. (Default:
Hardware)
Note
This object type does not have am identifier and is identified by the name of the type
only. There can only be one instance of this type.
3.39.15. RoutingSettings
Description
Configure the routing capabilities of the system.
Properties
RouteFailOver_IfacePollInterval
Time (ms) between polling of interface failure. (Default: 500)
RouteFailOver_ARPPollInterval
Time (ms) between ARP-lookup of gateways. May be overridden for each route. (Default: 1000)
RouteFailOver_PingPollInterval
Time (ms) between PING'ing of gateways. (Default: 1000)
RouteFailOver_GraceTime
Time (s) between startup/reconfigure and monitoring start.
(Default: 30)
130
3.39.16. SSLSettings
Chapter 3. Configuration Reference
RouteFailOver_ConsecFails
Number of consecutive failures before route is marked as unavailable. (Default: 5)
RouteFailOver_ConsecSuccess
Number of consecutive success before route is marked as
available. (Default: 5)
Transp_CAMToL3CDestLearnin
g
Do L3 Cache learning based on destination IPs and MACs in
combination with CAM table contents. (Default: Yes)
Transp_DecrementTTL
Decrement TTL on packets forwarded between transparent
interfaces. (Default: No)
Transp_CAMSize
Maximum number of entries in each CAM table. (Default:
8192)
Transp_L3CSize
Maximum number of entries in each Layer 3 Cache. (Default:
8192)
Note
This object type does not have am identifier and is identified by the name of the type
only. There can only be one instance of this type.
3.39.16. SSLSettings
Description
Settings related to SSL (Secure Sockets Layer).
Properties
SSL_ProcessingPriority
The amount of of CPU time that SSL processing is allowed to
use. (Default: Normal)
TLS_RSA_WITH_3DES_168_S
HA1
Enable cipher RSA_WITH_3DES_168_SHA1. (Default:
Yes)
TLS_RSA_WITH_RC4_128_SH
A1
TLS_RSA_WITH_RC4_128_MD
5
Enable cipher RSA_WITH_RC4_128_SHA1. (Default: Yes)
TLS_RSA_EXPORT1024_WITH
_RC4_56_SHA1
Enable
cipher
TLS_RSA_EXPORT1024_WITH_RC4_56_SHA1. (Default:
Yes)
TLS_RSA_EXPORT512_WITH_
RC4_40_MD5
Enable
cipher
TLS_RSA_EXPORT1024_WITH_RC4_40_MD5. (Default:
No)
TLS_RSA_EXPORT512_WITH_
RC2_40_MD5
Enable
cipher
TLS_RSA_EXPORT1024_WITH_RC2_40_MD5. (Default:
No)
TLS_RSA_EXPORT_WITH_NU
LL_SHA1
Enable cipher TLS_RSA_EXPORT_WITH_NULL_SHA1
(no encryption, just message validation). (Default: No)
Enable cipher TLS_RSA_WITH_RC4_128_MD5. (Default:
Yes)
131
3.39.17. StateSettings
Chapter 3. Configuration Reference
LL_MD5
Enable cipher TLS_RSA_EXPORT_WITH_NULL_MD5 (no
encryption, just message validation). (Default: No)
Note
This object type does not have am identifier and is identified by the name of the type
only. There can only be one instance of this type.
3.39.17. StateSettings
Description
Parameters for the state engine in the system.
Properties
ConnReplace
What to do when the connection table is full. (Default: ReplaceLog)
LogOpenFails
Log packets that are neither part of open connections nor valid new
connections. (Default: Yes)
LogReverseOpens
Log reverse connection attempts through an established connection.
(Default: Yes)
LogStateViolations
Log packets that violate stateful tracking rules; for instance, TCP
connect sequences. (Default: Yes)
LogConnections
Demand that responses arrive on the same interface that the request
was sent from. (Default: Log)
Note
This object type does not have am identifier and is identified by the name of the type
only. There can only be one instance of this type.
3.39.18. TCPSettings
Description
Settings related to the TCP protocol.
Properties
TCPOptionSizes
Validity of TCP header option sizes. (Default: ValidateLogBad)
TCPMSSMin
Minimum allowed TCP MSS (Maximum Segment Size). (Default:
100)
TCPMSSOnLow
How to handle too low MSS values. (Default: DropLog)
TCPMSSMax
Maximum allowed TCP MSS (Maximum Segment Size). (Default:
1460)
132
3.39.18. TCPSettings
Chapter 3. Configuration Reference
TCPMSSVPNMax
Limits TCP MSS for VPN connections; minimizes fragmentation.
(Default: 1400)
TCPMSSOnHigh
How to handle too high MSS values. (Default: Adjust)
TCPMSSLogLevel
When to log regarding too high TCP MSS, if not logged by "TCP
MSS on high". (Default: 7000)
TCPMSSAutoClamping
Automatically clamp TCP MSS according to MTU of involved interfaces - in addition to "TCP MSS max". (Default: Yes)
TCPZeroUnusedACK
Force unused ACK fields to zero; helps prevent connection spoofing.
(Default: Yes)
TCPZeroUnusedURG
Force unused URG fields to zero; prevents small information leak.
(Default: Yes)
TCPOPT_WSOPT
The WSOPT (Window Scale) option (common). (Default: ValidateLogBad)
TCPOPT_SACK
The SACK/SACKPERMIT (Selective ACK) options (common).
(Default: ValidateLogBad)
TCPOPT_TSOPT
The TSOPT (Timestamp) option (common). (Default: ValidateLogBad)
TCPOPT_ALTCHKREQ
The ALTCHKREQ (Alternate Checksum Request) option. (Default:
StripLog)
TCPOPT_ALTCHKDATA
The ALTCHKDATA (Alternate Checksum Data) option. (Default:
StripLog)
TCPOPT_CC
The CC (Connection Count) option series (semi common). (Default:
StripLogBad)
TCPOPT_OTHER
How to handle TCP options not specified above. (Default: StripLog)
TCPSynUrg
The TCP URG flag together with SYN; normally invalid (strip=strip
URG). (Default: DropLog)
TCPSynPsh
The TCP PSH flag together with SYN; normally invalid but always
used by some IP stacks (strip=strip PSH). (Default: StripSilent)
TCPSynRst
The TCP RST flag together with SYN; normally invalid (strip=strip
RST). (Default: DropLog)
TCPSynFin
The TCP FIN flag together with SYN; normally invalid (strip=strip
FIN). (Default: DropLog)
TCPFinUrg
The TCP URG flag together with FIN; normally invalid (strip=strip
URG). (Default: DropLog)
TCPUrg
The TCP URG flag; many operating systems cannot handle this correctly. (Default: StripLog)
TCPECN
The Explicit Congestion Notification (ECN) flags. Previously known
as "XMAS"/"YMAS" flags. Also used in OS fingerprinting. (Default:
StripLog)
TCPRF
The TCP Reserved field: should be zero. Used in OS fingerprinting.
Also part of ECN extension. (Default: StripLog)
TCPNULL
TCP "NULL" packets without SYN, ACK, FIN or RST; normally invalid, used by scanners. (Default: DropLog)
133
3.39.19. VLANSettings
Chapter 3. Configuration Reference
Note
This object type does not have am identifier and is identified by the name of the type
only. There can only be one instance of this type.
3.39.19. VLANSettings
Description
Settings for IEEE 802.1Q based Virtual LAN interfaces.
Properties
UnknownVLANTags
VLAN packets tagged with an unknown ID. (Default: DropLog)
Note
This object type does not have am identifier and is identified by the name of the type
only. There can only be one instance of this type.
134
3.40. SSHClientKey
Chapter 3. Configuration Reference
3.40. SSHClientKey
Description
The public key of the client connecting to the SSH server.
Properties
Name
Specifies a symbolic name for the key. (Identifier)
Type
DSA or RSA. (Default: DSA)
Subject
Value of the Subject header tag of the public key file. (Optional)
PublicKey
Specifies the public key.
Comments
Text describing the current object. (Optional)
135
3.41. ThresholdRule
Chapter 3. Configuration Reference
3.41. ThresholdRule
Description
A Threshold Rule defines a filter for matching specific network traffic. When the filter criteria is
met, the Threshold Rule Actions are evaluated and possible actions taken.
Properties
Index
The index of the object, starting at 1. (Identifier)
Name
Specifies a symbolic name for the rule. (Optional)
SourceInterface
Specifies the name of the receiving interface to be compared to
the received packet.
SourceNetwork
Specifies the sender span of IP addresses to be compared to the received packet.
DestinationInterface
Specifies the the destination interface to be compared to the received packet.
DestinationNetwork
Specifies the span of IP addresses to be compared to the destination IP of the received packet.
Service
Specifies a service that will be used as a filter parameter when
matching traffic with this rule.
Schedule
By adding a schedule to a rule, the security gateway will only allow that rule to trigger at those designated times. (Optional)
Comments
Text describing the current object. (Optional)
Note
If no Index is specified when creating an instance of this type, the object will be
placed last in the list and the Index will be equal to the length of the list.
3.41.1. ThresholdAction
Description
A Threshold Rule Action specifies what thresholds to measure, and what action to take if those
thresholds are reached.
Properties
Index
The index of the object, starting at 1. (Identifier)
Action
Protect or Audit. (Default: Protect)
GroupBy
Specifies whether the threshold should be host- or networkbased. (Default: SourceIP)
136
3.41.1. ThresholdAction
Chapter 3. Configuration Reference
ConnRate
Specifies the threshold in connections per second. (Default:
1000)
ZoneDefense
Activate ZoneDefense. (Default: No)
BlackList
Activate BlackList. (Default: No)
BlackListTimeToBlock
The number of seconds that the dynamic black list should remain. (Optional)
BlackListBlockOnlyService
Only block the service that triggered the blacklisting.
(Default: No)
BlackListIgnoreEstablished
Do not drop existing connection. (Default: No)
LogEnabled
Enable logging. (Default: No)
LogSeverity
Specifies with what severity log events will be sent to the specified log receivers. (Default: Default)
Comments
Text describing the current object. (Optional)
Note
If no Index is specified when creating an instance of this type, the object will be
placed last in the list and the Index will be equal to the length of the list.
137
3.42. UpdateCenter
Chapter 3. Configuration Reference
3.42. UpdateCenter
Description
Configure automatical updates.
Properties
AVEnabled
Automatic updates of antivirus definitions and engine. (Default: No)
IDPEnabled
Automatic updates of IDP maintenance signatures. (Default: No)
AdvancedIDPEnabled
Automatic updates of Advanced IDP signatures. (Default: No)
UpdateInterval
Specifies the interval at which the automatic update runs. (Default:
Daily)
UpdateDate
Specifies the day of month when the automatic update is runs.
UpdateWeekday
Specifies the day of week when the automatic update is runs.
(Default: mon)
Hourly
Specififes the number of hours between periodical updates.
UpdateHour
Specifies the hour when the update is run. (Default: 0)
UpdateMinute
Specifies the minute when the update is run. (Default: 0)
Comments
Text describing the current object. (Optional)
Note
This object type does not have am identifier and is identified by the name of the type
only. There can only be one instance of this type.
138
3.43. UserAuthRule
Chapter 3. Configuration Reference
3.43. UserAuthRule
Description
The User Authentication Ruleset specifies from where users are allowed to authenticate to the system, and how.
Properties
Index
The index of the object, starting at 1. (Identifier)
Name
Specifies a symbolic name for the rule. (Optional)
Agent
HTTP, HTTPS, XAUTH, PPP or EAP. (Default: HTTP)
AuthSource
Disallow, Radius or Local.
Interface
The interface on which the connection was received.
OriginatorIP
The network object that the incoming IP address must be a part
of.
TerminatorIP
Specifies the destination IP configured on the PPTP/L2TP
server configuration. Only used when agent is PPP.
RadiusServers
Specifies the authentication servers that will be used to authenticate users matching this rule.
RadiusMethod
Specifies the authentication method used for encrypting the
user password. (Default: PAP)
LocalUserDB
Specifies the local user database that will be used to authenticate users matching this rule.
LoginType
HTML form or Basic authentication. (Default: HTMLForm)
RealmString
The string that is presented as a part of the 401 - Authentication
Required message.
HostCertificate
Specifies the host certificate that the security gateway sends to
the client.
RootCertificate
Specifies the root certificate that was used to sign the host certificate. (Optional)
PPPAuthNoAuth
Allow no authentication. (Default: No)
PPPAuthPAP
Use PAP authentication protocol. User name and password are
sent in plaintext. (Default: Yes)
PPPAuthCHAP
Use CHAP authentication protocol. (Default: Yes)
PPPAuthMSCHAP
Use MS-CHAP authentication protocol. (Default: Yes)
PPPAuthMSCHAPv2
Use MS-CHAP v2 authentication protocol. (Default: Yes)
IdleTimeout
If a user has successfully been authenticated, and no traffic has
been seen from his IP address for this number of seconds, he/
she will automatically be logged out. (Default: 1800)
139
3.43. UserAuthRule
Chapter 3. Configuration Reference
SessionTimeout
If a user has successfully been authenticated, he/she will automatically be logged out after this many seconds, regardless of
if there has been activity from the user or not. (Optional)
UseServerTimeouts
Use timeouts received from the authentication server. If no values are received, the manually specified values will be used.
(Default: No)
MultipleUsernameLogins
Specifies how multiple username logins will be handled.
(Default: AllowMultiple)
ReplaceIdleTime
Replace existing user if idle for more than this number of
seconds. (Default: 10)
LogEnabled
Enable logging. (Default: No)
LogSeverity
Specifies with what severity log events will be sent to the specified log receivers. (Default: Default)
Comments
Text describing the current object. (Optional)
Note
If no Index is specified when creating an instance of this type, the object will be
placed last in the list and the Index will be equal to the length of the list.
140
3.44. WebContentFilteringCategories
Chapter 3. Configuration Reference
3.44. WebContentFilteringCategories
Description
View the preset Web Content Filtering categories.
Properties
WebContentFilteringCategories
Lists the available web content filtering categories. (Optional)
Comments
Text describing the current object. (Optional)
Note
Objects of this type cannot be created or modified by the user.
141
3.45. ZoneDefenseBlock
Chapter 3. Configuration Reference
3.45. ZoneDefenseBlock
Description
Manually configured blocks are used to block a host/network on the switches either by default or
based on schedule.
Properties
Index
The index of the object, starting at 1. (Identifier)
Addresses
Specifies the addresses to block.
Protocol
All, TCP, UDP or ICMP. (Default: All)
Port
Specifies which UDP or TCP port to use. (Default: 0)
Schedule
Specifies the schedule when the given addresses should be blocked. (Optional)
Comments
Text describing the current object. (Optional)
Note
If no Index is specified when creating an instance of this type, the object will be
placed last in the list and the Index will be equal to the length of the list.
142
3.46. ZoneDefenseExcludeList
Chapter 3. Configuration Reference
3.46. ZoneDefenseExcludeList
Description
The exclude list is used exclude certain hosts/networks from being blocked out by IDP/Threshold
rule violations.
Properties
Addresses
Specifies the addresses that should not be blocked. (Optional)
Comments
Text describing the current object. (Optional)
Note
This object type does not have am identifier and is identified by the name of the type
only. There can only be one instance of this type.
143
3.47. ZoneDefenseSwitch
Chapter 3. Configuration Reference
3.47. ZoneDefenseSwitch
Description
A ZoneDefense switch will have its ACLs controlled and hosts/networks violating the IDP/
Threshold rules will be blocked directly on the switch.
Properties
Name
Specifies a symbolic name for the ZoneDefense switch. (Identifier)
SwitchModel
Specifies the switch model type. (Default: DES-3226S)
IP
The IP address of the management interface of the switch.
Enabled
Enable the ZoneDefense switch. (Default: Yes)
SNMPCommunity
The SNMP community string (write access).
Comments
Text describing the current object. (Optional)
144
3.47. ZoneDefenseSwitch
Chapter 3. Configuration Reference
145
Index
Commands
A
ifstat, 30
ikesnoop, 31
ippool, 32
ipsecglobalstats, 32
ipseckeepalive, 33
ipsecstats, 33
K
about, 18
activate, 9
add, 9
arp, 18
arpsnoop, 19
ats, 19
avupdate, 20
killsa, 33
B
M
bigpond, 20
blacklist, 20
buffers, 22
L
license, 34
linkmon, 34
lockdown, 35
logout, 35
memory, 36
O
C
ospf, 36
cam, 22
cancel, 10
cc, 11
cd, 12
(see also cc)
certcache, 23
cfglog, 23
commit, 12
connections, 23
cpuid, 24
crashdump, 25
customlog, 25
P
D
sessionmanager, 40
set, 14
show, 15
shutdown, 41
sshserver, 42
stats, 43
delete, 12
dhcp, 25
dhcprelay, 26
dhcpserver, 27
dns, 27
dynroute, 28
ping, 47
pipes, 38
R
reject, 13
routemon, 38
routes, 38
rules, 39
S
T
E
time, 43
enter, 13
(see also cc)
U
F
undelete, 17
urlcache, 44
userauth, 44
frags, 28
H
ha, 29
help, 48
history, 48
httpposter, 30
I
V
vlan, 45
vpnstats, 45
(see also ipsecstats)
Z
zonedefense, 45
idpupdate, 30
146
Index
Object types
A
Access, 51
ALG_FTP, 56
ALG_H323, 56
ALG_HTTP, 57
ALG_HTTP_URL, 58
ALG_SMTP, 58
ARP, 60
ARPTableSettings, 122
B
IDPFactorySignatureGroup, 82
IDPFactorySignatureGroups, 82
IDPFactorySignatureGroupWildcard, 83
IDPRule, 84
IDPRuleAction, 84
IKEAlgorithms, 86
InterfaceGroup, 88
IP4Address, 53
IP4Group, 54
IP4HAAddress, 54
IPRule, 95
IPSecAlgorithms, 97
IPSecTunnel, 88
IPSecTunnelSettings, 125
IPSettings, 126
IXP4NPEEthernetDriver, 73
BlacklistWhiteHost, 61
L
C
Certificate, 62
COMPortDevice, 66
ConnTimeoutSettings, 122
D
DateTime, 67
DefaultInterface, 87
Device, 68
DHCPRelay, 69
DHCPRelaySettings, 123
DHCPServer, 70
DHCPServerCustomOption, 70
DHCPServerSettings, 124
DNS, 72
DynamicRoutingRule, 75
DynamicRoutingRuleAddRoute, 76
DynamicRoutingRuleExportOSPF, 76
DynDnsClientCjbNet, 63
DynDnsClientDyndnsOrg, 63
DynDnsClientDynsCx, 63
DynDnsClientPeanutHull, 64
E
Ethernet, 87
EthernetAddress, 53
EthernetAddressGroup, 53
EthernetDevice, 78
F
FragSettings, 124
H
HighAvailability, 79
HTTPPoster, 80
I
ICMPSettings, 125
ID, 81
IDList, 81
IDPFactorySignature, 82
L2TPClient, 90
L2TPServer, 91
L2TPServerSettings, 127
LDAPServer, 98
LengthLimSettings, 127
LocalMgmtSettings, 128
LocalReassSettings, 129
LocalUserDatabase, 99
LoginClientBigPond, 64
LoginClientTelia, 65
LogReceiverMemory, 100
LogReceiverMessageException, 101
LogReceiverSMTP, 100
LogReceiverSyslog, 101
LogSettings, 129
M
MarvellEthernetPCIDriver, 73
O
OSPFAggregate, 105
OSPFArea, 103
OSPFInterface, 103
OSPFNeighbor, 104
OSPFProcess, 102
OSPFVLink, 105
P
Pipe, 106
PipeRule, 109
PPPoETunnel, 92
PSK, 110
R
R8139EthernetPCIDriver, 73
RadiusServer, 111
RemoteMgmtHTTP, 112
RemoteMgmtSettings, 129
RemoteMgmtSNMP, 112
RemoteMgmtSSH, 112
Route, 116
RoutingRule, 115
147
Index
RoutingSettings, 130
RoutingTable, 116
S
ScheduleProfile, 118
ServiceGroup, 119
ServiceICMP, 119
ServiceIPProto, 120
ServiceTCPUDP, 120
SSHClientKey, 135
SSLSettings, 131
StateSettings, 132
SwitchRoute, 117
T
TCPSettings, 132
ThresholdAction, 136
ThresholdRule, 136
U
UpdateCenter, 138
User, 99
UserAuthRule, 139
W
WebContentFilteringCategories, 141
V
VLAN, 93
VLANSettings, 134
Z
ZoneDefenseBlock, 142
ZoneDefenseExcludeList, 143
ZoneDefenseSwitch, 144
148