InTracer Component Installation

This chapter provides information and procedure to install InTracer components.

This chapter includes following sections:

Preparing for Installation

This section describes the steps that need to be performed prior to installation of an InTracer component.

InTracer dedicated user: It is recommended to have the InTracer installation and execution done by a dedicated user other than the 'root'. The user may be named 'staradm'. Ensure that the home directory of this user is set correctly like '/home/staradm' or '/export/home/staradm'. Also note that the user name should not exceed 8 characters.

IMPORTANT:

InTracer must be installed by a non root user and it does not require 'root' privileges for its functioning.

Unpacking Installation Files

InTracer Application installation files are distributed as a single compressed zip file, 'intracer.X.Y.Z.zip', where X,Y and Z together corresponds to the major and minor versions of InTracer.

Once the installation file is copied to the server machine in which the InTracer component is to be installed, use the following procedure:

  1. Create a user folder for InTracer application.
    mkdir <InTracer_APPS_directory>
    
  2. Copy or move the distributed InTracer application installation file to this directory.
    cp intracer.X.Y.Z.zip
    to <InTracer_apps_directory>
    
    OR
    mv intracer.X.Y.Z.zip
    to <InTracer_apps_directory>
    
  3. Change directory to <InTracer_apps_directory> and unzip the installation file
    unzip intracer.X.Y.Z.zip
    
    De-compressing the above file results in the following:
    • setup.bin - An executable binary file containing all the required application installation files
    • README - A text file with basic installation, operation and troubleshooting instructions

Pre Installation Checklist

The user installing an InTracer component should verify the check-list items mentioned below prior to the installation:

  • Ensure that the installation procedure is performed by the InTracer user created on this machine. Go through the InTracer dedicated user section above for more details.
  • It is strongly recommended to install only one InTracer component on a given server machine.
  • The server machine on which the installation is to be done should have a defined 'hostname'.
  • The network ports to be configured during the InTracer component installation should not be conflicting with any other application on the given server machine. Refer to the Network Default Port Utilization section for more details.
  • Ensure sufficient disk space is available on the partition where the InTracer component is being installed. The installation procedure might give an error if appropriate disk space is not available.

Installation Methods

InTracer installation provides the following installation methods. Any one of them can be used to perform the InTracer component installation.

GUI based Installation

This is the most often used installation method. Following are requirements that need to be met to using this method:

  • It requires a logon account to the InTracer component installation machine with display terminal (monitor) attached and some X-Windows client installed on the server
  • It requires the network connectivity to this machine via Telnet or SSH using some X-Windows client on the remote work-station.

Console based Installation

This method is available for users who do not have an X-Windows client available for remote connectivity to the InTracer component installation machine via Telnet or SSH.

Installing the InTracer Software using the GUI-Based Installation Wizard

To install an InTracer component using the GUI based installation, follow the steps below:

  1. Change directory to <InTracer_apps_directory> and run the setup.bin file
    cd <InTracer_apps_directory>./setup.bin
    

    CAUTION:

    If X Server is not running or Display variable is not set properly system automatically starts console based installation.

    A GUI screen as shown in sample given below appears and starts the InTracer installation.
  2. Click Next to proceed.
  3. Choose the component to install from C-InTracer, R-InTracer and RTCE.
  4. Choose using check box Nodal Trace or LTE Trace or both according to your requirement.
  5. Choose the InTracer installation mode from Standalone and Cluster failover.
  6. Select Upgrade installation or New installation as per the requirement. Enter the directory path if the installation is new.
  7. Follow the on-screen prompts to progress through the various installation dialogs and configure the parameters as required. C-InTracer Installation and Parameter description
    Parameter Description Default Value
    C-InTracer Component Configuration
    IP Address
    Select / Enter the IP Address
    Not Selected
    Mgmt Port
    Enter the port number for management interface on InTracer Server Component. This value must be between 1024 and 65530.
    The management port should be unique and should not conflict with that of any other InTracer component.
    45000
    Apache Server Configuration
    SSL Port
    Enter the port number for Apache server.This value must be between 1025 and 65530.
    The port should be unique and should not conflict with that of any other InTracer component port.

    IMPORTANT:

    To use port number between 1025 through 65530 you need “root” privilege.

    8443
    Port
    Enter the port number for Apache server. This value must be between 1025 and 65530.
    The port should be unique and should not conflict with that of any other InTracer component port.
    8080
    RPC Server Configuration
    Port
    Enter the port number for RPC server. This value must be between 1024 and 65530.
    The port should be unique and should not conflict with that of any other InTracer component port.
    45002
    Postgres Configuration
    Username
    username is automatically populated where as port number should be provided.
    .
    Port
    Enter the port number for Postgres server. This value must be between 1024 and 65530.
    The port should be unique and should not conflict with that of any other InTracer component port.
    5432
    Single Sign On (SSO) with Prime Central
    Single Sign On (SSO) with Prime Central
    Prime Central is a Cisco product used to provide an integrated user experience of network analysis.
    Alongside some other Cisco products, InTracer provides an option to the end-user to integrate its InTracer installation with Prime Central during installation.
    By integrating, it is possible to cross-launch InTracer through a Prime Central UI without going through the authentication process, hence it is termed a single-sign-on mechanism.
    After such integration, the integrated InTracer becomes a part of the Prime Suite of products and can no longer be invoked in a stand-alone fashion. User functions like Logout, User management is there-after governed by Prime Central and these options are not available on InTracer UI.
    .
    Enable SSO with Prime Central
    Enables SSO with Prime Central details.
    check/uncheck
    Prime Central Details
    DB Server host name
    Specify the host name local_host where you are installing the InTracer Server.
    NOTE: A host/server name must be specified for proper installation of InTracer components
    local_host
    DB User
    Specify the DB User db_user
    primedba
    DB Password
    Specify the DB Password db_password
    Admin123~
    DB Port
    Enter the port number for management interface on InTracer Server Component. This value must be between 1025 and 65530.The management port should be unique and should not conflict with that of any other InTracer component.
    1521
    DB SID
    Specify the DB Password db_sid
    primedb
    CAS URL
    Specify the CAS URLcas_url
    www.cisco.com:8443/SSO
    Pre installation summary
    Pre-Installation summary
    This section displays the pre installation summary.
    .
    .
    This screen asks user to review the configured parameters before installation starts and provides facility to modify the given parameters by clicking the “Previous” button. The information included in this screen are:
    • Installation location
    • Prime Central Details
    • Apache configuration SSL Port value
    • Prime Central Server Host name
    • Prime Central DB User
    • Prime Central DB Password
    • Prime Central DB Port
    • Prime Central DB SID
    • Prime Central CAS URL
    • RPC server port value
    • Post-gre Server Port
    Review the given information carefully. Once you click on Install button the system starts the installation procedure for selected component with configured parameters.
    .
    Installation summary
    .
    This section displays the installation summary.
    .


    R-InTracer Installation and Parameter Descriptions
    Parameter Description Default Value
    Component Configuration
    This section asks user to configure the InTracer components installation parameters. Client Parameters (IP address and Management port) should be specified carefully so that it enabled communication between R-InTracer and C-InTracer.
    C-InTracer Component Configuration
    IP Address
    Select / Enter the IP Address
    Not Selected
    Mgmt Port
    Enter the port number for management interface on InTracer Server Component. This value must be between 1024 and 65530.
    The management port should be unique and should not conflict with that of any other InTracer component.
    45000
    R-InTracer Component Configuration
    Server Name
    Specify the host name local_host where you are installing the InTracer Server.
    NOTE: A host/server name must be specified for proper installation of InTracer components.
    local_host
    IP Address
    Select / Enter the IP Address
    Not Selected
    Mgmt Port
    Enter the port number for management interface on InTracer Server Component. This value must be between 1024 and 65530
    The management port should be unique and should not conflict with that of any other InTracer component.
    45000
    Data Storage Period
    Enter the data storage period in days. This value must be between 2 and 365
    .
    Application Data Directories
    Application Data Directories
    This screen appears only when the selected R-InTracer component Installation type is Server Installation. This screen asks for application data directory1 through 4.

    IMPORTANT:

    This step appears only if you choose Nodal Trace while Installing InTracer.

    .
    Pre Installation Summary
    Pre Installation summary
    This section displays the pre installation summary.
    .
    .
    This screen asks the user to review the configured parameters before installation starts and provides facility to modify the given parameters by clicking the “Previous” button.
    Review the given information carefully. Once you click on Install button, the system starts the installation procedure for selected component with configured parameters.
    .
    Installation Summary
    .
    This section displays the installation summary.
    .


    R-TCE Installation and Parameter Descriptions
    Parameter Description Default Value
    C-InTracer Component Configuration
    IP Address
    Select / Enter the IP Address
    Not Selected
    Mgmt Port
    Enter the port number for management interface on InTracer Server Component. This value must be between 1024 and 65530.
    The management port should be unique and should not conflict with that of any other InTracer component.
    45000
    R-TCE Component Configuration
    TCE Name
    Specify the host name tce where you are installing the R-TCE.
    .
    IP Address
    Select / Enter the IP Address
    Not Selected
    Mgmt Port
    Enter the port number for management interface on R-TCE. This value must be between 1024 and 65530
    The management port should be unique and should not conflict with that of any other InTracer component.
    45000
    Data Storage Period
    Enter the data storage period in days. This value must be between 2 and 365
    .
    Pre Installation Summary
    Pre Installation summary
    This section displays the pre installation summary.
    .
    .
    This screen asks the user to review the configured parameters before installation starts and provides facility to modify the given parameters by clicking the “Previous” button.
    Review the given information carefully. Once you click on Install button, the system starts the installation procedure for selected component with configured parameters.
    .
    Installation Summary
    .
    This section displays the installation summary.
    .


  8. Click the Install button in Pre installation Summary screen to start the installation. Once you click on the Install button the installation starts. After successful completion of installation the system displays the Install Complete screen to indicate the successful completion of installation with configured parameters.
  9. Click the Done button to finish the installation and proceed to the installation of any of the remaining component on another machine as required.
  10. Once both the components installed on separate hosts, proceed to the section before starting the InTracer component(s).

Installing the InTracer Software using the Console-Based Installation Method

To install an InTracer component using the console based installation, follow the steps below:

  1. Change directory to <InTracer_apps_directory> and run the setup.bin file
    cd <InTracer_apps_directory>./setup.bin
    -i console
    
  2. Choose the component to install from the choices available onscreen.
  3. Choose the type of trace.
  4. Select the installation mode.
  5. C-InTracer Component Configuration: Enter the IP Address, Management port, Apache Port value, SSL port value and RPC Server Management Port value.
  6. Configure Postgre by entering the Server name and Port.
  7. Configuration for SSO with Prime Central: Enter the Prime Central DB Server host name, User, Password, Port, SID and CAS URL.
  8. R-InTracer Component Configuration: Enter the C-InTracer IP Address, Management port, R-InTracer name, IP Address, Management Port value and Data Storage Period.
  9. Enter the Application Data Directories path
  10. R-TCE Component Configuration: Enter the C-InTracer IP Address, Management port, R-TCE name, IP Address, Management Port value and Data Storage Period.
  11. Follow the on-screen prompts to proceed through the installation script and configure the various parameters as required. Once you have completed the installation configuration and all processes have started, you receive a message indicating that the required InTracer component was successfully installed. ======================================================================================Introduction Welcome to InstallAnywhere wizard, It will guide you through the installationof InTracer 12.2.171. InTracer Cisco Systems, Inc http://www.cisco.com Copyright (C)2011 Cisco Systems, Inc. All Rights Reserved. The copyrights to certain works contained in this software are owned by other third parties and used and distributed under license. Certain components of this software are licensed under the GNU General Public License (GPL) version 2.0 or the GNU Lesser General Public License (LGPL) Version 2.1. A copy of each such license is available at http://www.opensource.org/licenses/gpl-2.0.php and http://www.opensource.org/licenses/lgpl-2.1.php PRESS <ENTER> TO CONTINUE:
  12. Press ENTER to continue the installation.
  13. Follow the on-screen prompts to proceed through the installation script and configure the various parameters as required.
  14. The following Pre-Installation summary is displayed: ===============================================================================Pre-Installation Summary------------------------ Please Review the Following Before Continuing Product Name :InTracer Install Location :/home/kbollaba/InTracer Product Components : C-InTracer Postgres Apache RPC Server Disk Space Information : Required : 760.61 MB Available : 138.25 GB Installation Mode : Standalone InTracer C-InTracer Component Configuration IP Address of the C-InTracer : 10.105.87.195 Management Port value [1024-65530] : 45000 Postgres Configuration Username : kbollaba Port value [1024-65530] : 5432 RPC Server Configuration Port value : 45002 SSO with Prime Central : Details Apache SSL Port : 8443 Prime Central DB Server Hostname : Prime Central DB User : primedba Prime Central DB Port : 1521 Prime Central DB SID : primedb CAS URL : Apache Configuration Port value : 8080 N. Next panel P. Previous panel E. Exit Installation Enter your choice : (DEFAULT: N): N
  15. Once installation procedure is completed, following Post-Installation summary is displayed: ===============================================================================Post-Installation Summary-------------------------InTracer has been successfully installed to: /home/kbollaba/InTracer Installation logfile located at: /home/kbollaba/InTracer/InTracer_InstallLog.log Manage individual InTracer component as: C-InTracer ./ipmssys qs start ./ipmssys qs stop Status of InTracer system can be checked with: ./ipmssys status For Usage of ipmssys: ./ipmssys --help
  16. Verify that all InTracer processes were successfully started by looking at the on-screen messages in the console window.

    IMPORTANT:

    Both the installation methods are completely same and all the operations possible through one method are available in the other method.

Post Installation Checklist

The user installing an InTracer component should verify the check-list items mentioned below once the installation procedure is done.

  • Check whether the installation successfully completed by looking at the post installation summary.
  • To ensure proper functioning of R-InTracer, it is required to set the system UDP socket receive-buffer size to a high value. For example, 512 MB, to do this, run either of the following commands as 'root':
    • utils/ipmsserverconf
  • To ensure proper functioning of R-InTracer, it is required to increase the open file limit for R-Intracer user. To do so, add the following lines as a ‘root’ user in /etc/security/limits.conf file:
    <R-Intracer username>
      soft    nofile  65535
    
    <R-Intracer username>
      hard    nofile    65535
    
  • To ensure InTracer component starting at server machine startup, appropriate system '/etc' directory changes are automatically done by the Installation process. Check whether these changes are in place.
  • To ensure proper maintenance of InTracer, appropriate 'cron' entries are added for the InTracer user by the Installation process. Check whether these changes are in place.
  • To ensure proper functioning of user queries, check whether all the InTracer components are time synchronized. Go through the Time Synchronization section for more details.
  • Once all InTracer components including C-InTracer and R-InTracer(s) are installed on various server machines, check whether these can PING each other using the configured interface addressing.
  • From the gateway, check whether PING to each of the R-InTracer IP address is successful.
  • If the user wants to install their SSL certificates:
    1. Copy SSLCertificateFile and SSLCertificateKeyFile files to C-Intracer installation directory. For example, your_domain_name.crt and your_private.key.

      IMPORTANT:

      SSLCertificateFile should be your DigiCert certificate file (e.g. your_domain_name.crt). SSLCertificateKeyFile should be the key file generated when you created the CSR.

    2. Change directory to C-Intracer installation directory.
      bash-3.2$ cd
      <C-Intracer installation directory>
      
    3. Edit httpd-ssl.conf located at 3rdparty/apache/conf/extra/httpd-ssl.conf using following command:
      bash-3.2$vi
      3rdparty/apache/conf/extra/httpd-ssl.conf
      
    4. Replace SSLCertificateFile configuration parameter from httpd-ssl.conf with newly generated certificate path. For example,
      SSLCertificateFile
      "/path to C-Intracer installation directory/your_domain_name.crt"
      
    5. Replace SSLCertificateKeyFile configuration parameter from httpd-ssl.conf with newly generated key path. For example,
      SSLCertificateKeyFile
      " / path to C-Intracer installation directory /your_private.key"
      
    6. Save the file.
    7. Restart apache server using following command:
      bash-3.2$./ipmsapachectl
      stop
      
      bash-3.2$./ipmsapachectl start
      

How to start the InTracer

Start the InTracer Query Server Web Client GUI.
https://<intracer_host>:8443/intracer/

IMPORTANT:

To launch InTracer Query Server Web Client GUI, system should have SSL certificates for Apache Web server installed using SSL port 8443.

IMPORTANT:

Use user ID ‘superuser’ and Password ‘superuser’ to access InTracer Query Server.

To start the Intracer Query Server Web Client GUI which is using other than default port.
https://<intracer_host>:XXX/intracer/

IMPORTANT:

Use user ID ‘superuser’ and Password ‘superuser’ to access InTracer Query Server.