Smart Collector Overview. Smart Portal User Guide Version

Transcription

1 This chapter provides details about the smart collector processes of the Cisco smart portal. This chapter provides information on both the Smart Collector- Common Services Platform (CSP-C) and the Smart Collector - Embedded and covers the following areas: Smart Collector Overview Smart Collector - CSP-C Registration : o Download Smart Collector CSP-C Software o Register CSP-C o Download a Certificate o Update a CSP-C registration o Delete a CSP-C registration Smart Collector - Embedded Registration: o Maintain an Embedded Collector Registration o Download Manager Option (Java option) o Non-Java Download option o Update an embedded collector registration o Unregister an embedded collector registration Smart Collector Overview Smart Collector generically refers to two different types of collection options for collecting device data, those collector options are: Smart Collector Common Services Platform (100 or more devices per network) Smart Collector Embedded (100 or fewer devices per network) For large networks (100 or more devices per network) a customer provided workstation will run the Common Services Platform Collector (CSP-C). For smaller networks (100 of fewer devices per network), collection can be performed by intelligent Cisco devices themselves through scripting and Embedded Event Manager (EEM) polices using the embedded collector. The Smart Collector Common Services Platform Collector (CSP-C) provides an extensive collection mechanism to collect various aspects of customer network information. CSP-C connects to the discovered devices providing delivery of network information to network administrators and engineers. Data collected by CSP-C is used by the network management applications to provide detailed reports and analytics for both the hardware and software, such as inventory reports. Version

2 Chapter 3 Smart Collectors Prior to using CSP-C, you must install and configure the client and server components either on a Windows workstation or a Linux workstation. Additional information regarding installation and configuration of the CSP-C are covered in the Common Services Platform Collector Quick Start Guide. The Smart Collector Embedded, also known as the embedded collector, is used for smaller-sized networks (100 or fewer devices). No on-premise appliance (workstation) is required, the way CSP-C requires an on-premise appliance; instead a laptop or desktop is used and it contains the Smart Collector Embedded Assistant. The Smart Collector Embedded Assistant lets you add, verify, and assign devices for data collection, and initiates collections. For the embedded collector solution the devices in the customer network are categorized into one of the following three roles: Gateway Collector End device The three device-related roles perform the following functions: The gateway devices are either a router or Cisco switch that collects information from the collectors and sends the collected data securely to the backend server in Cisco for processing. The collector can run either Tcl scripting or embedded code in the image to collect its own device information, or neighborhood device information. The end devices can be any devices, and none of the device needs a Cisco IOS Software upgrade, or TCL scripting. The devices can be dumb devices, or devices with EEM capability. There is also an application called the Smart Collector Embedded Assistant that acts as an interface to the devices that are being used in the embedded collector solution. The assistant lets the user perform the following actions: Verify the prerequisites of the gateway and collector. Apply the roles (gateway, collector and end devices) for the devices, after the gateway and collector verification is performed. Apply scripts and seed file to gateway. Start the process of collection. For a company that has multiple networks and wants IR/NLS to aggregate the data into a single report across the multiple networks, then it is required that each network be collected by a separate registered collector or Transport Gateway. There should be no overlap of devices in seed files or otherwise. The same device should appear only once and not appear in data collected from other networks. Additional information regarding the installation and use of the Smart Collector Embedded Assistant, to perform the preceding functions, is presented in the Smart Collector Embedded Assistant User Guide. The Cisco smart portal gives you access to certain registration data from the two different types of collectors. This chapter discusses how to access the select registration data from both collectors. Common Services Platform Collector (CSP-C ) Registration This section covers the following areas of CSP-C: Download Smart Collector CSP-C Software Register CSP-C Maintain CSP-C Registrations 3-2 Version 0.5

3 Chapter 3 Smart Collectors Download Smart Collector CSP-C Software The download location for the Smart Collector CSP-C software is located on the smart portal Overview page. To download the Smart Collector CSP-C software perform the following steps: On the smart portal Overview page, in the Download section, click Smart Collector Common Services Platform Software; the Download Software window appears. Version

4 Chapter 3 Smart Collectors Find the most recent download and click Download Now; the Software Download Rules information appears. Click Agree, the Download Software window appears again. 3-4 Version 0.5

5 Chapter 3 Smart Collectors To verify if Java is working on the system you are using, then click the here hyperlink, which performs the following Java verification tests. If the java code is not working properly check the following items for possible error indications: o o o Navigate to the log folder in the installation location of the Assistant software. (e.g. C:\Program Files\Smart Embedded Collector Assistant\log). Open file helpdesk.log and look for text like "JVM not found or terminated". If any of these errors are noted in the log, then contact Cisco customer support for the resolution of this issue. Go back to the Download tab window (see next graphic). Version

6 Chapter 3 Smart Collectors There are two different download options: Download Manager Option (Java-based option) Non Java Download Option Download Manager Option (Java-based option) This download option requires a minimum Java version of 1.4.2_xx; a hyperlink is available to verify Java is working on your computer. To use the Download Manager Option perform the following steps: Click the Download Manager Option; a security warning appears. Click the Run button; a Select Location window appears. 3-6 Version 0.5

7 Chapter 3 Smart Collectors Specify the location you want the file to be downloaded and click Open; a download status window appears. After the file has completed downloading a message appears indicating results of the download. Version

8 Chapter 3 Smart Collectors Click the Close Window button. The process of installing the Smart Collector CSP-C download file is covered in the Smart Collector CSP-C Quick Start Guide. Non Java Download Option Click the Non Java Download Option; a new window opens. Click Download; the File Download window appears. 3-8 Version 0.5

9 Chapter 3 Smart Collectors Click Save; the Save As window opens. Specify where you want the file downloaded, then click Save; the file is saved at the specified location and the Download complete window appears. The download status quickly displays followed by a Download Complete message, click Close; the Download complete window is closed. Register CSP-C The CSP-C registration needs to be performed before the collector can be utilized by smart portal. The registration allows a validation to occur that creates a connection between the CSP-C collector and the Cisco backend. To register a CSP-C, perform the following steps: Version

10 Chapter 3 Smart Collectors On the Smart Collector Overview page, click one of the following items: o Register CSP-C o Smart Collector- Common Services Platform tab Clicking either of the above options displays the Smart Collector- Common Services Platform page; by default this page displays all the registered CSP-C s, if any have been registered. On the Smart Collector- Common Services Platform page, click New Request; the CSP-C Registration view is displayed Version 0.5

11 Chapter 3 Smart Collectors 1 Enter all the required information, which is designated by a red asterisk*. Enter information that is relevant to the device/site, which will make finding/working with the device easier in the future. For the Site ID you can either manually enter the id or select one from the drop-down list. The serial number information can be obtained from the invoice or other paperwork that came with the device; however the best source for the serial number is from the actual device. Click Submit; a message appears indicating that the submission was successful and instructs you to download a certificate. Downloading a Certificate Downloading a certificate provides you a security certificate and other registration related files that will be used later when configuring the CSP-C. There are two ways to download a certificate. One way is to use the download link specified in an notification that is sent after registering a new CSP-C or updating an existing CSP-C registration. The other method is to use the download certificate function on the smart portal. Version

12 Chapter 3 Smart Collectors To download a certificate from the smart portal, perform the following steps: Click the Download Certificate button, a zip file window appears requesting you to either save or open the file. The certificate can be downloaded at any time, but must be downloaded before configuring the CSP-C since the certificate and other entitlement info is needed during the CSP-C configuration process. To download the certificate later, simply come to this web page, select the CSP-C you want the certificate for and click Download Certificate. Click the Save File radio button, and then click OK. You should not open the zip file and extract the files, doing so might complicate the CSP-C configuration process later. Store the zip file in a safe place that will be easy to find later. Maintain CSP-C Registrations There are two options for maintaining a CSP-C registration: 3-12 Version 0.5

13 Chapter 3 Smart Collectors Update a CSP-C Registration Delete a CSP-C Registration Update a CSP-C Registration Updating a registration can be performed on only those registrations that have a registration status of Completed. Registrations that are in an unregistered state cannot be updated. To update a CSP-C registration perform the following steps: On the Smart Collector Overview page, click one of the following items: Maintain CSP-C Registrations Smart Collector- Common Services Platform tab Clicking either of the above options displays the Smart Collector- Common Services Platform page; by default this page displays all the registered CSP-C s, if any have been registered. Version

14 Chapter 3 Smart Collectors Select a radio button of a registration that has a status of Completed Click the Update button; the Edit CSP-C Registration view appears. Enter the data you want to modify in any of the available fields. Click Submit; the previous view appears with a message and updated contents. The updated view has a message indicating the success of the update, and the modified information appears in the refreshed view. An notification is sent to the user, by the Cisco backend, after updating a CSP-C registration, the notification indicates the status of the update. Delete a CSP-C Registration Deleting a CSP-C registration does not delete the CSP-C device that is installed; instead, it revokes the security certificate of the installed CSP-C. To delete a CSP-C registration perform the following steps: 3-14 Version 0.5

15 Chapter 3 Smart Collectors On the Smart Collector Overview page, click one of the following items: Maintain CSP-C Registrations Smart Collector- Common Services Platform tab Clicking either of the above options displays the Smart Collector- Common Services Platform page; by default this page displays all the registered CSP-C s, if any have been registered. Select the radio button of the CSP-C registration you want to delete. Click the Delete button; a confirmation window appears to verify that you want to delete the registration and indicates that doing so will stop the CSP-C communication to the Cisco backend. Version

16 Chapter 3 Smart Collectors Click OK; a status message appears on the previous view indicating the success of the registration deletion. The refreshed view has a message indicating that the requested deletion has been successfully performed, and the deleted registration is no longer displayed in the list. An notification is sent to the user, by the Cisco backend, after deleting a CSP-C registration, the notification indicates the status of the deletion. Additional CSP-C Resources There is also additional information related to CSP-C operation, in the following documents: Common Services Platform Collector Quick Start Guide provides the following information: o Configuring the IP Address on the CSP-C Collector o CSP-C Registration o Installing and Configuring CSP-C Client o CLI Commands o Basic troubleshooting CSP-C hardware and software support provides the following information: o Recommended hardware configurations for CSP-C o Software support and supported devices for CSP-C CSP-C supported devices list 3-16 Version 0.5

17 Chapter 3 Smart Collectors Embedded Collector Registration Registration of the embedded collector is performed on the Smart Collector Embedded Assistant, where a gateway is assigned, scripts applied, and a connection is established to the Cisco backend. The smart portal lets you access the download code for the Smart Collector Embedded Assistant, where the registration is later performed, and smart portal lets you update selected registration data in the embedded collector. Maintain an Embedded Collector Registration The maintain embedded collector registration function on the smart portal provides two functions: Provides a link to download the Smart Collector Embedded Assistant executable code that installs the Smart Collector Embedded Assistant, where the embedded collector registration can be performed. After the registration has been completed on the Smart Collector Embedded Assistant the smart portal can be used to maintain/update certain embedded collector information (change the embedded collector name and add/change the description contents). This section covers the following areas of the embedded collector: Download the Smart Collector Embedded Assistant Update Embedded Collector Registration Download the Smart Collector Embedded Assistant To download the Smart Collector Embedded Assistant executable code, perform the following steps: There are two different ways to access the download location for the SmartCollectorEmbeddedAssistant.exe. Both methods get you to the Login for the Download Software window. One way is to go to the Smart Collector Overview page and click Smart Collector - Embedded Software Assistant. The other way is to perform the following steps: On the Smart Collector Overview page click one of the following items: Version

18 Chapter 3 Smart Collectors o Maintain Embedded Collector Registrations o Smart Collector- Embedded tab Clicking either of the above options displays the Smart Collector- Embedded page; by default this page displays all the registered embedded collectors, if any have been registered. The o o o o o o o o in the list indicates that all the entries in the list are not shown in the graphic. On the Smart Collector - Embedded page, click Smart Collector - Embedded Software Assistant; a Log In window appears requesting your CCO login credentials. Enter your CCO login credentials, then click Login; the Download Software window appears Version 0.5

19 Chapter 3 Smart Collectors Click 0.5 to access the most current software for Smart Collector Embedded Assistant; the window updates and displays the 0.5 download. A 1 Click the Download Now button; the Download Cart (1) pane appears. If the Download Now button is not enabled you may have to click the download cart button instead. Version

20 Chapter 3 Smart Collectors 2 To verify if Java is working on the system you are using, then click the here hyperlink, which performs the following Java verification tests. If the java code is not working properly check the following items for possible error indications: o Navigate to the log folder in the installation location of the Assistant software. (e.g. C:\Program Files\Smart Embedded Collector Assistant\log) Version 0.5

21 Chapter 3 Smart Collectors o o Open file helpdesk.log and look for text like "JVM not found or terminated". If any of these errors are noted in the log, then contact Cisco customer support for the resolution of this issue. Click the Proceed With Download button; to continue the download; the Cisco's End User Software License Agreement appears. Click the Agree button; the Download Option view appears. 1 2 There are two different download options: Download Manager Option (Java-based option) Non Java Download Option Version

22 Chapter 3 Smart Collectors Download Manager Option (Java-based option) This download option requires a minimum Java version of 1.4.2_xx; a hyperlink is available to verify Java is working on your computer. To use the Download Manager Option perform the following steps: Click the Download Manager Option; a security warning appears. Click the Run button; a Select Location window appears. Specify the location you want the file to be downloaded; a download status window appears Version 0.5

23 Chapter 3 Smart Collectors After the file has completed downloading a message appears indicating results of the download. The process of installing the SmartCollectorEmbeddedAssistant.exe download file is covered in the Smart Collector Embedded Assistant User Guide. Non Java Download Option Version

24 Chapter 3 Smart Collectors Click the Non Java Download Option; a new window opens. 1 Click the Download hyperlink; a window opens prompting for a Save option. Click Save; a Save As window appears Version 0.5

25 Chapter 3 Smart Collectors Indicate where you want the file saved; a download status window appears, at the end the window indicates Download Complete The process of installing the SmartCollectorEmbeddedAssistant.exe download file is covered in the Smart Collector Embedded Assistant User Guide. Update Embedded Collector Registration There is one option for maintaining an embedded collector registration; to update an embedded collector registration, perform the following steps: Version

26 Chapter 3 Smart Collectors 2 1 On the Smart Collector Overview page, click one of the following items: Maintain Embedded Collector Registrations Smart Collector- Embedded tab Clicking either of the above options displays the Smart Collector- Embedded page; by default this page displays all the registered embedded collectors, if any have been registered. The o o o o o o o o in the list indicates that all the entries in the list are not shown in the graphic Version 0.5

27 Chapter 3 Smart Collectors In the list select an embedded collector registration, then click the Update button; the Edit Embedded Collector Registration view appears. 1 2 Update the data in one of the available fields (Embedded Collector Name and/or Description fields). Click Submit; the previous view appears with the updated contents displayed and a message indicating the result of the update. The o o o o o o o o in the list indicates that all the entries in the list are not shown in the graphic. In the list, the updated embedded collector registration appears with the updated data. Version

28 Chapter 3 Smart Collectors Unregister Embedded Collector Registrations If you need to unregister an embedded collector there are two options, neither of which can be done by a customer on the Cisco smart portal; those options are: Go to the Smart Collector Embedded Assistant application and unassign the gateway. Have a Cisco employee delete the embedded collector registration for you. A Cisco employee has the ability to delete embedded collector registrations on the Cisco smart portal Version 0.5