Appendix A: CLI Guide

This appendix contains a categorized listing of Command Line Interface (CLI) commands for SonicOS Enhanced firmware. Each command is described, and where appropriate, an example of usage is included.

This appendix contains the following sections:

Input Data Format Specification

The table below describes the data formats acceptable for most commands. H represents one or more hexadecimal digit (0-9 and A-F). D represents one or more decimal digit.

Table 4

MAC Address

HH:HH:HH:HH:HH:HH

MAC Address

HHHH.HHHH.HHHH

IP Address

D.D.D.D

IP Address

Integer Values

D

Integer Values

0xH

Integer Range

D-D

Text Conventions

Bold text indicates a command executed by interacting with the user interface.

Courier bold text indicates commands and text entered using the CLI.
Italic text indicates the first occurrence of a new term, as well as a book title, and also emphasized text. In this command summary, items presented in italics represent user-specified information.
Items within angle brackets (“< >”) are required information.
Items within square brackets (“[ ]”) are optional information.
Items separated by a “pipe” (“|”) are options. You can select any of them.
Note
Though a command string may be displayed on multiple lines in this guide, it must be entered on a single line with no carriage returns except at the end of the complete command.

Editing and Completion Features

You can use individual keys and control-key combinations to assist you with the CLI. The table below describes the key and control-key combination functions.

Table 5

Tab

Completes the current word

?

Displays possible command completions

Most configuration commands require completing all fields in the command. For commands with several possible completing commands, the Tab or ? key display all options.

myDevice> show [TAB]

security-
services

The Tab key can also be used to finish a command if the command is uniquely identified by user input.

myDevice> show al [TAB]

displays

myDevice> show alerts

Additionally, commands can be abbreviated as long as the partial commands are unique. The following text:

myDevice> sho int inf

is an acceptable abbreviation for
myDevice> show interface info

Command Hierarchy

The CLI configuration manager allows you to control hardware and firmware of the appliance through a discreet mode and submode system. The commands for the appliance fit into the logical hierarchy shown below.

To configure items in a submode, activate the submode by entering a command in the mode above it.

For example, to set the default LAN interface speed or duplex, you must first enter configure , then interface x0 lan . To return to the higher Configuration mode, simply enter end or finished .

Configuration Security

SonicWALL Internet Security appliances allow easy, flexible configuration without compromising the security of their configuration or your network.

Passwords

The SonicWALL CLI currently uses the administrator’s password to obtain access. SonicWALL devices are shipped with a default password of password . Setting passwords is important in order to access the SonicWALL and configure it over a network.

Factory Reset to Defaults

If you are unable to connect to your device over the network, you can use the command restore to reset the device to factory defaults during a serial configuration session.

Management Methods for the SonicWALL Network Security Appliance

You can configure the SonicWALL appliance using one of three methods:

Initiating a Management Session using the CLI

Serial Management and IP Address Assignment

Follow the steps below to initiate a management session via a serial connection and set an IP address for the device.

Note
The default terminal settings on the SonicWALL and modules is 80 columns by 25 lines. To ensure the best display and reduce the chance of graphic anomalies, use the same settings with the serial terminal software. The device terminal settings can be changed, if necessary. Use the standard ANSI setting on the serial terminal software.
1.
Attach the included null modem cable to the appliance port marked CONSOLE . Attach the other end of the null modem cable to a serial port on the configuring computer.
2.
3.
Press Enter/Return . Initial information is displayed followed by a DEVICE NAME> prompt.

 

Initiating an SSH Management Session via Ethernet

Note

Follow the steps below to initiate an SSH management session through an Ethernet connection from a client to the appliance.

1.
Attach an Ethernet cable to the interface port marked XO . Attach the other end of the Ethernet cable to an Ethernet port on the configuring computer.
2.
3.
Within the emulation application, enter the IP destination address for the appliance and enter 22 as the port number.
4.
Select SSH as the connection type and open a connection.

Logging in to the SonicOS CLI

When the connection is established, log in to the security appliance:

1.
At the User prompt enter the Admin’s username. Only the admin user will be able to login from the CLI. The default Admin username is admin . The default can be changed.
2.
At the Password prompt, enter the Admin’s password. If an invalid or mismatched username or password is entered, the CLI prompt will return to User :, and a “CLI administrator login denied due to bad credentials” error message will be logged. There is no lockout facility on the CLI.

SonicOS Enhanced Command Listing

The following section displays all commands available for the SonicWALL:

Table 6
clear ssh < int | hex >
Terminates a particular secure shell connection, specified by integer or hexidecimal input
Causes exit from a submenu. If issued at the global level, returns to the login prompt
help < command >
nslookup < dotted-int | hex | ident >
Looks up the IP address of the given domain name from the configurable domain name servers
ping <dotted-int | hex | ident >
show address-group < string | ident>
Displays system address groups specified by particular string or identifier input
show address-object < string | ident>
Displays all defined address objects specified by particular string or identifier input
Displays the configuration information from dif ­ ferent modules of the firewall
Displays all ARS paths being managed through Network Status Management (NSM)
Displays all ARS paths using Routing Information Protocol (RIP)
Displays continuous core work resources specified by particular integer or hexidecimal input
Displays currently selected continuous traffic interface, specified by an indentifier
Displays continuous system traffic specified by a particular integer or hexidecimal input
show core < int | hex>
Displays CPU utility for a process specified by an integer or hexidecimal input
show cpu < string | ident>
Displays CPU and memory information, speci ­ fied by a particular string or identifier input
Displays on the console the contents of the status section of the Technical Support Report (TSR)
Displays interface status information specified by a particular integer or hexidecimal input
show processes < string | ident>
Displays SonicOS processes specified by a particular string or indentifier input
Displays the complete status of all security services on the SonicWALL, including license status, licenses available, licenses in use, and license expiration dates
Displays all services associated with the appli ­ ance, along with protocol group and port details
Displays all service groups associated with the appliance, along with protocol group and port details
show service-groups < group-name>
show service < service-name>
Displays a service associated with the appli ­ ance, based on the specific service name input
Displays all incoming and outgoing secure shell connections to the unit
Displays all client routes associated with current SSL-VPN connections to the unit shown on the client routes GUI page
show sslvpn clientRoutes < string | ident>
Displays client routes associated with current SSL-VPN connections to the unit, specified by the particular string or indentifier input
Displays all current client settings associated with SSL-VPN connections to the unit shown on the client settings GUI page
Displays all current portal settings for SSL-VPN connections shown on the portal set ­ tings GUI page
Displays Technical Support Report listing active UTM units on the network
Displays TSR containing table relating IP addresses to corresponding MAC or physical addresses
Displays TSR data relating to Ethernet connections and availability
Displays TSR information relating to hypervisor data on multiple operating systems running on the host computer
Displays TSR data relating to internet datagram protocol statistics
Displays TSR data relating to IP Helper configuration and settings
Displays TSR data relating to Layer 2 Tunneling Protocol (L2TP) client statistics
Displays TSR listing appliance’s current network address translation policies
Displays TSR data relating to current public key infrastructure certificates
Displays TSR data relating to point-to-point- protocol over Ethernet system settings
Displays TSR data relating to point-to-point tunneling protocol client configuration
Displays TSR listing the appliance’s current Quality of Service resource reservations status
Displays TSR data relating to Real Time Streaming Protocol statistics
Displays TSR data relating to the appliance’s Session Initiation Protocol settings
Displays TSR data detailing appliance’s stateful synchronization configuration
(Available on UTM appliances with built in wireless interfaces)
Displays TSR data relating to managed wireless local area network zones
show vpn policy < string | ident>
Displays detailed information on VPN security association Internet Key Exchange policies
Displays a data summary on VPN security association Internet Key Exchange policies
Displays detailed information on VPN security associations connected with IPSec routing protocols
Displays a data summary on VPN security associations connected with IPSec routing protocols
show vpn sa < string>
Displays a particular VPN security association, specified by a particular string input
show vpn sa < string> detail
Displays details on a VPN security association, specified by a particular string input
show vpn sa < string> summary
Displays a data summary on a security association, specified by a particular string input
show vpn sa < string> ike
Displays Internet Key Exchange data for a VPN security association, specified by a particular string input
show vpn sa < string> ike detail
Displays details for Internet Key Exchange data for a VPN security association, specified by a particular string input
show vpn sa < string> ike summary
Displays a summary for Internet Key Exchange data for a VPN security association, specified by a particular string input
show vpn sa < string> ipsec
Displays IPSec data for a VPN security association, specified by a particular string input
show vpn sa < string> ipsec detail
Displays details for IPSec data for a VPN security association, specified by a particular string input
show vpn sa < string> ipsec sum­mary
Displays a summary for IPSec data for a VPN security association, specified by a particular string input
show vpn sa < ident>
Displays VPN security associations, specified by a particular identifier input
show vpn sa < ident> detail
Displays details for a VPN security association, specified by a particular identifier input
show vpn sa < ident> summary
Displays a summary for VPN security associations, specified by a particular indentifier input
show vpn sa < ident> ike
Displays Internet Key Exchange data for a VPN security association, specified by a particular identifier
show vpn sa < ident> ike detail
Displays detailed Internet Key Exchange data for VPN security associations, specified by a particular identified input
show vpn sa < ident> ike summary
Displays a summary on Internet Key Exchange data for VPN security associations, specified by a particular identifier input
show vpn sa < ident> ipsec
Displays IPSec data for VPN security associations, specified by a particular identifier input
show vpn sa < ident> ipsec detail
Displays detailed IPSec data for VPN security associations, specified by a particular identifier input
show vpn sa < ident> ipsec summary
Displays a summary on IPSec data for VPN security associations, specified by a particular identifier input
show zone < lan | wan | dmz | wlan >
Displays all rules for a specified zone. For example, show zone <lan rules> displays all of the rules to and from the LAN zone
Displays configurable zones on the appliance and interfaces associated with each zone
stacktrace < string | ident>
Runs report for a specific active set of stack frames, based on the particular string or identifier input
Synchronizes the SonicWALL licensing information with the mysonicwall.com backend
traceroute < dotted-int | hex | ident >
Displays router hops to destination, specified by dotted-integer, hexidecimal, or identifier input
Table 7

 

access-rules < from-zone> < to-zone>
Allows configuration of access rules between one zone and another
< add> commands
action < allow| deny| dis­card>
[ no] allow-fragments
comment < comments>
Allows administrators to record comments related to this access rule
destination < address object>
Configures an address object destination for an access rule
[ no] logging
maxconns < percentage>
Configures maximum number of connections in a pool
qos dscp < none| preserve| explicit| map> [< arg>]
qoa 802.1p < none| preserve| explicit| map> [< arg>]
[ no] reflexive
schedule < schedule object>
service < service object>
source < address object>
tcptimeout < minutes>
udptimeout < seconds>
user < user object>
delete < index>
list [< index>]
Displays one access rule whose index matches the specified value input. If index is not available, all access rules in the current zone to zone context will display
< modify> commands
< index>
action < allow| deny| dis­card>
Modifies an allow, deny, or discard action relating to a specific access rule
[ no] allow-fragments
comment < comments>
destination < address object>
Modifies the destination address object for a specific access rule
[ no] logging
Modifies whether packet logging is enabled for a specific access rule
qos dscp < none| preserve| explicit| map> [< arg>]
qos 802.1p < none| preserve| explicit| map> [< arg>]
maxconns < percentage>
Modifies maximum number of connections in a pool
schedule < schedule object>
service < service object>
source < address object>
Modifies the source address object connected to an access rule
tcptimeout < minutes>
udptimeout < seconds>
user < user object>
[ no] address-object < object name>
[ no] address-group < group name>
host < ip address>
network < subnet> < netmask>
range < begin-address> < end address>
zone < zone name>
Configures a zone for the specified address object or group
[ no ] arp < ip address > < MAC address > interface < lan | wan | dmz >[ perm ][ pub ]
Adds or removes arp entries for specified interface(s)
< gms>
algorithm < des-md5 | frd3- sha >
[ no ] authentication-key < hex key >
Sets the 32-hex or 40-hex authentica ­ tion key to communicate with the GMS server
[ no ] behind-nat
bound-interface < x1 | x2 | x3 | x4 | x5 >
[ no ] enable
encryption-key < hex key >
set the 16-hex/48-hex encryption key to communicate with the GMS server
help < command >
[ no ] nat-address < IP Address >
[ no ] over-vpn
[ no ] send-heartbeat
[ no ] server < IP Address >
[ no ] standby-management- sa
syslog-port < uvalue | (default) >
ha < disable| enable>
Enables or disables the High Availability function
< add> commands
orig-src < original source object>
trans-src < translated source object>
orig-dst < original destination source object>
orig-svc < original service name>
trans-svc < translated service name>
inbound-interface < inbound interface>
outbound-interface < outbound interface>
[ no] enable
[ no] reflexive
Creates/Removes a reflexive NAT policy once it has been saved
comment < comments>
Allows administrator to leave comments relating to a NAT policy
< delete> commands
delete < item-number>
< modify> commands
< item-number>
[ no] enable
[ no] comment < comments>
Allows administrator to modify com ­ ments relating to a NAT policy
orig-src < original source object>
trans-src < translated source object>
orig-dst < original destination address object>
Modifies the original destination address object for this policy
trans-dst < translated destination address object>
Modifies the translated destination- address object for this policy
orig-svc < original service name>
trans-svc < translated service name>
inbound-interface < inbound interface>
outbound-interface < outbound interface>
Configures the Advanced Routing Suite for the NSM module
Configures the Advanced Routing Suite for the OSPF module
Configures the Advanced Routing Suite for the RIP module
< add> commands
< service name>
Allows configuration of a new service type to be associated to the appliance
< group name>
[ no] service < service name>
ip-type < ip type>
port-begin < port>
port-end < port>
Allows additional values to be added for the specific service
< delete> commands
< group name>
< service name>
< modify> commands
< service name>
< group name>
ip-type < ip type>
port-begin < port>
port-end < port>
[ no] service < service name}
[ info]
Optional, displays service values for service name, protocol, and port range
< sonicpoint>
< string>
country-code < US| CA>
[ no] delete
[ no] enable
[ no] radio-a enable
Enables or disables 802.11a radio band wireless connections
Adds a specific MAC address to the Access Control List (ACL) to allow 802.11a radio band wireless connections to a SonicPoint
Adds a specific MAC address to the denied Access Control List, preventing 802.11a radio band wireless connections to a SonicPoint
[ no] radio-acl enable
Enables or disables the Access Control List feature on 802.11a radio
radio-a acl mode < deny| allow| disabled| enabled>
radio-a antenna-diversity < one| two| both>
Sets which antenna (left, right, or both) the SonicPoint uses to send and receive data
radio-a authtype < both| open| psk| shared>
Sets the method type for authentication to be both, open, WPA/PSK, or WEP- shared
Sets the interval (in milliseconds) between broadcasts of the wireless beacon
radio-a datarate < 6| 9| 12| 18| 24| 36| 48| 54| best>
Sets the data rate at which data is transmitted and received to either the best possible rate, or a specified rate
radio-a dtim < uvalue>
Sets 802.11a radio DTIM, which is the numbers of beacon frames that must occur before the radio sends buffered multicast frames
Sets the number of bytes of fragmented data for the SonicPoint to allow
[ no] radio-a hide-ssid
Sets SSID to be broadcast as part of the wireless beacon, rather than as a separate broadcast
Sets maximum number of clients that can the SonicPoint can support at one time
radio-a radio-mode < standard| turbo>
Sets a convenient time to schedule an Intrusion Detection Scan (IDS)
radio-a ssid < string>
Sets Service Set Identifier (SSID) identifying a particular SonicPoint
radio-a txpower < eighth| full| half| minimum| quarter>
radio-a wep key-value < 1-4> < string>
Sets the 802.11a radio WEP key value for each encryption key slot
radio-a wep key-mode < 64bit| 128bit| 152bit| none>
Sets WEP key mode, establishing character length of encryption
radio-a wep key-type < alpha| hex>
radio-a wpa cipher < aes| auto| tkip>
Sets the cipher type system used by the WPA to either AES, AUTO, or TKIP
Sets the length of time between re-keying the WPA key
Sets WiFi Protected Access Pre-shared key passphrase
[ no] radio-g enable
Enables or disables 802.11g radio band wireless connections
[ no] radio-g acl enable
Adds a specific MAC address to the Access Control List (ACL) to allow 802.11g radio band wireless connections to a SonicPoint
Adds a specific MAC address to the denied Access Control List, preventing 802.11g radio band wireless connections to a SonicPoint
radio-g acl mode < deny| allow| disabled| enabled>
radio-g antenna-diversity < one| two| both>
Sets which antenna the SonicPoint uses to send and receive data
radio-g authtype < both| open| psk| shared>
Sets the interval (in milliseconds) between broadcasts of the wireless beacon
radio-g datarate < b1| b11| b2| b5| best| g1| g11| g12| g18| g2| g24| g36| g48| g5| g54| g6| g9| super108| super12| super18| super24| super36| super48| super72| super96>
Sets the data rate at which data is transmitted and received
radio-g dtim < uvalue>
Sets 802.11g radio DTIM, which is the numbers of beacon frames that must occur before the radio sends buffered multicast frames
Sets the number of bytes of frag ­ mented data for the SonicPoint to allow
[ no] radio-g g-only
[ no] radio-g hide-ssid
Sets SSID to be broadcast as part of the wireless beacon, rather than as a separate broadcast
Sets maximum number of clients that can the SonicPoint can support at one time
Sets the difference in radio transmit power allowed between 802.11g and 802.11b modes
[ no] radio-g preamble-long
Sets the length of the initial wireless communication when associating with the host
radio-g protection mode < always| none>
radio-g protection type < cts-only| rts-cts>
radio-g radio-mode < b| g| super-g>
Sets radio mode. If super-g is selected, all clients must use access cards that support this mode
radio-g ssid < string>
Sets a convenient time to schedule an Intrusion Detection Scan (IDS)
[ no] radio-g short-slot
Allows clients to disassociate and re-associate more quickly
radio-g txpower < eighth| full| half| minimum| quarter>
radius1 address < ip address>
Sets the IP address location of the RADIUS authentication server
radius1 secret < string>
Sets the secret passcode for the RADIUS authentication server
radius2 address <ip address >
Sets the IP address for the backup RADIUS authentication server
radius2 secret < string>
Sets the secret passcode for the backup RADIUS authentication server
Stops all SSH sessions, disables all SSH management, and resets the port
timeout < minutes>
[ no] vpn < enable| disable> < policy name>
[ no] vpn policy < policy-name> [ preshared| manual| cert]
[ no] advanced apply-nat < local| remote> < trans­lated address object>
Enable or disable translation of the local and/or remote networks communicating with this VPN tunnel
[ no] advanced auto-add-rule
advanced bound-to interface <interface>
[ no] advanced default-lan-gw <ip address>
[ no] advanced keepalive
Enables or disables heartbeat messages between peers on this VPN tunnel
[ no] advanced management http
Enables or disables HTTP as the management method security association
[ no] advanced management https
Enables or disables HTTPS as the management method security association
[ no] advanced multicast
[ no] advanced netbios
Enables or disables Windows Networking (NetBIOS) Broadcast
[ no] advanced use-xauth < group-name>
Configures or removes the specified user group for XAUTH users
[ no] advanced user-login http
[ no] advanced user-login https
gw domain-name < domain name>
gw ip-address < ip address>
id local < domain-name| email address| ip-address| sonicwall-id> < our id>
id remote < domain name| email address| ip-address| sonicwall-id> < their id>
network local < address-object> < address object string>| any| dhcp>
Sets a local network for the VPN tunnel, or configures the network to obtain IP addresses using DHCP
network remote < address- object< address object string>| any| dhcp>
Sets a specific VPN tunnel as the default route for all incoming Internet traffic
proposal ike [< main| aggres­sive| ikev2>] [ encr < des| triple-des| aes-128| aes-192| aes-256>] [ auth < md5| sha1>] [ dh < 1| 2| 5>] [ lifetime < seconds>]
Sets the desired IKE encryption suite configurations for VPN tunnel traffic
proposal ipsec [< esp| ah>] [ encr < des| triple-des| aes-128| aes-192| aes-256>] [ auth < md5| sha1>] [ dh < 1| 2| 5>] [ lifetime < seconds>]
sec-gw domain-name < domain name>
sec-gw ip-address < ip address>
[ no] advanced apply-nat < local| remote> < trans­lated address object>
Enable or disable translation of the local and/or remote networks communicating with this VPN tunnel
[ no] advanced auto-add-rule
advanced bound-to interface <interface>
[ no] advanced keepalive
Enables or disables heartbeat messages between peers on this VPN tunnel
[ no] advanced management http
Enables or disables HTTP as the management method security association
[ no] advanced managment https
Enables or disables HTTPS as the management method security association
[ no] advanced multicast
[ no] advanced netbios
Enables or disables Windows Networking (NetBIOS) Broadcast
[ no] advanced use-xauth < group name>
Configures or removes the specified user group for XAUTH users
[ no] advanced user-login http
[ no] advanced user-login https
gw domain-name < domain name>
gw ip-address < ip address>
network local <address object < address object string> | any>
Sets a local network for the VPN tunnel, or configures the network to obtain IP addresses using DHCP
network remote < address object < address object string> | any>
Sets a specific VPN tunnel as the default route for all incoming Internet traffic
proposal ipsec [< esp| ah>] [ encr < des| triple-des| aes-128| aes-192| aes-256>] [ auth < md5| sha1>] [ dh < 1| 2| 5>] [ lifetime < seconds>]
sa [ in-spi < Incoming SPI>] [ out-spi < Outgoing SPI>] [ encr-key < Encryp­tion Key>] [ auth-key < Authentication Key>]
Sets hexidecimal incoming and outgoing Security Parameter Index (SPI) to allow the SonicWALL to uniquely identify all security associations
[ no] advanced apply-nat
Enable or disable translation of the local and/or remote networks communicating with this VPN tunnel
[ no] advanced auto-add-rule
advanced bound-to inter ­ face < interface>
[no ] advanced default-lan-gw < ip address>
[ no] advanced keepalive
Enables or disables heartbeat messages between peers on this VPN tunnel
[ no] advanced management http
Enables or disables HTTP as the management method security association
[ no] advanced managment https
Enables or disables HTTPS as the management method security association
[ no] advanced multicast
[ no] advanced netbios
Enables or disables Windows Networking (NetBIOS) Broadcast
[ no] advanced ocsp < url>
Enables use of Online Certificate Status Protocol (OCSP) to check VPN certificate status and specifies the URL where to check the certificate status
[ no] advanced use-xauth < group name>
Configures or removes the specified user group for XAUTH users
[ no] advanced user-login http
[ no] advanced user-login https
cert < certname>
gw domain-name < domain name>
gw ip-address < ip address>
id remote < domain name | email address | distin­guished name> < peer-id>
network local < address object < address object string> | any>
Sets a local network for the VPN tunnel, or configures the network to obtain IP addresses using DHCP
network remote < address object < address object string> | any>
Sets a specific VPN tunnel as the default route for all incoming Internet traffic
proposal ike [< main| aggres­sive| ikev2>] [encr < des| triple-des| aes-128| aes-192| aes-256>] [ auth < md5| sha1>] [ dh < 1| 2| 5>] [ lifetime < seconds>]
Sets the desired IKE encryption suite configurations for VPN tunnel traffic
proposal ipsec [< esp| ah>] [ encr < des| triple-des| aes-128| aes-192| aes-256>] [ auth < md5| sha1>] [ dh < 1| 2| 5>] [ lifetime < seconds>]
sec-gw domain-name < domain name>
sec-gw ip-address < ip address>
address < start ip address> < end ip address> < interface>
Sets the global IP address pool from which NetExtender clients are assigned an IP address
[ no] auto-update
Enables/Disables auto-update which assists users in updating their NetEx ­ tender client when a newer version is required to establish a connection
cache-username-password < username-only | pass­word-username | prohibit>
Sets the user name and password cache policy used for the NetExtender client
[ no] client-communicate
Enables/Disables traffic between hosts connecting to server with NetExtender
[ no] create-connection-profile
Enables/Disables NetExtender client’s ability to create a connection profiles
dns-domain < DNS domain name>
Sets the DNS domain which is the NetExtender client DNS-specific suffix
dns1 < ip address>
Sets the primary DNS server IP address to be used by all NetExtender clients
dns2 < ip address>
Sets the secondary DNS server IP address to be used by all NetExtender clients
[ no] exit-after-discon­nect
Enables/Disables the forcing of a NetExtender client to exit after disconnecting from the server
Displays available sub-commands for SSL VPN client configuration
sslvpn-access < LAN| WAN| DMZ| WLAN>
[ no] uninstall-after-exit
Enables/Disables automatic uninstall of NetExtender clients after exit
user-domain < user domain name>
wins1 < ip address>
wins2 < ip address>
[ no] auto-launch
Enables/Disables automatic launch of NetExtender after a user logs into the portal
banner-title < portal banner title name>
Sets the portal banner title that displays next to the logo on the portal home page
[ no] cache-control
Enables/Disables the use of some HTML META tags to tell browser to cache UI files in portal pages
Sets a customized logo to be used on the portal page. The URL entered must be valid and reachable by the unit.
[ no] default-logo
Enables/Disables the use of the default SonicWALL logo on the portal page
[ no] display-cert
Enables/Disables the display of the button to import the SSL VPN server certificate
Displays available subcommands for SSL VPN portal settings
site-title < portal site title name>
Sets the portal HTML page title that displays in the browser window’s title
add-routes < address object name>
delete-routes < address object name>
Deletes specified SSL VPN client route entry, identified as an address object
Displays available subcommands for SSL VPN client routes settings
[ no] tunnel-all
Enables/Disables tunnel all mode which configures the NetExtender client to tunnel all traffic over the SSL VPN connection
[ no] web-management otp enable
Configures one-time password for VPN user access to the appliance
Table 8

 

interface < x0 | x1 | x2 | x3 | x4 | x5 > [< lan | wan | dmz >]
Assigns zone and enters the configura ­ tion mode for the interface
comment < string >
duplex < full | half >
help < command >
[no] management <http|https|ping|snmmp|ss h> enable
Enables or disables specified manage ­ ment protocol on the interface
[no] user-login <http|https>
< lan >
help < command >
ip < IP Address > netmask <mask>
name < interface name >
speed < 10 | 100 >
Table 9

 

< wan >
comment < string >
duplex < full | half >
Enables/disables fragmentation of packets larger than the interface MTU
help < command >
[ no] https-redirect enable
[ no] management < http| https| ping| snmmp| ssh> enable
Enables or disables specified manage ­ ment protocol on the interface
[ no] user-login < http| https>
mode < static | dhcp | pptp | l2tp | pppoe >
Sets the mode for the WAN interface and enters the mode configuration
Mode Static WAN Interface Configuration
[ no ] dns < IP Address >
gateway < IP Address >
help < command >
[ no ] ip < IP Address >
Mode DHCP WAN Interface Configuration
help < command >
[ no ] hostname < string >
Mode PPTP WAN Interface Configuration
[ no ] dynamic
help < command >
[ no ] hostname < string >
[ no ] inactivity
timeout < uvalue >
[ no ] ip < IP Address >
[ no ] password < quoted string >
[ no ] server ip <IP Address >
[ no ] username < string >
L2TP WAN Configura ­ tion Mode
[ no ] dynamic
help < command >
[ no ] hostname < string >
[ no ] inactivity
timeout < uvalue >
[ no ] ip < IP Address>
[ no ] password < quoted string >
[ no ] server ip < IP Address >
[ no ] username < string >
mtu < uvalue >
name < interface name >
speed < 10 | 100 >
Other Interface Configuration
comment < string >
duplex < full | half >
help < command >
name < interface name >
speed < 10 | 100 >
Log Category Information
[ no ] all
[ no ] attack
[ no ] blocked-code
[ no ] blocked-sites
[no ] connection
[ no ] conn-traffic
[ no ] debug
help < command >
[ no ] icmp
[no ] lan-icmp
[ no ] lan-tcp
[ no ] lan-udp
[ no ] maintenance
[ no ] mgmt-80211b
[ no ] modem-debug
[ no ] sys-env
[ no ] sys-err
[ no ] tcp
[ no ] udp
[ no ] user-activity
[ no ] vpn-stat
[ no ] vpn-tunnel-status
[ no ] log filter-time <uvalue>
Assign/clear ordering method when displaying log entries
name < string>
[ no ] route default < IP address >
[ no ] route < Destination > < Netmask > < Gateway > [ metric < route metric >]
[ no ] web-management http enable < x0 | x1 | x2 | x3 | x4 | x5 >
web-management http port < tcp port or 'default' >
Assigns the HTTP web management port or reset to default
[ no ] web-management https enable < x0 | x1 | x2 | x3 | x4 | x5 >
web-management https port < tcp port or 'default' >
Assigns the HTTPS web management port or resets to default
Restores default web-management port and interface assignments
[ no ] intrazone-communica ­ tions
comment < string >
duplex < full | half >
Enable/disable fragmentation of pack ­ ets larger than the interface MTU
[ no] sslvpn-access
< guest services>
Configures the zone’s bypass authentication based on string or identifier input
custom footer-text <string|identifier
custom header-text <string|identifier>
Enables guests to be directed to a landing page post-authentication
Configures which URL guests are directed to after authentication
smtp-redirect <string|identifier>

Configuring Site-to-Site VPN Using CLI

This section describes how to create a VPN policy using the Command Line Interface. The examples used are a SonicWALL TZ 170 appliance with SonicOS Enhanced 3.2 firmware. You can configure all of the parameters using the CLI, and enable the VPN without using the Web management interface.

Note

CLI Access

1.
2.
3.

TZ170>

If you have used any other CLI, such as Unix shell or Cisco IOS, this process should be relatively easy and similar. It has auto-complete so you do not have to type in the entire command.

4.

TZ170 > configure

(config[TZ170])>

The command prompt changes and adds the word config to distinguish it from the normal mode. Now you can configure all the settings, enable and disable the VPNs, and configure the firewall.

Configuration

In this example, a site-to-site VPN is configured between two TZ 170 appliance, with the following settings:

Local TZ 170 (home):
WAN IP: 10.50.31.150
LAN subnet: 192.168.61.0
Mask 255.255.255.0

Remote TZ 170 (office):
WAN IP: 10.50.31.104
LAN subnet: 192.168.15.0
Mask: 255.255.255.0

Authentication Method: IKE using a Pre-Shared Key
Phase 1 Exchange: Main Mode
Phase 1 Encryption: 3DES
Phase 1 Authentication SHA1
Phase 1 DH group: 2
Phase 1 Lifetime: 28800
Phase 2 Protocol: ESP
Phase 2 Encryption: 3DES
Phase 2 Authentication: SHA1
Phase 2 Lifetime: 28800
No PFS

1.
In configure mode, create an address object for the remote network, specifying the name , zone assignment , type , and address . In this example, we use the name OfficeLAN :

(config[TZ170]> address-object Office LAN
(config-address-object[OfficeLAN])>

Note

(config-address-object[OfficeLAN])> zone VPN
(config-address-object[OfficeLAN])> network 192.168.15.0 255.255.255.0
(config-address-object[OfficeLAN])> finished

2.

TZ170 > show address-object OfficeLAN

The output will be similar to the following:

address-object OfficeLAN
network 192.168.15.0 255.255.255.0
zone VPN

3.

(config[TZ170])> vpn policy OfficeVPN pre-shared
(config-vpn[OfficeVPN])>

Note
4.

(config-vpn[OfficeVPN])> pre-shared-secret sonicwall

5.

(config-vpn[OfficeVPN])> gw ip-address 10.50.31.104

6.

(config-vpn[OfficeVPN])> network local address-object "LAN Primary Subnet"
(config-vpn[OfficeVPN])> network remote address-object "OfficeLAN"

7.

(config-vpn[OfficeVPN])> proposal ike main encr triple-des auth sha1 dh 2 lifetime 28800
(config-vpn[OfficeVPN])> proposal ipsec esp encr triple-des auth sha1 dh no lifetime 28800

8.

(config-vpn[OfficeVPN])> advanced keepalive

9.

(config[TZ170])> vpn enable "OfficeVPN"

10.

(config-vpn[OfficeVPN])> finished
(config[TZ170])>

The configuration is complete.

Note

Viewing VPN Configuration

Use the following steps to configure the VPN policies.

1.

(config[TZ170])> show vpn policy

Policy: WAN GroupVPN (Disabled)
Key Mode: Pre-shared
Pre Shared Secret: DE65AD2228EED75A

Proposals:
IKE: Aggressive Mode, 3DES SHA, DH Group 2, 28800 seconds
IPSEC: ESP, 3DES SHA, No PFS, 28800 seconds

Advanced:
Allow NetBIOS OFF, Allow Multicast OFF
Management: HTTP OFF, HTTPS OFF
Lan Default GW: 0.0.0.0
Require XAUTH: ON, User Group: Trusted Users

Client:
Cache XAUTH Settings: Never
Virtual Adapter Settings: None
Allow Connections To: Split Tunnels
Set Default Route OFF, Apply VPN Access Control List OFF
Require GSC OFF
Use Default Key OFF

Policy: OfficeVPN (Enabled)
Key Mode: Pre-shared
Primary GW: 10.50.31.104
Secondary GW: 0.0.0.0
Pre Shared Secret: sonicwall

IKE ID:
Local: IP Address
Peer: IP Address

Network:
Local: LAN Primary Subnet
Remote: OfficeLAN

Proposals:
IKE: Main Mode, 3DES SHA, DH Group 2, 28800 seconds
IPSEC: ESP, 3DES SHA, No PFS, 28800 seconds

Advanced:
Keepalive ON, Add Auto-Rule ON, Allow NetBIOS OFF
Allow Multicast OFF
Management: HTTP ON, HTTPS ON
User Login: HTTP ON, HTTPS ON
Lan Default GW: 0.0.0.0
Require XAUTH: OFF
Bound To: Zone WAN

2.

(config[TZ170])> show vpn policy "OfficeVPN"

The output will be similar to the following:

Policy: OfficeVPN (Enabled)
Key Mode: Pre-shared
Primary GW: 10.50.31.104
Secondary GW: 0.0.0.0
Pre Shared Secret: sonicwall

IKE ID:
Local: IP Address
Peer: IP Address

Network:
Local: LAN Primary Subnet
Remote: OfficeLAN

Proposals:
IKE: Main Mode, 3DES SHA, DH Group 2, 28800 seconds
IPSEC: ESP, 3DES SHA, No PFS, 28800 seconds

Advanced:
Keepalive ON, Add Auto-Rule ON, Allow NetBIOS OFF
Allow Multicast OFF
Management: HTTP ON, HTTPS ON
User Login: HTTP ON, HTTPS ON
Lan Default GW: 0.0.0.0
Require XAUTH: OFF
Bound To: Zone WAN

3. Type the command show vpn sa “name” to see the active SA:

(config[TZ170])> show vpn sa "OfficeVPN"

Policy: OfficeVPN
IKE SAs

GW: 10.50.31.150:500 --> 10.50.31.104:500
Main Mode, 3DES SHA, DH Group 2, Responder
Cookie: 0x0ac298b6328a670b (I), 0x28d5eec544c63690 (R)
Lifetime: 28800 seconds (28783 seconds remaining)

IPsec SAs

GW: 10.50.31.150:500 --> 10.50.31.104:500
(192.168.61.0 - 192.168.61.255) --> (192.168.15.0 - 192.168.15.255)
ESP, 3DES SHA, In SPI 0xed63174f, Out SPI 0x5092a0b2
Lifetime: 28800 seconds (28783 seconds remaining)

SonicWALL NetExtender Windows Client CLI Commands

The following section includes commands for the NetExtender Windows Client CLI (NEClient.exe):

Usage: NECLI [OPTIONS]

connect [OPTIONS]

-s server
-u user name
-p password
-d domain name
-clientcertificatethumb thumb(when server need client
certificate)
-clientcertificatename name(when server need client
certificate)

disconnect
createprofile [OPTIONS]

-s server
-u user name(optional)
-p password(optional)
-d domain name

displayprofile [OPTIONS]

-s server(optional)
-d domain(optional)
-u username(optional)

deleteprofile [OPTIONS]

-s server
-d domain
-u username

showstatus
setproxy [OPTIONS]

-t 1 automatic detect setting; 2 configuration script; 3 proxy server
-s proxy address/URL of automatic configuration script
-o port
-u user name
-p password
-b bypass proxy
-save
queryproxy
reconnect
viewlog
-profile

servername: connect to server directly when password has been saved

Example:

NECLI -version

NECLI connect -s 10.103.62.208 -d LocalDomain -u admin -p
password

NECLI connect -s 10.103.62.208 -d LocalDomain -u admin -p
password - clientcertificatethumb
cf3d20378ba7f2d9a79c536e230a2495d4a46734

NECLI connect -s 10.103.62.208 -d LocalDomain -u admin -p
password - clientcertificatename "Admin"

NECLI disconnect

NECLI createprofile -s 10.103.62.208 -d LocalDomain -u admin

NECLI displayprofile -s 10.103.62.208

NECLI deleteprofile -s 10.103.62.208 -d LocalDomain -u admin

NECLI showstatus

NECLI -t 3 -s 10.103.62.201 -o 808 -u user1 -p password -b
10.103.62.101;10.103.62.102

NECLI queryproxy

NECLI viewlog

NECLI reconnect

NECLI -profile 10.103.62.208

SonicWALL NetExtender MAC and Linux Client CLI Commands

The following section includes the Mac and Linux CLI version, which is similar to the NetExtender Windows Client CLI in the previous section:

Usage: netExtender [OPTIONS] server[:port]

-u user
-p password
-d domain
-t timeout Login timeout in seconds, default is 30 sec.
-e encryption Encryption cipher to use. To see list use -e -h.
-m Use this option to not add remote routes.
-r filename Generate a diagnostic report.
-v Display NetExtender version information.
-h Display this usage information.

server: Specify the server either in FQDN or IP address.
The default port for server is 443 if not specified.

Example:

netExtender -u u1 -p p1 -d LocalDomain sslvpn.company.com
[root@linux]# netExtender -u demo sslvpn.demo.sonicwall.com
SUSE/Ubuntu compatibility mode off

User Access Authentication
Password:
Domain: Active Directory
Connecting to SSL-VPN Server "sslvpn.demo.sonicwall.com:443". . .
Connected.
Logging in...
Login successful.
Using SSL Encryption Cipher 'DHE-RSA-AES256-SHA'
Using new PPP frame encoding mechanism
You now have access to the following 5 remote networks:

192.168.150.0/255.255.255.0

192.168.151.0/255.255.255.0

192.168.152.0/255.255.255.0

192.168.153.0/255.255.255.0

192.168.158.0/255.255.255.0

NetExtender connected successfully. Type "Ctrl-c" to disconnect...
Disconnecting NetExtender...
Terminating pppd.......
SSL-VPN logging out...
SSL-VPN connection is terminated.
Exiting NetExtender client.