S M A R T N E T T O T A L C A R E S U P P O R T T E A M CSPC 2.6.1 OVA Getting Started Guide Copyright 2016 Cisco Systems, Inc. Corporate Headquarters Cisco Systems, Inc. 170 West Tasman Drive San Jose, CA 95134-1706 USA http://www.cisco.com i
Table of Contents Modification History... iii Contributors... iii Reviewers... iii Introduction to SNTC and the CSPC OVA... 1 Smart Net Total Care Security... 1 Smart Net Total Care Support Community... 1 Virtual Platform Requirements... 2 Download the Virtual Machine Image... 2 Configure Appliance IP Address... 3 CSPC Registration... 6 Log into the Software Appliance... 8 Collector Operation... 10 Entering CSPC Device Credentials... 10 Device Discovery, Inventory Collection and Upload... 12 Discover the Devices... 13 Discover Devices Using Known IP Addresses... 13 Discover Devices with Protocols such as CDP, OSPF and ARP.. 14 Discover Devices by Scanning/Pinging a Range of IP Addresses 16 Discovery Schedule Options... 17 Run Collection Profile and Upload Data... 19 Verifying the Upload... 23 ii
Modification History Rev Date Author Changes 1 11/4/2015 Josh Harpst Submitted for review 2 11/4/2015 Lynden Price Changed 200 GB to 250 GB in Virtual Platform Requirements Changed 4.x or 5.x to 4.x or higher in Virtual Platform Requirements Removed references to HyperV and KVM and modified wording in Configure Appliance IP Address Standardized all CLI commands to font Courier New Added additional explanation for Linux user password generation Added onboarding instructions to CSPC Registration Added prerequisites section to Introduction to CSPC 3 9/1/2016 Nida Uddin & Shaina Moore Updated for 2.6.1 OVA Changed default GUI username and password 9/2/2016 Lynden Price Significant Re-design and formatting Contributors Name Email Role Josh Harpst jharpst@cisco.com SNTC Collector Support Engineer Lynden Price josprice@cisco.com SNTC Collector Support Technical Lead Nida Uddin niduddin@cisco.com SNTC Support Engineer Shaina Moore shaimoor@cisco.com Reviewers Name Email Role SNTC Support Engineer Lynden Price josprice@cisco.com Document Owner / SNTC Collector Support Technical Lead iii
Introduction to SNTC and the CSPC OVA T his document provides information about the CSPC 2.6.1 release. In order to configure CSPC and ensure a successful setup, you should have experience configuring devices from a command line as well as a basic understanding of network management systems. CSPC is an SNMP-based tool that discovers and collects information from your Cisco devices. You should know the SNMP Read Only community string(s) that are set up on your devices. This document will walk you through the steps for a basic CSPC setup. Before you ll have the ability to generate the CSPC s license file, you ll first need to complete your portal onboarding to gain access to the Smart Net Total Care Portal. To do that follow the link below: New to Smart Net Total Care https://supportforums.cisco.com/document/12566021/new-smart-net-total-care Smart Net Total Care Security CSPC gathers data from supported Cisco devices using a variety of protocols. At minimum, you ll need SNMP Read Only access to poll the devices in the network and collect inventory details from the devices. Additionally, you can enable SSH and/or Telnet access to supplement your collections. The Cisco collector uses Telnet and/or SSH to collect data for device configuration, additional inventory information, and exception-based data following critical events. A list of commands that the collector is capable of executing is listed in the Cisco Security White Paper, available at this link: https://supportforums.cisco.com/document/12627856/smart-net-total-care-securitywhitepaper Smart Net Total Care Support Community For more information about Smart Net Total Care, please see the Smart Net Total Care Support Community where you can find discussion groups, frequently asked questions, training, and other Smart Net Total Care-related resources. Smart Net Total Care Support Community: https://supportforums.cisco.com/community/4891/smart-net-total-care 1
Virtual Platform Requirements This section provides information about the virtual platform requirements. This guide does not provide directions on how to install the different virtual platforms. These are the minimum system requirements for the collector image that runs on a ESXi 4.x or higher virtual platform: 250 GB of hard drive space 4 CPU cores (virtual CPUs) 1 virtual NIC (dependent on network topology) 4GB of virtual RAM Download the Virtual Machine Image After ensuring that your virtual environment can provide the needed resources, the next step is to download the Smart Net Total Care image. The software image can be obtained from the download center. The download center contains the most recent software image. To access the Cisco Smart Net Total Care image perform the following steps: 1. Go to the following URL: http://software.cisco.com/download/type.html?mdfid=283107976&catid=null 2. Login with your CCO ID and password by clicking on the Log In link at the top right corner of the screen. 3. Click SNTC Software Collector Appliance; the Download Software window appears. 2
4. Click the Download button. If you are prompted, accept the Terms and Conditions to start the image download. 5. Deploy this image on your virtual environment. Configure Appliance IP Address This section applies to both the virtual machine and hardware platform versions of the appliance. To configure the IP address of the appliance, perform the following steps: Note For hardware appliances: connect a monitor and keyboard to the server. For software appliances: connect to the virtual machine console using your virtual environment s tools. After powering on the collector, you should see a request to press any key. Select the console window and press a key. The Press any key to continue display is normal during the boot up process and may take several minutes before you will see a login prompt. Log into the software appliance via connected console using the default credentials below: Username: admin Password: Admin!23 On the first login, the appliance forces a password change from the default CLI password. 3
After logging in to the appliance you will see the following screen: 1. To assign a static IP address, the command conf ip is used. At the command prompt enter the following information: conf ip <interface> <IP address> <Netmask> <Default Gateway> For example: conf ip eth0 192.168.1.100 255.255.255.0 192.168.1.1 To assign a dynamic IP address, the command conf dhcp is used. At the command prompt enter the following information: conf dhcp <interface> For example: conf dhcp eth0 2. Configure the DNS servers: conf dns a <DNS IP address 1> <DNS IP address 2> 3. Configure the timezone by running this command and entering the appropriate value at the prompt: 4
timezone 4. Configure the time by syncing with your NTP server. You can also press enter at the prompt to use the default: timesync 5. Enable the Linux user login collectorlogin and set in how many days it should expire (1-180) pwdreset collectorlogin 180 1 The password in the above image is not your password. It is only an example. Record this password! 6. Enable the Linux root login and set in how many days it should expire (1-180) pwdreset root 180 2 The password in the above image is not your password. It is only an example. Record this password! 7. To make the changed settings effective, the appliance needs to be rebooted. At the command prompt enter: reboot confirm the question on the screen with y 8. After the appliance has rebooted, confirm that the IP is correct. 5
At the command prompt enter: show ip 9. Connect to the appliance via SSH to ensure you can manage the CSPC remotely. CSPC Registration A CSPC registration needs to be performed before the collector can be utilized by the Cisco Smart Net Total Care portal. The registration allows a validation to occur that creates a connection between the CSPC collector and the Cisco data center. The registration process requires you to obtain the entitlement files (a security certificate and other registration files). These registration/entitlement files are used later to complete the CSPC installation. Note In order to generate the entitlement for the collector, you will first need to complete the Self-Service registration. To register for Smart Net Total Care please follow the steps outlined in this blog Self Service Registration: https://supportforums.cisco.com/blog/12600946/self-service-onboarding-registerget-access-smart-net-total-care-portal To generate an entitlement, go to the Smart Net Total Care portal: Smart Net Total Care Portal https://tools.cisco.com/smartservices/ Close out of any splash screens. 6
In the left pane, Select Library > All Collectors Once the screen loads, select the Actions dropdown and choose to Register a New CSPC Complete the fields as follows: CSP-C name: The CSPC name should match the Server s hostname, or can be any name used to identify this collector on your network. Do not use any special characters. 7
Inventory name: For inventory name, you can use the same name you entered for the CSPC name, followed by a dash and word inventory such as this format Hostname-inventory. Any alternative way of identifying the inventory is fine. Click the Submit button and wait for the dialogue to popup which will allow you to download the zip file. Save the zip file to a location you will be able to find it. Do NOT unzip it! After you complete the steps above, click the Submit button and wait for the dialogue to popup that will allow you to download the zip file. Save the zip file to a location where you will be able to find it. Note Do not unzip the file! Log into the Software Appliance To access the appliance, open a browser window and perform the following steps: Use the following URL format to access the appliance: https://<your_appliance_ip_address>:8001/ You will see some type of security certificate warning on your browser that alerts you about the websites security certificate or that the browser cannot confirm a secure connection. The warning will be different depending upon the type browser you have. Acknowledge the warning and then continue with the appliance login. 8
You ll then see a login screen. Use the following default credentials to login: GUI Username: Admin123 GUI Password: Admin123 The very first time you log into the collector you will be prompted to import an entitlement certificate. You will not be able to login to the CSPC GUI until this step is performed. This message will appear: Browse to your.zip entitlement file and then click OK. After you upload the entitlement and click OK, the collector will reboot. It will take a couple minutes before you ll be able to log back in. Once you re able to log back in, an End User License Agreement will pop up. Read through it and then click I Accept to proceed. You will then be prompted for Password Reset Questions. Click No to provide this information at a later time. The software will now load. 9
Collector Operation The collector operation requires that the collector have these related tasks performed: Entering CSPC Device Credentials Device Discovery, Inventory Collection and Upload Entering CSPC Device Credentials In order to discover network devices and collect device data, you must first enter the device credentials. The device credentials entered into the CSPC are used to discover the devices and for data collection. To set the device credentials using the SNMP protocol, perform the following steps: On the CSPC menu, choose Settings > Device Credentials The Device Credential Configuration window appears. Click Add to create a credential. 10
The device credentials window appears which contains credential identification, authentication information, and SNMP Read community string details. Fill out the required data as outlined below. In the example, we consider a v2c credential. 1. Enter a credential name (in example, UAT-Test). The name can be anything you choose to identify the particular credential. 2. In the Transport section, click the Protocol field drop-down list and select the SNMP version of your string. 3. Click the icon to the right of Read Community under the SNMP V1/V2 Community Strings section. Then enter your SNMP Read Only community string as seen below. 4. Click on the pencil icon to enter an IP Address list as shown below. This list represents which IP address(es) CSPC is able to use the credential on for device discovery and collection. 5. After entering the IP Address in the IP Address list field, click Add 11
The IP addresses that are referenced should be as tight or as restrictive as possible, while allowing coverage for all required devices. Specific IPs can be provided or wildcards can be used to replace octets of an IP Address to create a range. For Example: Entering *.*.*.* will allow CSPC to use the credential with any IP. 172.16.*.* would only allow the credentials to be used for devices in the 172.16.0.0/16 subnet. 6. After entering in your IP Address(es) click OK to save your IP Address list. 7. Click OK to save the credential. If you have more than one SNMP string used in your network, you ll want to repeat the above steps to include all of them. The next steps will show you how discover your devices, collect the appropriate information and upload your data. Device Discovery, Inventory Collection and Upload There are several different processes that are required to perform an inventory upload. Those processes are: Discover the Devices Run Collection Profile and Upload Data 12
Discover the Devices This section shows the three ways you can discover your devices as well as how to run the discovery job: Discover Devices Using Known IP Addresses Discover Devices with Protocols such as CDP, OSPF and ARP Discover Devices by Scanning/Pinging a Range of IP Addresses Discovery Schedule Options To discover your devices for any of the 3 discovery options, choose Management > Discover and Manage Devices. The Discover and Manage Network Devices window appears. Discover Devices Using Known IP Addresses This discovery process finds the available devices in a managed network, where the IP addresses of the devices are already known. To discover these devices, perform the following steps: 1. Select the first method Discover devices with known IP Addresses. 2. Click Next. 13
3. Enter the IP Addresses for the devices that you want to discover from your network. 4. Place the IP Address in the IP Address/Host Name field 5. Click + Add, to add the IP to the list. 6. You can add multiple IPs at once by using a space in between IPs in the IP Address/Host name field. 7. Click Next to proceed to the Discovery Schedule Options Discover Devices with Protocols such as CDP, OSPF and ARP This discovers the network devices by using protocol tables such as Cisco Discovery Protocol (CDP), and Address Resolution Protocol (ARP). Data collected from discovered devices is used to find additional devices in the network. 1. Select Discover devices with protocols such as CDP, OSPF and ARP 14
2. Click Next. 3. Select which protocol(s) you would like the CSPC to consider. 4. Specify the Hop Count value. 5. Enter your seed device IP Address(es) 15
6. Click +Add to add your seed device to the seed device list 7. Click Next to proceed to the Discovery Schedule Options Discover Devices by Scanning/Pinging a Range of IP Addresses This method uses SNMP to contact all the IP addresses in the range you specify. You provide the starting IP address and the ending IP address of the range or specify a particular subnet using CIDR notation. 1. Select Discover Devices by scanning/pinging range of IP Addresses. 2. Click Next. You have the option to enter in the ranges yourself or by using CIDR notation. The steps below outline the CIDR option. 16
3. Enter the network address in the Start IP Address field followed by a slash (/) and the appropriate network bit number. 4. Click the CIDR Address box 5. Click +Add to generate the range of IP Addresses 6. Any range larger than 255 addresses will yield the following pop-up message. This is informing you that it may take some time for the Discovery Job to complete. 7. Click Yes to proceed. 8. Click Next to proceed to the Discovery Schedule Options Discovery Schedule Options After you select one of the three discovery options mentioned above and put in your IP Addresses or ranges of IP Addresses, decide if you want to run that discovery now or schedule it for some time in the future. 17
1. Under Management Protocol, select the version of SNMP that corresponds with your Device Credentials. 2. Decide if you want the discovery to run now or schedule for the future. For this example, we will consider the option to discover now. 3. Click Finish and your discovery job will begin. 4. After performing the above steps, the Successfully completed the Discovery Operation message is displayed. 18
5. Click OK to close the message and then Close to close the window. Run Collection Profile and Upload Data The below steps will help you set up the Collection Profile that will enable CSPC to collect relevant device data, as well as initiate an upload to the Cisco Data Center upon completion. 1. To manage your Collection Profile, go to Settings > Manage Data Collection Profiles 2. The Minimum Collection Profile is bundled with the CSPC appliance. The Minimum Collection Profile contains a minimum set of mandatory collection commands that are required to be processed for each inventory collection/upload. 3. Double-click the collection profile sntc 1x_min_cp. 4. The Modify Collection Profile window appears. 19
5. Click the Profile Details tab 6. Check the boxes for Use Fallback Credentials, Run 7. Discovery Before Collection, and Run DAV Before Collection 8. Scroll to the bottom of the window to make the final adjustments. 9. Check the box for Schedule Periodic Collection 20
10. Check the box for Export upon successful execution of collection profile 11. The Export upon successful execution of collection profile checkbox enables uploads. With this checkbox checked, after the collection completes, CSPC will upload the collected data from the Collection Profile to Cisco. 12. Click Configure Schedule 13. The Configure Schedule window appears. 14. Click the calendar icon and set the date for the first collection 15. Then enter the time of day that you want the collection to occur. 16. Check the box for Repeat schedule 17. Select the No end date radio button 18. Set the Recurrence Pattern 19. Click OK to save your changes and return to the Modify Collection Profile Window, then click OK to close the window. Your collections will run at the date and time you specified in the above steps. After the collection completes the transport file will be uploaded to the Cisco Data Center. If you want to run an On Demand collection/upload 1. Go to Management > Run Collection Profile 21
2. Click on sntc1x_min_cp 3. Click Finish. The collection job will begin and you ll see the status for each discovered IP as can be seen below. The details of the data collection are filled in. A summary is above and the details are below. After the collection process finishes, you have the option to export the collection details by clicking on Export Report. 22
However, you do not have to wait for the job to complete you can click Close and select Run in the Background Verifying the Upload When the collection job completes, the upload will be sent to the Cisco Data Center. It may take up to 24 hours before your upload will be processed by the portal. To view the status of the upload, go to the SNTC Portal and click Library > Administration > Upload Processing. 23