11/18/2015

SonicWALLCDPCLICommandReferenceGuide(PDF)(SW6916)

SonicWALL CDP CLI Command Reference Guide (PDF) (SW6916)

Title
SonicWALL CDP CLI Command Reference Guide (PDF)

Resolution

1.

1. 1.ReboottheSonicWALLCDPappliance,andinterruptthebootprocessbytappingthe

2. 2.YourSonicWALLCDPwillappeartopartiallyreboot,andwillperformanadditionalfull
rebootoncemore.Yourusername/passwordisresetto

3. 3.Usethekeyboardandmonitortologintotheapplianceusingthe

1.

1. ESCkeyonthekeyboardasthebootprocessprogresses,untilyouareintheGRUB
bootloaderscreen.Youwillseeavarietyofoptions.SelecttheAuthenticationResetoption.
adminandthegenericpassword,password.adminusernameandthecurrentCDP
password.
SNWLCLI>
Thisisthestandardinput/outputstatisticsutility.

https://support.software.dell.com/kb/sw6916

1/25

11/18/2015

SonicWALLCDPCLICommandReferenceGuide(PDF)(SW6916)

Thisisthestandardinput/outputstatisticsutility.

Arguments
[options]:seemanualfordetails
<interval>:seemanualfordetails
<count>:seemanualfordetails

Type

Defaults

ntp

iostat[options...][<interval>[<count>]]::Executable:none
SNWLCLI>
ThisvariablecontrolstheNTP(NetworkTimeProtocol)onanappliance.Withno
arguments,itwillprintoutthecurrentNTPconfiguration.InordertochangeNTP
configuration,pass"on"or"off"asafirstargumentfollowedbyalistofNTPserverstouse.
UsethiscommandtosynchronizethetimewithaNTPserver.

Arguments
<
<
<
<

Type

Defaults

6
ntp<on|off>[<defaultservers|<server>[<server>]...>]:on>:EnablesNTPusingcurrently
https://support.software.dell.com/kb/sw6916

2/25

11/18/2015

SonicWALLCDPCLICommandReferenceGuide(PDF)(SW6916)

ntp<on|off>[<defaultservers|<server>[<server>]...>]:on>:EnablesNTPusingcurrently
configuredNTPserversoff>:TurnoffNTPdefaultservers>:EnablesNTPandresetslistof
serverstothebuiltindefaultsserver>:specifiesaservertobesetinNTPlist:System
Variable:Currentconfiguration
ping

SNWLCLI>

Thisfunctionisthestandardpingfunction.Usethiscontroltotestconnectivity.Italsotests
theappliancesDNSlookupvalues.
ping[cCOUNT][sSIZE][q]host
Arguments

host
c COUNT: send only COUNT pings
s SIZE: Send SIZE date bytes in packets
q: quite mode, only displays output at start and when finished

Type

Defaults

quit

::targetofping:Executable:SentSIZEdatabytesinpackets=56
SNWLCLI>

ExitsoutoftheCLI.
quit
Arguments

Type

https://support.software.dell.com/kb/sw6916

3/25

11/18/2015

SonicWALLCDPCLICommandReferenceGuide(PDF)(SW6916)

Defaults

raidadd

:none:Executable:none
SNWLCLI>

ThisfunctionaddsanewdrivetotheRAIDarray.
raidadd
Arguments

Type

Defaults

Related Commands

raidinfo

:none:Executable:none:raidinfo,raidrebuild,raidremove,raidstatus,raidverify
SNWLCLI>

ThisfunctionoutputsinformationabouttheRAIDdevicesinthebox.
raidinfo
Arguments

Type

Defaults
Related Commands:

https://support.software.dell.com/kb/sw6916

4/25

11/18/2015

SonicWALLCDPCLICommandReferenceGuide(PDF)(SW6916)

7
:none:Executable:noneraidadd,raidrebuild,raidremove,raidstatus,raidverify
raidrebuild

1.

1. 1.IntheCLI,execute

Thiscommandshouldnotgenerateanyverboseoutput.
2.Execute
Thestatusofport0shouldchangetoNOTPRESENT.
3.Removethebaddiskandinsertanewdisk.
4.Execute
5.Run
InthestatusoutputunderArray,youwillseetwoentries:0and1:
ArrayStatusSizeType

SNWLCLI>
Thisfunctionwillrebuildadrivewithintheraidarray.Withnoarguments,itwilldisplaythe
rebuildstatusandscheduledjobs.With<

Arguments
<
<

Type

Defaults

RelatedCommands
ExampleUseCase

https://support.software.dell.com/kb/sw6916

5/25

11/18/2015

ExampleUseCase

SonicWALLCDPCLICommandReferenceGuide(PDF)(SW6916)

Problem
SNWLCLI>

Controller:2
Manufacturer:3ware
Model:9650SE4LPML
Serial:L222008A8110095
Firmware:FE9X4.06.00.004
Driver:2.26.08.0042.6.23
ArrayStatusSizeType

0DEGRADED2249961567683RAID5
PortStatusSizeModelSerial

0UNKNOWNN/AN/AN/A
1OK750156374016WDCWD7502ABYS01A6B0WDWMATW0008111
2OK750156374016WDCWD7502ABYS01A6B0WDWMATW0015222
3OK750156374016WDCWD7502ABYS01A6B0WDWMATW0008333
SNWLCLI>

ControllerArray0

2DEGRADED
::ASonicWALLCDPappliancehasadegradedRAIDarrayanddisplaysthefollowing
information:raidinforaidstatus
Solution

1.

1.

https://support.software.dell.com/kb/sw6916

6/25

11/18/2015

1.

1.

SonicWALLCDPCLICommandReferenceGuide(PDF)(SW6916)

6.Execute
Youwillseethefollowingorsimilaroutput:
ControllerArray0

20%
7.Run
ThestatusofthearraywillshowasREBUILDING.

:RebuildtheRAIDdriveinthearraywithvalidarguments,byperformingthefollowingsteps:
raidremove20,wherethecontrollernumberis2andthedriveportis0.raidinfotocheckthe
status.raidadd.raidinfotocheckthestatus.
0DEGRADED2249961567683RAID5
1OK750147176759SPARE

raidremove

raidrebuild20drive0,torebuildarray0.raidinfotocheckstatusafterstartingtherebuild.
SNWLCLI>
ThisfunctionremovesadefectivedrivefromtheRAIDarray.Ittakesthenameofthedrive
toberemovedasanargument.

NOTE

Arguments
<controller>:
<port>:removesthespecifiedport

Type

https://support.software.dell.com/kb/sw6916

7/25

11/18/2015

SonicWALLCDPCLICommandReferenceGuide(PDF)(SW6916)

Defaults
RelatedCommands:

raidstatus

raidremove<controller>,<port>:Theraidremovecommandmustbeexecutedbeforethe
baddiskisremoved.Otherwise,therewillbeanerroroutput.::Executable:noneraidadd,
raidinfo,raidrebuild,raidstatus,raidverify
SNWLCLI>

ThisfunctionprintsoutinformationaboutthestatusoftheRAIDarrays.
raidstatus
Arguments

Type

Defaults

RelatedCommands

raidverify

:none:Executable:none:raidadd,raidinfo,raidrebuild,raidremove,raidverify
SNWLCLI>
ThisfunctionwillverifytheRAIDarray.Withnoarguments,itwilldisplaytheverification
statusandscheduledjobs.Schedulingverifyingoperationsisrecommendedastheycan
takealongtime.SonicWALLrecommendsallowingafullnightforRAIDverification.

Arguments

<
https://support.software.dell.com/kb/sw6916

8/25

11/18/2015

<

SonicWALLCDPCLICommandReferenceGuide(PDF)(SW6916)

<job>

9
raidverify[{start|stop}c<controller>.a<array>=<m:h:D|now>|remove<job>]:m:h:D>:
scheduleisexpressedaseither"now"orm:h:Dwheremistheminute,histhehour,andD
isthedayofweek06where0isSunday,and*inanyfieldmeans"everytime":rebuildjob
toberemoved

Type

Defaults
RelatedCommands:

reboot

start:schedulesverificationstartstop:schedulesverificationstopremove:removesverification
job:Executable:displaysverificationstatusandscheduledjobsraidadd,raidinfo,
raidrebuild,raidrebuild,raidstatus
SNWLCLI>

Thisfunctionwillreboottheappliance.
reboot
Arguments

Type

Defaults

restart
https://support.software.dell.com/kb/sw6916

9/25

11/18/2015

SonicWALLCDPCLICommandReferenceGuide(PDF)(SW6916)

:none:Executable:none
SNWLCLI>
Thisfunctionrestartsrunningservices.Ittakesaservicenameasanargument.

Arguments
<service>:servicetorestart

Type

Defaults
RelatedCommands:

route

restart<appservices|postgresql|stunnel|webui>::Executable:nonestop,restart
SNWLCLI>
Thisfunctionactslikeasystemvariable.Withnoargument,itwilldisplayroutes.Itcanadd
routesifprovidedwithaninterfacenameoragatewayIP,orremoveanexistingroute.Use
thiscommandtotroubleshootroutingproblems.

Arguments
<
<
<

Type

Defaults

ExampleUseCase
https://support.software.dell.com/kb/sw6916

10/25

11/18/2015

ExampleUseCase

SonicWALLCDPCLICommandReferenceGuide(PDF)(SW6916)

Problem

Solution
SNWLCLI>

10
route<add<target>destination<destination>|remove<index>>:target>:anIPaddress,
netasIP/CIDR,ordefaulttobeaddedasatargettothenewroutedestination>:an
interfacenameoragatewayIPindex>:indexnumberoftheroutetoberemoved:
Executable:Currentroutes::YouwanttoreplacethegatewayIPforyournetwork,
andaddarouteforit.:Executethefollowingcommand,wherethenewgatewayIP
addressis10.10.100.1:routeadd0.0.0.0/0destination10.10.100.1
snmp

SNWLCLI>

ThisvariableholdstheSNMPstatus.Thecurrentvaluewillbedisplayedifthe
commandisusedwithoutanargument.
snmp<on|off>
Arguments
<on>:enablesSNMP
<off>:disablesSNMP

Type

Defaults

sshd

::SystemVariable:Currentconfiguration
SNWLCLI>

https://support.software.dell.com/kb/sw6916

11/25

11/18/2015

SonicWALLCDPCLICommandReferenceGuide(PDF)(SW6916)

Thisvariableholdsthesshdstatus.Thecurrentvaluewillbedisplayedifthe
commandisusedwithouttheargument.
sshd<on|off>
Arguments
<on>:enablessshd
<off>:disablessshd

Type

Defaults

start

::SystemVariable:on
SNWLCLI>

Thisfunctionstartsservices.Ittakesaservicenameasanargument.Thelistof
servicesisapplicationspecific.
start<appservices|postgresq|stunnel|webui>
Arguments
<

Type

Defaults

RelatedCommands

stop

:service>:servicetostart:Executable:none:stop,restart
SNWLCLI>
https://support.software.dell.com/kb/sw6916

12/25

11/18/2015

SNWLCLI>

SonicWALLCDPCLICommandReferenceGuide(PDF)(SW6916)

Thisfunctionstopsrunningservices.Ittakesaservicenameasanargument.The
listofservicesisapplicationspecific.
stop<appservices|postgresq|stunnel|webui>
Arguments

11

:
<

Type

Defaults

RelatedCommands

telnet

service>:servicetostop:Executable:none:start,restart
SNWLCLI>
Thisfunctionsjustliketheinteractivenetworkcommunicationprogramwiththe
samename.Ittakesahostandaportasarguments.Usethistooltoestablish
connectivityissueswithaSMTPserver.ItisalsousefultocheckifoutboundSMTP
rulesonafirewallarewellconfigured

Arguments
<
<

Type

Defaults

https://support.software.dell.com/kb/sw6916

13/25

11/18/2015

SonicWALLCDPCLICommandReferenceGuide(PDF)(SW6916)

Defaults

time

telnet<host>[<port>]:host>:hostnameoftelnettargetport>:portnumber:
Executable:none
SNWLCLI>
Thisfunctioncontrolsthedate,time,andthetimezone.

Arguments
<

<MM>:
<DD>:day
<hh>:hours

<mm
<

Type

Defaults

tsr

time[<YYYY/MM/DDhh:mm>][TZ<timezone>]:YYYY>:yearmonth>:minutes
timezone>:timezone:SystemVariable:Currentconfiguration
SNWLCLI>

Thisfunctionoutputsaninternalsystemstatereport.Itdoesnottakeany
arguments.
tsr
https://support.software.dell.com/kb/sw6916

14/25

11/18/2015

tsr

SonicWALLCDPCLICommandReferenceGuide(PDF)(SW6916)

Arguments

Type

Defaults

12
:none:Executable:none
tzlist

Lastupdated:6/17/09
PN23200162850RevA
SNWLCLI>

Thisfunctionoutputsalistofallavailabletimezones.
tzlist
Arguments

Type

Defaults

:none:Executable:noneraidrebuild<controller><array>[drive<drive>]controller>
and<array>arguments,itrebuildsthearrayusinganoptionalspecifieddriveorthefirst
availablesparedrive.Schedulingrebuildingoperationsisrecommendedasrebuildingan
arraycantakealongtime.SonicWALLrecommendsallowingafullnightfortherebuilding
process.:controller>,<array>:rebuildsusinganoptionalspecifieddriveorafirstavailable
sparedrive>:driveusedtorebuildthearray:Executable:none:raidadd,raidinfo,
raidremove,raidstatus,raidverify

iostat

interfaceeth0

https://support.software.dell.com/kb/sw6916

15/25

11/18/2015

interfaceeth0

SonicWALLCDPCLICommandReferenceGuide(PDF)(SW6916)

The SNWLCLI> prompt is displayed.

4. Type the following command to determine the IP address of the appliance:
SNWLCLI>

CDP SonicWALL CDP CLI Command Reference CLI Commands

ThisdocumentdescribeseachSonicWALLCDPCommandLineInterface(CLI)command.Thereare
twotypesofcommands:executablesandsystemvariables.Typinginasystemvariablebyitselfwill
returnthecurrentvalueofthevariable.Toupdateavariable,typeitinfollowedwithapropervalue.
Someexecutablecommandstakeanargument,butmostdonot.
date

SNWLCLI>

Thisvariablecontrolsthedateontheappliance.
date
Arguments

Type

Defaults

RelatedCommands

dig

SNWLCLI>
Thisisthestandard

https://support.software.dell.com/kb/sw6916

16/25

11/18/2015

SonicWALLCDPCLICommandReferenceGuide(PDF)(SW6916)

1.

1. ConnectivitytoDNSserver

2. Outboundemailsbeingqueued

3. DNSdoesnotresolveintoanIPaddresstoconnect

Arguments
qclass:oneofin,hs,ch
qtype:oneofa,any,mx,ns,soa,hinfo,axfr,txt(Useixfr=versionfortypeixfr)
qoptisoneof:
xdotnotation:shortcutforinaddrlookups
i:IP6.INTreverseIPv6lookups
ffilename:batchmode
baddress[#port]:bindtosourceaddress/port
pport:specifyportnumber
ttype:specifyquerytype
cclass:specifyqueryclass
kkeyfile:specifytsigkeyfile
ynamekey:specifynamedbase64tsigkey
4:useIPv4querytransportonly
6:useIPv6querytransportonly
doptisoftheform+keyword[=value],wherekeywordis:

https://support.software.dell.com/kb/sw6916

17/25

11/18/2015

SonicWALLCDPCLICommandReferenceGuide(PDF)(SW6916)

doptisoftheform+keyword[=value],wherekeywordis:
+[no]vc:TCPmode
+[no]tcp:TCPmode,alternatesyntax
+time=###:Setquerytimeout[5]
+tries=###:SetnumberofUDPattempts[3]
+retry=###:SetnumberofUDPretries[2]
+domain=###:Setdefaultdomainname
+bufsize=###:SetEDNS0MaxUDPpacketsize
+ndots=###:SetNDOTSvalue

2
+[no]search:Setwhethertousesearchlist
+[no]defname:Ditto
+[no]recurse:Recursivemode
+[no]ignore:Don'treverttoTCPforTCresponses
+[no]fail:Don'ttrynextserveronSERVFAIL
+[no]besteffort:Trytoparseevenillegalmessages
+[no]aaonly:SetAAflaginquery(+[no]aaflag)
+[no]adflag:SetADflaginquery
+[no]cdflag:SetCDflaginquery
+[no]cl:Controldisplayofclassinrecords
+[no]cmd:Controldisplayofcommandline
+[no]comments:Controldisplayofcommentlines
+[no]question:Controldisplayofquestion
+[no]answer:Controldisplayofanswer
+[no]authority:Controldisplayofauthority
+[no]additional:Controldisplayofadditional
+[no]stats:Controldisplayofstatistics

+[no]short:Disableeverythingexceptshortformofanswer
+[no]ttlid:Controldisplayofttlsinrecords
https://support.software.dell.com/kb/sw6916

18/25

11/18/2015

SonicWALLCDPCLICommandReferenceGuide(PDF)(SW6916)

+[no]all:Setorclearalldisplayflags
+[no]qr:Printquestionbeforesending
+[no]nssearch:Searchallauthoritativenameservers
+[no]identify:IDrespondersinshortanswers
+[no]trace:Tracedelegationdownfromroot
+[no]dnssec:RequestDNSSECrecords
+[no]multiline:Printrecordsinanexpandedformat
Type

Defaults
qclass:in
qtype:a

dns

SNWLCLI>
ThisvariablecontrolstheDNSconfigurationsettingsonanappliance.Calledwithnoarguments
itwillreturnthecurrentconfiguration.

Arguments
<
<

Type

Defaults

drives

SNWLCLI>

https://support.software.dell.com/kb/sw6916

19/25

11/18/2015

SonicWALLCDPCLICommandReferenceGuide(PDF)(SW6916)

Thisfunctionoutputsalistofdrivesregisteredwiththesystem.Threetypesofdrivesare:
drives

1.

1. System:Defaultdatastoragewithoperatingsysteminstalledonit

2. Internal:Additionalinternaldevice

3. Temporary:Temporaryexternaldevice,suchasaUSBdrive

Arguments

3
Type

Defaults

RelatedCommands

exit

SNWLCLI>

ThisfunctionwillexitoutoftheCLI.
exit

https://support.software.dell.com/kb/sw6916

20/25

11/18/2015

SonicWALLCDPCLICommandReferenceGuide(PDF)(SW6916)

exit
Arguments

Type

Defaults

fetchurl

SNWLCLI>
ThisfunctionsendsanHTTPrequestanddumpsittostandardoutput.

Arguments
<
q:quiet
S:dumpheaderinadditiontoresponsebody

Type

Defaults

get

SNWLCLI>
Thisfunctionwillretrieveconfigurationparameters.

Arguments

Type

Defaults

https://support.software.dell.com/kb/sw6916

21/25

11/18/2015

SonicWALLCDPCLICommandReferenceGuide(PDF)(SW6916)

gms

SNWLCLI>
ThisvariablestorestheintervaltimebetweenSonicWALLGMSheartbeatmessages.Heartbeat
messagesallowSonicWALLGMStomonitortheSonicWALLCDPappliance.

Arguments
<
<server>:

Type

Defaults

4
help

SNWLCLI>
ThisfunctionwillprinthelpmessagesdescribingavailablecommandsfromtheCLI.Callingit
withnoargumentswillprintoutalistofavailablecommands.Itcantakeacommandnameasan
argumentandwillprintoutmoredetailedexplanationofthegivencommand.

Arguments
<

Type

Defaults

hostname
https://support.software.dell.com/kb/sw6916

22/25

11/18/2015

SonicWALLCDPCLICommandReferenceGuide(PDF)(SW6916)

SNWLCLI>

Thisfunctionwilldisplayorsetcurrenthostname.Callingitwithnoargumentwilldisplaythe
currenthostname.
hostname<fqdn>
Arguments
<

Type

Defaults

interface

SNWLCLI>
Thisvariablecontrolstheconfigurationofinterfaces.Withnoarguments,itwillreturnthe
configurationofallavailableinterfaces.Passingitaninterfacenameasanargumentwillreturn
alldatarelatedtothegiveninterface.PassingitaninterfacenameandanIPaddresswill
overwritethecurrentconfigurationoftheinterface.

Arguments
<
<
<
<

Type

Defaults

Example
https://support.software.dell.com/kb/sw6916

23/25

11/18/2015

SonicWALLCDPCLICommandReferenceGuide(PDF)(SW6916)

SNWLCLI>interfaceeth0192.168.168.169/24
SNWLCLI>interfaceeth0192.168.168.169255.255.255.0

ExampleUseCase

Problem

Solution

interface<ifname<ip/bits|ipnetmask>>:ifname>:nameofinterfacetobeconfiguredip>:new
IPaddresstobeassignedtointerfacebits>:bitratetobeassignedtointerfacenetmask>:
netmasktobeassignedtointerface:SystemVariable:currentconfiguration:::Youhavelost
thepasswordandIPaddressforyourSonicWALLCDPappliance.:First,resetthepasswordto
thedefault,andthendeterminetheIPaddressoftheSonicWALLCDPappliance.ConnectaUSB
keyboardandmonitortoyourSonicWALLCDPapplianceandperformthefollowingsteps::
fqdn>:fullyqualifieddomainname:Executable:snwl.example.comhelp<command>:
command>:nameofavalidCLIcommand:Executable:allavailablecommandsgms<interval>
[<server>]:interval>:timeinsecondsbetweenSonicWALLGMSheartbeatmessages,setto0
todisable:SystemVariable:noneget<arg>[arg]:[arg]:Validargumentsthatcanberetrieved:
ntp,ntpservers,syslogservers,tz:Executable:nonefetchurl[q]<URL>:URL>:TheURLbeing
requested.:Executable:none:none:Executable:none:SystemVariable:none:time :nonedns[
nameserver<ip>]...[search<domain>]...:ip>:IPaddresstobeassignedtotheserverdomain>:Domain
nametobesearchedfor:SystemVariable:qclass:Executable:
global dopts and servers (before host name) affect all queries.
local dopts and servers (after host name) affect only that lookup.
:dig[@globalserver][domain][qtype][qclass]{qopt}{globaldopt}host[@localserver]{localdopt}[
host[@localserver]{localdopt}]digcommandfromthebindtoolspackage.Usethiscommandto
troubleshootDNSrelatedissues,suchas::none:SystemVariable:none:time

The output will look similar to the following example:

eth0: 192.168.181.10 255.255.0.0
Media: Autodetected
https://support.software.dell.com/kb/sw6916

24/25

11/18/2015

SonicWALLCDPCLICommandReferenceGuide(PDF)(SW6916)

where 192.168.181.10 is the current IP address and 255.255.0.0 is the current subnet mask for the
SonicWALL CDP default network adaptor.
5. If that IP address is not routable in your network (for example, it was set incorrectly or with a typo
during setup), you can change the IP address on a laptop or another computer to an IP address on the
same (incorrect) subnet, allowing you to gain access to the SonicWALL CDP web management interface
to change the CDP IP address. Be sure to reset your laptop IP address to its previous setting after
updating the IP address on the SonicWALL CDP.

https://support.software.dell.com/kb/sw6916

25/25