Aruba Instant 6.4.4.4-4.2.3.0 Command-Line Interface

705 Pages·2016·2.31 MB·English

Aruba Instant
6.4.4.4-4.2.3.0
Command-Line Interface
e
d
i
u
G
e
c
n
e
r
e
f
e
R
Copyright
©Copyright2016HewlettPackardEnterpriseDevelopmentLP
Open Source Code
ThisproductincludescodelicensedundertheGNUGeneralPublicLicense,theGNULesserGeneralPublic
License,and/orcertainotheropensourcelicenses.Acompletemachine-readablecopyofthesourcecode
correspondingtosuchcodeisavailableuponrequest.Thisofferisvalidtoanyoneinreceiptofthisinformation
andshallexpirethreeyearsfollowingthedateofthefinaldistributionofthisproductversionbyHewlett-
PackardCompany.Toobtainsuchsourcecode,sendacheckormoneyorderintheamountofUS$10.00to:
Hewlett-PackardCompany
Attn:GeneralCounsel
3000HanoverStreet
PaloAlto,CA94304
USA
Pleasespecifytheproductandversionforwhichyouarerequestingsourcecode.Youmayalsorequestacopy
[email protected].
Revision02| March2016 ArubaInstant6.4.4.4-4.2.3.0 | CLI ReferenceGuide
Chapter 1
About this Guide
ThisdocumentdescribestheArubaInstantcommandsyntaxandprovidesthefollowinginformationforeach
command:
l CommandSyntax—Thecompletesyntaxofthecommand.
l Description—Abriefdescriptionofthecommand.
l Syntax—Adescriptionofthecommandparameters,theapplicablerangesanddefaultvalues,ifany.
l UsageGuidelines—Informationtohelpyouusethecommand,includingprerequisites,prohibitions,and
relatedcommands.
l Example—Anexampleofhowtousethecommand.
l CommandHistory—TheversionofInstantinwhichthecommandwasfirstintroduced.
l CommandInformation—Thistabledescribescommandmodesandplatformsforwhichthiscommandis
applicable.
Thecommandsarelistedinalphabeticalorder.
Intended Audience
ThisguideisintendedforcustomerswhoconfigureanduseArubaInstant.
Related Documents
Inadditiontothisdocument,theArubaInstantproductdocumentationincludesthefollowing:
l ArubaInstantAccessPointInstallationGuides
l ArubaInstantQuickStartGuide
l ArubaInstantUserGuide
l ArubaInstantMIBReferenceGuide
l ArubaInstantSyslogMessagesReferenceGuide
l ArubaInstantReleaseNotes
ArubaInstant6.4.4.4-4.2.3.0 |CLI ReferenceGuide AboutthisGuide | 3
Conventions
Thefollowingconventionsareusedthroughoutthisdocumenttoemphasizeimportantconcepts:
Table1:TypographicalConventions
Type Style Description
Italics Thisstyleisusedforemphasizingimportanttermsandto
markthetitlesofbooks.
Boldface Thisstyleisusedforcommandnamesandparameter
optionswhenmentionedinthetext.
Commands Thisfixed-widthfontdepictscommandsyntaxandexamples
ofcommandsandcommandoutput.
<angle brackets> Inthecommandsyntax,textwithinanglebracketsrepresents
itemsthatyoushouldreplacewithinformationappropriateto
yourspecificsituation.
Forexample,ping<ipaddr>
Inthisexample,youwouldtype“ping”atthesystemprompt
exactlyasshown,followedbytheIPaddressofthesystemto
whichICMPechopacketsaretobesent.Donottypethe
anglebrackets.
[square brackets] Inthecommandsyntax,itemsenclosedinbracketsare
optional.Donottypethebrackets.
{Item_A|Item_B} Inthecommandexamples,singleitemswithincurledbraces
andseparatedbyaverticalbarrepresenttheavailable
choices.Enteronlyonechoice.Donottypethebracesor
bars.
{ap-name <ap-name>}|{ipaddr <ip- Twoitemswithincurledbracesindicatethatbothparameters
addr>}
mustbeenteredtogether.Iftwoormoresetsofcurled
bracesareseparatedbyaverticalbar,likeintheexampleto
theleft,enteronlyonechoice.Donottypethebracesorbars.
Thefollowinginformationaliconsareusedthroughoutthisguide:
Indicateshelpfulsuggestions,pertinentinformation,andimportantthingstoremember.
Indicatesariskofdamagetoyourhardwareorlossofdata.
Indicatesariskofpersonalinjuryordeath.
4| AboutthisGuide ArubaInstant6.4.4.4-4.2.3.0 |CLIReferenceGuide
Contacting Support
Table2:SupportInformation
MainSite arubanetworks.com
SupportSite support.arubanetworks.com
AirheadsSocialForumsand community.arubanetworks.com
KnowledgeBase
NorthAmericanTelephone 1-800-943-4526(TollFree)
1-408-754-1200
InternationalTelephones arubanetworks.com/support-services/aruba-support-
program/contact-support/
SoftwareLicensingSite licensing.arubanetworks.com/login.php
SecurityIncident Site:arubanetworks.com/support-services/security-bulletins/
ResponseTeam(SIRT)
Email:[email protected]
Americas,EMEA,andAPAC arubanetworks.com/support-services/contact-support/
ArubaInstant6.4.4.4-4.2.3.0 |CLI ReferenceGuide AboutthisGuide | 5
What is New in This Release
ThissectionliststhenewandmodifiedcommandsinInstant6.4.4.4-4.2.3.0.
New Commands
Thefollowingcommandsareintroducedinthisrelease.
Table3:NewCommands
Command Description
lacp-mode SupportsthestaticLACPconfiguration.
ble EnablesBluetoothLowEnergy(BLE)beaconmanagementbytheBeaconManagement
ConsoleandallowsyoutoconfigureBLEoperationmodes.
per-ap-ssid<essid> Setstheenvironmentvariable,per_ap_ssidinapboot.
per-ap-vlan<vlans> Setstheenvironmentvariable,per_ap_vlaninapboot.
showapdebugble- DisplaysBLEconfigurationdetails.
config
showapdebugble- DisplaysBLEconnectiondetails.
connect
showapdebugble- DisplaysBLEdaemonlogmessages.
daemon
showapdebugble- DisplaysBLErelayprocesslogs.
relay
showapdebugble- DisplaysbeacondetailsfortheBLEdevicesdetectedbytheIAP.
table
showble-config DisplaysBLEconfigurationdetails.
ap1x Configures802.1XauthenticationtypeontheIAP.
ap1x-peap-user ConfiguresIAPasan802.1Xsupplicantforauthenticatingagainstthesecuredwiredports.
out-of-service-hold- Configurestheholdtimeintervalfortriggeringout-of-serviceoperation.
on-time
showap1x Displaysthe802.1Xsupplicantconfigurationdetails.
showap1xcert DisplaysthedetailsoftheserverandCA certificatesusedforvalidatingauthentication
servertowhichIAPauthenticatesasa802.1Xsupplicant.
url-visibility ThiscommandenablesURL visibilityontheIAP,extractsthefullURLinformationfromthe
httpandhttpssessionsandsendsthemtoALE.
6| AboutthisGuide ArubaInstant6.4.4.4-4.2.3.0 |CLIReferenceGuide
Table3:NewCommands
Command Description
showurl-visibility Thiscommanddisplaystheurlvisibilitystatusoftheoutstandingusersessionsandthe
clientURLsthatareyettobeforwardedtotheALEserver.
dynamic-dns-ap ThiscommanddynamicallyupdatestheDNS recordsoftheIAPanditsclientsonthe
server.
dynamic-dns-interval ThiscommandconfiguresatimeintervalduringwhichtheDNS updatesareperiodically
addedtotheDNS server.
dynamic-dns ThiscommandisexecutedintheprivilegedEXEC modeoftheCLIandperformsaone
timeupdateoftheDNS recordsontheserver.
showddns ThiscommanddisplaystheDDNS statusoftheclientsandthelistofDDNS clients.
a-max-clients Thiscommandsetsthemaximumnumberofclientsfora5GHzradiochannel.
g-max-clients Thiscommandsetsthemaximumnumberofclientsfora2.4GHzradiochannel.
Modified Commands
Thefollowingcommandsaremodifiedinthisrelease:
Table4:ModifiedCommands
Command Description
showap-env ThiscommanddisplaysthestaticLACPconfiguration.
copy ThiscommandnowallowsyoutocopytheserverandCA certificatesthatarerequired
for802.1XauthenticationfromanexternalFTP,TFTPorHTTPservertotheIAPdatabase.
download-cert ThiscommandnowallowsyoutodownloadserverandCA certificatesusedforthe
802.1XauthenticationfromtheIAPtoanexternalFTP,TFTPorHTTPserver.
clear-cert ThiscommandnowallowsyoutoremovetheserverandCA certificatesuploadedfor
802.1XauthenticationfromtheIAP.
wlanssid-profile Thiscommandisenhancedtoincludeanewparameterout-of-servicethatallowsyouto
definetheSSID availabilitybasedontheout-of-servicestateoftheIAP.
ipdhcp Thiscommandnowallowsyouenabledynamicdnsupdatesforthepool.
showdpi-stats ThiscommandnowdisplaystheblockedURLsandwebcontentrelatedtraffic.
uplink Thiscommandnowincludesthefailover-internet-ipparameterthatallowsyouto
configureanIPaddresstowhichthemasterIAPscansendICMPpacketstocheckifthe
Internetisreachable.
ArubaInstant6.4.4.4-4.2.3.0 |CLI ReferenceGuide AboutthisGuide | 7
Table4:ModifiedCommands
Command Description
IDS Thiscommandnowincludesthewired-containment-ap-adjmacandwired-
containment-susp-l3-rogueparameterswhichenableswiredcontainmenttorogueAP,
andwhichenablesuserstoidentifyandcontainIAPthatisdifferentfromtheBSSIDofthe
IAPrespectively.
speedtest Anewparametercalledserver-porthasbeenincludedtoconfigureacustomportto
whichtheclientconnectstorunthespeedtest.
speedtest<server> Thisactioncommandhasbeenenhancedtoconfigureaserverporttowhichtheclient
connectstorunthespeedtest.
8| AboutthisGuide ArubaInstant6.4.4.4-4.2.3.0 |CLIReferenceGuide
Chapter 2
Instant CLI
InstantsupportstheuseofCommandLineInterface(CLI)forscriptingpurposes.YoucanaccesstheInstant
CLIthroughaSecureShell(SSH).
ToenabletheSSHaccesstotheInstantCLI:
1. FromtheInstantUI,navigatetoSystem>Showadvancedoptions.
2. SelectEnabledfromtheTerminalaccessdrop-downlist.
3. ClickOK.
Connecting to a CLI Session
OnconnectingtoaCLIsession,thesystemdisplaysitshostnamefollowedbytheloginprompt.Usethe
administratorcredentialstostartaCLIsession.Forexample:
(Instant AP)
User: admin
Password: *****
Iftheloginissuccessful,theprivilegedcommandmodeisenabledandacommandpromptisdisplayed.For
example:
(Instant AP)#
Theprivilegedmodeprovidesaccesstoshow,clear,ping,traceroute,andcommit commands.The
configurationcommandsareavailableintheconfiguration(config)mode.Tomovefromprivilegedmodeto
theconfigurationmode,enterthefollowingcommandatthecommandprompt:
(Instant AP)# configure terminal
Theconfigureterminalcommandallowsyoutoenterthebasicconfigurationmodeandthecommandprompt
isdisplayedasfollows:
(Instant AP)(config)#
TheInstantCLIallowsCLIscriptinginseveralothersub-commandmodestoallowtheuserstoconfigure
individualinterfaces,SSIDs,accessrules,andsecuritysettings.
Youcanusethequestionmark(?)toviewthecommandsavailableinaprivilegedmode,configurationmode,or
sub-mode.
Althoughautomaticcompletionissupportedforsomecommandssuchasconfigure terminal,the
completeexitandendcommandsmustbeenteredatcommandpromptforsuccessfulexecution.
Applying Configuration Changes
EachcommandprocessedbytheVirtualControllerisappliedonalltheslaveIAPsinacluster.Whenyoumake
configurationchangesonamasterIAPintheCLI,allassociatedIAPsintheclusterinheritthesechangesand
subsequentlyupdatetheirconfigurations.ThechangesconfiguredinaCLIsessionaresavedintheCLIcontext.
TheCLIdoesnotsupporttheconfigurationdataexceedingthe4KbuffersizeinaCLIsession:therefore,Aruba
recommendsthatyouconfigurefewerchangesatatimeandapplythechangesatregularintervals.
Toapplyandsavetheconfigurationchangesatregularintervals,usethefollowingcommandintheprivileged
mode:
(Instant AP)# commit apply
ArubaInstant6.4.4.4-4.2.3.0 |CLI ReferenceGuide InstantCLI | 9
Toapplytheconfigurationchangestothecluster,withoutsavingtheconfiguration,usethefollowing
commandintheprivilegedmode:
(Instant AP)# commit apply no-save
Toviewthechangesthatareyettobeapplied,usethefollowingcommandintheprivilegedmode:
(Instant AP)# show uncommitted-config
Toreverttotheearlierconfiguration,usethefollowingcommandintheprivilegedmode.
(Instant AP)# commit revert
Example:
(Instant AP)(config)# rf dot11a-radio-profile
(Instant AP)(RF dot11a Radio Profile)# beacon-interval 200
(Instant AP)(RF dot11a Radio Profile)# no legacy-mode
(Instant AP)(RF dot11a Radio Profile)# dot11h
(Instant AP)(RF dot11a Radio Profile)# interference-immunity 3
(Instant AP)(RF dot11a Radio Profile)# csa-count 2
(Instant AP)(RF dot11a Radio Profile)# spectrum-monitor
(Instant AP)(RF dot11a Radio Profile)# end
(Instant AP)# show uncommitted-config
rf dot11a-radio-profile
no legacy-mode
beacon-interval 200
no dot11h
interference-immunity 3
csa-count 1
no spectrum-monitor
Instant Access Point# commit apply
Configuration Sub-modes
Somecommandsinconfigurationmodeallowyoutoenterintoasub-modetoconfigurethecommands
specifictothatmode.Whenyouareinaconfigurationsub-mode,thecommandpromptchangestoindicate
thecurrentsub-mode.
Youcanexitasub-commandmodeandreturntothebasicconfigurationmodeortheprivilegedExec(enable)
modeatanytimebyexecutingtheexit orendcommand.
Deleting Configuration Settings
Usethenocommandtodeleteornegatepreviously-enteredconfigurationsorparameters.
l Toviewalistofnocommands,typenoatthepromptintherelevantmodeorsub-modefollowedbythe
questionmark.Forexample:
(Instant AP)(config) # no?
l Todeleteaconfiguration,usethenoformofaconfigurationcommand.Forexample,thefollowing
commandremovesaconfigureduserrole:
(Instant AP)(config) # no user <username>
l Tonegateaspecificconfiguredparameter,usethenoparameterwithinthecommand.Forexample,the
followingcommanddeletesthePPPoEuserconfigurationsettings:
(Instant AP)(config) # pppoe-uplink-profile
(Instant AP)(pppoe_uplink_profile)# no pppoe-username
10| InstantCLI ArubaInstant6.4.4.4-4.2.3.0 |CLIReferenceGuide