CSPC Collection Platform Software Installation and Configuration Guide

Available Languages

Updated:January 1, 2019
Document ID:1552401994147460

Bias-Free Language

The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.

CSPC Collection Platform Software Installation and Configuration Guide

Introduction
  Introduction to CSPC Collection Platform Software
Installation and Configuration
  OVA Installation
  ESXi Patch Installation
  CSR1000V NAT OVA Installation
  CSR1000v Upgrade
  CIMC Patch Installation
  NOS Configurer

 

Introduction

This guide explains how to use install and configure CSPC Server. Refer to CSPC User Guide to use the application.

For program updates and important notes, refer to CSPC Release Notes and README documentation.

Introduction to CSPC Collection Platform Software

The Cisco Common Service Platform Collector (CSPC) is an SNMP-based tool that discovers and collects information from the Cisco devices installed on your network. The CSPC software provides an extensive collection mechanism to gather various aspects of customer device data. Information gathered by the collector is used by several Cisco Service offers, such as Smart Net Total Care, Partner Support Service, and Business Critical Services. The data is used to provide inventory reports, product alerts, configuration best practices, technical service coverage, lifecycle information, and many other detailed reports and analytics for both the hardware and operating system (OS) software.

Who Should Use This Guide

This guide is written for Network and Security Administrators and Cisco Network Engineers and also for new users.

The user should have Administrative privileges on the machine to install CSPC.

Installation and Configuration

CSPC Server image comes with a preloaded application that consists of server software, database, and all the necessary tools.

OVA Installation

This section describes detailed installation procedures for different installation stages

Pre-requisites

For an uninterrupted deployment, installation, and configuration of CSPC software, have these ready:

  • xxx.ova file from the download center
  • CSPC static IP address, default gateway IP address and subnet mask use. This is recommended only if DHCP is not enabled.

Deploy CSPC OVA

This section describes steps to deploy CSPC OVA using VMWare vSphere Client:

  1. Get the xxx.ova file either to a web server or local file system where vSphere client is available
  2. Launch vSphere client and login using credentials with the privilege to deploy an OVA file
  3. Use vSphere client and select the ESXi host or IP address that manages CSPC virtual machine
  4. Use vSphere client and select the File menu and then select the Deploy OVF Template… menu item shown in the file menu.
  5. There are two ways to select the OVF file to deploy:
    • Select the OVF file residing on local or a remote web server using web browser. If this option is used, type the URL for the file xxx.ova, then click Next.
    • Select the OVF file residing locally using the file explorer. If this option is used, click Browse… and navigate the file explorer to locate the file xxx.ova, then click Next.

    Note: All the screens below are just for illustration and not actual ones.

    figure 2.1
  6. Browse to select the URL and click Next to proceed.
    figure 2.2
  7. Click Next to proceed.
    figure 2.3
  8. Click Accept to acknowledge the end user agreement.
    figure 2.4
  9. Select the appropriate storage to store the virtual machine then click Next to proceed.
    figure 2.5
  10. Select the required configuration and click Next.
    figure 2.6
  11. Click Next to proceed.
    figure 2.7
  12. Map the network use and click Next.
    figure 2.8
  13. Choose the Poweron after deployment, then click Finish.
    figure 2.9
    Deployment progress screen appears. Wait for the deployment to complete.
    figure 2.10

After Successful installation of CSPC OVA, you have to configure IP address.

  1. Click on the new installed CSPC OVA.
    figure 2.11
    You will be prompted to enter your password. First enter the password and confirm the password.

    Note: All the screens below are just for illustration and not actual ones.

    Once you enter your password, you will be able to configure the IP from the menu or in the command shell prompt.

    No matter which method you use to configure the IP address, be sure to connect to the admin shell to initialize the collectorlogin and root users.
  2. Select any one of the options.
    figure 2.12

Configure IPv4 Address

  1. Select 1 to configure IPv4 address.
  2. Select one of the options displayed:
    • Select 1 to fetch IP address automatically.
      figure 2.13
    • Select 2 to enter the IP Address manually.
      figure 2.14
    • Select 3 to go back to main menu.

Configure IPv6 Address

  1. Select 2 to configure IPv6 address.
  2. Select one of the options displayed:
    • Select 1 to fetch IP address automatically.
      figure 2.15
    • Select 2 to enter the IP Address manually.
      figure 2.16
    • Select 3 to go back to main menu.

Configure the IP Address Directly on Shell

  1. Select 3 to view Command line (Shell).

    Note: Only admin users can configure IP. Before configuring IP, switch over as an admin user.

  2. Enter the command Conf ip -v4 eth0 or Conf ip -v6 eth0 and enter IP Address, Subnet mask, and gateway as show in the figure.
    figure 2.17
  3. Confirm your IP address settings:
    # show ip

Enable Default Account

To initially set or reset the password use the below command:

  1. Enable the Linux user login "collectorlogin:"
    # pwdreset collectorlogin 90
    This generates a password for the username "collectorlogin."
  2. Enable the Linux root login:
    # pwdreset root 90
    This generates a password for the username " root".
  3. To connect to root first connect to the collectorlogin prompt and then use the command su root:
    $ su root

    Note: Be sure to save both the collectorlogin and root passwords in a secure, accessible location!

    You are not allowed to connect directly to root, attempts to connect directly to the user root will cause a lock on that account!

    figure 2.18

    Note: You can now connect to the server using SSH or through a browser at address
    https://<IP Address of the Collector>:8001

    There are additional commands on the admin shell. To display them just do the following:
    # ?

ESXi Patch Installation

Prerequisites

  • Make sure all the virtual machines are powered off before proceeding for Upgrade.
  • After upgrade from ESXi 5.x to ESXi 6.x, old 5.x license key will be deleted and you are required to add 6.x license key for VMs in ESXi to work.

Upgrade ESXi 6.0

  1. Login to collector appliance as admin.
  2. To check updates for ESXI execute below command:
    #check update esxi
  3. To download the ESXI patch execute below command:
    #download jeos-100.0.6-0-lnx64
  4. To check download status execute below command:
    #show download
  5. Once the patch is downloaded to /opt/LCM/tmp, unzip the patch and follow the instructions from Read_me_ESXI_6.0U3_and_6.0_patch_build_9313334.docx

CSR1000V NAT OVA Installation

Prerequisites

You require all these noted below before you start deploying CSRV:

  • ESXI Login IP and credentials.
  • Existing NAT router / Pfsense VM login IP and credentials.
  • Copy of NAT rules and other customized configuration on old NAT router VM that required to be replaced.
  • VSphere client to connect to ESXI.
  • CSR1000V CSPC NAT OVA available locally or on network to deploy. Default credentials of the OVA.

This section describes steps to deploy CSR1000V CSPC NAT OVA using VMWare vSphere Client:

  1. Get the xxx.ova file either to a web server or local file system where vSphere client is available
  2. Launch vSphere client and login using credentials with the privilege to deploy an OVA file
  3. Use vSphere client and select the ESXi host or IP address that manages NAT virtual machine
  4. Use vSphere client and select the File menu and then select the Deploy OVF Template… menu item shown in the file menu.
  5. Select the OVA file residing locally using the file explorer. If this option is used, click Browse… and navigate the file explorer to locate the file xxx.ova, then click Next.
    figure 2.19
  6. Browse to select the URL and click Next to proceed
    figure 2.20
  7. Click Next to proceed
    figure 2.21
  8. Select the appropriate storage to store the virtual machine then click Next to proceed
    figure 2.22
  9. Click Next to proceed
    figure 2.23
  10. Map the network use and click Next.
    figure 2.24
  11. Choose the Poweron after deployment, then click Finish
    figure 2.25
  12. Deployment is completed. Click Close.
    figure 2.26

After Successful installation of OVA, you have to configure CSR1000V CSPC NAT OVA.

To configure CSR1000V CSPC NAT OVA, perform the following:

  1. Take Snapshot of old Pfsense and Power OFF old Pfsense VM.
    figure 2.27
  2. Right click on new CSR1000V VM, and select Open Console. Once Router is up and running, press Enter key. It navigates to console mode of router.
    figure 2.28
  3. In router console mode, enter en and press Enter key and provide default password XXxxXX (contact CSPC support for default password).
    figure 2.29
  4. Enter conf t, it navigates to router’s configure terminal mode.
  5. Enter int gi1, it navigates to wan interface configuration mode. (provide IPaddress and Netmask)
       ip address <ipaddress> <netmask>
       no shutdown
       exit
  6. Provide default gateway and default routing in configuration mode and exit and save the configuration.
       ip default-gateway <gateway IP>
       ip route 0.0.0.0 0.0.0.0 <gateway IP>
       exit
       wr mem
    figure 2.30
  7. To verify the Configuration use the command sh run
  8. CSR1000V router is configured with IP and accessible from WEB UI. Login to WEB UI by URL http://<IP Address> and username root and password XXxxXX (contact CSPC support for password, CLI and UI will have same password).
    figure 2.31

    Note: This CSRV Nat router OVA can be accessed from ESXI console or by CLI using telnet from private network VMs only. (You need to login to CSPC or other VMs on that host by using CLI and do telnet to CSR1000V IP or 192.168.1.1)

    figure 2.32
    Once configuration is completed on CSRV1000V router you will be able to access CSPC and other VMs from CLI and UI.

CSR1000v Upgrade

To upgrade CSR1000V, perform the following:

  1. Get new CSR1000v System Image (xxx.bin) to CSR1000V VM under bootflash: directory.
  2. Run dir bootflash: command to view list of all files and directories in bootflash.
    Example: Router# dir bootflash:
  3. Run configure terminal command to enter global configuration mode.
    Example:
    Router# configure terminal
    Router(config)#
  4. Run no boot system command to delete all entries in the boot-able image list. That specifies the order in which the router attempts to load the system images at the next system reload or power cycle.
    Example: Router(config)# no boot system
  5. Run boot system bootflash:<system-image-filename>.bin command to load the new system image after the next system reload or power cycle. For example:
    Example: Router(config)# boot system
    bootflash:<system-image-filename>.bin
  6. Run exit command to exit global configuration mode
    Example:
    Router(config)# exit
    Router#
  7. Run write or write memory command to update the GRUB menu list of images available on the bootflash disk.
    Example: Router# write memory
  8. Run show version command to display the configuration register setting.
    Example:
    Router# show version
    Cisco IOS XE Software, Version 16.06.04
    …
    Cisco Internetwork Operating System Software…
    …
    …
    Configuration register is 0x2102
    Router#
  9. If the last digit in the above output in Step 8, in configuration register is 0 or 1, proceed to next Step 10. Or if the last digit in the configuration register is between 2 and F, proceed to the Step 13.
  10. Run configure terminal command to enter global configuration mode.
    Example:
    Router# configure terminal
    Router(config)#
  11. Run config-register 0x2102 command to set the configuration register so that, after the next system reload or power cycle, the router loads system image from the boot system commands in the startup configuration file.
    Example: Router(config)# config-register 0x2102
  12. Run exit command to exit global configuration mode
    Example:
    Router(config)# exit
    Router#
  13. Run copy running-config startup-config command to copy the running configuration to the startup configuration.
    Example: Router# copy running-config startup-config
  14. Run write memory command to update the GRUB menu list of images available on the bootflash disk.
    Example: Router# write memory
  15. Run reload command to reload the operating system.
    Example: Router# reload
  16. When prompted to save the system configuration, enter no
    Example:
    System configuration has been modified. Save? [yes/no]: no
  17. When prompted to confirm the reload, enter y
    Example:
    Proceed with reload? [confirm] y
  18. Run show version command to verify that the router loaded the proper system image:
    Example:
    Router# show version
    Cisco IOS XE Software, Version 16.09.02
    Cisco IOS Software [Fuji],......
    …
    System returned to ROM by reload
    System image file is "bootflash:csr1000v-xxx"
    Last reload reason: Reload Command…

CIMC Patch Installation

  1. Login to collector appliance as admin
  2. To check updates for CIMC execute below command:
    #check update cimc
  3. To download the CIMC patch execute below command (M3 server):
    #download jeos-101.0.3-0-lnx64
  4. To download the CIMC patch execute below command (M4 server):
    #download jeos-101.0.4-0-lnx64
  5. To check download status execute below command:
    #show download
  6. Once the patch is downloaded to /opt/LCM/tmp, unzip the patch and follow the instructions from Read_me_CIMC_3.0(4i).docx

NOS Configurer

Installation Sequence For nos_configurer

Note: This is only for NOS.

This section shows the instructions on how to install nos_configurer_2.8 on CSPC 2.8, and to configure CSPC for NOS specific functionalities.

Note: The NOS Configurer, RI Addons should be installed manually which are present in the $CSPCHOME/installer/manual folder.

There is no updates on nos configurer in CSPC 2.8. So, you can follow the same steps below.

Note: This only for fresh nos installation.

It performs the following tasks:

  1. Schedule jobs to carry out NOS functionalities
    Following jobs are scheduled:
    • Weekly Inventory Job
    • Daily Upload Job
    • Daily DAV Job
    • Daily Health Upload Job
  2. Adds dependency rules to maintain data consistency

Follow the steps given below to install nos_configure_2.8 on CSPC 2.8:

  1. Terminal login to CSPC appliance
  2. Navigate to path $CSPCHOME/installs/manual
  3. Unzip the file nos_configurer_2.8.zip
  4. On unzipping, a folder named nos_configurer_2.8 is created
  5. Enter the command:
    1. cd nos_configurer_2.8
    2. sh nos_cspc_2.8_patch.sh <username> <pwd> <fullInventoryDay>
      <hourOfFullInventory> <hourOfUpload>
      Example: sh nos_cspc_2.8_patch.sh <username> <pwd> 1 22 23

    Note: You can install the installer without giving above three optional arguments. This will install support installer with default values as 1, 23 and 23.

    In the above example:
    1..7 = Sunday to Saturday
    1…23 = hours in a day.
  6. On triggering the above command, it will prompt for user confirmations. Provide them accordingly.
    1. Do you want to cancel installation and rerun with additional arguments? Enter Y or N: (y/n)? N
    2. Do you want to cancel installation and rerun with different scheduling day and hours ? Enter Y or N: (y/n)? N
    3. Do you want to schedule health job immediately Enter Y or N: (y/n)? Y
    4. Do you want to schedule inventory/DAV/Upload job immediately Enter Y or N: (y/n)? Y
    5. Restarting the server to make sure inventory is not running. Do you want to continue? Enter Y or N: (y/n)? N

    Note: You have option to schedule the job now or later.

Was this Document Helpful?

FeedbackFeedback

Contact Cisco