Smart Collector Embedded Assistant User Guide

Transcription

1 Smart Cllectr Embedded Assistant User Guide Sept. 16, 2010 Crprate Headquarters Cisc Systems, Inc. 170 West Tasman Drive San Jse, CA USA

2 Smart Cllectr Embedded Assistant User Guide Smart Cllectr Embedded Assistant Overview 4 Smart Cllectr Embedded Assistant Installatin 4 Brwse Fr Flder 7 Chse Shrtcut Flder 7 Smart Cllectr Embedded Assistant Operatinal Prerequisites 11 Prerequisite List (Netwrk and Devices) 11 Hw t Check fr Minimum Requirements 11 Launch the Smart Cllectr Embedded Assistant Applicatin 13 GUI 14 Parts f the GUI 14 Changing the Views 15 Hide/Unhide View by Gateway 15 Hide/Unhide View by Cllectr 16 Cnfigure the Smart Cllectr Embedded Assistant 17 Adding Devices 18 Imprt the Seed File 18 Add a Device Manually 21 Verify Gateways 22 Verify Gateway (Single) 23 Verify Gateways (Multiple) 24 Specify Glbal Settings 27 Assign a Gateway and Apply Scripts 25 Verify Cllectrs 27 Verify Cllectr Overview 30 Verify Cllectr Prcess 31 Verify Cllectr (Single) Verify Cllectr (Multiple) Assign a Cllectr 34 Assign an End Device 35 Assign a Single End Device t a Cllectr 35 Grup Device t Cllectr 37 Install a Cllectr 38 Cllectin 39 Manually Start a Cllectin 39 Schedule a Cllectin 42 Synchrnize 42 Other Gateway, Cllectr and End Device Functins 43 Gateway Push a Seed File 43 Edit Gateways, Cllectrs, End Devices 44 Edit a Gateway 44 Edit a Cllectr 45 Edit an End Device 45 Unassign an End Device, Cllectr, Gateway 46 Unassign an End Device 46 Unassign a Cllectr 47 Unassign a Gateway 49 Deleting a Device 50 11:27:08 AM Page 2 f 74

3 Smart Cllectr Embedded Assistant User Guide Switching Device Rles 51 Switch Gateway Rle t a Cllectr 51 Switch Cllectr Rle t a Gateway 52 Switch End Devices t a Different Cllectr 52 Lgs 53 Uninstalling 53 Uninstall Gateway and Cllectr Scripts 53 Uninstall Smart Cllectr Embedded Assistant 55 Uninstall Gateway and Cllectr Scripts 55 Uninstall Smart Cllectr Embedded Assistant Prgram 56 Uninstall Assistant Prcess 57 Help 60 Appendix 62 Trubleshting Guide fr Smart Cllectr Embedded Assistant Errrs 62 Device Cmmunicatin 62 Verify Gateway 62 Push Script 63 Verify Cllectr 63 Install Cllectr 63 Start Cllectin 63 FAQ s 63 Running Cnfig Inf fr Gateways and Cllectrs 65 Gateway Device 65 EEM Cnfiguratin Changes 65 Other Autmated Cnfiguratin Changes 66 Other Manual Cnfiguratin Changes 66 Files Cpied t Lcal Strage 66 EEM Plicies 67 EEM Library File 67 Cllectr Device 67 EEM Cnfiguratin Changes 67 Other Autmated Cnfiguratin Changes 67 Other Manual Cnfiguratin Changes 68 Files Cpied t Lcal Strage 68 EEM Plicies 68 EEM Library File 68 File Structures and EEM Envirnments 68 Gateway Device File Structure & EEM Envirnment Variables 68 Cllectr Device File Structure & EEM Envirnment Variables 71 Seed File Frmat and Cntents 73 Page 3 f 74 9/16/2010

4 Smart Cllectr Embedded Assistant User Guide Smart Cllectr Embedded Assistant Overview The Smart Cllectr Embedded Assistant lets the user verify gateway and cllectr prerequisites then apply ne f several device rles (gateway, cllectr and end device). This applicatin als lets yu apply the scripts and seed file t a gateway and start the cllectin prcess. This dcument prvides infrmatin n the fllwing areas: Smart Cllectr Embedded Assistant Installatin Smart Cllectr Embedded Assistant Prerequisites Launch the Smart Cllectr Embedded Assistant Applicatin Smart Cllectr Embedded Assistant Views Cnfigure the Smart Cllectr Embedded Assistant Cllectin Synchrnize Unassign Gateways, Cllectrs, End Devices Switching Device Rles Deleting a Device Uninstall Smart Cllectr Embedded Assistant Uninstall Gateway and Cllectr Scripts Smart Cllectr Embedded Assistant Installatin This sectin describes the steps that are invlved after the Smart Cllectr Embedded Assistant Sftware (executable binary with file name extensin exe) has already been dwnladed. Fr infrmatin abut hw t dwnlad the Smart Cllectr Embedded Assistant executable g t the Smart Cllectrs chapter f the Smart Prtal User Guide and review the Dwnlad the Smart Cllectr Embedded Assistant sectin. T install the Smart Cllectr Embedded Assistant, perfrm the fllwing steps: G t the lcatin yu previusly saved the Smart Cllectr Embedded Assistant.exe. Duble-click the Smart Cllectr Embedded Assistant.exe. r right-click the.exe file, then click Open; the InstallAnywhere windw appears. The InstallAnywhere windw displays the extractin prcess indicatr bar; the extractin prcess culd take several minutes. 11:27:08 AM Page 4 f 74

5 Smart Cllectr Embedded Assistant User Guide The Smart Cllectr Embedded Assistant flash windw appears quickly, and displays an install prgress bar at the bttm. The Intrductin windw appears, click Next; the Chse Install Flder pane appears. Page 5 f 74 9/16/2010

6 Smart Cllectr Embedded Assistant User Guide The custmer chses ne f the fllwing ptins: Clicking Chse lets yu take an intermediate step and pens the Brwse Fr Flder windw. Clicking Restre Default Flder, pens the Chse Shrtcut Flder pane and installs the Smart Cllectr Embedded Assistant at the default install lcatin identified in the lcatin field. TFTP prt must be available fr the install; if prt 69 is nt available then the fllwing errr will be seen. 11:27:08 AM Page 6 f 74

7 Smart Cllectr Embedded Assistant User Guide Brwse Fr Flder This windw lets yu specify a different install flder lcatin by perfrming the fllwing steps: Navigate t the lcatin where yu want the install flder t be lcated; yu may als create a new flder lcatin by clicking Make New Flder. After specifying the flder, click OK; the Chse Shrtcut Flder pane appears. Chse Shrtcut Flder Yu cme t the Chse Shrtcut Flder pane either directly frm previusly chsing the Restre Default Flder ptin, r indirectly by previusly chsing the Chse ptin. T cntinue the install, perfrm the fllwing steps: Page 7 f 74 9/16/2010

8 Smart Cllectr Embedded Assistant User Guide Specify where yu want prduct icns created. After specifying where t create the icns, click Next; the Pre-Installatin Summary pane appears. This pane infrms yu abut all the actins that were just perfrmed and what the results are. Click Install; the Installing Smart Cllectr Embedded Assistant pane appears. 11:27:08 AM Page 8 f 74

9 Smart Cllectr Embedded Assistant User Guide The install package starts installing the cde. The installatin shws the prgress and has tw parts t the install: The Smart Cllectr Embedded Assistant cde install (shwn abve) Installing AdbeAirRuntime (the fllwing windw briefly displays during the install) After Adbe AirRuntime is installed, the Smart Cllectr Embedded Assistant windw appears with the Install Cmplete pane. Page 9 f 74 9/16/2010

10 Smart Cllectr Embedded Assistant User Guide Click Dne t exit the installer prgram; the Please Wait pane appears while the Smart Cllectr Embedded Assistant applicatin is autmatically launched. See the next sectin fr instructins n hw t use the Smart Cllectr Embedded Assistant applicatin. 11:27:08 AM Page 10 f 74

11 Smart Cllectr Embedded Assistant User Guide Smart Cllectr Embedded Assistant Operatinal Prerequisites There are several areas cvered in the prerequisite sectin: Prerequisite List (Netwrk and Devices) Hw t Check fr Minimum Requirements Seed File Frmat and Cntents (appendix) Prerequisite List (Netwrk and Devices) The fllwing items are Smart Cllectr Embedded Assistant prerequisites fr the netwrk, gateway and cllectr devices: Click hyperlinks belw t see steps n hw t verify requirements. Gateway device must have the fllwing items EEM (Embedded Event Manager) versin 2.4 r later. PKI Supprt (a.k.a crypt r k9 image ). Ttal space needed fr nn-vlatile memry 250k plus 200k fr each device (e.g. if yu are cllecting frm 30 end devices, then apprximately 6 Mbytes are needed). ICMP ping shuld be enabled, shuld be able t cnnect t Cisc backend /repsitry (e.g. be able t ping ). There must be SCP capability between the gateway and the cllectr. DRAM size 256 Mbytes r larger. Cllectr devices must have the fllwing items: PC EEM (Embedded Event Manager) versin 2.4 r later. PKI Supprt (a.k.a crypt r k9 image ). Ttal space needed fr nn-vlatile memry 250k plus 200k fr each device (e.g. if yu are cllecting frm 30 end devices, then apprximately 6 Mbytes are needed). There must be SCP capability between the gateway and the cllectr. Windws XP based laptp r desktp (Windws emulatins currently nt tested), need t have capability t telnet and cpy files t the Gateway device (n firewall shuld be between the PC and the Gateway devices). The gateway and ne f the cllectrs may be n the same device. Each cllectr can cllect up t 10 ther devices. In rder fr Smart Cllectr Embedded Assistant t cmmunicate with the gateway device it is recmmended that yu disable any Firewall between the gateway and the device running the Smart Cllectr Embedded Assistant applicatin. Hw t Check fr Minimum Requirements The Smart Cllectr Embedded Assistant identifies candidate devices that are eligible t be gateways and cllectrs; hwever, if yu wuld like t check manually befre registering and dwnlading the Smart Cllectr Embedded Assistant, then perfrm the fllwing checks: Hw d I check fr the crrect EEM Versin? Lg int the device Page 11 f 74 9/16/2010

12 Smart Cllectr Embedded Assistant User Guide Run the shw event manager versin cmmand, the first line shws the EEM versin; versin shuld be 2.4 r later. Hw d I check PKI supprt? Lg int the device. Run the shw subsys inc ipsec_cmmn cmmand, lk fr ipsec_cmmn in the utput. If PKI is nt supprted, then chse anther device with a crypt image r upgrade IOS image. Hw d I check fr sufficient free lcal strage? Lg int the device. Run the shw file systems cmmand; lk fr the Free clumn fr a file system with sufficient space. Verify ICMP Check cnnectivity t the Cisc backend /repsitry (e.g. be able t ping ). Hw d I cnfigure SCP/SCP capability t cllectr: Use the external AAA server t cnfigure authenticatin & authrizatin and issue the fllwing cmmands. aaa new-mdel! aaa authenticatin lgin default lcal aaa authrizatin exec default lcal The SSH/SCP dmain name is used during encryptin; enter the fllwing cmmand: ip dmain name cisc.cm A username/passwrd is needed s that an external device can ssh r scp t this ruter. Cnfigure the usernames t the highest privilege level: username cust1 privilege 15 passwrd 0 test username cust2 privilege 15 passwrd 0 lab The SSH/SCP prtcls needs an rsa key-pair. Generate a key pair that can be used fr encrypting data that is sent using Selectin Criteria page; SSH is enabled with mdulus Issue the fllwing cmmand t generate an rsa key-pair: crypt key generate rsa Fr remving the keys issue crypt key zerize rsa Hw d I verify SCP capability t cllectr? After keys are generated they can be viewed by issuing the fllwing cmmand. shw crypt key mypubkey rsa Enable the SCP server capability n the ruter s the external device can send data using SCP t this SCP enabled ruter. Issue the fllwing cmmand: ip scp server enable Need t have 2 sets f vty lines cnfigured: line vty 0 4 line vty 5 15 exec-timeut 0 0 exec-timeut 0 0 privilege level 15 privilege level 15 passwrd lab transprt input all transprt utput all passwrd lab transprt input all transprt utput all Lg int the device and enter privileged mde 11:27:08 AM Page 12 f 74

13 Smart Cllectr Embedded Assistant User Guide Run the fllwing cmmand and verify that the cpy cmpletes successfully: cpy nvram:/startup-cnfig Launch the Smart Cllectr Embedded Assistant Applicatin T launch the Smart Cllectr Embedded Assistant applicatin g t the Start menu and chse All Prgrams > Smart Cllectr Embedded Assistant > Start Service, let the service start then chse Start > All Prgrams > Smart Cllectr Embedded Assistant > Assistant Launching the Smart Cllectr Embedded Assistant brings up the Smart Cllectr Embedded Assistant applicatin windw. Page 13 f 74 9/16/2010

14 Smart Cllectr Embedded Assistant User Guide GUI The Graphical User Interface (GUI) has several different aspects t it. This sectin cvers the fllwing items: What the different parts f the GUI are named. Hw t change the views n the GUI. Parts f the GUI The Smart Cllectr Embedded Assistant has names fr the different parts f the GUI. This sectin identifies the names f thse different parts f the GUI: Assistant Task Bar Tabs Pane View Device Manager Task Bar The fllwing items are parts f the GUI: The Assistant task bar has five different functinal items: Glbal Settings 11:27:08 AM Page 14 f 74

15 Smart Cllectr Embedded Assistant User Guide Imprt Seed file Start Cllectin Schedule Synchrnize There are tw different tabs, each f which has its wn assciated pane view: Device Manager tab has the Device Manager View pane (shwn abve) Lgs tab has the Lg View pane (shwn belw) There is a Device Manager task bar that has six functinal items: Add Device Verify Gateways Verify Cllectrs Install Cllectrs Grup Devices t a Cllectr Delete The Lgs tab has the Lgs View pane, which cntains tw different windws: Lg frm the Assistant windw. Lg frm the devices windw. Changing the Views There are several ways yu can change the view f the data represented in the GUI; thse different views are: Hide/Unhide view by Gateway Hide/Unhide view by Cllectr Hide/Unhide View by Gateway The Device Manager View pane prvides tw gateway views; shwing (unhide) all the assigned cllectrs, and shwing nly the gateway (hide). Page 15 f 74 9/16/2010

16 Smart Cllectr Embedded Assistant User Guide The triangle in the left clumn lets yu alternate the tw views. The dwnward pinting triangle displays the assigned cllectrs, clicking the triangle hides the assciated cllectrs. Hide/Unhide View by Cllectr The Device Manager View pane prvides tw cllectr views; shwing all the assigned end devices, and shwing nly the cllectr. Shwing all the assigned end devices and shwing nly the cllectr (hide). 11:27:08 AM Page 16 f 74

17 Smart Cllectr Embedded Assistant User Guide The triangle in the left clumn lets yu alternate the tw views. The dwnward pinting triangle displays the assigned end devices, clicking the triangle hides the assciated end devices. Cnfigure the Smart Cllectr Embedded Assistant After the prgram installatin cmpletes, the Smart Cllectr Embedded Assistant windw appears, n device data is available at this pint. By default the Device Manager View pane is displayed. Page 17 f 74 9/16/2010

18 Smart Cllectr Embedded Assistant User Guide There are several tasks that need t be perfrmed, in the sequence nted belw, when cnfiguring the Smart Cllectr Embedded Assistant: Imprt the Seed File r Add a Device Manually Verify Gateways Specify Glbal Settings Assign a Gateway and Apply Scripts Verify Cllectrs Assign a Cllectr Assign an End Device Install a Cllectr Start a Cllectin Adding Devices There are tw different ways t add devices (gateways, cllectrs, and end devices) t the Smart Cllectr Embedded Assistant: Imprt the Seed File Add a Device Manually Imprt the Seed File Device data can be imprted via a seed file; the seed file needs t be in a cmma separated value (CSV) frmat. If the user creates their wn seed file, then they will need t imprt it int the Smart Cllectr Embedded Assistant and have the Smart Cllectr Embedded Assistant push it t the gateway in rder t encde the fields in a manner that the embedded cllectr can decde. The imprt by the Smart Cllectr Embedded Assistant allws the credentials t be bfuscated prir t string n the gateway device. See Seed File Frmat and Cntents fr mre infrmatin abut seed file cntents and their frmatting requirements. 11:27:08 AM Page 18 f 74

19 Smart Cllectr Embedded Assistant User Guide T imprt a seed file perfrm the fllwing tasks: On the Smart Cllectr Embedded Assistant click the Imprt Seed File buttn; the Imprt Seed File windw appears. Click the Brwse buttn t designate the seed file lcatin; an Open windw appears where yu can specify the seed file yu want t use. Page 19 f 74 9/16/2010

20 Smart Cllectr Embedded Assistant User Guide After specifying the seed file, click Open; the Imprt Seed File windw appears again. Click Imprt; the Device Manager View pane appears with the devices the seed file ppulated n the windw. The next step is ne f the fllwing ptins: If additinal devices need t be added, then add a device manually If n additinal devices need t be added, then verify the gateways. The rle assignment fr Gateway and Cllectr can be dne nly thrugh the Smart Cllectr Embedded Assistant. 11:27:08 AM Page 20 f 74

21 Add a Device Manually Smart Cllectr Embedded Assistant User Guide If a seed file is nt available, r if devices (gateways, cllectrs, and end devices) need t be added, then devices can be added manually. T add a device, perfrm the fllwing steps: 1 On the Device Manager View pane click Add Device; the Add Device windw appears. There are three required fields that must be filled in (Hst Name, IP Address, and SNMP RO (passwrd)), they are dented by a red * (asterisk) next t the field names. Yu can ptinally enter data in the remaining fields. After entering the required/ptinal data, click Apply; a cnfirmatin windw appears. Click OK; the Add Device windw is ready fr anther device add. Page 21 f 74 9/16/2010

22 Smart Cllectr Embedded Assistant User Guide Primary / TACACS User Name is the first lgin fr the ruter. If TACACS is set up n the ruter, then the primary user and primary passwrd will be the TACACS username and passwrd respectively. If TACACS is nt set up n the ruter, then the user uses their nrmal lgin username and passwrd fr the ruter. If n ther devices need t be added, then click Cancel; the windw clses and the Device Manager View pane with the newly added device(s) (see graphic belw). T add mre devices, repeat the abve prcess, when finished adding devices click Cancel t clse the windw and return t the Device Manager View pane. Verify Gateways After the devices have been added, by either manually adding r by imprting a seed file, the devices are listed n the Device Manager View pane. 11:27:08 AM Page 22 f 74

23 Smart Cllectr Embedded Assistant User Guide Ntice the fllwing items: The Device Rles have nt been assigned. The gateways and cllectrs have nt been verified as being eligible yet. N scripts have been installed, r cllectins been perfrmed. The next step is t verify the gateways; the gateway verificatin invlves checking the fllwing items: Crypt image File system space EEM versin Cnnectivity t backend Use ne f the tw methds fr verifying the gateways: Verify Gateway (Single) Verify Gateways (Multiple) Yu must select at least ne device befre clicking Verify Gateways, r else yu will get the fllwing errr message. Verify Gateway (Single) T verify nly a single gateway, perfrm the fllwing steps: A 2 Click the assciated Click Here fr the device yu want t verify as a gateway; a cntext sensitive menu appears. On the cntext sensitive menu click Verify Gateway. Page 23 f 74 9/16/2010

24 Smart Cllectr Embedded Assistant User Guide After the gateway verificatin, nly the selected gateway is verified. which is nted by a green checkmark in the Gateway + Cllectr Eligibility clumn. Verify Gateways (Multiple) T verify mre than ne device at a time, as a pssible gateway, perfrm the fllwing steps: 1 A Select the Gateways yu want t verify, Click the Verify Gateways buttn; as the verificatin is perfrmed an in prcess icn is displayed sequentially in each selected item rw. When the verificatin is cmpleted, there will be a green checkmark, indicating the device is eligible t be a gateway, r a red X indicating the device is nt eligible t be a gateway. 11:27:08 AM Page 24 f 74

25 Smart Cllectr Embedded Assistant User Guide After the Smart Cllectr Embedded Assistant cmpletes the verificatin, the Eligible Gateway fields display checkmarks in thse areas fr which the devices are eligible as a gateway and red X s fr thse that are nt. When the gateway verificatin is perfrmed the fllwing prerequisite items are checked t verify the device is qualified t be a gateway: Disk Space Ttal space needed fr nn-vlatile memry 250k plus 100k fr each device. Shw Event Manager Versin Versin shuld be greater than r equal t 2.4. Shw Subsys inc crypt_ipsec_cmmn This verifies if the device has the crypt image r nt. Cnnectivity t Cisc backend. If yu click the green checkmark fr the eligible gateway r cllectr yu will see the fllwing infrmatin: Assign a Gateway and Apply Scripts The gateway is the interface fr passing inventry data between the cllectrs and the Cisc Backend. T assign a gateway and apply scripts, perfrm the fllwing steps: Page 25 f 74 9/16/2010

26 Smart Cllectr Embedded Assistant User Guide A 1 Click the assciated Click Here fr the device yu want t assign as a gateway; a cntext sensitive menu appears. On the cntext sensitive menu click Assign Gateway; the Push Script windw appears. A default flder lcatin fr the script file is laded in the Script file lcatin field, if yu want t use a different script file click Brwse and navigate t the new script file lcatin. Click Apply Scripts, the Smart Cllectr Embedded Assistant pushes the gateway script files t the designated gateway. The Push Script windw changes, and indicates that the script is being pushed t the selected device. An in prgress indicatr is displayed; applying the script files t the gateway culd take several minutes. 11:27:08 AM Page 26 f 74

27 Smart Cllectr Embedded Assistant User Guide The Smart Cllectr Embedded Assistant pushes the scripts and perfrms EEM cnfiguratins in the gateway, in cnfiguratin mde, and als registers the EEM parameters f ID, Tken and inventry name in cnfiguratin mde. The EEM parameters were btained frm the Glbal Settings. 1 After assigning the gateway, the Device Manager View pane shws the fllwing changes: Under the Device Rle clumn, the selected device is assigned as a gateway and indicates the Gateway rle.. Under the Script Installed clumn, the gateway shws a green checkmark, and has an uninstall hyperlink, fr uninstalling the pushed script. If yu need t unassign the gateway, then click the UnAssign ptin ff the crrespnding Click Here cntext sensitive menu. If yu need t uninstall the scripts frm the gateway click the crrespnding uninstall hyperlink start the gateway uninstall prcess. t Specify Glbal Settings The glbal settings let yu specify imprtant infrmatin related t selecting an entitled cmpany (party), inventry name and descriptin, alng with registering the cllectr n the Cisc Backend. Befre specifying the Glbal Settings, yu must first assign a gateway rle t a device. Click Glbal Settings at the tp f the windw; the glbal settings windw appears. Page 27 f 74 9/16/2010

28 Smart Cllectr Embedded Assistant User Guide Fill in the required data fields; the data has the fllwing requirements: Enter the user id and passwrd. Prt numbers 514 and 69 are default numbers. Prt 69 needs t be available fr the Smart Cllectr Embedded Assistant TFTP server; there shuld be n ther syslg server r TFTP running n this cmputer. After entering the user id and passwrd data, click Get Party; an in prgress bar appears at the bttm f the windw. 11:27:08 AM Page 28 f 74

29 Smart Cllectr Embedded Assistant User Guide The inventry name is whatever name the custmer wants t call the inventry. Click Register; the TCL ID and Tken data are filled in when the Registratin is perfrmed. Click Apply; a cnfirmatin windw appears indicating the status f the change. Page 29 f 74 9/16/2010

30 Smart Cllectr Embedded Assistant User Guide Click OK; the windw is clsed and the Device Manager View pane becmes the primary windw again. The next step is t assign a gateway and apply the gateway scripts. Verify Cllectrs The verify cllectrs prcess is a script that is run frm the gateway; this sectin has tw parts: Verify Cllectr Overview Explains hw the verificatin prcess wrks. Verify Cllectr Prcess Cvers the steps that are perfrmed in the cllectr verificatin prcess. Verify Cllectr Overview The Verifycllectr.tcl script is run frm the Gateway, this is because we assume that the PC running the Smart Cllectr Embedded Assistant applicatin may nt be able t cmmunicate with all cllectrs, but the gateway must be able t. The fllwing infrmatin explains what the different parameters are in the verify cllectr script and hw they are used: If n arguments are prvided t the script, then all devices nminated as cllectrs in the seed file are checked fr prerequisites. If individual hstnames are prvided as arguments, then nly these devices are verified. if -all argument is specified, then all devices in the seed file (regardless f whether they have been nminated as ptential cllectrs) are verified If install argument is specified, then the cllectr EEM plicies are installed and cnfigured n thse devices that pass verificatin The all and install ptins are mutually exclusive (fr safety). If all is specified, then all ther arguments are ignred. This next sectin describes what the cllectr verificatin prcess des: First the embedded cllectr installatin n the gateway is checked, the gateway must have all the cllectr install files available. SSH cnnectivity frm gateway t cllectr is checked using seed file credentials; if successful, then the startup-cnfig is retrieved frm the nminated device via scp (this checks bth ssh and scp cnnectivity by default). The EEM versin is checked via shw event man versin cmmand n the nminated device. The number f devices that the nminated cllectr is t cllect is ttaled frm the seed file, and multiplied by 200k. Then a file system with enugh free space is checked via the shw file sys cmmand. If the abve steps pass, the cllectr device is verified. If the install ptin has been specified, then the script cntinues. This next sectin explains what steps are perfrmed during the script file installatin: The startup-cnfig, which was retrieved during the scp verificatin step abve, is pened and searched fr existing EEM plicy and library directries. If they exist, they are re-used; if nt, new directries are created n a file system cntaining enugh space fr the scripts. The EEM scheduler script thread default class number is checked. If it exists, and is set t ne, a failure syslg is generated indicated we require at least tw threads. If it desn t exist, the number is set t 10 by default. The vty cnfiguratin is checked; we add five t the thread number abve, and bump up the vty s if needed. The TCB_ROOT and TCB_ARCH directries are created t cntain the cllected data, and data archives respectively. 11:27:08 AM Page 30 f 74

31 Smart Cllectr Embedded Assistant User Guide Three EEM plicies are cpied t the cnfigured EEM user dir plicy directry Cisc_SNMP_Cllectr.tcl Cisc_Frwarder.tcl Cisc_CLI_Cllectr.tcl The fllwing library files are cpied t the cnfigured EEM user dir library directry Cisc_SNMP_Sup.tcl Cisc_debug.tcl Cisc_eemcli.tcl Cisc_ICF.tcl CIsc_ICF_Sup.tcl Cisc_seed_file.tcl Cisc_TCBIFF_Sup.tcl Cisc_md5.tcl Cisc_util.tcl tclindex The SNMP server-manager is checked, and cnfigured if nt The SNMP RO cmmunity string is checked t see if it matches the seed file, and cnfigured If nt Three EEM envirnment variables are cnfigured - _TCBIFF_ROOT, _SE_ARCHIVE_DIR, and easy_shell_debug The three EEM plicies abve are registered The mdified startup-cnfig is cpied back t the nminated device as the new running-cnfig and saved via wr mem Verify Cllectr Prcess After the gateway has been verified and assigned the next step is verifying the cllectr. Yu must assign the gateway befre verifying the cllectr, r else yu will get the fllwing message. Yu must have als perfrmed the registratin setup in the glbal settings befre perfrming the cllectr verificatin, r else yu will get the fllwing message. Use ne f the tw methds fr verifying the gateways: Verify Cllectr (Single) Verify Cllectr (Multiple) Page 31 f 74 9/16/2010

32 Smart Cllectr Embedded Assistant User Guide Verify Cllectr (Single) T verify nly a single cllectr, perfrm the fllwing steps: A 2 Select a device that yu want t verify as a pssible cllectr. Click the assciated Click Here fr the device yu want t verify as a cllectr; a cntext sensitive menu appears. On the cntext sensitive menu click Verify Cllectr; nly the selected cllectr is verified. If the device is eligible as a cllectr there will be a green checkmark, if nt there will be a red X. 11:27:08 AM Page 32 f 74

33 Smart Cllectr Embedded Assistant User Guide Verify Cllectr (Multiple) T verify mre than ne device at a time, as a pssible cllectr, perfrm the fllwing steps: 1 Select the devices yu want t verify as pssible cllectrs, then click Verify Cllectrs buttn; a verificatin prcess indicatr appears during the cllectr verificatin prcess fr each selected device. After the Smart Cllectr Embedded Assistant cmpletes the verificatin, the Eligible Gateway fields display a green checkmark fr thse devices that are eligible as a gateway, r a red X fr thse devices that are nt eligible as a cllectr. Page 33 f 74 9/16/2010

34 Smart Cllectr Embedded Assistant User Guide Assign a Cllectr The functin f a cllectr is t g ut and gather the inventry infrmatin frm its assigned end devices, and then send the cllected inventry data t the Cisc Backend via the assigned gateway. T assign a cllectr perfrm the fllwing tasks: Click the assciated Click Here fr the device yu want t assign as a cllectr; a cntext sensitive menu appears. On the cntext sensitive menu click Assign Cllectr. 11:27:08 AM Page 34 f 74

35 Smart Cllectr Embedded Assistant User Guide The Cllectr rle is assigned t the device and the cllectr is indented under the Gateway. The Script Installed clumn has a red X, which indicates that the cllectr scripts have nt been installed yet (see Install a Cllectr fr details n hw t install the cllectr scripts). If yu need t unassign the cllectr frm a gateway, then there is an UnAssign ptin ff the crrespnding Click Here cntext sensitive menu. Assign an End Device The end device(s) are the devices that have their inventry infrmatin cllected frm the cllectr, then sent t the Cisc Backend via the assigned gateway. There are tw ways t assign an end device: Assign a Single End Device t a Cllectr Grup Device t Cllectr T assign an end device perfrm ne f the abve ptins. Assign a Single End Device t a Cllectr T assigning a single end device t a cllectr, perfrm the fllwing steps: Click the assciated Click Here fr the device yu want t assign t the cllectr as an end device. Page 35 f 74 9/16/2010

36 Smart Cllectr Embedded Assistant User Guide On the cntext sensitive menu click Assign End-Device; the Cllectr Selectin windw appears. In the Cllectr Selectin windw, frm the Cllectr drp-dwn list, chse the IP Address f the cllectr that yu want yur end devices assigned. Click Add, the Device Manager View windw updates the assignments. The end device that is assigned t the cllectr is indented under the assigned cllectr. If yu need t unassign the end device frm the cllectr there is an ptin ff the crrespnding Click Here cntext sensitive menu. 11:27:08 AM Page 36 f 74

37 Smart Cllectr Embedded Assistant User Guide Grup Device t Cllectr One methd fr assigning end devices t a cllectr is t select multiple end devices and assign them all tgether as a grup t a cllectr. T assign end devices as a grup t a cllectr, perfrm the fllwing steps: Select tw r mre end devices then click Grup Device t Cllectr; the Cllectr Selectin windw appears. In the Cllectr Selectin windw, frm the Cllectr drp-dwn list, chse the IP Address f the cllectr that yu want yur end devices assigned. Click Add, the Device Manager View windw updates the assignments. The end devices that were assigned t the cllectr are indented under the assigned cllectr. If yu need t unassign the end device frm the cllectr there is an ptin ff the crrespnding Click Here cntext sensitive menu. The next step in the prcess is t wrk with the cllectr; install a cllectr then start a cllectin. Page 37 f 74 9/16/2010

38 Install a Cllectr Smart Cllectr Embedded Assistant User Guide Cllectrs that have assigned end devices, frm which inventry data is cllected and then sent t the Cisc Backend via the cllectrs dedicated gateway. In rder fr an assigned cllectr t perate as a cllectr, specific script files must be laded/pushed t the device assigned as the cllectr. T install script files t a cllectr, perfrm the fllwing steps: The Script Installed clumn has a red X, which indicates that the cllectr scripts have nt been installed yet (a red X was placed there during the assign cllectr prcess). When the cllectr scripts have been installed the red X will be replaced by the green checkmark. On the Device Manager View pane click Install Cllectr; the Smart Cllectr Embedded Assistant pushes script files t the cllectr. While the Smart Cllectr Embedded Assistant pushes script files t the cllectr, there is an In Prgress indicatr being displayed. 11:27:08 AM Page 38 f 74

39 Smart Cllectr Embedded Assistant User Guide 1 2 The push files t the cllectr culd take several minutes. After the files have been pushed t the cllectr, a green checkmark is placed under the Script Installed clumn, n the cllectr rw. If yu need t unassign the cllectr click the UnAssign ptin ff the crrespnding Click Here cntext sensitive menu. If yu need t uninstall the scripts frm the gateway click the crrespnding uninstall hyperlink start the gateway uninstall prcess. The next step in the prcess is t perfrm a cllectin. t Cllectin A cllectin prcess cllects inventry data frm end devices that are assigned t the cllectr. The cllectin prcess allws a user t push cllectr updates, hst (end device) assciatins, and entire seed file t the gateway. The gateway s envirnment variable cnfiguratin will als be updated during the cllectin prcess. When a cllectin is perfrmed fr a large number f devices (e.g. 70 devices), please ensure that the debug level fr the gateway is set t 0, r 1 at the mst. When the debug level is higher than 1, the message utput increases significantly, which causes prblems fr Embedded Event Manager functinality in the ruter. As a result f the increased utput the gateway relads. The EC Assistant prvides a capability t mark all the devices at the same time, and then click a 'verify' buttn t determine which nes can becme Cllectrs. When the seed file is large (e.g. 50 devices), the cllectr verificatin shuld be dne in batches f 25 t 30 devices at a time. There are tw ways that a cllectin can be perfrmed: Manual cllectin start Scheduled cllectin Manually Start a Cllectin T start a cllectin, perfrm the fllwing steps: Page 39 f 74 9/16/2010

40 Smart Cllectr Embedded Assistant User Guide On the Smart Cllectr Embedded Assistant applicatin click Start Cllectin, which starts an ndemand cllectin; the Start Cllectin windw appears with a cnfirmatin that: The seed file was successfully pushed t the gateway. The cllectin was successfully started. Scheduled cllectin cannt be kicked ff withut first perfrming an initial n-demand cllectin by clicking Start Cllectin n the Smart Cllectr Embedded Assistant. Als it is gd t perfrm an n-demand cllectin if changes have been made t the seed file, s that a scheduled cllectin uses the mst up-t-date seed file. Either click Save Seed File, r click Clse. If yu click Save Seed File a Save As windw appears. This is a Sanitized Seed File; it is used by the gateway and cllectr fr their cllectins tasks and is pushed t the gateway. The seed file can als be saved n the laptp as an ptinal additinal step. Navigate t the flder where the seed file is lcated, chse the seed file r enter a seed file name, and click Save. 11:27:08 AM Page 40 f 74

41 Smart Cllectr Embedded Assistant User Guide When a cllectin is started, a cllectin status message appears at the bttm-right crner f the windw, indcating that the cllectin was started. Anther status message appears shrtly after the first, indicating that the cllectin is still in prgress (see graphic belw). When the cllectin is finished, anther status message appears indicating that the cllectin cmpleted, and when the cllectin cmpleted (see graphic belw). Page 41 f 74 9/16/2010

42 Smart Cllectr Embedded Assistant User Guide Schedule a Cllectin This is an autmatically scheduled cllectin, nce a mnth that des nt need the Assistant present t d the cllectin. T set the schedule fr when the cllectin will ccur, perfrm the fllwing steps: Click the Schedule tab; the Schedule Settings windw appears. The Schedule Settings windw lets yu set the day in the mnth, and what time that day the unassisted cllectin will ccur. Click the Day f mnth drp-dwn list t specify which day the cllectin will ccur. Click the Time f day drp-dwn list t specify which hur f the specified day the cllectin will ccur. Click Apply t set the specified day and cllectin time; a cnfirmatin windw appears indicating the schedule update was successful. Click OK; the Device Manage View pane appears. Synchrnize 11:27:08 AM Page 42 f 74

43 Smart Cllectr Embedded Assistant User Guide In real time, the client laptp, installed with the Smart Cllectr Embedded Assistant applicatin, gets a dynamic IP address assigned t it by the netwrk. T synchrnize this change and ther cnfiguratin changes frm the Assistant applicatin t the gateway device a Synchrnize actin is perfrmed. T perfrm a synchrnize, perfrm the fllwing steps: Click the Synchrnize buttn; a cnfirmatin windw appears indicating that the synchrnizatin was successful. Click OK; the view returns back t the Smart Cllectr Embedded Assistant windw. Other Gateway, Cllectr and End Device Functins Aside frm the cnfiguratin functins that have been perfrmed there are ther functins that a Gateway, Cllectr and End Device can perfrm; thse functins are: Gateway Push a Seed File Edit Gateways, Cllectrs, End Devices Unassign an End Device, Cllectr, Gateway Delete a Device Gateway Push a Seed File Befre the gateway can push a seed file, the assciated cllectr must have the script file installed (see install a cllectr), r else yu will get the fllwing message. T have a gateway push a seed file t a cllectr, perfrm the fllwing steps: Click the assciated Click Here fr the gateway, the cntext sensitive menu appears. Page 43 f 74 9/16/2010

44 Smart Cllectr Embedded Assistant User Guide Click PushSeedFile; the Push Seed File Status windw appears. The status windw will indicate a successful push if the seed file push was successful. Edit Gateways, Cllectrs, End Devices There are three types f devices that can be edited: Edit a Gateway Edit a Cllectr Edit an End Device Edit a Gateway Yu can mdify certain data fr a gateway. Perfrm the fllwing steps t edit a gateway: Click the assciated Click Here fr the gateway. Click Edit; the Update Device windw appears. Update any f the data in the fields that need t be changed. 11:27:08 AM Page 44 f 74

45 Smart Cllectr Embedded Assistant User Guide Click Apply; a cnfirmatin windw appears, indicating that the device was successfully updated. Click OK; the Device Manager View pane appears. Edit a Cllectr Yu can mdify certain data fr a cllectr. Perfrm the fllwing steps t edit a cllectr: Click the assciated Click Here fr the cllectr. Click Edit; the Update Device windw appears. Update any f the data in the fields that need t be changed. Click Apply; a cnfirmatin windw appears, indicating that the device was successfully updated. Click OK; the Device Manager View pane appears. Edit an End Device Page 45 f 74 9/16/2010

46 Smart Cllectr Embedded Assistant User Guide Yu can mdify certain data fr an end device. Perfrm the fllwing steps t edit an end device: Click the assciated Click Here fr the end device. Click Edit; the Update Device windw appears. Update any f the data in the fields that need t be changed. Click Apply; a cnfirmatin windw appears, indicating that the device was successfully updated. Click OK; the Device Manager View pane appears. Unassign an End Device, Cllectr, Gateway There are three types f devices that can be unassigned: Unassign an End Device Unassign a Cllectr Unassign a Gateway Unassign an End Device 11:27:08 AM Page 46 f 74

47 Smart Cllectr Embedded Assistant User Guide If there is mre than ne cllectr in the device list, yu culd re-assign an end device frm ne cllectr t anther cllectr. T perfrm the re-assign yu must first unassign the end device frm the current cllectr. Perfrm the fllwing steps t unassign an end device frm a cllectr: 1 2 Click the crrespnding end device Click Here, a cntext sensitive menu appears; In the cntext sensitive menu click Unassign; a Cnfirm windw appears. In the Cnfirm windw click Yes. After the end device is unassigned the unassigned device is n lnger indented under the previusly assigned cllectr. Unassign a Cllectr Page 47 f 74 9/16/2010

48 Smart Cllectr Embedded Assistant User Guide Befre unassigning the cllectr yu must first uninstall the script, r else yu will get the fllwing message. If scripts need t be uninstalled frm the gateways r cllectrs bth script remvals are perfrmed by the same uninstall prcess; there is n separate uninstall hyperlink fr the cllectr device n the Smart Cllectr Embedded Assistant. Click uninstall in the script installed clumn (see belw). A See Uninstall Gateway and Cllectr Scripts fr mre details abut uninstalling scripts. The uninstall functin will change the gateway and cllectr green checkmarks t a red X. Perfrm the fllwing steps t unassign a cllectr: 1 2 Click the crrespnding end device Click Here, a cntext sensitive menu appears; In the cntext sensitive menu click Unassign; a Cnfirm windw appears. In the Cnfirm windw click Yes. 11:27:08 AM Page 48 f 74

49 Smart Cllectr Embedded Assistant User Guide The Device Manager View pane shws the device rles fr the cllectr and assciated end devices as Nt assigned. The red X is als remved frm the script installed clumn f the Cllectr rw. Unassign a Gateway Befre unassigning the gateway yu must first uninstall the scripts r else yu will get use the fllwing message: Perfrm the fllwing steps t unassign a gateway: Click the crrespnding device s Click Here; a cntext sensitive menu appears. In the cntext sensitive menu click Unassign; a Cnfirm windw appears. In the Cnfirm windw click Yes. Page 49 f 74 9/16/2010

50 Smart Cllectr Embedded Assistant User Guide The Device Manager View pane shws all the device rles as Nt assigned. The red X and the install link are remved frm the Script Installed clumn. Deleting a Device A device can be deleted frm the list f devices displayed n Device Manager View pane. T delete a device frm Device Manager View pane, perfrm the fllwing steps: Click the crrespnding Click Here fr the device yu want t delete, a cntext sensitive menu appears. In the cntext sensitive menu click Delete; a Cnfirm windw appears. Click Yes; the device is remved frm the list. 11:27:08 AM Page 50 f 74

51 Smart Cllectr Embedded Assistant User Guide When deleting a gateway r cllectr yu must uninstall the script first, r else yu will get the fllwing message. Switching Device Rles If yu want t switch a device s rle (i.e. gateway t a cllectr, r a cllectr t a gateway) the current assigned rle cannt be changed directly t anther rle. T switch a device s rle, first the current rle (e.g. gateway) must be unassigned, and then the new rle (e.g. cllectr) can be assigned. Yu can perfrm the fllwing rle switches: Switch Gateway rle t a Cllectr Switch Cllectr rle t a Gateway Switch End Devices t a Different Cllectr Switch Gateway Rle t a Cllectr When yu Unassign a gateway device yu must select anther default gateway device fr the cllectr device(s) t be assigned t, and ther end devices beneath the cllectr. T switch a gateway t cllectr rle, perfrm the fllwing steps: Perfrm the Unassign a Gateway prcess: (click hyperlink fr mre details n this prcess) Unassign the Gateway device t a Nt assigned state by clicking the crrespnding gateway device s Click Here, in the Actins clumn, then click Unassign in the cntext sensitive menu. The Device Rle clumn shws Nt assigned fr every device in the list. Perfrm the remaining steps t assign a new gateway, cllectr and end devices. Perfrm the Assign a Gateway and Apply Scripts prcess: (click hyperlink fr mre details n this prcess) Select an alternate eligible Gateway, a device that has a green checkmark in the Gateway + Cllectr Eligibility clumn. Page 51 f 74 9/16/2010

52 Smart Cllectr Embedded Assistant User Guide Click the device s crrespnding Click Here, in the Actins clumn, then click Assign Gateway in the cntext sensitive menu; the Push Script windw appears. In the Push Script windw click Apply Script; a rle f Gateway is nted in the Device Rle clumn f the newly assigned gateway. Perfrm the Assign a Cllectr prcess: (click hyperlink fr mre details n this prcess) In the device list select an alternate eligible cllectr, a device that has a checkmark in the Cllectr Eligibility clumn. Click the device s crrespnding Click Here, in the Actins clumn, then click Assign Cllectr in the cntext sensitive menu; a windw appears asking if the default gateway is available. Click OK; the windw clses and the Device Manager View is the primary fcus again, a rle f Cllectr is nted in the Device Rle clumn f the newly assigned cllectr. Perfrm the Install Cllectrs prcess: (click hyperlink fr mre details n this prcess) On the Device Manager View pane click Install Cllectrs; the Smart Cllectr Embedded Assistant pushes script files t the cllectr. The push files t the cllectr culd take several minutes. After the files have been pushed t the cllectr, a green checkmark is placed under the Script Installed clumn, n the cllectr rw. Perfrm the Assign End Device prcess t assign the end device(s) t the new cllectr. Switch Cllectr Rle t a Gateway Only ne default gateway device is allwed, s yu must first unassign the current Gateway device s that the new gateway yu want t assign can be assigned. Unassigning the gateway changes all the device rles t Nt assigned ; therefre, yu must fllw the same steps perfrmed Switch Gateway Rle t a Cllectr: Perfrm the Unassign a Gateway prcess: (click hyperlink fr mre details n this prcess) Perfrm the Assign a Gateway and Apply Scripts prcess: (click hyperlink fr mre details n this prcess) Perfrm the Assign a Cllectr prcess: (click hyperlink fr mre details n this prcess) Perfrm the Install Cllectrs prcess: (click hyperlink fr mre details n this prcess) Perfrm the Assign End Device prcess t assign the end device(s) t the new cllectr. Switch End Devices t a Different Cllectr Any devices can be assigned as an end device. If yu want t assign an end device t a different cllectr, perfrm the fllwing steps: Perfrm the fllwing steps t unassign an end device frm a cllectr: On the end device yu want t change cllectrs, click the crrespnding Click Here; a cntext sensitive menu appears. In the cntext sensitive menu click Unassign; a Cnfirm windw appears. In the Cnfirm windw click Yes. After the end device is unassigned, the Device Rle clumn shws Nt assigned fr that device, als the unassigned device is n lnger indented under the previusly assigned cllectr. Perfrm the Assign End Device prcess t assign the end device(s) t a different cllectr. 11:27:08 AM Page 52 f 74

53 Lgs Smart Cllectr Embedded Assistant User Guide The Lg View pane prvides lgging infrmatin in tw lg windws, ne frm the Smart Cllectr Embedded Assistant the ther frm the Syslg. The Syslg inf is cntained in the Lg frm the devices windw; the syslg infrmatin is sent frm the gateway. 1 T see the infrmatin cntained in the lgs perfrm the fllwing steps: Click the Lgs buttn; the Lg View pane appears, with the tw different windws displaying their respective infrmatin. Click the Open Lg buttn t see additinal details abut the respective lg. Click the Refresh buttn t see the mst current data fr each respective screen. Uninstalling There are tw ways t d that. The partners and custmers can unregister the embedded cllectr when they perfrm Unassign f Gateway rle frm Smart Cllectr Embedded Assistant UI. If they are nt able t d that, the cisc emplyee can d it thrugh the Smart Prtal - Maintain Embedded Cllectr Page There are several different install prcesses: Uninstall Gateway and Cllectr Scripts Uninstall Smart Cllectr Embedded Assistant Prgram Uninstall Gateway and Cllectr Scripts If scripts need t be uninstalled frm the gateways and cllectrs bth script remvals are perfrmed by the same uninstall prcess; there is n separate uninstall hyperlink fr the cllectr device n the Smart Cllectr Embedded Assistant. The uninstall script prcess first uninstalls all the installed cllectr devices under the gateway device then the gateway device themselves are uninstalled. T uninstall the scripts that were previusly installed n the gateway and cllectr, perfrm the fllwing steps: Page 53 f 74 9/16/2010

54 Smart Cllectr Embedded Assistant User Guide 1 T uninstall the scripts frm the gateway and cllectr click the crrespnding uninstall t start the script uninstall prcess; a cnfirmatin windw appears. Click Yes; an In Prgress indicatr appears in the Script Installed clumn fr bth the gateway and cllectr. 11:27:08 AM Page 54 f 74

55 Smart Cllectr Embedded Assistant User Guide 2 3 After the uninstall is finished tw items change in the Gateway s Script Installed clumn: Fr bth the gateway and cllectr, the green checkmark changes t a red X. Fr the gateway the uninstall link changes t an install link. Uninstall Smart Cllectr Embedded Assistant There are tw different uninstall prcesses fr the Smart Cllectr Embedded Assistant: Uninstall Gateway and Cllectr Scripts Uninstall Smart Cllectr Embedded Assistant Prgram Uninstall Gateway and Cllectr Scripts The uninstall prcess in the Device Manager View pane remves the script files frm the crrespnding gateway/cllectr(s). T uninstall the gateway/cllectr script files, perfrm the fllwing steps: 1 On the Device Manager View pane click Uninstall. Page 55 f 74 9/16/2010

56 Smart Cllectr Embedded Assistant User Guide The Uninstall prcess starts and an In Prgress indicatr is displayed in the Script Installed clumn fr the gateway and cllectr. After uninstalling the gateway and cllectr scripts the previus green checkmarks are replaced with red X s and the uninstall link is replaced with an install link. Uninstall Smart Cllectr Embedded Assistant Prgram T uninstall the Smart Cllectr Embedded Assistant prgram perfrm the fllwing steps: Frm the Start menu chse Start > All Prgrams > Smart Cllectr Embedded Assistant > Uninstall Assistant The uninstall prcess starts (see next sectin). 11:27:08 AM Page 56 f 74

57 Uninstall Assistant Prcess Smart Cllectr Embedded Assistant User Guide The Uninstall prcess (initiated frm the start menu) brings yu t this next windw, and then ges thrugh the fllwing steps: The Smart Cllectr Embedded Assistant windw appears with a lading prgress bar, and then displays the Uninstall Smart Cllectr Embedded Assistant windw. The Uninstall Smart Cllectr Embedded Assistant pane prvides infrmatin abut what is ging t ccur. Click Next; the Uninstall Optins pane appears. Page 57 f 74 9/16/2010

58 Smart Cllectr Embedded Assistant User Guide Chse which uninstall ptin yu want perfrmed, and then click Next; the Uninstall Smart Cllectr Embedded Assistant pane appears. The uninstall prcess stps the Smart Cllectr Embedded Assistant, in rder t prceed with the uninstall. 11:27:08 AM Page 58 f 74

59 Smart Cllectr Embedded Assistant User Guide The Uninstall Smart Cllectr Embedded Assistant pane indicates what features are being remved and the prgress f the uninstall. Click the radi buttn chice yu want the uninstaller t perfrm, and then click Dne; the requested ptin is perfrmed. The fllwing will remain after un-installatin (when EEM was already in use prir t the embedded cllectr installatin): Page 59 f 74 9/16/2010

60 Smart Cllectr Embedded Assistant User Guide The EEM library and plicy directries (plicies in these directries will be remved, but the directries themselves will remain). The EEM scheduler thread class default cnfiguratin. If the vty number was increased as part f installatin, it will nt be decreased. If SNMP RO cmmunity string was added as part f installatin, it will remain. Help There is a Help sectin that cntains a lt f useful infrmatin. There are several sectins t the Help file, thse sectins are: Descriptin f the Smart Cllectr Embedded Assistant applicatin. List f Help tpics. Navigatin aids. T view different tpics perfrm the fllwing steps: 11:27:08 AM Page 60 f 74

61 Smart Cllectr Embedded Assistant User Guide Select a tpic; the page fr that tpic appears in the windw There are several pieces f infrmatin t be nted: The page number the tpic is displayed. The tpic names. Tpic cntent and ntes. Page 61 f 74 9/16/2010

62 Smart Cllectr Embedded Assistant User Guide Navigatinal aids: yu can navigate t anther area by clicking ne f the fllwing items: Previus ges t previus page (page 2). Next ges t next page (page 4). Back t Tp if there is mre data than can fit within the windw, a scrll bar appears n the right. The navigatinal aids will be at the bttm f the windw and clicking Back t Tp will mve the display t the tp f the windw. Clicking Back t Tp, when there is n scrll bar, des nt alter the display f data. G t Hme ges back t the initial page where all the tpics are listed. Appendix Additinal infrmatin related t Smart Cllectr Embedded Assistant peratin are nte in the fllwing items: Trubleshting Guide fr Smart Cllectr Embedded Assistant Errrs Running Cnfig Inf fr Gateways and Cllectrs Trubleshting Guide fr Smart Cllectr Embedded Assistant Errrs This sectin lists fixes fr thse areas listed belw: Device Cmmunicatin Verify Gateway Push script Verify Cllectr Install Cllectr Start Cllectin Device Cmmunicatin Here are sme items that can be checked if there are prblems with device cmmunicatin: Telnet will be tried first, if it fails, then SSH will be tried next. Manually check which prtcl is successful, if device cmmunicatin fails. There are numerus ways t cnfigure TACACS; the mst imprtant aspect f any slutin is that the credentials in the seed file have the apprpriate privilege, whether using lcal r centralized AAA. What happens if Smart Cllectr Embedded Assistant n lnger receives syslg messages frm the devices it interfaces? The IP address may have been changed n the machine when Smart Cllectr Embedded Assistant was actively running; change the IP address back t the riginal IP Address. Verify Gateway The fllwing items can be manually checked t verify infrmatin abut the gateway that interfaces with Smart Cllectr Embedded Assistant. Check Telnet/SSH wrks fine manually with credentials. Ensure that disk space is available by issuing the shw file systems cmmand. If a disk is selected, please check that yu are able t write/create a directry int that disk space. 11:27:08 AM Page 62 f 74

63 Smart Cllectr Embedded Assistant User Guide Verify that ICMP is enabled in the gateway and that the gateway can ping the Cisc backend. Verify that the EEM versin is => 2.4 r higher. Gateway shuld have IOS. Push Script The fllwing items can be manually checked t verify that the Push Script wrks prperly: Check windws firewall security, ensure it is turned ff. Check Telnet/SSH, ensure that it wrks fine manually, with credentials. Check if TFTP wrks fine by manually cpying a sample file frm Smart Cllectr Embedded Assistant t a device (i.e. verify that the TFTP prt is nt being used by anther service). TFTP pushing shuldn t take mre time; therwise, a timeut exceptin will ccur. Ensure that tar archive extractin is wrking fine. Ensure that all cnfiguratins are perfrmed in cnfig mde. Ensure that the certificate is installed crrectly. Verify Cllectr The fllwing items can be manually checked t verify cllectr requirements and peratin: Verify that Telnet/SSH wrks fine manually with credentials. Verify that the windws firewall security is turned ff. Check that the syslg is pinting t a Smart Cllectr Embedded Assistant (HD) IP address by checking the IOS lg cmmand (i.e. issue the shw running cnfig inc lg cmmand). Verify that the HD Syslg server is running, and that the syslg messages are directed t the Smart Cllectr Embedded Assistant. Please ensure that the seed file is pushed t the gateway, fr cllectr verificatin. Please ensure the hstname is given crrectly in the seed file; therwise, LWC will btain an errr that will nt be able t identify the gateway. Please check that the syslg message has COLLECTOR_VERIFICATION_PASSED fr <devicename> r COLLECTO.R_VERIFICATION_FAILED fr <devicename> is cming in the lg. Install Cllectr Perfrm all the steps given in the verify cllectr prcess, except the last step. Check the syslg fr ne f the fllwing messages: COLLECTOR_INSTALLATION_PASSED fr <devicename>. COLLECTOR_INSTALLATION_FAILED fr <devicename> is cming in the lg. Start Cllectin Perfrm all the steps given in the verify cllectr prcess, except the last step. FAQ s The fllwing are Frequently Asked Questins (FAQ s) fr the Smart Cllectr Embedded Assistant applicatin: What are the system requirements fr Smart Cllectr Embedded Assistant? 32 bit windws perating system (Windws XP is recmmended). Page 63 f 74 9/16/2010

64 Smart Cllectr Embedded Assistant User Guide 2 GB f RAM. 2 GB f recmmended free disk space fr installatin. What system resurces are required fr the Smart Cllectr Embedded Assistant? Smart Cllectr Embedded Assistant uses pre-defined r cnfigured prts n the machine fr its internal cmmunicatin. By default, prts #69 and #514 will be used by Smart Cllectr Embedded Assistant fr running the built-in TFTP and Syslg servers; hwever, these prts can be cnfigurable in the Smart Cllectr Embedded Assistant UI. See User guide n hw t cnfigure and define the prts fr Smart Cllectr Embedded Assistant. Hw d I check the EEM Versin? Lg int the device Issue the shw event manager versin cmmand Lk at the first line, which shws the EEM versin; the versin shuld be 2.4 r later. Hw d I check fr PKI supprt? Lg int the device. Issue the shw subsys inc ipsec_cmmn cmmand Lk fr ipsec_cmmn in the utput If PKI is nt supprted, chse anther device with a crypt image r upgrade the IOS image. Hw d I verify that there is sufficient free lcal strage? Lg int the device. Issue the shw file systems cmmand. Lk fr the Free clumn fr a file system with sufficient space. Hw d I check if there is secure cnnectivity between gateway and cllectrs? Lg int the device and enter privileged mde. Issue the cpy nvram:/startup-cnfig scp://user:passwd@<gateway_ip>/<gateway_file_system>/test.cfg cmmand Verify the cpy cmpletes successfully. Hw d I check the Memry - DRAM Size Expected DRAM fr Gateway as well as Cllectrs is 256 Mbytes r greater. Issue the shw versin include bytes f memry cmmand, which shws the available memry n a ruter. Issue the shw memry include Prcessr cmmand; the third clumn in the utput shws the amunt f free memry. What happens if ne r mre pre-defined prts n the machine are blcked? Smart Cllectr Embedded Assistant requires the pre-defined r cnfigured prts t be always available and shuld nt be blcked by the firewall r the OS. Smart Cllectr Embedded Assistant might nt be fully respnsive fr any blcking r unavailability f the pre-defined r cnfigured prts. Fr example, we can see an Indefinite prgress bar appears during the installatin f the Gateway scripts r accurate status f the cllectr installatin might nt be reflected r updated in Smart Cllectr Embedded Assistant user interface. What happens if the IP address f the machine is changed when Smart Cllectr Embedded Assistant is active and running? If the IP address is changed n the machine, which Smart Cllectr Embedded Assistant is actively running, then Smart Cllectr Embedded Assistant will n lnger able t receive syslg messages frm the devices it interfaces. Hw can I check the status f Smart Cllectr Embedded Assistant predefined r cnfigurable prt numbers? Open a new cmmand prmpt n the machine. 11:27:08 AM Page 64 f 74

65 Smart Cllectr Embedded Assistant User Guide The fllwing cmmand gives the status f the prt number 69. netstat -a find "69" Can I have an external TFTP and Syslg Servers installed n the machine? Yes, but it is always recmmended t nt install any third-party syslg, r tftp servers n the machine. Hw can I make sure n ther TFTP server is running n the machine? Befre installing r starting the Smart Cllectr Embedded Assistant, please check if default prt 69 (r cnfigured prt number) is free. Otherwise, please make sure yu free it r cnfigure an alternate free prt number in the Smart Cllectr Embedded Assistant. Fllw the fllwing steps t free up prt 69: 1. Frm the Start->Run cmd windw, issue the fllwing cmmand: C:\netstat na 2. Lk fr prt 69 using the cmmand - netstat na find :69 3. If the prt is in use, run the fllwing cmmand t get the executable name: TASKLIST find <PID matching prt 69 frm prev step 2> 4.Terminate r end the PID specific executable frm Task Manager Hw can I make sure n ther Syslg server is running n the machine? Befre installing r starting the Smart Cllectr Embedded Assistant, please check if default prt 514 (r cnfigured prt number) is free. Otherwise, please make sure yu free it r cnfigure an alternate free prt number in the Smart Cllectr Embedded Assistant. Ensure the prt is nt blcked by the firewall. Hw t check if the system prts are being blcked by the firewall? Nrmally, windws firewalls like MacAfee r any security agent might blck the prts. Please check the lgs f the security agent and un-blck the prt if any. Running Cnfig Inf fr Gateways and Cllectrs The fllwing items list all the pssible changes t the running cnfiguratins f devices that were identified as either gateways r cllectrs in the Smart Cllectr Embedded Assistant applicatin. Sme changes may nt be necessary if already cnfigured, e.g., EEM plicy r library directries. Gateway Device The fllwing items identify cnfiguratin changes that can ccur t gateway devices. EEM Cnfiguratin Changes event manager directry user plicy "<Plicy_Dir>" event manager directry user library "<Library_Dir>" event manager scheduler script thread class default number 10 event manager plicy Cisc_Scheduler.tcl event manager plicy Cisc_C_Cntrl.tcl event manager plicy Cisc_SNMP_Cllectr.tcl event manager plicy Cisc_CLI_Cllectr.tcl event manager plicy Cisc_Transprt.tcl event manager plicy Cisc_Verifycllectr.tcl event manager plicy Cisc_Uninstall_Cllectr.tcl event manager applet emb_cllectr event timer crn crn-entry "0 1 5 * *" actin ne plicy CIsc_Scheduler.tcl Page 65 f 74 9/16/2010

66 Smart Cllectr Embedded Assistant User Guide In additin t the abve cnfiguratins, the fllwing list f EEM envirnment variables may be cnfigured via the event manager envirnment <variable> <value> cnfiguratin Cisc IOS CLI. Variable _SE_SEED_FILE Descriptin URL t seed file _TC_ID _TC_TOKEN _INVENTORY_NAME _TCBIFF_ROOT TCL Cllectr ID frm registratin Security Tken frm registratin User defined string identifying this netwrk URL t stre cllected data _SE_ARCHIVE_DIR URL t stre tar archives _CISCO_REPOSITORY _SVCLOC _GW_CHASSIS_SN IP r FQDN f Cisc DMZ Service lcatin name where the tar file is sent via https Gateway Device s Serial Number Other Autmated Cnfiguratin Changes Other cnfig changes that are autmated are nted belw: Additinal vty lines may be required. The embedded cllectr runs multiple EEM plicies cncurrently. Each plicy that interacts with the Cisc IOS CLI will require a vty. SNMP server-manger will be cnfigured if nt already enabled SNMP RO cmmunity string will be cnfigured t match the seed file entry if required Other Manual Cnfiguratin Changes The fllwing changes may be needed fr secure gateway cllectr cmmunicatin: aaa new-mdel aaa authenticatin lgin default lcal aaa authrizatin exec default lcal ip dmain name <dmain> username cust1 privilege 15 passwrd 0 test (t match seed file credentials) crypt key generate rsa ip scp server enable line vty 0 <platfrm_max> transprt input <ssh all> Files Cpied t Lcal Strage Files that are cpied t lcal strage are nted belw: 11:27:08 AM Page 66 f 74

67 Smart Cllectr Embedded Assistant User Guide EEM Plicies Cisc_C_Cntrl.tcl CIsc_SNMP_Cllectr.tcl Cisc_Frwarder.tcl Cisc_CLI_Cllectr.tcl Cisc_Scheduler.tcl Cisc_Transprt.tcl Cisc_Uninstall_Cllectr.tcl Cisc_Verifycllectr.tcl EEM Library File Cisc_debug.tcl Cisc_eemcli.tcl Cisc_ICF_Sup.tcl Cisc_ICF.tcl Cisc_md5.tcl Cisc_seed_file.tcl Cisc_SNMP_Sup.tcl Cisc_TCBIFF_Sup.tcl tclindex Cisc_util.tcl Cllectr Device The fllwing items identify cnfiguratin changes that can ccur t cllectr devices. EEM Cnfiguratin Changes event manager directry user plicy "<Plicy_Dir>" event manager directry user library "<Library_Dir>" event manager scheduler script thread class default number 10 event manager plicy Cisc_SNMP_Cllectr.tcl event manager plicy Cisc_CLI_Cllectr.tcl event manager plicy Cisc_Frwarder.tcl In additin t the abve cnfiguratins, the fllwing list f EEM envirnment variables may be cnfigured via the event manager envirnment <variable> <value> cnfiguratin Cisc IOS CLI. Variable _TCBIFF_ROOT _SE_ARCHIVE_DIR Descriptin URL t stre cllected data URL t stre tar archives Other Autmated Cnfiguratin Changes Other cnfig changes that are autmated are nted belw: Additinal vty lines may be required. The embedded cllectr runs multiple EEM plicies cncurrently. Each plicy that interacts with the Cisc IOS CLI will require a vty. SNMP server-manger will be cnfigured if nt already enabled SNMP RO cmmunity string will be cnfigured t match the seed file entry if required Page 67 f 74 9/16/2010

68 Smart Cllectr Embedded Assistant User Guide Other Manual Cnfiguratin Changes The fllwing changes may be needed fr secure gateway cllectr cmmunicatin: aaa new-mdel aaa authenticatin lgin default lcal aaa authrizatin exec default lcal ip dmain name <dmain> username cust1 privilege 15 passwrd 0 test (t match seed file credentials) crypt key generate rsa ip scp server enable line vty 0 <platfrm_max> transprt input <ssh all> Files Cpied t Lcal Strage EEM Plicies Cisc_SNMP_Cllectr.tcl Cisc_Frwarder.tcl Cisc_CLI_Cllectr.tcl EEM Library File Cisc_debug.tcl Cisc_eemcli.tcl Cisc_ICF_Sup.tcl Cisc_ICF.tcl Cisc_md5.tcl Cisc_seed_file.tcl Cisc_SNMP_Sup.tcl Cisc_TCBIFF_Sup.tcl tclindex Cisc_util.tcl File Structures and EEM Envirnments The fllwing items cntain infrmatin file structures and envirnment variables fr gateways and cllectrs Gateway Device File Structure & EEM Envirnment Variables Cllectr Device File Structure & EEM Envirnment Variables Gateway Device File Structure & EEM Envirnment Variables The fllwing graphics shw the file structure and EEM envirnment variables fr a gateway device. Belw each graphic is a brief descriptin f what the data represents: 11:27:08 AM Page 68 f 74

69 Smart Cllectr Embedded Assistant User Guide EEM variables after applying gateway script but befre registratin frm Assistant Plicy files in the Gateway Page 69 f 74 9/16/2010

70 Smart Cllectr Embedded Assistant User Guide Library Files in the Gateway Files cpied after Assign Gateway -> Apply Script peratin. 11:27:08 AM Page 70 f 74

71 Smart Cllectr Embedded Assistant User Guide Gateway device directry shwing the seed files (*.csv). EEM variables set after Apply Script and After registratin. Cllectr Device File Structure & EEM Envirnment Variables The fllwing graphics shw the file structure and EEM envirnment variables fr a cllectr device. Belw each graphic is a brief descriptin f what the data represents: Page 71 f 74 9/16/2010

72 Smart Cllectr Embedded Assistant User Guide EEM variables set n the cllectr device after the Install Cllectr peratin. Flder structure in the cllectr device, after the Install Cllectr. 11:27:08 AM Page 72 f 74

73 Smart Cllectr Embedded Assistant User Guide Plicy files n the cllectr device. Libraries n the cllectr device. Seed File Frmat and Cntents The installatin bundle cntains a sample seed file seedfile_withut_headers.csv. Yu can manually add yur devices int the sample seed file spread sheet and then imprt it. Fr the Cllectr Clumn (clumn #33) r Gateway clumn (clumn #34) they shuld cntain a valid ip address that cntains n spaces. This appendix cntains the exact frmat fr the Smart Enabler seed file: ; This file is generated by the exprt utility f Service Appliance 1.0, If yu edit this file, be sure yu knw what yu are ding Cisc Systems NM data imprt, surce = exprt utility; Versin = 1.0; Type = Csv Page 73 f 74 9/16/2010