Cisco 2960 X Owners Manual

							PurposeCommand or Action
Expressionsarecasesensitive.Forexample,ifyouenter
|excludeoutput,thelinesthatcontainoutputarenot
displayed,butthelinesthatcontainoutputappear.Example:Switch#showinterfaces|includeprotocolVlan1isup,lineprotocolisupVlan10isup,lineprotocolisdownGigabitEthernet1/0/1isup,lineprotocolisdownGigabitEthernet1/0/2isup,lineprotocolisup
Accessing the CLI through a Console Connection or through Telnet
BeforeyoucanaccesstheCLI,youmustconnectaterminaloraPCtotheswitchconsoleorconnectaPCto
theEthernetmanagementportandthenpowerontheswitch,asdescribedinthehardwareinstallationguide
thatshippedwithyourswitch.
Ifyourswitchisalreadyconfigured,youcanaccesstheCLIthroughalocalconsoleconnectionorthrougha
remoteTelnetsession,butyourswitchmustfirstbeconfiguredforthistypeofaccess.
Youcanuseoneofthesemethodstoestablishaconnectionwiththeswitch:
•Connecttheswitchconsoleporttoamanagementstationordial-upmodem,orconnecttheEthernet
managementporttoaPC.ForinformationaboutconnectingtotheconsoleorEthernetmanagement
port,seetheswitchhardwareinstallationguide.
•UseanyTelnetTCP/IPorencryptedSecureShell(SSH)packagefromaremotemanagementstation.
TheswitchmusthavenetworkconnectivitywiththeTelnetorSSHclient,andtheswitchmusthavean
enablesecretpasswordconfigured.
•Theswitchsupportsupto16simultaneousTelnetsessions.ChangesmadebyoneTelnetuserare
reflectedinallotherTelnetsessions.
•TheswitchsupportsuptofivesimultaneoussecureSSHsessions.
Afteryouconnectthroughtheconsoleport,throughtheEthernetmanagementport,throughaTelnet
sessionorthroughanSSHsession,theuserEXECpromptappearsonthemanagementstation.
Catalyst 2960-X Switch Network Management Configuration Guide, Cisco IOS Release 15.0(2)EX    
   OL-29044-0111
Using the Command-Line Interface
Accessing the CLI through a Console Connection or through Telnet 
						

							   Catalyst 2960-X Switch Network Management Configuration Guide, Cisco IOS Release 15.0(2)EX
12OL-29044-01  
Using the Command-Line Interface
Accessing the CLI through a Console Connection or through Telnet 
						

							CHAPTER 2
Configuring Cisco IOS Configuration Engine
ThischapterdescribeshowtoconfiguretheCiscoIOSConfigurationEngine.
•FindingFeatureInformation,page13
•PrerequisitesforConfiguringtheConfigurationEngine,page13
•RestrictionsforConfiguringtheConfigurationEngine,page14
•InformationAboutConfiguringtheConfigurationEngine,page14
•HowtoConfiguretheConfigurationEngine,page20
•MonitoringCNSConfigurations,page31
•AdditionalReferences,page32
•FeatureHistoryandInformationfortheConfigurationEngine,page32
Finding Feature Information
Yoursoftwarereleasemaynotsupportallthefeaturesdocumentedinthismodule.Forthelatestfeature
informationandcaveats,seethereleasenotesforyourplatformandsoftwarerelease.
UseCiscoFeatureNavigatortofindinformationaboutplatformsupportandCiscosoftwareimagesupport.
ToaccessCiscoFeatureNavigator,gotohttp://www.cisco.com/go/cfn.AnaccountonCisco.comisnot
required.
Prerequisites for Configuring the Configuration Engine
•Obtainthenameoftheconfigurationengineinstancetowhichyouareconnecting.
•BecausetheCNSusesboththeeventbusandtheconfigurationservertoprovideconfigurationsto
devices,youmustdefinebothConfigIDandDeviceIDforeachconfiguredswitch.
•Allswitchesconfiguredwiththecnsconfigpartialglobalconfigurationcommandmustaccessthe
eventbus.TheDeviceID,asoriginatedontheswitch,mustmatchtheDeviceIDofthecorresponding
switchdefinitionintheCiscoConfigurationEngine.Youmustknowthehostnameoftheeventbusto
whichyouareconnecting.
Catalyst 2960-X Switch Network Management Configuration Guide, Cisco IOS Release 15.0(2)EX    
    OL-29044-0113 
						

							Related Topics
CiscoNetworkingServicesIDsandDeviceHostnames,onpage16
DeviceID,onpage17
Restrictions for Configuring the Configuration Engine
•Withinthescopeofasingleinstanceoftheconfigurationserver,notwoconfiguredswitchescanshare
thesamevalueforConfigID.
•Withinthescopeofasingleinstanceoftheeventbus,notwoconfiguredswitchescansharethesame
valueforDeviceID.
Related Topics
CiscoNetworkingServicesIDsandDeviceHostnames,onpage16
Information About Configuring the Configuration Engine
Cisco Configuration Engine Software
TheCiscoConfigurationEngineisnetworkmanagementutilitysoftwarethatactsasaconfigurationservice
forautomatingthedeploymentandmanagementofnetworkdevicesandservices.EachCiscoConfiguration
EnginemanagesagroupofCiscodevices(switchesandrouters)andtheservicesthattheydeliver,storing
theirconfigurationsanddeliveringthemasneeded.TheCiscoConfigurationEngineautomatesinitial
configurationsandconfigurationupdatesbygeneratingdevice-specificconfigurationchanges,sendingthem
tothedevice,executingtheconfigurationchange,andloggingtheresults.
TheCiscoConfigurationEnginesupportsstandaloneandservermodesandhastheseCiscoNetworking
Services(CNS)components:
•Configurationservice:
◦Webserver
◦Filemanager
◦Namespacemappingserver
•Eventservice(eventgateway)
•Dataservicedirectory(datamodelsandschema)
   Catalyst 2960-X Switch Network Management Configuration Guide, Cisco IOS Release 15.0(2)EX
14OL-29044-01  
Configuring Cisco IOS Configuration Engine
Restrictions for Configuring the Configuration Engine 
						

							Instandalonemode,theCiscoConfigurationEnginesupportsanembeddeddirectoryservice.Inthismode,
noexternaldirectoryorotherdatastoreisrequired.Inservermode,theCiscoConfigurationEnginesupports
theuseofauser-definedexternaldirectory.
Figure 1: Cisco Configuration Engine Architectural Overview
Configuration Service
TheConfigurationServiceisthecorecomponentoftheCiscoConfigurationEngine.Itconsistsofa
ConfigurationServerthatworkswithCiscoIOSCNSagentsontheswitch.TheConfigurationServicedelivers
deviceandserviceconfigurationstotheswitchforinitialconfigurationandmassreconfigurationbylogical
groups.SwitchesreceivetheirinitialconfigurationfromtheConfigurationServicewhentheystartuponthe
networkforthefirsttime.
TheConfigurationServiceusestheCNSEventServicetosendandreceiveconfigurationchangeeventsand
tosendsuccessandfailurenotifications.
TheConfigurationServerisawebserverthatusesconfigurationtemplatesandthedevice-specificconfiguration
informationstoredintheembedded(standalonemode)orremote(servermode)directory.
ConfigurationtemplatesaretextfilescontainingstaticconfigurationinformationintheformofCLIcommands.
Inthetemplates,variablesarespecifiedbyusingLightweightDirectoryAccessProtocol(LDAP)URLsthat
referencethedevice-specificconfigurationinformationstoredinadirectory.
TheCiscoIOSagentcanperformasyntaxcheckonreceivedconfigurationfilesandpublisheventstoshow
thesuccessorfailureofthesyntaxcheck.Theconfigurationagentcaneitherapplyconfigurationsimmediately
ordelaytheapplicationuntilreceiptofasynchronizationeventfromtheconfigurationserver.
Catalyst 2960-X Switch Network Management Configuration Guide, Cisco IOS Release 15.0(2)EX    
   OL-29044-0115
Configuring Cisco IOS Configuration Engine
Configuration Service 
						

							Event Service
TheCiscoConfigurationEngineusestheEventServiceforreceiptandgenerationofconfigurationevents.
TheEventServiceconsistsofaneventagentandaneventgateway.Theeventagentisontheswitchand
facilitatesthecommunicationbetweentheswitchandtheeventgatewayontheCiscoConfigurationEngine.
TheEventServiceisahighlycapablepublish-and-subscribecommunicationmethod.TheEventServiceuses
subject-basedaddressingtosendmessagestotheirdestinations.Subject-basedaddressingconventionsdefine
asimple,uniformnamespaceformessagesandtheirdestinations.
Related Topics
EnablingtheCNSEventAgent,onpage20
NameSpace Mapper
TheCiscoConfigurationEngineincludestheNameSpaceMapper(NSM)thatprovidesalookupservicefor
managinglogicalgroupsofdevicesbasedonapplication,deviceorgroupID,andevent.
CiscoIOSdevicesrecognizeonlyeventsubject-namesthatmatchthoseconfiguredinCiscoIOSsoftware;
forexample,cisco.cns.config.load.Youcanusethenamespacemappingservicetodesignateeventsbyusing
anydesirednamingconvention.Whenyouhavepopulatedyourdatastorewithyoursubjectnames,NSM
changesyoureventsubject-namestringstothoseknownbyCiscoIOS.
Forasubscriber,whengivenauniquedeviceIDandevent,thenamespacemappingservicereturnsasetof
eventstowhichtosubscribe.Similarly,forapublisher,whengivenauniquegroupID,deviceID,andevent,
themappingservicereturnsasetofeventsonwhichtopublish.
Cisco Networking Services IDs and Device Hostnames
TheCiscoConfigurationEngineassumesthatauniqueidentifierisassociatedwitheachconfiguredswitch.
Thisuniqueidentifiercantakeonmultiplesynonyms,whereeachsynonymisuniquewithinaparticular
namespace.Theeventserviceusesnamespacecontentforsubject-basedaddressingofmessages.
TheCiscoConfigurationEngineintersectstwonamespaces,onefortheeventbusandtheotherforthe
configurationserver.Withinthescopeoftheconfigurationservernamespace,thetermConfigIDistheunique
identifierforadevice.Withinthescopeoftheeventbusnamespace,thetermDeviceIDistheCNSunique
identifierforadevice.
Related Topics
PrerequisitesforConfiguringtheConfigurationEngine,onpage13
RestrictionsforConfiguringtheConfigurationEngine,onpage14
ConfigID
EachconfiguredswitchhasauniqueConfigID,whichservesasthekeyintotheCiscoConfigurationEngine
directoryforthecorrespondingsetofswitchCLIattributes.TheConfigIDdefinedontheswitchmustmatch
theConfigIDforthecorrespondingswitchdefinitionontheCiscoConfigurationEngine.
   Catalyst 2960-X Switch Network Management Configuration Guide, Cisco IOS Release 15.0(2)EX
16OL-29044-01  
Configuring Cisco IOS Configuration Engine
Event Service 
						

							TheConfigIDisfixedatstartuptimeandcannotbechangeduntilthedevicerestarts,eveniftheswitch
hostnameisreconfigured.
DeviceID
EachconfiguredswitchparticipatingontheeventbushasauniqueDeviceID,whichisanalogoustotheswitch
sourceaddresssothattheswitchcanbetargetedasaspecificdestinationonthebus.
TheoriginoftheDeviceIDisdefinedbytheCiscoIOShostnameoftheswitch.However,theDeviceID
variableanditsusageresidewithintheeventgatewayadjacenttotheswitch.
ThelogicalCiscoIOSterminationpointontheeventbusisembeddedintheeventgateway,whichinturn
functionsasaproxyonbehalfoftheswitch.Theeventgatewayrepresentstheswitchanditscorresponding
DeviceIDtotheeventbus.
Theswitchdeclaresitshostnametotheeventgatewayimmediatelyafterthesuccessfulconnectiontothe
eventgateway.TheeventgatewaycouplestheDeviceIDvaluetotheCiscoIOShostnameeachtimethis
connectionisestablished.TheeventgatewayretainsthisDeviceIDvalueforthedurationofitsconnectionto
theswitch.
Related Topics
PrerequisitesforConfiguringtheConfigurationEngine,onpage13
Hostname and DeviceID
TheDeviceIDisfixedatthetimeoftheconnectiontotheeventgatewayanddoesnotchangeevenwhenthe
switchhostnameisreconfigured.
Whenchangingtheswitchhostnameontheswitch,theonlywaytorefreshtheDeviceIDistobreakthe
connectionbetweentheswitchandtheeventgateway.ForinstructionsonrefreshingDeviceIDs,see"Related
Topics."
Whentheconnectionisreestablished,theswitchsendsitsmodifiedhostnametotheeventgateway.Theevent
gatewayredefinestheDeviceIDtothenewvalue.
WhenusingtheCiscoConfigurationEngineuserinterface,youmustfirstsettheDeviceIDfieldtothe
hostnamevaluethattheswitchacquiresafter,notbefore,andyoumustreinitializetheconfigurationfor
yourCiscoIOSCNSagent.Otherwise,subsequentpartialconfigurationcommandoperationsmay
malfunction.
Caution
Related Topics
RefreshingDeviceIDs,onpage28
Hostname, DeviceID, and ConfigID
Instandalonemode,whenahostnamevalueissetforaswitch,theconfigurationserverusesthehostnameas
theDeviceIDwhenaneventissentonhostname.Ifthehostnamehasnotbeenset,theeventissentonthe
cn=ofthedevice.
Catalyst 2960-X Switch Network Management Configuration Guide, Cisco IOS Release 15.0(2)EX    
   OL-29044-0117
Configuring Cisco IOS Configuration Engine
Cisco Networking Services IDs and Device Hostnames 
						

							Inservermode,thehostnameisnotused.Inthismode,theuniqueDeviceIDattributeisalwaysusedfor
sendinganeventonthebus.Ifthisattributeisnotset,youcannotupdatetheswitch.
Theseandotherassociatedattributes(tagvaluepairs)aresetwhenyourunSetupontheCiscoConfiguration
Engine.
Cisco IOS CNS Agents
TheCNSeventagentfeatureallowstheswitchtopublishandsubscribetoeventsontheeventbusandworks
withtheCiscoIOSCNSagent.Theseagents,embeddedintheswitchCiscoIOSsoftware,allowtheswitch
tobeconnectedandautomaticallyconfigured.
Initial Configuration
Whentheswitchfirstcomesup,itattemptstogetanIPaddressbybroadcastingaDynamicHostConfiguration
Protocol(DHCP)requestonthenetwork.AssumingthereisnoDHCPserveronthesubnet,thedistribution
switchactsasaDHCPrelayagentandforwardstherequesttotheDHCPserver.Uponreceivingtherequest,
theDHCPserverassignsanIPaddresstothenewswitchandincludestheTrivialFileTransferProtocol
(TFTP)serverInternetProtocol(IP)address,thepathtothebootstrapconfigurationfile,andthedefault
gatewayIPaddressinaunicastreplytotheDHCPrelayagent.TheDHCPrelayagentforwardsthereplyto
theswitch.
TheswitchautomaticallyconfigurestheassignedIPaddressoninterfaceVLAN1(thedefault)anddownloads
thebootstrapconfigurationfilefromtheTFTPserver.Uponsuccessfuldownloadofthebootstrapconfiguration
file,theswitchloadsthefileinitsrunningconfiguration.
TheCiscoIOSCNSagentsinitiatecommunicationwiththeConfigurationEnginebyusingtheappropriate
ConfigIDandEventID.TheConfigurationEnginemapstheConfigIDtoatemplateanddownloadsthefull
configurationfiletotheswitch.
Thefollowingfigureshowsasamplenetworkconfigurationforretrievingtheinitialbootstrapconfiguration
filebyusingDHCP-basedautoconfiguration.
Figure 2: Initial Configuration
Related Topics
AutomatedCNSConfiguration,onpage19
   Catalyst 2960-X Switch Network Management Configuration Guide, Cisco IOS Release 15.0(2)EX
18OL-29044-01  
Configuring Cisco IOS Configuration Engine
Cisco IOS CNS Agents 
						

							Incremental (Partial) Configuration
Afterthenetworkisrunning,newservicescanbeaddedbyusingtheCiscoIOSCNSagent.Incremental
(partial)configurationscanbesenttotheswitch.Theactualconfigurationcanbesentasaneventpayloadby
wayoftheeventgateway(pushoperation)orasasignaleventthattriggerstheswitchtoinitiateapulloperation.
Theswitchcancheckthesyntaxoftheconfigurationbeforeapplyingit.Ifthesyntaxiscorrect,theswitch
appliestheincrementalconfigurationandpublishesaneventthatsignalssuccesstotheconfigurationserver.
Iftheswitchdoesnotapplytheincrementalconfiguration,itpublishesaneventshowinganerrorstatus.When
theswitchhasappliedtheincrementalconfiguration,itcanwriteittononvolatilerandom-accessmemory
(NVRAM)orwaituntilsignaledtodoso.
Synchronized Configuration
Whentheswitchreceivesaconfiguration,itcandeferapplicationoftheconfigurationuponreceiptofa
write-signalevent.Thewrite-signaleventtellstheswitchnottosavetheupdatedconfigurationintoits
NVRAM.Theswitchusestheupdatedconfigurationasitsrunningconfiguration.Thisensuresthattheswitch
configurationissynchronizedwithothernetworkactivitiesbeforesavingtheconfigurationinNVRAMfor
useatthenextreboot.
Automated CNS Configuration
ToenableautomatedCNSconfigurationoftheswitch,youmustfirstcompletetheprerequisiteslistedinthis
topic.Whenyoucompletethem,powerontheswitch.Atthesetupprompt,donothing;theswitchbeginsthe
initialconfiguration.Whenthefullconfigurationfileisloadedonyourswitch,youdonotneedtodoanything
else.
Formoreinformationonwhathappensduringinitialconfiguration,see"RelatedTopics."
Table 4: Prerequisites for Enabling Automatic Configuration
Required ConfigurationDevice
Factorydefault(noconfigurationfile)Accessswitch
•IPhelperaddress
•EnableDHCPrelayagent1
•IProuting(ifusedasdefaultgateway)
Distributionswitch
•IPaddressassignment
•TFTPserverIPaddress
•PathtobootstrapconfigurationfileontheTFTP
server
•DefaultgatewayIPaddress
DHCPserver
Catalyst 2960-X Switch Network Management Configuration Guide, Cisco IOS Release 15.0(2)EX    
   OL-29044-0119
Configuring Cisco IOS Configuration Engine
Automated CNS Configuration 
						

							Required ConfigurationDevice
•Abootstrapconfigurationfilethatincludesthe
CNSconfigurationcommandsthatenablethe
switchtocommunicatewiththeConfiguration
Engine
•Theswitchconfiguredtouseeithertheswitch
MACaddressortheserialnumber(insteadof
thedefaulthostname)togeneratetheConfigID
andEventID
•TheCNSeventagentconfiguredtopushthe
configurationfiletotheswitch
TFTPserver
Oneormoretemplatesforeachtypeofdevice,with
theConfigIDofthedevicemappedtothetemplate.
CNSConfigurationEngine
1ADHCPRelayisneededonlywhentheDHCPServerisonadifferentsubnetfromtheclient.
Related Topics
InitialConfiguration,onpage18
How to Configure the Configuration Engine
Enabling the CNS Event Agent
YoumustenabletheCNSeventagentontheswitchbeforeyouenabletheCNSconfigurationagent.Note
BeginninginprivilegedEXECmode,followthesestepstoenabletheCNSeventagentontheswitch.
SUMMARY STEPS
1.configureterminal
2.cnsevent{hostname|ip-address}[port-number][[keepalivesecondsretry-count][failover-timeseconds
][reconnect-timetime]|backup]
3.end
   Catalyst 2960-X Switch Network Management Configuration Guide, Cisco IOS Release 15.0(2)EX
20OL-29044-01  
Configuring Cisco IOS Configuration Engine
How to Configure the Configuration Engine