smart collector embedded assistant user guide - cisco.com filesmart collector embedded assistant...

Smart Collector

Embedded Assistant

User Guide

Sept. 16, 2010

Corporate Headquarters Cisco Systems, Inc. 170 West Tasman Drive San Jose, CA 95134-1706 USA http://www.cisco.com

http://www.cisco.com/

Smart Collector Embedded Assistant User Guide

11:27:08 AM of 74

Smart Collector Embedded Assistant Overview 4

Smart Collector Embedded Assistant Installation 4

Browse For Folder 7

Choose Shortcut Folder 7

Smart Collector Embedded Assistant Operational Prerequisites 11

Prerequisite List (Network and Devices) 11

How to Check for Minimum Requirements 11

Launch the Smart Collector Embedded Assistant Application 13

GUI 14

Parts of the GUI 14

Changing the Views 15 Hide/Unhide View by Gateway 15 Hide/Unhide View by Collector 16

Configure the Smart Collector Embedded Assistant 17

Adding Devices 18 Import the Seed File 18 Add a Device Manually 21

Verify Gateways 22 Verify Gateway (Single) 23 Verify Gateways (Multiple) 24

Specify Global Settings 27

Assign a Gateway and Apply Scripts 25

Verify Collectors 27 Verify Collector Overview 30 Verify Collector Process 31

Verify Collector (Single) 32 Verify Collector (Multiple) 33

Assign a Collector 34

Assign an End Device 35 Assign a Single End Device to a Collector 35 Group Device to Collector 37

Install a Collector 38

Collection 39

Manually Start a Collection 39

Schedule a Collection 42

Synchronize 42

Other Gateway, Collector and End Device Functions 43

Gateway Push a Seed File 43

Edit Gateways, Collectors, End Devices 44 Edit a Gateway 44 Edit a Collector 45 Edit an End Device 45

Unassign an End Device, Collector, Gateway 46 Unassign an End Device 46 Unassign a Collector 47 Unassign a Gateway 49

Deleting a Device 50


of 74 9/16/2010

Switching Device Roles 51

Switch Gateway Role to a Collector 51

Switch Collector Role to a Gateway 52

Switch End Devices to a Different Collector 52

Logs 53

Uninstalling 53

Uninstall Gateway and Collector Scripts 53

Uninstall Smart Collector Embedded Assistant 55 Uninstall Gateway and Collector Scripts 55 Uninstall Smart Collector Embedded Assistant Program 56 Uninstall Assistant Process 57

Help 60

Appendix 62

Troubleshooting Guide for Smart Collector Embedded Assistant Errors 62 Device Communication 62 Verify Gateway 62 Push Script 63 Verify Collector 63 Install Collector 63 Start Collection 63

FAQ’s 63

Running Config Info for Gateways and Collectors 65 Gateway Device 65

EEM Configuration Changes 65 Other Automated Configuration Changes 66 Other Manual Configuration Changes 66 Files Copied to Local Storage 66

EEM Policies 67 EEM Library File 67

Collector Device 67 EEM Configuration Changes 67 Other Automated Configuration Changes 67 Other Manual Configuration Changes 68 Files Copied to Local Storage 68

EEM Policies 68 EEM Library File 68

File Structures and EEM Environments 68 Gateway Device – File Structure & EEM Environment Variables 68 Collector Device – File Structure & EEM Environment Variables 71

Seed File Format and Contents 73


11:27:08 AM of 74

Smart Collector Embedded Assistant Overview The Smart Collector Embedded Assistant lets the user verify gateway and collector prerequisites then apply one of several device roles (gateway, collector and end device). This application also lets you apply the scripts and seed file to a gateway and start the collection process.

This document provides information on the following areas:

Smart Collector Embedded Assistant Installation

Smart Collector Embedded Assistant Prerequisites

Launch the Smart Collector Embedded Assistant Application

Smart Collector Embedded Assistant Views

Configure the Smart Collector Embedded Assistant

Collection

Synchronize

Unassign Gateways, Collectors, End Devices

Switching Device Roles

Deleting a Device

Uninstall Smart Collector Embedded Assistant

Uninstall Gateway and Collector Scripts

Smart Collector Embedded Assistant Installation This section describes the steps that are involved after the Smart Collector Embedded Assistant Software (executable binary with file name extension exe) has already been downloaded. For information about how to download the Smart Collector Embedded Assistant executable go to the Smart Collectors chapter of the Smart Portal User Guide and review the Download the Smart Collector Embedded Assistant section.

To install the Smart Collector Embedded Assistant, perform the following steps:

Go to the location you previously saved the Smart Collector Embedded Assistant.exe.

Double-click the Smart Collector Embedded Assistant.exe. or right-click the .exe file, then click Open; the InstallAnywhere window appears.

The InstallAnywhere window displays the extraction process indicator bar; the extraction process could take several minutes.

http://cisco.com/en/US/docs/net_mgmt/smart_portal/User_Guides/Smart_Collectors.pdf


of 74 9/16/2010

The Smart Collector Embedded Assistant flash window appears quickly, and displays an install progress bar at the bottom.

The Introduction window appears, click Next; the Choose Install Folder pane appears.


11:27:08 AM of 74

The customer chooses one of the following options:

o Clicking Choose lets you take an intermediate step and opens the Browse For Folder window.

o Clicking Restore Default Folder, opens the Choose Shortcut Folder pane and installs the Smart Collector Embedded Assistant at the default install location identified in the location field.

TFTP port must be available for the install; if port 69 is not available then the following error will be seen.


of 74 9/16/2010

Browse For Folder This window lets you specify a different install folder location by performing the following steps:

Navigate to the location where you want the install folder to be located; you may also create a new folder location by clicking Make New Folder.

After specifying the folder, click OK; the Choose Shortcut Folder pane appears.

Choose Shortcut Folder You come to the Choose Shortcut Folder pane either directly from previously choosing the Restore Default Folder option, or indirectly by previously choosing the Choose option. To continue the install, perform the following steps:


11:27:08 AM of 74

Specify where you want product icons created.

After specifying where to create the icons, click Next; the Pre-Installation Summary pane appears.

This pane informs you about all the actions that were just performed and what the results are.

Click Install; the Installing Smart Collector Embedded Assistant pane appears.


of 74 9/16/2010

The install package starts installing the code.

The installation shows the progress and has two parts to the install:

The Smart Collector Embedded Assistant code install (shown above)

Installing AdobeAirRuntime (the following window briefly displays during the install)

After Adobe AirRuntime is installed, the Smart Collector Embedded Assistant window appears with the Install Complete pane.


11:27:08 AM of 74

Click Done to exit the installer program; the Please Wait pane appears while the Smart Collector Embedded Assistant application is automatically launched.

See the next section for instructions on how to use the Smart Collector Embedded Assistant application.


of 74 9/16/2010

Smart Collector Embedded Assistant Operational Prerequisites There are several areas covered in the prerequisite section:

Prerequisite List (Network and Devices)

How to Check for Minimum Requirements

Seed File Format and Contents (appendix)

Prerequisite List (Network and Devices) The following items are Smart Collector Embedded Assistant prerequisites for the network, gateway and collector devices:

Click hyperlinks below to see steps on how to verify requirements.

Gateway device must have the following items

o EEM (Embedded Event Manager) version 2.4 or later.

o PKI Support (a.k.a “crypto or k9 image”).

o Total space needed for non-volatile memory 250k plus 200k for each device (e.g. if you are collecting from 30 end devices, then approximately 6 Mbytes are needed).

o ICMP ping should be enabled, should be able to connect to Cisco backend /repository (e.g. be able to ping 128.107.242.16).

o There must be SCP capability between the gateway and the collector.

o DRAM size 256 Mbytes or larger.

Collector devices must have the following items:

o EEM (Embedded Event Manager) version 2.4 or later.

o PKI Support (a.k.a “crypto or k9 image”).

o Total space needed for non-volatile memory 250k plus 200k for each device (e.g. if you are collecting from 30 end devices, then approximately 6 Mbytes are needed).

o There must be SCP capability between the gateway and the collector.

PC

o Windows XP based laptop or desktop (Windows emulations currently not tested), need to have capability to telnet and copy files to the Gateway device (no firewall should be between the PC and the Gateway devices).

The gateway and one of the collectors may be on the same device. Each collector can collect up to 10 other devices.

In order for Smart Collector Embedded Assistant to communicate with the gateway device it is recommended that you disable any Firewall between the gateway and the device running the Smart Collector Embedded Assistant application.

How to Check for Minimum Requirements The Smart Collector Embedded Assistant identifies candidate devices that are eligible to be gateways and collectors; however, if you would like to check manually before registering and downloading the Smart Collector Embedded Assistant, then perform the following checks:

How do I check for the correct EEM Version?

o Log into the device


11:27:08 AM of 74

o Run the show event manager version command, the first line shows the EEM version; version should be 2.4 or later.

How do I check PKI support?

o Log into the device.

o Run the show subsys | inc ipsec_common command, look for ipsec_common in the output.

o If PKI is not supported, then choose another device with a crypto image or upgrade IOS image.

How do I check for sufficient free local storage?


o Run the show file systems command; look for the “Free” column for a file system with sufficient space.

Verify ICMP

o Check connectivity to the Cisco backend /repository (e.g. be able to ping 128.107.242.16).

How do I configure SCP/SCP capability to collector:

o Use the external AAA server to configure authentication & authorization and issue the following commands.

aaa new-model

!

aaa authentication login default local

aaa authorization exec default local

o The SSH/SCP domain name is used during encryption; enter the following command:

ip domain name cisco.com

o A username/password is needed so that an external device can ssh or scp to this router. Configure the usernames to the highest privilege level:

username cust1 privilege 15 password 0 test

username cust2 privilege 15 password 0 lab

o The SSH/SCP protocols needs an rsa key-pair. Generate a key pair that can be used for encrypting data that is sent using Selection Criteria page; SSH is enabled with modulus 1024. Issue the following command to generate an rsa key-pair:

crypto key generate rsa

For removing the keys issue “crypto key zeroize rsa”

o How do I verify SCP capability to collector?

After keys are generated they can be viewed by issuing the following command.

show crypto key mypubkey rsa

Enable the SCP server capability on the router so the external device can send data using SCP to this SCP enabled router. Issue the following command:

ip scp server enable

Need to have 2 sets of vty lines configured:

line vty 0 4 line vty 5 15

exec-timeout 0 0 exec-timeout 0 0

privilege level 15 privilege level 15

password lab password lab

transport input all transport input all

transport output all transport output all

Log into the device and enter privileged mode


of 74 9/16/2010

Run the following command and verify that the copy completes successfully:

copy nvram:/startup-config scp://user:passwd@<gateway_ip>/<gateway_file_system>/test.cfg.

Launch the Smart Collector Embedded Assistant Application To launch the Smart Collector Embedded Assistant application go to the Start menu and choose All Programs > Smart Collector Embedded Assistant > Start Service, let the service start then choose Start > All Programs > Smart Collector Embedded Assistant > Assistant

Launching the Smart Collector Embedded Assistant brings up the Smart Collector Embedded Assistant application window.


11:27:08 AM of 74

GUI The Graphical User Interface (GUI) has several different aspects to it. This section covers the following items:

What the different parts of the GUI are named.

How to change the views on the GUI.

Parts of the GUI The Smart Collector Embedded Assistant has names for the different parts of the GUI. This section identifies the names of those different parts of the GUI:

The following items are parts of the GUI:

The Assistant task bar has five different functional items:

o Global Settings

Tabs

Assistant Task Bar

Pane View Device Manager Task Bar


of 74 9/16/2010

o Import Seed file

o Start Collection

o Schedule

o Synchronize

There are two different tabs, each of which has its own associated pane view:

o Device Manager tab – has the Device Manager View pane (shown above)

o Logs tab – has the Log View pane (shown below)

There is a Device Manager task bar that has six functional items:

o Add Device

o Verify Gateways

o Verify Collectors

o Install Collectors

o Group Devices to a Collector

o Delete

The Logs tab has the Logs View pane, which contains two different windows:

Log from the Assistant window.

Log from the devices window.

Changing the Views There are several ways you can change the view of the data represented in the GUI; those different views are:

Hide/Unhide view by Gateway

Hide/Unhide view by Collector

Hide/Unhide View by Gateway

The Device Manager View pane provides two gateway views; showing (unhide) all the assigned collectors, and showing only the gateway (hide).


11:27:08 AM of 74

The triangle in the left column lets you alternate the two views. The downward pointing triangle displays the assigned collectors, clicking the triangle hides the associated collectors.

Hide/Unhide View by Collector

The Device Manager View pane provides two collector views; showing all the assigned end devices, and showing only the collector.

Showing all the assigned end devices and showing only the collector (hide).


of 74 9/16/2010

The triangle in the left column lets you alternate the two views. The downward pointing triangle displays the assigned end devices, clicking the triangle hides the associated end devices.

Configure the Smart Collector Embedded Assistant After the program installation completes, the Smart Collector Embedded Assistant window appears, no device data is available at this point. By default the Device Manager View pane is displayed.


11:27:08 AM of 74

There are several tasks that need to be performed, in the sequence noted below, when configuring the Smart Collector Embedded Assistant:

Import the Seed File or Add a Device Manually

Verify Gateways

Specify Global Settings

Assign a Gateway and Apply Scripts

Verify Collectors

Assign a Collector

Assign an End Device

Install a Collector

Start a Collection

Adding Devices There are two different ways to add devices (gateways, collectors, and end devices) to the Smart Collector Embedded Assistant:

Import the Seed File

Add a Device Manually

Import the Seed File

Device data can be imported via a seed file; the seed file needs to be in a comma separated value (CSV) format.

If the user creates their own seed file, then they will need to import it into the Smart Collector Embedded Assistant and have the Smart Collector Embedded Assistant push it to the gateway in order to encode the fields in a manner that the embedded collector can decode. The import by the Smart Collector Embedded Assistant allows the credentials to be obfuscated prior to storing on the gateway device.

See Seed File Format and Contents for more information about seed file contents and their formatting requirements.


of 74 9/16/2010

To import a seed file perform the following tasks:

On the Smart Collector Embedded Assistant click the Import Seed File button; the Import Seed File window appears.

Click the Browse button to designate the seed file location; an Open window appears where you can specify the seed file you want to use.


11:27:08 AM of 74

After specifying the seed file, click Open; the Import Seed File window appears again.

Click Import; the Device Manager View pane appears with the devices the seed file populated on the window.

The next step is one of the following options:

o If additional devices need to be added, then add a device manually

o If no additional devices need to be added, then verify the gateways.

The role assignment for Gateway and Collector can be done only through the Smart Collector Embedded Assistant.


of 74 9/16/2010

Add a Device Manually

If a seed file is not available, or if devices (gateways, collectors, and end devices) need to be added, then devices can be added manually. To add a device, perform the following steps:

On the Device Manager View pane click Add Device; the Add Device window appears.

There are three required fields that must be filled in (Host Name, IP Address, and SNMP RO

(password)), they are denoted by a red * (asterisk) next to the field names. You can optionally enter

data in the remaining fields.

After entering the required/optional data, click Apply; a confirmation window appears.

Click OK; the Add Device window is ready for another device add.

1


11:27:08 AM of 74

Primary / TACACS User Name is the first login for the router.

If TACACS is set up on the router, then the primary user and primary password will be the TACACS username and password respectively. If TACACS is not set up on the router, then the user uses their normal login username and password for the router.

If no other devices need to be added, then click Cancel; the window closes and the Device Manager

View pane with the newly added device(s) (see graphic below).

To add more devices, repeat the above process, when finished adding devices click Cancel to close the window and return to the Device Manager View pane.

Verify Gateways After the devices have been added, by either manually adding or by importing a seed file, the devices are listed on the Device Manager View pane.


of 74 9/16/2010

Notice the following items:

The Device Roles have not been assigned.

The gateways and collectors have not been verified as being eligible yet.

No scripts have been installed, or collections been performed.

The next step is to verify the gateways; the gateway verification involves checking the following items:

Crypto image

File system space

EEM version

Connectivity to backend

Use one of the two methods for verifying the gateways:

Verify Gateway (Single)

Verify Gateways (Multiple)

You must select at least one device before clicking Verify Gateways, or else you will get the following error message.

Verify Gateway (Single)

To verify only a single gateway, perform the following steps:

Click the associated Click Here for the device you want to verify as a gateway; a context sensitive menu appears.

On the context sensitive menu click Verify Gateway.

A

2


11:27:08 AM of 74

After the gateway verification, only the selected gateway is verified. which is noted by a green

checkmark√ in the Gateway + Collector Eligibility column.

Verify Gateways (Multiple)

To verify more than one device at a time, as a possible gateway, perform the following steps:

Select the Gateways you want to verify,

Click the Verify Gateways button; as the verification is performed an „in process‟ icon is displayed sequentially in each selected item row. When the verification is completed, there will be a green

checkmark√, indicating the device is eligible to be a gateway, or a red X indicating the device is not

eligible to be a gateway.

1

A


of 74 9/16/2010

After the Smart Collector Embedded Assistant completes the verification, the Eligible Gateway fields display checkmarks in those areas for which the devices are eligible as a gateway and red X‟s for those that are not.

When the gateway verification is performed the following prerequisite items are checked to verify the device is qualified to be a gateway:

Disk Space – Total space needed for non-volatile memory 250k plus 100k for each device.

Show Event Manager Version – Version should be greater than or equal to 2.4.

Show Subsys | inc crypto_ipsec_common – This verifies if the device has the crypto image or not.

Connectivity to Cisco backend.

If you click the green checkmark√ for the eligible gateway or collector you will see the following information:

Assign a Gateway and Apply Scripts The gateway is the interface for passing inventory data between the collectors and the Cisco Backend. To assign a gateway and apply scripts, perform the following steps:


11:27:08 AM of 74

Click the associated Click Here for the device you want to assign as a gateway; a context sensitive menu appears.

On the context sensitive menu click Assign Gateway; the Push Script window appears.

A default folder location for the script file is loaded in the Script file location field, if you want to use a different script file click Browse and navigate to the new script file location.

Click Apply Scripts, the Smart Collector Embedded Assistant pushes the gateway script files to the designated gateway. The Push Script window changes, and indicates that the script is being pushed to the selected device.

An in progress indicator is displayed; applying the script files to the gateway could take several minutes.

A

1


of 74 9/16/2010

The Smart Collector Embedded Assistant pushes the scripts and performs EEM configurations in the gateway, in configuration mode, and also registers the EEM parameters of ID, Token and inventory name in configuration mode. The EEM parameters were obtained from the Global Settings.

After assigning the gateway, the Device Manager View pane shows the following changes:

o Under the Device Role column, the selected device is assigned as a gateway and indicates the Gateway role. .

o Under the Script Installed column, the gateway shows a green checkmark√, and has an uninstall

hyperlink, for uninstalling the pushed script.

If you need to unassign the gateway, then click the UnAssign option off the corresponding Click Here context sensitive menu.

If you need to uninstall the scripts from the gateway click the corresponding uninstall hyperlink to start the gateway uninstall process.

Specify Global Settings The global settings let you specify important information related to selecting an entitled company (party), inventory name and description, along with registering the collector on the Cisco Backend.

Before specifying the Global Settings, you must first assign a gateway role to a device.

Click Global Settings at the top of the window; the global settings window appears.

1


11:27:08 AM of 74

Fill in the required data fields; the data has the following requirements:

o Enter the user id and password.

o Port numbers 514 and 69 are default numbers.

Port 69 needs to be available for the Smart Collector Embedded Assistant TFTP server; there should be no other syslog server or TFTP running on this computer.

After entering the user id and password data, click Get Party; an in progress bar appears at the bottom of the window.


of 74 9/16/2010

The inventory name is whatever name the customer wants to call the inventory.

Click Register; the TCL ID and Token data are filled in when the Registration is performed.

Click Apply; a confirmation window appears indicating the status of the change.


11:27:08 AM of 74

Click OK; the window is closed and the Device Manager View pane becomes the primary window again. The next step is to assign a gateway and apply the gateway scripts.

Verify Collectors The verify collectors‟ process is a script that is run from the gateway; this section has two parts:

Verify Collector Overview – Explains how the verification process works.

Verify Collector Process – Covers the steps that are performed in the collector verification process.

Verify Collector Overview

The Verifycollector.tcl script is run from the Gateway, this is because we assume that the PC running the Smart Collector Embedded Assistant application may not be able to communicate with all collectors, but the gateway must be able to.

The following information explains what the different parameters are in the verify collector script and how they are used:

If no arguments are provided to the script, then all devices nominated as collectors in the seed file are checked for prerequisites.

If individual hostnames are provided as arguments, then only these devices are verified.

if -all argument is specified, then all devices in the seed file (regardless of whether they have been nominated as potential collectors) are verified

If –install argument is specified, then the collector EEM policies are installed and configured on those devices that pass verification

The –all and –install options are mutually exclusive (for safety). If –all is specified, then all other arguments are ignored.

This next section describes what the collector verification process does:

First the embedded collector installation on the gateway is checked, the gateway must have all the collector install files available.

SSH connectivity from gateway to collector is checked using seed file credentials; if successful, then the startup-config is retrieved from the nominated device via scp (this checks both ssh and scp connectivity by default).

The EEM version is checked via “show event man version” command on the nominated device.

The number of devices that the nominated collector is to collect is totaled from the seed file, and multiplied by 200k. Then a file system with enough free space is checked via the “show file sys” command.

If the above steps pass, the collector device is verified.

If the –install option has been specified, then the script continues. This next section explains what steps are performed during the script file installation:

The startup-config, which was retrieved during the scp verification step above, is opened and searched for existing EEM policy and library directories. If they exist, they are re-used; if not, new directories are created on a file system containing enough space for the scripts.

The EEM scheduler script thread default class number is checked. If it exists, and is set to one, a failure syslog is generated indicated we require at least two threads. If it doesn‟t exist, the number is set to 10 by default.

The vty configuration is checked; we add five to the thread number above, and bump up the vty‟s if needed.

The TCB_ROOT and TCB_ARCH directories are created to contain the collected data, and data archives respectively.


of 74 9/16/2010

Three EEM policies are copied to the configured EEM user dir policy directory –

o Cisco_SNMP_Collector.tcl

o Cisco_Forwarder.tcl

o Cisco_CLI_Collector.tcl

The following library files are copied to the configured EEM user dir library directory –

o Cisco_SNMP_Sup.tcl Cisco_debug.tcl

o Cisco_eemcli.tcl Cisco_ICF.tcl

o CIsco_ICF_Sup.tcl

o Cisco_seed_file.tcl

o Cisco_TCBIFF_Sup.tcl Cisco_md5.tcl

o Cisco_util.tcl tclIndex

The SNMP server-manager is checked, and configured if not

The SNMP RO community string is checked to see if it matches the seed file, and configured If not

Three EEM environment variables are configured - _TCBIFF_ROOT, _SE_ARCHIVE_DIR, and easy_shell_debug

The three EEM policies above are registered

The modified startup-config is copied back to the nominated device as the new running-config and saved via “wr mem”

Verify Collector Process

After the gateway has been verified and assigned the next step is verifying the collector. You must assign the gateway before verifying the collector, or else you will get the following message.

You must have also performed the registration setup in the global settings before performing the collector verification, or else you will get the following message.

Use one of the two methods for verifying the gateways:

Verify Collector (Single)

Verify Collector (Multiple)


11:27:08 AM of 74

Verify Collector (Single)

To verify only a single collector, perform the following steps:

Select a device that you want to verify as a possible collector.

Click the associated Click Here for the device you want to verify as a collector; a context sensitive menu appears.

On the context sensitive menu click Verify Collector; only the selected collector is verified.

If the device is eligible as a collector there will be a green checkmark√, if not there will be a red X.

2

A


of 74 9/16/2010

Verify Collector (Multiple)

To verify more than one device at a time, as a possible collector, perform the following steps:

Select the devices you want to verify as possible collectors, then click Verify Collectors button; a verification process indicator appears during the collector verification process for each selected device.

After the Smart Collector Embedded Assistant completes the verification, the Eligible Gateway fields

display a green checkmark√ for those devices that are eligible as a gateway, or a red X for those

devices that are not eligible as a collector.

1


11:27:08 AM of 74

Assign a Collector The function of a collector is to go out and gather the inventory information from its assigned end devices, and then send the collected inventory data to the Cisco Backend via the assigned gateway.

To assign a collector perform the following tasks:

Click the associated Click Here for the device you want to assign as a collector; a context sensitive menu appears.

On the context sensitive menu click Assign Collector.


of 74 9/16/2010

The Collector role is assigned to the device and the collector is indented under the Gateway.

The Script Installed column has a red X, which indicates that the collector scripts have not been installed yet (see Install a Collector for details on how to install the collector scripts).

If you need to unassign the collector from a gateway, then there is an UnAssign option off the corresponding Click Here context sensitive menu.

Assign an End Device The end device(s) are the devices that have their inventory information collected from the collector, then sent to the Cisco Backend via the assigned gateway. There are two ways to assign an end device:

Assign a Single End Device to a Collector

Group Device to Collector

To assign an end device perform one of the above options.

Assign a Single End Device to a Collector

To assigning a single end device to a collector, perform the following steps:

Click the associated Click Here for the device you want to assign to the collector as an end device.


11:27:08 AM of 74

On the context sensitive menu click Assign End-Device; the Collector Selection window appears.

In the Collector Selection window, from the Collector drop-down list, choose the IP Address of the collector that you want your end devices assigned.

Click Add, the Device Manager View window updates the assignments.

The end device that is assigned to the collector is indented under the assigned collector.

If you need to unassign the end device from the collector there is an option off the corresponding Click Here context sensitive menu.


of 74 9/16/2010

Group Device to Collector

One method for assigning end devices to a collector is to select multiple end devices and assign them all together as a group to a collector. To assign end devices as a group to a collector, perform the following steps:

Select two or more end devices then click Group Device to Collector; the Collector Selection window appears.

In the Collector Selection window, from the Collector drop-down list, choose the IP Address of the collector that you want your end devices assigned.

Click Add, the Device Manager View window updates the assignments.

The end devices that were assigned to the collector are indented under the assigned collector.

If you need to unassign the end device from the collector there is an option off the corresponding Click Here context sensitive menu.

The next step in the process is to work with the collector; install a collector then start a collection.


11:27:08 AM of 74

Install a Collector Collectors that have assigned end devices, from which inventory data is collected and then sent to the Cisco Backend via the collectors dedicated gateway. In order for an assigned collector to operate as a collector, specific script files must be loaded/pushed to the device assigned as the collector. To install script files to a collector, perform the following steps:

The Script Installed column has a red X, which indicates that the collector scripts have not been installed yet (a red X was placed there during the assign collector process). When the collector scripts have been installed the red X will be replaced by the green checkmark √.

On the Device Manager View pane click Install Collector; the Smart Collector Embedded Assistant pushes script files to the collector.

While the Smart Collector Embedded Assistant pushes script files to the collector, there is an In

Progress indicator being displayed.


of 74 9/16/2010

The push files to the collector could take several minutes.

After the files have been pushed to the collector, a green checkmark is placed under the Script Installed column, on the collector row.

If you need to unassign the collector click the UnAssign option off the corresponding Click Here context sensitive menu.

If you need to uninstall the scripts from the gateway click the corresponding uninstall hyperlink to start the gateway uninstall process.

The next step in the process is to perform a collection.

Collection A collection process collects inventory data from end devices that are assigned to the collector. The collection process allows a user to push collector updates, host (end device) associations, and entire seed file to the gateway. The gateway‟s environment variable configuration will also be updated during the collection process.

When a collection is performed for a large number of devices (e.g. 70 devices), please ensure that the debug level for the gateway is set to 0, or 1 at the most. When the debug level is higher than 1, the message output increases significantly, which causes problems for Embedded Event Manager functionality in the router. As a result of the increased output the gateway reloads.

The EC Assistant provides a capability to mark all the devices at the same time, and then click a 'verify' button to determine which ones can become Collectors. When the seed file is large (e.g. 50 devices), the collector verification should be done in batches of 25 to 30 devices at a time.

There are two ways that a collection can be performed:

Manual collection start

Scheduled collection

Manually Start a Collection To start a collection, perform the following steps:

1

2


11:27:08 AM of 74

On the Smart Collector Embedded Assistant application click Start Collection, which starts an on-demand collection; the Start Collection window appears with a confirmation that:

o The seed file was successfully pushed to the gateway.

o The collection was successfully started.

Scheduled collection cannot be kicked off without first performing an initial on-demand collection by clicking Start Collection on the Smart Collector Embedded Assistant. Also it is good to perform an on-demand collection if changes have been made to the seed file, so that a scheduled collection uses the most up-to-date seed file.

Either click Save Seed File, or click Close.

If you click Save Seed File a Save As window appears.

This is a Sanitized Seed File; it is used by the gateway and collector for their collections tasks and is pushed to the gateway. The seed file can also be saved on the laptop as an optional additional step.

Navigate to the folder where the seed file is located, choose the seed file or enter a seed file name, and click Save.


of 74 9/16/2010

When a collection is started, a collection status message appears at the bottom-right corner of the window, indcating that the collection was started. Another status message appears shortly after the first, indicating that the collection is still in progress (see graphic below).

When the collection is finished, another status message appears indicating that the collection completed, and when the collection completed (see graphic below).


11:27:08 AM of 74

Schedule a Collection This is an automatically scheduled collection, once a month that does not need the Assistant present to do the collection. To set the schedule for when the collection will occur, perform the following steps:

Click the Schedule tab; the Schedule Settings window appears.

The Schedule Settings window lets you set the day in the month, and what time that day the unassisted collection will occur.

Click the Day of month drop-down list to specify which day the collection will occur.

Click the Time of day drop-down list to specify which hour of the specified day the collection will occur.

Click Apply to set the specified day and collection time; a confirmation window appears indicating the schedule update was successful.

Click OK; the Device Manage View pane appears.

Synchronize


of 74 9/16/2010

In real time, the client laptop, installed with the Smart Collector Embedded Assistant application, gets a dynamic IP address assigned to it by the network. To synchronize this change and other configuration changes from the Assistant application to the gateway device a “Synchronize” action is performed.

To perform a synchronize, perform the following steps:

Click the Synchronize button; a confirmation window appears indicating that the synchronization was successful.

Click OK; the view returns back to the Smart Collector Embedded Assistant window.

Other Gateway, Collector and End Device Functions Aside from the configuration functions that have been performed there are other functions that a Gateway, Collector and End Device can perform; those functions are:

Gateway Push a Seed File

Edit Gateways, Collectors, End Devices

Unassign an End Device, Collector, Gateway

Delete a Device

Gateway Push a Seed File Before the gateway can push a seed file, the associated collector must have the script file installed (see install a collector), or else you will get the following message.

To have a gateway push a seed file to a collector, perform the following steps:

Click the associated Click Here for the gateway, the context sensitive menu appears.


11:27:08 AM of 74

Click PushSeedFile; the Push Seed File Status window appears.

The status window will indicate a successful push if the seed file push was successful.

Edit Gateways, Collectors, End Devices There are three types of devices that can be edited:

Edit a Gateway

Edit a Collector

Edit an End Device

Edit a Gateway

You can modify certain data for a gateway. Perform the following steps to edit a gateway:

Click the associated Click Here for the gateway.

Click Edit; the Update Device window appears.

Update any of the data in the fields that need to be changed.


of 74 9/16/2010

Click Apply; a confirmation window appears, indicating that the device was successfully updated.

Click OK; the Device Manager View pane appears.

Edit a Collector

You can modify certain data for a collector. Perform the following steps to edit a collector:

Click the associated Click Here for the collector.





Edit an End Device


11:27:08 AM of 74

You can modify certain data for an end device. Perform the following steps to edit an end device:

Click the associated Click Here for the end device.





Unassign an End Device, Collector, Gateway There are three types of devices that can be unassigned:

Unassign an End Device

Unassign a Collector

Unassign a Gateway

Unassign an End Device


of 74 9/16/2010

If there is more than one collector in the device list, you could re-assign an end device from one collector to another collector. To perform the re-assign you must first unassign the end device from the current collector. Perform the following steps to unassign an end device from a collector:

Click the corresponding end device Click Here, a context sensitive menu appears;

In the context sensitive menu click Unassign; a Confirm window appears.

In the Confirm window click Yes.

After the end device is unassigned the unassigned device is no longer indented under the previously assigned collector.

Unassign a Collector

2

1


11:27:08 AM of 74

Before unassigning the collector you must first uninstall the script, or else you will get the following message.

If scripts need to be uninstalled from the gateways or collectors both script removals are performed by the same uninstall process; there is no separate uninstall hyperlink for the collector device on the Smart Collector

Embedded Assistant. Click uninstall in the script installed column (see below).

See Uninstall Gateway and Collector Scripts for more details about uninstalling scripts. The uninstall function

will change the gateway and collector green checkmarks√ to a red X.

Perform the following steps to unassign a collector:

Click the corresponding end device Click Here, a context sensitive menu appears;



1

2

A


of 74 9/16/2010

The Device Manager View pane shows the device roles for the collector and associated end devices as „Not assigned‟.

The red X is also removed from the script installed column of the Collector row.

Unassign a Gateway

Before unassigning the gateway you must first uninstall the scripts or else you will get use the following message:

Perform the following steps to unassign a gateway:

Click the corresponding device‟s Click Here; a context sensitive menu appears.




11:27:08 AM of 74

The Device Manager View pane shows all the device roles as „Not assigned‟.

The red X and the install link are removed from the Script Installed column.

Deleting a Device A device can be deleted from the list of devices displayed on Device Manager View pane. To delete a device from Device Manager View pane, perform the following steps:

Click the corresponding Click Here for the device you want to delete, a context sensitive menu appears.

In the context sensitive menu click Delete; a Confirm window appears.

Click Yes; the device is removed from the list.


of 74 9/16/2010

When deleting a gateway or collector you must uninstall the script first, or else you will get the following message.

Switching Device Roles If you want to switch a device’s role (i.e. gateway to a collector, or a collector to a gateway) the current

assigned role cannot be changed directly to another role. To switch a device’s role, first the current role (e.g.

gateway) must be unassigned, and then the new role (e.g. collector) can be assigned. You can perform the

following role switches:

Switch Gateway role to a Collector

Switch Collector role to a Gateway

Switch End Devices to a Different Collector

Switch Gateway Role to a Collector When you “Unassign” a gateway device you must select another “default gateway device” for the collector device(s) to be assigned to, and other end devices beneath the collector. To switch a gateway to collector role, perform the following steps:

Perform the Unassign a Gateway process: (click hyperlink for more details on this process)

o Unassign the Gateway device to a “Not assigned” state by clicking the corresponding gateway device‟s Click Here, in the Actions column, then click Unassign in the context sensitive menu.

o The Device Role column shows “Not assigned” for every device in the list. Perform the remaining steps to assign a new gateway, collector and end devices.

Perform the Assign a Gateway and Apply Scripts process: (click hyperlink for more details on this process)

o Select an alternate eligible Gateway, a device that has a green checkmark√ in the Gateway +

Collector Eligibility column.


11:27:08 AM of 74

o Click the device‟s corresponding Click Here, in the Actions column, then click Assign Gateway in the context sensitive menu; the Push Script window appears.

o In the Push Script window click Apply Script; a role of Gateway is noted in the Device Role column of the newly assigned gateway.

Perform the Assign a Collector process: (click hyperlink for more details on this process)

o In the device list select an alternate eligible collector, a device that has a checkmark in the Collector Eligibility column.

o Click the device‟s corresponding Click Here, in the Actions column, then click Assign Collector in the context sensitive menu; a window appears asking if the default gateway is available.

o Click OK; the window closes and the Device Manager View is the primary focus again, a role of Collector is noted in the Device Role column of the newly assigned collector.

Perform the Install Collectors process: (click hyperlink for more details on this process)

o On the Device Manager View pane click Install Collectors; the Smart Collector Embedded Assistant pushes script files to the collector.

The push files to the collector could take several minutes.

o After the files have been pushed to the collector, a green checkmark√ is placed under the Script

Installed column, on the collector row.

Perform the Assign End Device process to assign the end device(s) to the new collector.

Switch Collector Role to a Gateway Only one default gateway device is allowed, so you must first unassign the current Gateway device so that the new gateway you want to assign can be assigned. Unassigning the gateway changes all the device roles to “Not assigned”; therefore, you must follow the same steps performed Switch Gateway Role to a Collector:

Perform the Unassign a Gateway process: (click hyperlink for more details on this process)

Perform the Assign a Gateway and Apply Scripts process: (click hyperlink for more details on this process)

Perform the Assign a Collector process: (click hyperlink for more details on this process)

Perform the Install Collectors process: (click hyperlink for more details on this process)

Perform the Assign End Device process to assign the end device(s) to the new collector.

Switch End Devices to a Different Collector Any devices can be assigned as an end device. If you want to assign an end device to a different collector, perform the following steps:

Perform the following steps to unassign an end device from a collector:

On the end device you want to change collectors, click the corresponding Click Here; a context sensitive menu appears.



After the end device is unassigned, the Device Role column shows “Not assigned” for that device, also the unassigned device is no longer indented under the previously assigned collector.

Perform the Assign End Device process to assign the end device(s) to a different collector.


of 74 9/16/2010

Logs The Log View pane provides logging information in two log windows, one from the Smart Collector Embedded Assistant the other from the Syslog. The Syslog info is contained in the „Log from the devices‟ window; the syslog information is sent from the gateway.

To see the information contained in the logs perform the following steps:

Click the Logs button; the Log View pane appears, with the two different windows displaying their respective information.

Click the Open Log button to see additional details about the respective log.

Click the Refresh button to see the most current data for each respective screen.

Uninstalling There are two ways to do that. The partners and customers can unregister the embedded collector when they perform Unassign of Gateway role from Smart Collector Embedded Assistant UI.

If they are not able to do that, the cisco employee can do it through the Smart Portal - Maintain Embedded Collector Page

There are several different install processes:


Uninstall Smart Collector Embedded Assistant Program

Uninstall Gateway and Collector Scripts If scripts need to be uninstalled from the gateways and collectors both script removals are performed by the same uninstall process; there is no separate uninstall hyperlink for the collector device on the Smart Collector Embedded Assistant. The uninstall script process first uninstalls all the installed collector devices under the gateway device then the gateway device themselves are uninstalled.

To uninstall the scripts that were previously installed on the gateway and collector, perform the following steps:

1


11:27:08 AM of 74

To uninstall the scripts from the gateway and collector click the corresponding uninstall to start the script uninstall process; a confirmation window appears.

Click Yes; an In Progress indicator appears in the Script Installed column for both the gateway and collector.

1


of 74 9/16/2010

After the uninstall is finished two items change in the Gateway‟s Script Installed column:

o For both the gateway and collector, the green checkmark changes to a red X.

o For the gateway the uninstall link changes to an install link.

Uninstall Smart Collector Embedded Assistant There are two different uninstall processes for the Smart Collector Embedded Assistant:




The uninstall process in the Device Manager View pane removes the script files from the corresponding gateway/collector(s).

To uninstall the gateway/collector script files, perform the following steps:

On the Device Manager View pane click Uninstall.

1

2

3


11:27:08 AM of 74

The Uninstall process starts and an „In Progress‟ indicator is displayed in the Script Installed column for the gateway and collector.

After uninstalling the gateway and collector scripts the previous green checkmarks√ are replaced with

red X’s and the uninstall link is replaced with an install link.


To uninstall the Smart Collector Embedded Assistant program perform the following steps:

From the Start menu choose Start > All Programs > Smart Collector Embedded Assistant > Uninstall Assistant

The uninstall process starts (see next section).


of 74 9/16/2010

Uninstall Assistant Process

The Uninstall process (initiated from the start menu) brings you to this next window, and then goes through the following steps:

The Smart Collector Embedded Assistant window appears with a loading progress bar, and then displays the Uninstall Smart Collector Embedded Assistant window. The Uninstall Smart Collector Embedded Assistant pane provides information about what is going to occur.

Click Next; the Uninstall Options pane appears.


11:27:08 AM of 74

Choose which uninstall option you want performed, and then click Next; the Uninstall Smart Collector Embedded Assistant pane appears.

The uninstall process stops the Smart Collector Embedded Assistant, in order to proceed with the uninstall.


of 74 9/16/2010

The Uninstall Smart Collector Embedded Assistant pane indicates what features are being removed and the progress of the uninstall.

Click the radio button choice you want the uninstaller to perform, and then click Done; the requested option is performed.

The following will remain after un-installation (when EEM was already in use prior to the embedded collector installation):


11:27:08 AM of 74

The EEM library and policy directories (policies in these directories will be removed, but the directories themselves will remain).

The EEM scheduler thread class default configuration.

If the vty number was increased as part of installation, it will not be decreased.

If SNMP RO community string was added as part of installation, it will remain.

Help There is a Help section that contains a lot of useful information. There are several sections to the Help file, those sections are:

Description of the Smart Collector Embedded Assistant application.

List of Help topics.

Navigation aids.

To view different topics perform the following steps:


of 74 9/16/2010

Select a topic; the page for that topic appears in the window.

There are several pieces of information to be noted:

The page number the topic is displayed.

The topic names.

Topic content and notes.

1

2

2


11:27:08 AM of 74

Navigational aids: you can navigate to another area by clicking one of the following items:

o Previous – goes to previous page (page 2).

o Next – goes to next page (page 4).

o Back to Top – if there is more data than can fit within the window, a scroll bar appears on the right. The navigational aids will be at the bottom of the window and clicking Back to Top will move the display to the top of the window.

Clicking Back to Top, when there is no scroll bar, does not alter the display of data.

o Go to Home – goes back to the initial page where all the topics are listed.

Appendix Additional information related to Smart Collector Embedded Assistant operation are note in the following items:

Troubleshooting Guide for Smart Collector Embedded Assistant Errors

Running Config Info for Gateways and Collectors

Troubleshooting Guide for Smart Collector Embedded Assistant Errors This section lists fixes for those areas listed below:

Device Communication

Verify Gateway

Push script

Verify Collector

Install Collector

Start Collection

Device Communication

Here are some items that can be checked if there are problems with device communication:

Telnet will be tried first, if it fails, then SSH will be tried next. Manually check which protocol is successful, if device communication fails.

There are numerous ways to configure TACACS; the most important aspect of any solution is that the credentials in the seed file have the appropriate privilege, whether using local or centralized AAA.

What happens if Smart Collector Embedded Assistant no longer receives syslog messages from the devices it interfaces?

o The IP address may have been changed on the machine when Smart Collector Embedded Assistant was actively running; change the IP address back to the original IP Address.

Verify Gateway

The following items can be manually checked to verify information about the gateway that interfaces with Smart Collector Embedded Assistant.

Check Telnet/SSH works fine manually with credentials.

Ensure that disk space is available by issuing the show file systems command.

If a disk is selected, please check that you are able to write/create a directory into that disk space.


of 74 9/16/2010

Verify that ICMP is enabled in the gateway and that the gateway can ping the Cisco backend.

Verify that the EEM version is => 2.4 or higher.

Gateway should have IOS.

Push Script

The following items can be manually checked to verify that the Push Script works properly:

Check windows firewall security, ensure it is turned off.

Check Telnet/SSH, ensure that it works fine manually, with credentials.

Check if TFTP works fine by manually copying a sample file from Smart Collector Embedded Assistant to a device (i.e. verify that the TFTP port is not being used by another service).

TFTP pushing shouldn‟t take more time; otherwise, a timeout exception will occur.

Ensure that tar archive extraction is working fine.

Ensure that all configurations are performed in config mode.

Ensure that the certificate is installed correctly.

Verify Collector

The following items can be manually checked to verify collector requirements and operation:

Verify that Telnet/SSH works fine manually with credentials.

Verify that the windows firewall security is turned off.

Check that the syslog is pointing to a Smart Collector Embedded Assistant (HD) IP address by checking the IOS log command (i.e. issue the show running config | inc log command).

Verify that the HD Syslog server is running, and that the syslog messages are directed to the Smart Collector Embedded Assistant.

Please ensure that the seed file is pushed to the gateway, for collector verification.

Please ensure the hostname is given correctly in the seed file; otherwise, LWC will obtain an error that will not be able to identify the gateway.

Please check that the syslog message has “COLLECTOR_VERIFICATION_PASSED for <devicename>” or “COLLECTO.R_VERIFICATION_FAILED for <devicename> is coming in the log.

Install Collector

Perform all the steps given in the verify collector process, except the last step.

Check the syslog for one of the following messages:

o COLLECTOR_INSTALLATION_PASSED for <devicename>.

o COLLECTOR_INSTALLATION_FAILED for <devicename> is coming in the log.

Start Collection

Perform all the steps given in the verify collector process, except the last step.

FAQ’s The following are Frequently Asked Questions (FAQ‟s) for the Smart Collector Embedded Assistant application:

What are the system requirements for Smart Collector Embedded Assistant?

o 32 bit windows operating system (Windows XP is recommended).


11:27:08 AM of 74

o 2 GB of RAM.

o 2 GB of recommended free disk space for installation.

What system resources are required for the Smart Collector Embedded Assistant?

o Smart Collector Embedded Assistant uses pre-defined or configured ports on the machine for its internal communication.

o By default, ports #69 and #514 will be used by Smart Collector Embedded Assistant for running the built-in TFTP and Syslog servers; however, these ports can be configurable in the Smart Collector Embedded Assistant UI. See User guide on how to configure and define the ports for Smart Collector Embedded Assistant.

How do I check the EEM Version?

o Log into the device

o Issue the show event manager version command

o Look at the first line, which shows the EEM version; the version should be 2.4 or later.

How do I check for PKI support?


o Issue the show subsys | inc ipsec_common command

o Look for ipsec_common in the output

o If PKI is not supported, chose another device with a crypto image or upgrade the IOS image.

How do I verify that there is sufficient free local storage?


o Issue the show file systems command.

o Look for the “Free” column for a file system with sufficient space.

How do I check if there is secure connectivity between gateway and collectors?

o Log into the device and enter privileged mode.

o Issue the copy nvram:/startup-config scp://user:passwd@<gateway_ip>/<gateway_file_system>/test.cfg command

o Verify the copy completes successfully.

How do I check the Memory - DRAM Size

o Expected DRAM for Gateway as well as Collectors is 256 Mbytes or greater.

o Issue the show version | include bytes of memory command, which shows the available memory on a router.

o Issue the show memory | include Processor command; the third column in the output shows the amount of free memory.

What happens if one or more pre-defined ports on the machine are blocked?

o Smart Collector Embedded Assistant requires the pre-defined or configured ports to be always available and should not be blocked by the firewall or the OS.

o Smart Collector Embedded Assistant might not be fully responsive for any blocking or unavailability of the pre-defined or configured ports. For example, we can see an “Indefinite progress bar appears during the installation of the Gateway scripts” or “accurate status of the collector installation might not be reflected or updated in Smart Collector Embedded Assistant user interface”.

What happens if the IP address of the machine is changed when Smart Collector Embedded Assistant is active and running?

o If the IP address is changed on the machine, which Smart Collector Embedded Assistant is actively running, then Smart Collector Embedded Assistant will no longer able to receive syslog messages from the devices it interfaces.

How can I check the status of Smart Collector Embedded Assistant predefined or configurable port numbers?

o Open a new command prompt on the machine.


of 74 9/16/2010

o The following command gives the status of the port number “69”.

netstat -a|find "69"

Can I have an external TFTP and Syslog Servers installed on the machine?

o Yes, but it is always recommended to not install any third-party syslog, or tftp servers on the machine.

How can I make sure no other TFTP server is running on the machine?

o Before installing or starting the Smart Collector Embedded Assistant, please check if default port “69” (or configured port number) is free. Otherwise, please make sure you free it or configure an alternate free port number in the Smart Collector Embedded Assistant.

o Follow the following steps to free up port 69:

1. From the Start->Run cmd window, issue the following command:

C:\netstat –nao

2. Look for port 69 using the command - netstat –nao | find “:69” 3. If the port is in use, run the following command to get the executable name:

TASKLIST | find <PID matching port 69 from prev step 2>

4 .Terminate or end the PID specific executable from Task Manager

How can I make sure no other Syslog server is running on the machine?

o Before installing or starting the Smart Collector Embedded Assistant, please check if default port “514” (or configured port number) is free. Otherwise, please make sure you free it or configure an alternate free port number in the Smart Collector Embedded Assistant. Ensure the port is not blocked by the firewall.

How to check if the system ports are being blocked by the firewall?

o Normally, windows firewalls like “MacAfee” or any security agent might block the ports. Please check the logs of the security agent and un-block the port if any.

Running Config Info for Gateways and Collectors The following items list all the possible changes to the running configurations of devices that were identified as either gateways or collectors in the Smart Collector Embedded Assistant application.

Some changes may not be necessary if already configured, e.g., EEM policy or library directories.

Gateway Device

The following items identify configuration changes that can occur to gateway devices.

EEM Configuration Changes

event manager directory user policy "<Policy_Dir>"

event manager directory user library "<Library_Dir>"

event manager scheduler script thread class default number 10

event manager policy Cisco_Scheduler.tcl

event manager policy Cisco_C_Control.tcl

event manager policy Cisco_SNMP_Collector.tcl

event manager policy Cisco_CLI_Collector.tcl

event manager policy Cisco_Transport.tcl

event manager policy Cisco_Verifycollector.tcl

event manager policy Cisco_Uninstall_Collector.tcl

event manager applet emb_collector

event timer cron cron-entry "0 1 5 * *"

action one policy CIsco_Scheduler.tcl


11:27:08 AM of 74

In addition to the above configurations, the following list of EEM environment variables may be configured via

the “event manager environment <variable> <value>” configuration Cisco IOS CLI.

Variable Description

_SE_SEED_FILE

URL to seed file

_TC_ID

TCL Collector ID from

registration

_TC_TOKEN

Security Token from

registration

_INVENTORY_NAME

User defined string identifying

this network

_TCBIFF_ROOT

URL to store collected data

_SE_ARCHIVE_DIR

URL to store tar archives

_CISCO_REPOSITORY IP or FQDN of Cisco DMZ

_SVCLOC Service location name where

the tar file is sent via https

_GW_CHASSIS_SN Gateway Device’s Serial

Number

Other Automated Configuration Changes

Other config changes that are automated are noted below:

Additional vty lines may be required. The embedded collector runs multiple EEM policies

concurrently. Each policy that interacts with the Cisco IOS CLI will require a vty.

SNMP server-manger will be configured if not already enabled

SNMP RO community string will be configured to match the seed file entry if required

Other Manual Configuration Changes

The following changes may be needed for secure gateway – collector communication:

aaa new-model



ip domain name <domain>

username cust1 privilege 15 password 0 test (to match seed file credentials)



line vty 0 <platform_max>

transport input <ssh | all>

Files Copied to Local Storage

Files that are copied to local storage are noted below:


of 74 9/16/2010

EEM Policies

Cisco_C_Control.tcl

CIsco_SNMP_Collector.tcl

Cisco_Forwarder.tcl

Cisco_CLI_Collector.tcl

Cisco_Scheduler.tcl

Cisco_Transport.tcl

Cisco_Uninstall_Collector.tcl

Cisco_Verifycollector.tcl

EEM Library File

Cisco_debug.tcl

Cisco_eemcli.tcl

Cisco_ICF_Sup.tcl

Cisco_ICF.tcl

Cisco_md5.tcl

Cisco_seed_file.tcl

Cisco_SNMP_Sup.tcl

Cisco_TCBIFF_Sup.tcl

tclIndex

Cisco_util.tcl

Collector Device

The following items identify configuration changes that can occur to collector devices.

EEM Configuration Changes

event manager directory user policy "<Policy_Dir>"

event manager directory user library "<Library_Dir>"

event manager scheduler script thread class default number 10

event manager policy Cisco_SNMP_Collector.tcl

event manager policy Cisco_CLI_Collector.tcl

event manager policy Cisco_Forwarder.tcl

In addition to the above configurations, the following list of EEM environment variables may be configured via

the “event manager environment <variable> <value>” configuration Cisco IOS CLI.

Variable Description

_TCBIFF_ROOT URL to store collected data

_SE_ARCHIVE_DIR URL to store tar archives

Other Automated Configuration Changes

Other config changes that are automated are noted below:

Additional vty lines may be required. The embedded collector runs multiple EEM policies

concurrently. Each policy that interacts with the Cisco IOS CLI will require a vty.

SNMP server-manger will be configured if not already enabled

SNMP RO community string will be configured to match the seed file entry if required


11:27:08 AM of 74

Other Manual Configuration Changes

The following changes may be needed for secure gateway – collector communication:

aaa new-model



ip domain name <domain>

username cust1 privilege 15 password 0 test (to match seed file credentials)



line vty 0 <platform_max>

transport input <ssh | all>

Files Copied to Local Storage

EEM Policies

Cisco_SNMP_Collector.tcl

Cisco_Forwarder.tcl

Cisco_CLI_Collector.tcl

EEM Library File

Cisco_debug.tcl

Cisco_eemcli.tcl

Cisco_ICF_Sup.tcl

Cisco_ICF.tcl

Cisco_md5.tcl

Cisco_seed_file.tcl

Cisco_SNMP_Sup.tcl

Cisco_TCBIFF_Sup.tcl

tclIndex

Cisco_util.tcl

File Structures and EEM Environments The following items contain information file structures and environment variables for gateways and collectors

Gateway Device – File Structure & EEM Environment Variables

Collector Device – File Structure & EEM Environment Variables

Gateway Device – File Structure & EEM Environment Variables

The following graphics show the file structure and EEM environment variables for a gateway device. Below

each graphic is a brief description of what the data represents:


of 74 9/16/2010

EEM variables after applying gateway script but before registration from Assistant

Policy files in the Gateway


11:27:08 AM of 74

Library Files in the Gateway

Files copied after Assign Gateway -> Apply Script operation.


of 74 9/16/2010

Gateway device directory showing the seed files (*.csv).

EEM variables set after Apply Script and After registration.

Collector Device – File Structure & EEM Environment Variables

The following graphics show the file structure and EEM environment variables for a collector device. Below

each graphic is a brief description of what the data represents:


11:27:08 AM of 74

EEM variables set on the collector device after the Install Collector operation.

Folder structure in the collector device, after the Install Collector.


of 74 9/16/2010

Policy files on the collector device.

Libraries on the collector device.

Seed File Format and Contents The installation bundle contains a sample seed file “seedFile_without_headers.csv”. You can manually add your devices into the sample seed file spread sheet and then import it.

For the Collector Column (column #33) or Gateway column (column #34) they should contain a valid ip address that contains no spaces.

This appendix contains the exact format for the Smart Enabler seed file:

; This file is generated by the export utility of Service Appliance 1.0, If you edit this file, be sure you know what you are doing

Cisco Systems NM data import, source = export utility; Version = 1.0; Type = Csv


11:27:08 AM of 74

; Here are the columns of the table.

; Col# = 1: IP Address (including domain or simply an IP) - Mandatory

; Col# = 2: Host Name - Mandatory

; Col# = 3: Domain Name

; Col# = 4: Device Identity - Mandatory

; Col# = 5: Display Name

; Col# = 6: SysObjectID

; Col# = 7: DCR Device Type

; Col# = 8: MDF Type

; Col# = 9; Snmp RO - Mandatory

; Col# = 10; Snmp RW

; Col# = 11; SnmpV3 User Name

; Col# = 12; Snmp V3 Auth Pass

; Col# = 13; Snmp V3 Engine ID

; Col# = 14; Snmp V3 Auth Algorithm

; Col# = 15; RX Boot Mode User

; Col# = 16; RX Boot Mode Pass

; Col# = 17; Primary User(Tacacs User) - Mandatory

; Col# = 18; Primary Pass(Tacacs Pass) - Mandatory

; Col# = 19; Primary Enable Pass - Mandatory

; Col# = 20; Http User

; Col# = 21; Http Pass

; Col# = 22; Http Mode

; Col# = 23; Http Port

; Col# = 24; Https Port

; Col# = 25; Cert Common Name

; Col# = 26; Secondary User

; Col# = 27; Secondary Pass

; Col# = 28; Secondary Enable Pass

; Col# = 29; Secondary Http User

; Col# = 30; Secondary Http Pass

; Col# = 31; Snmp V3 Priv Algorithm

; Col# = 32; Snmp V3 Priv Pass

; Col# = 33; User Field 1 - Will be used to indicate this device's collector - Mandatory

; Col# = 34; User Field 2 - Will be used to indicate this device's gateway

; Col# = 35; User Field 3

; Col# = 36; User Field 4

;

; Here are the rows of data.

sampledevicename,,,,,,,,public,,,,,,,,cncusr,cncpwd,cncenpwd,,,,,,,,,,,,,,,,,

smart collector embedded assistant user guide - cisco.com filesmart collector embedded assistant...

Documents