Getting Started Guide

Transcription

1 automap and autoasset tools Getting Started Guide Codima Inc. All Rights Reserved. Page 1

2 INDEX INTRODUCTION Installation Check list Loading Access Information Toolbox packaging APPENDICES APPENDIX 1 GETTING STARTED DIAGRAM AND CHECK LIST APPENDIX 2 SITE PLANNING AND OTHER DISCOVERY ISSUES APPENDIX 3 DEPLOYMENT APPENDIX 4 SYSTEM REQUIREMENTS APPENDIX 5 AUTOMAP OPERATION WITH AUTOVOIP, AUTOPINGER AND MICROSOFT OFFICE VISIO PROFESSIONAL 2007 APPENDIX 6 AUTOMAP OPERATION WITH MICROSOFT BASELINE SECURITY ANALYZER APPENDIX 7 USEFUL REFERENCE MATERIAL AND HELP LINKS INTRODUCTION The automap tool automatically:- Discovers network topology Presents the information as Microsoft Office Visio drawings The autoasset tool automatically Discovers network topology Presents the information as inventory reports. The discovery process uses the Codima Discovery Engine. Display showing features of the automap tool and the autoasset Tool which can be added to it, to enhance functionality Codima Inc. All Rights Reserved. Page 2

3 Installation Use the following URL to obtain detailed installation/upgrade instructions and other relevant information. Check list Use the following URL to obtain a hard copy of a check list covering what is needed to successfully use the Codima Tools to provide network topology drawings and asset inventory reports. It summarises the checks described in this document. Loading Use Start Menu select programs : Codima, Codima Toolbox Access Information Expand the automap or autoasset branch of the Pane 1 Tree view. automap with autoasset included:- autoasset only:- Toolbox packaging The automap tool can be a standalone tool or it can be supplied as part of a Consultancy Kit. The autoanalyzer Consultancy Kit includes the automap and the autoanalyzer tools, if using this kit you should also refer to the autoanalyzer Consultancy Kit Getting Started Guide The autovoip Consultancy Kit includes the automap, the autovoip, the autovoip Blaster and the autoanalyzer tools, if using this kit you should also refer to the autoanalyzer Consultancy Kit Getting Started Guide, the autovoip Getting Started Guide and the autovoip Blaster Getting Started Guide. The autoasset tool can be supplied on its own or it can be combined with the automap. This guide covers both situations. The guide highlights any parts that apply solely to the automap or autoasset tools Codima Inc. All Rights Reserved. Page 3

4 APPENDICES The following Appendices are provided to ensure you have all the necessary components and information needed to use the Codima Discovery Engine and the associated automap /autoasset tools.. APPENDIX 1 GETTING STARTED DIAGRAM AND CHECK LIST covering :- 1. Prerequisite software 2. Choosing SQL Database type 3. Platform checks 4. License Files 5. Network Connection 6. Platform IP address 7. Configuration : Start Discovery Settings/End of Discovery Tasks 8. Summary list of actions to start a discovery 9. End result Microsoft Office Visio views and asset inventory reports APPENDIX 2 SITE PLANNING AND OTHER DISCOVERY ISSUES Check list covering:- 1. Site Planning : SNMP, WMI 2. Other issues : Router/Switch Response, Firewalls APPENDIX 3 DEPLOYMENT covering :- 1. Connecting automap /autoasset tools to Network APPENDIX 4 SYSTEM REQUIREMENTS APPENDIX 5 AUTOMAP OPERATION WITH AUTOVOIP, AUTOPINGER AND MICROSOFT OFFICE VISIO PROFESSIONAL 2007 APPENDIX 6 AUTOMAP OPERATION WITH MICROSOFT BASELINE SECURITY ANALYZER APPENDIX 7 USEFUL REFERENCE MATERIAL AND HELP LINKS Codima Inc. All Rights Reserved. Page 4

5 APPENDIX 1 GETTING STARTED CHECK LIST Diagram showing network connection and highlighting key configuration information:- 1. Prerequisite software Ensure that the automap /autoasset is installed with the prerequisite software and correctly configured. Prerequisite components - automap Microsoft Office Visio 2007 Professional or 2003 Edition - Codima does not supply this software. Please note that Microsoft Visio Viewer is not sufficient to display the results of the discovery process, you must have a fully (activated) copy of Microsoft Office Visio to generate automap Visio Views (though not to perform the initial discovery). To operate with the automap Microsoft Office Visio 2003 we recommend that you set the Security level to low Codima Inc. All Rights Reserved. Page 5

6 Microsoft Office Visio Professional 2007 can also be used to introduce some additional functionality, see APPENDIX 5 Prerequisite components - automap and autoasset Java Runtime Engine, Standard Edition (JSE) V Installed automatically as part of the Toolbox Installation Microsoft Access driver - The installation program installs and configures a Microsoft Access database connector to the Discovery database. MySQL ODBC Connector - The installation program installs the ODBC for the mysql Server. 2. Choosing SQL Database type SQL Database range The Discovery Engines ODBC data source can be configured to use:- Microsoft Access driver (default setting) mysql driver (for scheduling multi-site discovery runs) Structured Query Language (SQL) forms the backbone of most modern database systems - the Codima Discovery Engine defaults to use a Microsoft Access database to store discovery results. Microsoft Access databases are 100% open, so SQL queries can be run on them. You can change the database used by the Codima Discovery Engine to mysql after installation. Check list for multi-site scheduling/using MySQL databases If you plan to use mysql databases to store the discovery results, you should: - 1. Install the Toolbox software 2. Change the database type to mysql 3. Install and configured mysql Servers. 4. Set up a new mysql databases for each of sites you plan to include in the multi-site schedule. 5. Complete a successful discovery run on each of the sites. For instructions covering this process, see Help entries titled:- 1. How to change database type 2. How to use Multi-site scheduler Codima Inc. All Rights Reserved. Page 6

7 3. Platform Check 1. Ensure the PC Platform meets the minimum specification for the automap /autoasset tool, see APPENDIX 4 2. Ensure that the PC Platforms has hibernation/standby disabled. 4. License File Ensure you have the correct license file to operate this tool. The automap /autoasset tools require:- A Toolbox license (license.txt) A Trial license file is provided when you download a trial version of the tool from the Codima Web site. For non trial systems A Machine locked Toolbox License file is ed with installation instructions. The Toolbox license defines the User Interface, e.g., configures it as:- automap autoasset automap combined with autoasset Ensure license file is copied to the correct folder. Copy Toolbox license file (License.txt) into the "C:\Program Files\CODIMA\Express\neonet\bin\license\" folder If you have a Pay As You Go license, ensure you are able to connect to the Internet, as the Toolbox will close down if you fail to report discovered device counts to the Codima PAYG Server on a regular basis. 5. Network Connection Ensure automap /autoasset is connected to Network, and is correctly positioned and configured to undertake active analysis. Access to an SNMP compliant Router/Switch is essential to the operation of the Codima Discovery Engine.. You can not normally undertake active operations for example when connected to a Mirror Port For detailed information on deployment, see APPENDIX Codima Inc. All Rights Reserved. Page 7

8 6. Platform IP Address Does the automap /autoasset Host PC have a suitable IP Address for the network it is connected too, can you ping the Seed List - Start Point IP address from the Host PC? Is the automap /autoasset tool configured with the correct IP address?, for example if using these tools on a network with DHCP, you may find that the IP address configured on the automap /autoasset system is no longer the one allocated to the Network Adapter Card. In such cases undertake the following actions:- 1. Close the Toolbox 2. Delete the file Network Interface Settings from the root directory C:\Program Files\CODIMA\Express 3. Restart the Toolbox - you will immediately have access to the Product Selector - Choose Network Interface dialog box 4. Select the appropriate tab, i.e., automap and select the required range of adapters Codima Inc. All Rights Reserved. Page 8

9 7. Configuration : Start Discovery Settings/End of Discovery Task The help entries titled How to start mapping and How to configure end of discovery Tasks provides detailed information covering the activation of the discovery process and selecting the tasks to be actioned when discovery finishes. The process to start a discovery involves the following steps:- Step Number Step Page(s) 1 COMPULSORY ACTIONS : USING START DISCOVERY SETTINGS TAB OPTIONAL ACTIONS : USING THE START DISCOVERY ADVANCED SETTINGS TAB 11 3 OPTIONAL ACTIONS : USING THE END OF DISCOVERY TASKS TAB 12 4 CLICKING ON THE START BUTTON TO START THE DISCOVERY PROCESS See listed pages for detailed guidance Codima Inc. All Rights Reserved. Page 9

10 COMPULSORY ACTIONS USING START DISCOVER SETTINGS TAB Interface example, showing dialog box used to:- Provide the required settings for a FAST discovery Ensure that the correct Start Discovery Settings are used:- Start Discovery Settings Required Settings Setting Network Name Seed List Discovery devices outside the scope of the seed list SNMP Discovery Notes This should be a name that describes the Network being mapped. This field must be completed. If you plan to run the discovery process more than once on the same network this name is used as a cross-reference Used to set start point for the discovery and the IP address range you want discovery to be applied to, see Help entry titled:-.how to control IP address range used by discovery engine Controls how the seed list is interpreted. When not ticked (the default setting) only the devices that are within the scope of the seed list are scanned. When ticked, the discovery will use routing and forwarding data from SNMP enabled routers and switches to automatically discover devices and links with IP addresses outside the scope of the seed list. SNMP v1 and v2 Read Community strings SNMP Read community, e.g., public,secret,special OR SNMPv3 Security parameters. For detailed information on SNMPv3 parameters use F1 to access help after you click on the SNMPv3 Security button. The Discovery Engine uses the above settings and other default settings to operate in a Fast Mode. The management protocol used for the discovery when running in the Fast mode is SNMP. You can enhance the discovery process using the Start Discovery Advanced Settings dialog box, see next section for details Codima Inc. All Rights Reserved. Page 10

11 Test Seed List button Use the Test Seed List button to check that the Start and End addresses in the Seed List responds to an SNMP request Recommend action prior to starting discovery. Tip: You can also use the Test Seed List button as a quick means of checking that your managed devices are going to able to respond to the SNMP requests associated with the discovery process. Instead of starting the discovery just temporarily changes the Seed List start address to the IP address of the managed device, add the read community string and click on the Test Seed List button Codima Inc. All Rights Reserved. Page 11

12 OPTIONAL ACTIONS USING START DISCOVER ADVANCED SETTINGS TAB Interface example, showing dialog box used to make changes that will affect the speed and depth of the discovery This dialog box is used to:- Change the Discovery Speed Include a Ping Scan as part of the discovery process Add additional protocols to the discovery process Undertake detailed VLAN scanning during discovery For detailed information on this dialog box use view the field specific tooltips and the on line help press <F1> to access Codima Inc. All Rights Reserved. Page 12

13 OPTIONAL ACTIONS USING THE END OF DISCOVERY TASKS TAB OPTIONAL ACTIONS : USING THE END OF DISCOVERY TASKS TAB Interface example, showing dialog box used to:- Select the tasks to be run automatically when discovery is complete Start the discovery process The options provided cover:- automonitor - Use this discovery to automatically monitor this network When ticked, automatically activates automonitor's SNMP Poll Manager Dialog to allow you to quickly update or create the SNMP Poll List using the latest discovery. This action is applied when the discovery has completed and is loaded. This feature is only available if you have an automonitor enabled Toolbox. See Help entry titled:- o How to configure Toolbox to provide access to automonitor SNMP Poll Manager when discovery is finished autoasset - Use this discovery to create the Asset Web Report When ticked a new Asset Web Report is created from the latest discovery and then opened in your Web Browser. This feature is only available if you have an autoasset enabled Toolbox. See help entry titled:- o How to configure Toolbox to create a Web report automatically following completion of a discovery run Codima Inc. All Rights Reserved. Page 13

14 automap - Open Visio View(s) Used to select which Visio Views of the network you want to automatically create from the latest discovery. Click on the adjacent Visio icon button to select from the view list. This feature is only available if you have an automap enabled Toolbox, with Microsoft Office Visio 2003 or later installed. See Help entry titled:- o How to open automap Visio Views automatically Toolbox - Send an when discovery has completed to Enter one or more addresses separated by spaces. Your program must be configured to allow scheduled sends, even when off-line. See Help entry titled:- o How to configure Toolbox to send an when network discovery is finished Codima Inc. All Rights Reserved. Page 14

15 8. Summary list of actions to start a discovery Codima Inc. All Rights Reserved. Page 15

16 9. End Results automap : Automatically produces Microsoft Office Visio drawings If you have Microsoft Office Visio installed, when discovery is completed, the database will be loaded automatically and any Visio Views you have selected using the Open Visio View option in the End of Discovery Tasks Tab will be opened automatically. Example covering some of the Microsoft Office Visio views Top layer views can be produced automatically. Drill down views can be produced manually ( right click and select menu item titled Drill Down to Drawing). The drawings can then be saved as.vsd or.htm files. Saving to.htm format will provide a Web page Codima Inc. All Rights Reserved. Page 16

17 Once you have undertake one successful discovery on a network, it is possible to then use the Discovery scheduler to automate both the discovery process and the production of Visio drawings (.vsd and.htm format) and if user also has the autoasset Add on, HTML Reports. For detailed information, see Help entry titled Scheduled Discovery automap/autoasset autoasset : Asset View and HTML Report production When discovery is complete (in situations where automap is not included) the final stage will be the opening of a tree view showing the results of the discovery run. The tree view will have individual branches for each type of device/object discovered, and tabs to access detailed information :- When discovery is complete a web report will be created, if you have selected in the End of Discovery Tasks to create and open a HTML Web report. Alternatively you can manually create an HTML Web Report using the Report Menu/Create Web report option. This Report sorts the assets by Vendor and Type, and provides a number of advanced reports Codima Inc. All Rights Reserved. Page 17

18 APPENDIX 2 SITE PLANNING AND OTHER DISCOVERY ISSUES To make best use of the Codima Discovery Engine used by the automap /autoasset you need to consider the methods used by the discovery process, and how well your site is prepared to enable it to run efficiently. The Codima Discovery Engine can be configured to use a number of protocols/methods including SNMP, SIP Queries, CDP, ICMP, WMI, and NetBIOS in the discovery and inventory process. For the most complete inventory, you need to ensure that your devices are correctly enabled to use these technologies - see o APPENDIX 1 diagram covering network connection and key configuration information o SNMP Planning and WMI Planning entries in this appendix. Device Library and SNMP MIB Support Check the device type list used by automap /autoasset (see Note 1) prior to running a discovery, as it will help you establish if the key device types on your network have already been incorporated in to the Codima discovery engine. Note 1: The Discovery Menu option titled Manage Device Library provides access to the device type list for full information see Help entry titled How to use Device Library. Check the MIB support associated with the Codima Discovery Engine, click here to access the MIB list. Toolbox_SNMP_MIB_List.zip Codima Inc. All Rights Reserved. Page 18

19 SNMP Planning It is important that all devices that are going to rely on SNMP as the main discovery protocol are configured correctly for IP and have SNMP Agents installed. The SNMP information required will depend on the version of SNMP. User needs to provide :- Addresses for Seed List Used to set start point for the discovery and the IP address range you want discovery to be applied to, ideally the start point should be an SNMP compliant Router or Switch A suitable IP address for use by automonitor Host PC SNMP information o SNMPv1 and v2 - Read community strings for the network (multiple Read community strings are supported). o SNMPv3 authentication and privacy information A physical connection to the network, e.g., free switch port Check list:- SNMP support Key devices need to have an SNMP Agent installed. SNMP access - You must be able to browse the discovery start point SNMP information - The correct range of SNMP read communities/authentication/ privacy information must be included in the start up parameters VLAN - The automonitor host Workstation must be on the management VLAN. Access restrictions - Devices should be checked to ensure they are not configured with filters or Access Lists restricting which administration addresses are allowed. Firewalls - For discovery to work, the Firewall needs to be configured to allow the automonitor Host PC to transmit and receive as a trusted user, for example to allow ICMP and SNMP source and destination packets through the Firewall. If running on a PC with XP service pack 2 that uses the XP system embedded firewall, ensure that you open the SNMP Ports Codima Inc. All Rights Reserved. Page 19

20 WMI Planning Microsoft WMI is implemented and enabled, by default, on all Windows 2000, XP, 2003 and Vista systems. Check list :- Domain Administrator - The discovery engine must be run from a Domain Administrator account WMI Support o o WMI discovery must be ticked in the Start Discovery dialog it is an option under the Start Discovery Advance Settings Tab. Network devices must support WMI. The Discovery Engine will identify all WMI supported machines logged on that Domain Can obtain WMI from:- o Windows 2000 (SP4 or later) o Windows XP o Windows 2003 o Vista Can NOT obtain WMI from:- o Windows 95 o Windows 98 o Windows NT (pre SP6) Microsoft recommends the latest service pack when using WMI on NT. Wrong permission means that the workstation you are running Codima Discovery Engine from is not a domain administrator or the workstation you are trying to discover is not logged on to the same domain. Either way windows has not given permission for you to access the WMI RPC services on the remote workstation. To obtain WMI information the discovery must be run from a Domain Administrator account Codima Inc. All Rights Reserved. Page 20

21 Other issues 1. Router/Switch response : Router/Switches may be not responding to SNMP User needs to check o SNMP access - Can you browse the start point?. Can you browse the Switches? o SNMP information SNMP v1 and v2 - Have you included all the required SNMP Read Community in the start up parameters SNMP v3 Have you configured the required authentication and privacy settings. o o VLAN - The automonitor Host PC must be on the management VLAN. Access Restrictions - Devices should be checked to ensure they are not configured with filters or Access Lists restricting which administration addresses are allowed. 2. Firewalls : The discovery operation may be blocked by a firewall User needs to check o Firewalls - For discovery to work, the Firewall needs to be configured to allow the automap /autoasset Host PC to transmit and receive as a trusted user, i.e., to allow SIP, ICMP and SNMP source and destination packets through the Firewall. If running on a PC with XP service pack 2 that uses the XP system embedded firewall, ensure that you open the SNMP Ports Codima Inc. All Rights Reserved. Page 21

22 APPENDIX 3 DEPLOYMENT Connecting automap /autoasset to Network The Toolbox software needs a standard Network Adapter (NIC) to run the active operations required for the discovery process, it requires only one Network Adapter. This section covers connecting the Network Adapter (NIC). Diagram showing how to connect automap /autoasset to network:- The NIC should be connected to a free port on a Hub or Switch. It should not be connected to a mirror/span port. Diagram showing automap /autoasset deployment:- See also Appendix 1 diagram covering network connection and key configuration information Cables :- Use an RJ45/Cat 5 drop cable Codima Inc. All Rights Reserved. Page 22

23 APPENDIX 4 SYSTEM REQUIREMENTS Here are the operating requirements for the PC platform to be used with the automap /autoasset tools. IMPORTANT INFORMATION The information below applies to the minimum specification, Codima strongly recommend when using this tool on medium/large networks that you use the best platform available, for example use PCs with 2Gb of memory, avoid PCs with Celeron chips or slow memory bus speeds. Multi core processors also work well with this tool, as the discovery process uses multi-threading. DESCRIPTION REQUIREMENTS/ADDITIONAL INFORMATION PC Platform 2 GHz or faster. Minimum 512 Mbytes - but for some of the applications associated with the automap, you ideally need at least 1Gb. Memory 2Gb is recommeded for larger networks. Note: The memory recommendations apply to the use of the Codima Toolbox applications, if you are running other memory intensive applications on the PC you will need more memory. Graphics Card Operating System Minimum 16Mb Microsoft XP Microsoft Windows 2003 Server Microsoft Vista Software Versions Microsoft Internet Explorer Version 6 or above. Disk space Monitor resolution Minimum 5 Gb 1024 X 768 (minimum) Codima Inc. All Rights Reserved. Page 23

24 APPENDIX 5 AUTOMAP OPERATATION MICROSOFT OFFICE VISIO PROFESSIONAL 2007 Microsoft Office Visio Professional 2007 provides a facility to show information as data graphics. This Appendix describes the different ways that this facility can be used by the automap tool. Toolbox contains automap and autovoip The discovery process can find SIP Phones, SIP Servers and SIP Gateways that respond to SNMP requests and SIP Queries. The information is presented in topology drawings. Additional information can be supplied to users who have the autovoip Tool and Microsoft Office Visio Professional 2007 installed. The autovoip tool will provide phone status for all the SIP phones on the parts of the network it is monitoring (even if they do not respond to SIP Queries or SNMP requests). This facility enables real time status to be viewed using the automap topology drawings. The facility is available to users who have the autovoip Consultancy Kit installed, as this kit combines the automap and autovoip tools. Topology view excerpt highlighting SIP Phone and SIP Server Codima Inc. All Rights Reserved. Page 24

25 Toolbox contains automap and autopinger or automonitor Users who have the autopinger Tool and Microsoft Office Visio Professional 2007 installed will also be able to see the Pinger results visually in the automap drawings. Users who have the automonitor Tool and Microsoft Office Visio Professional 2007 installed will also be able to see the hot spots/bottlenecks identified by the automonitor visually in the automap drawings. Topology view showing Pinger results and hot spots Green arrow = device responding Red arrow = device not responding Green and Red traffic lights indicate hotspot status for device Red and Amber links indicate hotspot status for interfaces Codima Inc. All Rights Reserved. Page 25

26 APPENDIX 6 AUTOMAP OPERATATION WITH MICROSOFT BASELINE SECURITY ANALYZER The automap Visio Views can operate with Microsoft Baseline Security Analyzer. The Visio 2007 Connector for MBSA allows you to visualize MBSA scan results on a Visio network diagram. The scan can also be run after you have saved the automap Visio View to a.vsd file Codima Inc. All Rights Reserved. Page 26

27 APPENDIX 7 USEFUL REFERENCE MATERIAL AND HELP LINKS Reference Material Access the Codima Web site Support page:- This will provide access to the Customer Support section, where a comprehensive FAQ document is available covering a wide range of questions on the Codima Toolbox. Help facility Pressing <F1> will provide access to the Codima Help facility. The following help entries will assist you in using the automap /autoasset tools. Help Link About automap About autoasset Seed List automap/autoasset Operations Discovery Duration How to start mapping How to open an automap drawing How to create Asset Report How to test if IP addresses in Seed List respond to SNMP How to view discovery progress and status information Troubleshooting Codima Discovery Engine Description Provides a detailed overview of the automap tool Provides a detailed overview of the autoasset tool Provides detailed information on suitable start points Provides a link to the Help entries that cover all the automap and autoasset operations Covers how long discoveries should take Step by step help covering how to start the automap discovery process. Provides information on the different methods that are available to open automap views. Provides information covering creation of Asset reports in HTML format, Excel, CSV and TSV. Step by step help covering how to test the Start and End addresses in the Seed List Step by step help covering how to check the progress of an automap discovery Help entry covering troubleshooting the operation of the discovery process Codima Inc. All Rights Reserved. Page 27