Cisco Operational Insights Onboarding Guide · Cisco Operational Insights (COI) ... RESPONSIBILITY FOR THEIR APPLICATION OF ANY PRODUCTS. THE SOFTWARE LICENSE AND LIMITED WARRANTY

Cisco Operational Insights (COI) Quick Start User Guide

Copyright © 2016 Cisco Systems, Inc. Cisco Confidential EDCS-11343758

A printed copy of this document is considered uncontrolled. Refer to the EDCS version online for the controlled revision. 1

Cisco Operational Insights (COI)

Collector Onboarding Guide




THE SPECIFICATIONS AND INFORMATION REGARDING THE PRODUCTS IN THIS MANUAL ARE SUBJECT TO CHANGE WITHOUT NOTICE. ALL STATEMENTS, INFORMATION, AND RECOMMENDATIONS IN THIS MANUAL ARE BELIEVED TO BE ACCURATE BUT ARE PRESENTED WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED. USERS MUST TAKE FULL RESPONSIBILITY FOR THEIR APPLICATION OF ANY PRODUCTS. THE SOFTWARE LICENSE AND LIMITED WARRANTY FOR THE ACCOMPANYING PRODUCT ARE SET FORTH IN THE INFORMATION PACKET THAT SHIPPED WITH THE PRODUCT AND ARE INCORPORATED HEREIN BY THIS REFERENCE. IF YOU ARE UNABLE TO LOCATE THE SOFTWARE LICENSE OR LIMITED WARRANTY, CONTACT YOUR CISCO REPRESENTATIVE FOR A COPY. The Cisco implementation of TCP header compression is an adaptation of a program developed by the University of California, Berkeley (UCB) as part of UCB’s public domain version of the UNIX operating system. All rights reserved. Copyright © 1981, Regents of the University of California. NOTWITHSTANDING ANY OTHER WARRANTY HEREIN, ALL DOCUMENT FILES AND SOFTWARE OF THESE SUPPLIERS ARE PROVIDED “AS IS” WITH ALL FAULTS. CISCO AND THE ABOVE-NAMED SUPPLIERS DISCLAIM ALL WARRANTIES, EXPRESSED OR IMPLIED, INCLUDING, WITHOUT LIMITATION, THOSE OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OR ARISING FROM A COURSE OF DEALING, USAGE, OR TRADE PRACTICE. IN NO EVENT SHALL CISCO OR ITS SUPPLIERS BE LIABLE FOR ANY INDIRECT, SPECIAL, CONSEQUENTIAL, OR INCIDENTAL DAMAGES, INCLUDING,WITHOUT LIMITATION, LOST PROFITS OR LOSS OR DAMAGE TO DATA ARISING OUT OF THE USE OR INABILITY TO USE THIS MANUAL, EVEN IF CISCO OR ITS SUPPLIERS HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. Cisco and the Cisco logo are trademarks or registered trademarks of Cisco and/or its affiliates in the U.S. and other countries. To view a list of Cisco trademarks, go to this URL: www.cisco.com/go/trademarks. Third-party trademarks mentioned are the property of their respective owners. The use of the word partner does not imply a partnership relationship between Cisco and any other company. (1110R) Any Internet Protocol (IP) addresses and phone numbers used in this document are not intended to be actual addresses and phone numbers. Any examples, command display output, network topology diagrams, and other figures included in the document are shown for illustrative purposes only. Any use of actual IP addresses or phone numbers in illustrative content is unintentional and coincidental. Cisco Operational Insights (COI) Onboarding Guide © 2016 Cisco Systems, Inc. All rights reserved.




Table of Contents

1 OVERVIEW ............................................................................................................................................ 4

1.1 Audience ...................................................................................................................................... 4

1.2 Product Overview ........................................................................................................................ 4

1.3 Related Documentation .............................................................................................................. 4

2 COLLECTOR INSTALLATION REQUIREMENTS ................................................................................ 4

2.1 Communication with the COI Database Services .................................................................... 4

2.2 Network Scaling ........................................................................................................................... 5

2.3 Ports the COI Platform Uses ...................................................................................................... 6

2.4 Supported Hypervisors ............................................................................................................... 7

2.5 Virtual Machine Options ............................................................................................................. 7

2.6 Web Client Requirements ........................................................................................................... 7

3 DEPLOYING THE ON-PREMISES COLLECTOR ................................................................................ 8

3.1 Before you Begin ......................................................................................................................... 8

3.2 Installing the On-premise Collector ........................................................................................... 8

4 COLLECTOR REGISTRATION & LICENSING ..................................................................................... 8

4.1 Configuring the Central Database IP address on the Collector ............................................. 8

4.2 Configure the COI Portal Phone Home Collector Widget ........................................................ 9

4.3 Add Collector using the Phone Home Widget ........................................................................ 10

4.4 Licensing the Collector ............................................................................................................. 14

4.5 Adding the Collector to the Cisco Operational Insights Platform ........................................ 17

4.6 Restore IP Address to Collector Ethernet Interface .............................................................. 19

4.7 Adding the Collector to a Collector group. ............................................................................. 19

4.7.1 Upgrading to a new software Version (Optional) ...................................................... 20

4.8 Update tunnel and watchdog services configuration .................. Error! Bookmark not defined.

List of Tables

Table 1 - TCP & UDP Port used by the COI Platform ............................................................................... 6

Table 2 - Supported Hypervisors ............................................................................................................... 7

Table 3 - VM Specifications, 100 to 1000 Devices ................................................................................... 7




1 Overview

This section provides basic information about the Cisco Operational Insights (COI) 1.0 interface and the onboarding process. This guide assumes that the partner site on the Cisco Cloud is already commissioned and connectivity is fully available.

This guide also includes details on supported platforms, hardware, and software requirements. The information in this guide helps you to complete the basic tasks needed to install COI on your system environment.

1.1 Audience

This guide is intended for system administrators, systems integrators, and Partner delivery teams who are responsible for installing, configuring, and managing the COI Collector.

These personnel must have the following skills and knowledge:

Understanding of virtualization concepts, virtualized environments (if applicable), and working with ISO images.

Network management skills.

Linux system administrator skills.

1.2 Product Overview

COI is a software as a service (SaaS) offering to facilitate a customer's IT infrastructure operation and advanced management capabilities efficiently and consistently. Because Cisco acts as both a provider of IT complex infrastructure solutions and a provider of Managed services and support solutions, customers enjoy lower operating costs and a better user experience.

1.3 Related Documentation

This guide is intended as a companion document to:

Cisco Operational Insights – Quick Start Guide

Cisco Operational Insights – Diagnostics Power Pack

2 Collector Installation Requirements

Cisco Operational Insights requires the Collector to be installed on the customer premises to provide connectivity between Cisco’s Cloud hosted platform and the customer’s network.

2.1 Communication with the COI Database Services

The On-premises Collector communicates with the Cisco Operational Insights Database Server using the “Phone Home” collection method:

The On-premises Collector initiates communication with the Database Server using secure SSH connection (TCP 22000)




2.2 Network Scaling

Network Bandwidth Requirement:

Recommended values between COI - Database Services (CIS Cloud) and On-premises Collector (Customer site)

o 1.5 kbps per monitored/managed device

(For example, approximately of 2 Mbps bandwidth for 1000 Managed devices and other network management overheads)

Recommended values between Collector and Managed device (Local to Customer site)

o 4 kbps per monitored device from the Collector to the monitored devices

(For example, approximately of 5 Mbps bandwidth for 1000 Managed devices and other network management overheads)

o Minimum of 256 kbps between the database server and each Collector to use the automatic patching mechanism

o Latency—up to 5 ms




2.3 Ports the COI Platform Uses

Table 1 - TCP & UDP Port used by the COI Platform

Name Description Protocol Port Source Destination

SSH Tunnel Designated SSH Tunnel port for Communication between Database Server and Customer On-premises Collector

TCP 22000 OPDC DB

HTTPS Secure Web Interface

HTTPS for browser session and API Requests to Portal and DB

TCP 443 OPDC DB/Portal

Collector Web Configurator

Web Configuration Utility from browser session on user workstation.

TCP 7700 CWD OPDC

NTP Communication between the Message Collector and configured NTP server.

TCP 123 OPDC Customer NTP Master

SSH ssh sessions from COI Collector to Managed devices

TCP 22 OPDC CD

Telnet Telnet access from COI Collector to Managed devices

TCP 23 OPDC CD

ICMP ICMP from COI Collector to Managed devices

ICMP Echo/Echo Reply

OPDC CD

SNMP Agent SNMP information messages from managed devices.

UDP 161 OPDC CD

SNMP Traps Receive SNMP traps from managed devices.

UDP 162 CD OPDC

Syslog messages Receive syslog messages from managed devices.

UDP 514 CD OPDC

HTTP Get Request

HTTP information messages from managed devices.

TCP 80 OPDC CD

HTTPS Get Request

HTTPS information messages from managed devices.

TCP 443 OPDC CD

Key

o On-premises Data Collector = OPDC

o COI DB = DB

o COI AP Server = Portal

o Customer Work Station = CW

o Customer Devices = CD




2.4 Supported Hypervisors

The COI Collector is only supported in a Virtual environment on the hypervisors listed in the table below.

Table 2 - Supported Hypervisors

Hypervisor Type Hypervisor Version Tools Supported Deployment Method

VMware 4.1, 5.1, 5.5 VMware Tools ISO

XenServer 5.6, 6.1, 6.2 XenTools ISO

Windows Server Hyper-V 2008 R2 SP 1, 2012, 2012 R2 TBD ISO

KVM RedHat / CentOS 6.2+ Ubuntu 12+

N/A ISO

NOTE:

1. "Over-commit" technology is not supported for any virtual appliance. In the case of VMware, this means that 100% of memory must be reserved

2. Fixed storage is required. Dynamically-expanding storage is not supported.

3. Licensing relies on appliance MAC addresses and UUIDs remaining intact. VM migrations which change these identifiers (such as storage vMotion with default vmx settings, or CloudStack orchestration move between XenServer hosts) will invalidate the license, thus limiting or disabling the appliance operation until a new license can be applied.

2.5 Virtual Machine Options

During installation, you can choose one of four VM specification configuration options. Below are the server requirements for each option:

Table 3 - VM Specifications, 100 to 1000 Devices

Recommended at 100 Devices

Recommended at 500 Devices Recommended at 1000 Devices

Type Description RAM (GB)

Cores Disk (GB)

RAM (GB)

Cores Disk (GB)

RAM (GB)

Cores Disk (GB)

COL Collector 4 2 60 12 3 90 24 4 150

2.6 Web Client Requirements

To access the COI Collector Web Configuration Utility from a browser on a client computer, the web client must meet the following Web Client requirements:

Hardware—A Mac or Windows laptop or desktop compatible with one of the following tested and supported browsers:

The web client must be running one of the following browsers:

o Microsoft Internet Explorer 9, 10, or 11

o The latest version of Mozilla Firefox




o Apple Safari 4.0 or later

o The latest version of Google Chrome

Display resolution—COI Collector supports 1024 x 768 or higher, but we recommend that you set the screen resolution to 1280 x 1024 or greater.

3 Deploying the On-premises Collector

The following topics walk you through how to install and start the Cisco Operational Insights Collector at the Customer Premises and provide connectivity to the Central Database services hosted in the Cisco Cloud.

3.1 Before you Begin

Obtain the ‘Collector MySQL DB root password’ from Cisco Operational Insights support staff.

Download the Collector ISO file from location provided in welcome email.

Verify the Supported Virtualization hypervisor

Create and Verify a VM as per the hardware specification

Network Firewall is permitting traffic listed on section 2.3 and in particular, open for outbound SSH communication on TCP port 22000 (for the connectivity between Collector and Cisco Cloud).

3.2 Installing the On-premise Collector

1. Create New Virtual Machine as per the VM specifications in section 2.5 based on expected # of devices to be on-boarded and supported by this collector.

2. Boot VM using the Collector ISO image.

3. Select 'Collector' (COL) at the “Model Type” prompt.

4. Enter IP networking information supplied by your network administrator.

5. At the “Root password” dialog, the password being entered here is actually for the “em7admin” CLI/Linux shell user on the collector not the “root” user (NOTE: all shell access is with the em7admin user and all privileged commands are performed using sudo. By default, it is not possible to login directly as the Linux root user.).

6. After the Collector installation with the ISO image is complete, install the proper VM tools for the hypervisor that the collector is deployed on.

4 Collector Registration & Licensing

Cisco Operational Insights Collectors currently require a license in order to function. The following steps will register the collector with the cloud hosted database (CDB), generate a registration token file which must be sent to Cisco, and in return a license key will be provided to complete the process.

It is important to follow these steps in the order specified otherwise the collector may not end up with a properly licensed registration with the CDB.

4.1 Configuring the Central Database IP address on the Collector

1. Log in to your Collector web configuration utility, https://IPADDRESS:7700.

https://ipaddress:7700/




2. Enter em7admin for the username and the password you entered during installation (see step 5 in section 3.2 above).

3. Click on Device Settings.

4. Enter the IP address of the Central Database that was provided in the welcome e-mail and click save.

Expected result is “Success: Changes have been saved”. If there is another result, please contact Cisco support.

4.2 Configure the COI Portal Phone Home Collector Widget

1. Open a web browser and enter the address of the cloud hosted portal as https://IPADDRESS

The address is provided in the welcome email.

https://ipaddress/




2. Log in as the partner_admin user with the default password that Cisco provided (upon first login, the system will prompt you to change the password).

3. At the first successful login, you are prompted to agree to the End-user License Agreement.

4. Read the End-user License Agreement and then select the I Agree to The Terms Outlined Above button.

5. Navigate to Dashboards -> Phone Home Configuration.

6. After the Phone Home widget loads, enter the Central DB IP address in the “External Facing IP Address” box, leaving the port as the default of 22000.

7. Click “Update External IP Information”.

4.3 Add Collector using the Phone Home Widget

1. Click Add New Collector.




2. Within a minute, the new Phone Home Collector is seen in the Phone Home Appliances section.

3. Click on the newly created Collector to display the Phone Home Appliance Key.

4. Copy the displayed key to your clipboard as it will be needed in subsequent steps. You can always come back to this widget and retrieve the key at any time.

NOTE: The IP address that is created for the Phone Home Collector is a “loopback” style address like 127.0.0.11. It is recommended that you keep this address nearby as it is needed later in the process.




5. Log into the Collector via an SSH session as the em7admin user and execute the following commands. First, the database password has to be changed to the randomly generated password provided by Cisco. Second, the Phone Home registration and synchronization can be performed.

5.1. To change database password on the Collector from default value of em7admin to match the specific new COI Central Database (CDB) service password:

NOTE: The new DB password has to match the DB password on the Central DB server.

i. Change the password in local database of the Collector.

[root@em7_cu ~]# silo_mysql

Welcome to the MySQL monitor. Commands end with ; or \g.

Your MySQL connection id is 14625

…..

….

mysql> set password for 'root'=PASSWORD('NEWPASSWORD');

Query OK, 0 rows affected (0.00 sec)

ii. Change em7admin to DB password supplied to you by Cisco.

Change /etc/silo.conf file in the Collector.

sudo vi /etc/silo.conf

Find the line beginning with dbpasswd.

EXAMPLE FILE:

[LOCAL]

mysqltooldir = /usr/local/mysql/bin

…

…

dbpasswd = em7admin <<<change em7admin to new DB password

..

…

5.2. Now the Phone Home registration can be performed:




i. Open a CLI SSH session to the collector, and login as em7admin, and complete the phone home registration.

sudo phonehome register <paste the registration URL from your clipboard>

(If prompted, enter em7admin password to satisfy sudo)

The expected result is “Registered device successfully”. If this is not the result you see, please contact Cisco support for additional assistance and stop the process at this point, otherwise proceed.

sudo phonehome sync

(If prompted, enter em7admin password to satisfy sudo)

The expected result is:

Started synchronization

Finished synchronization




4.4 Licensing the Collector

To configure the Collector license:

1. Open an SSH session to the Collector and login as em7admin user.

2. Execute the following command to edit the silo.conf file:

sudo vi /etc/silo.conf

3. Find the line that starts “ipaddress =”. The current value should be the IP address that was configured during collector deployment. This address needs to be changed to the “loopback” style address that is seen as part of the phone home registration key (example: 127.0.0.11).

4. After changing this address, save the file and exit.




5. Log in to your Collector web configuration utility, https://IPADDRESS:7700.

6. Enter em7admin for the username and the password you entered during installation

7. Click on Licensing

8. Click “Generate a registration key” and a popup will appear.

9. You are prompted to either Open or Save the key. Select Save file. Send the saved file to Cisco ([email protected]) as an email attachment. Once received, Cisco will return to you the license key. Please wait for this license key before proceeding at step 10.





10. Keep the Licensing window open and then click Next to upload the key that Cisco has sent back to you.

11. You are prompted to upload the key.

12. After license is uploaded, within the window is populated with data. Select the Submit button to finish.




A Success message should be shown indicating the license key was accepted and validated. If any other response is shown, please contact Cisco support for further assistance.

13. Click on the Interfaces option at the top right of the browser.

14. Click on the Ethernet device with the current IP address of the Collector.

15. In the Interface IP Address box, we have to temporarily change this address to be the “loopback” style address of the phone home collector (example: 127.0.0.11). Click Save.

NOTE: This is not a permanent configuration and will be un-done after the licensing process is completed. DO NOT reboot the Collector at this time, otherwise console access will be required to restore IP connectivity.

4.5 Adding the Collector to the Cisco Operational Insights Platform

After the Collector is licensed, you must perform additional tasks to begin managing your network. Once these tasks are completed, you are ready to start configuration for monitoring and management of your network.

1. In the address bar of your browser, enter the IP address of the COI portal as https://IPADDRESS

2. The login page appears:




3. Log in as the partner_admin user.

4. Navigate to the Appliance Manager page (System > Settings > Appliances).

5. Supply values in the following fields:

o Host Name. Enter the host name of the Collector.

o IP Address. Enter the “loopback” style IP address (example: 127.0.0.11) of the On-premises Collector.

o Model Type. Select the type of appliance (Data Collector) you are registering.

o Description. Enter a description for the Data Collector. This field is optional.

6. Click the Save button.

7. If all information is valid and the Database Server can communicate with the Collector, the appliance page displays Yes in the Validated column. It may be necessary to refresh (or click on the Reset button shown) the browser to reflect the Validation status.

a. If the Validated column remains No for longer than five minutes, please double-check your settings and network connection. Contact Cisco support for further assistance.

8. You should see the added collector, as shown below:

9. To check the collector’s communication status, navigate to System -> Monitor -> Collector Status. You should see Available in the Collector State. NOTE: The Sync State will fluctuate between Out of Sync and In Sync – this is normal behavior.




4.6 Restore IP Address to Collector Ethernet Interface

As noted in section 4.4 step 15, it is necessary to restore the IP address of the collector to its proper value so it is preserved during system reboots. 1. Log in to your Collector web configuration utility, https://IPADDRESS:7700.

2. Enter em7admin for the username and the password you entered during installation 3. Click on the Interfaces option at the top right of the browser. 4. Click on the Ethernet device with the current IP address of the Collector. 5. In the Interface IP Address box, change the loopback IP address (127.0.0.x) to the proper IP address

for the collector. Click Save.

4.7 Adding the Collector to a Collector group.

In the Cisco Operational Insights Platform portal, add the Collector to a Collector group:

1. Navigate to Collector Groups (System>Settings>Collector Groups).

2. Enter <Collector Group Name> in the Collector Group Name box.

3. Select the newly created Collector in the Collector Selection window.





4. Click Save. A Collector group entry appears at the bottom of the Collector Group Management window.

4.7.1 Upgrading to a new software Version (Optional)

If needed, Cisco upgrades software to the latest version on all the appliances.

The Collector is now licensed and registered. You can now begin to discover devices.

Documents

Cisco Operational Insights Onboarding Guide · Cisco Operational Insights (COI) ... RESPONSIBILITY FOR THEIR APPLICATION OF ANY PRODUCTS. THE SOFTWARE LICENSE AND LIMITED WARRANTY