Cisco Prime Central for Hosted Collaboration Solution 9.2.1 Installation Guide
Chapter 4: Installing Prime Central for HCS 9.2.1
Downloads: This chapterpdf (PDF - 260.0KB) The complete bookPDF (PDF - 2.19MB) | Feedback

Installing Prime Central for HCS 9.2.1

Table Of Contents

Installing Prime Central for HCS 9.2.1

Installing With Remotely Staged Files

Configuring SSH Agent

Installing Prime Central

Installing Event Collector

Installing Correlation Engine

Installing Service Visualizer

Installing Infrastructure Monitoring

Installing With Locally Staged Files on a Target Machine

Installing Prime Central

Installing Event Collector

Installing Correlation Engine

Installing Service Visualizer

Installing Infrastructure Monitoring


Installing Prime Central for HCS 9.2.1


This chapter explains how to install Prime Central for HCS using CLI. Prime Central establishes a connection with an external database called the Shared Data Repository (SDR) located on the HCM-Fulfillment server's VM. Data from SDR is used for event enrichment, Root Cause Analysis (RCA), and Service Impact Analysis (SIA).

For the installation procedure to be successful, it is crucial that you run the following five installers in the sequence mentioned below:

1. Prime Central

2. Event Collector

3. Correlation Engine

4. Service Visualizer

5. Infrastructure Monitoring

If you have previously installed Prime Central for HCS 1.0.1, 1.1, or 9.1.1 in your environment, you can either perform a fresh installation or an upgrade.


Caution You must clear all the five Prime Central for HCS virtual machines before starting the installation process. You must not install different installers in the same machine. The sequence of installation is crucial for the installation to be successful. Though you can install the Correlation Engine, Service Visualizer, and Infrastructure Monitoring components in parallel, we highly recommend that you follow the sequence specified in this document.

You can install the components in any one of the following two ways:

Installing With Remotely Staged Files—To install Prime Central for HCS, you have to run five installers on the staging server, in the order specified in this document. You can install the files from one machine by establishing an SSH connection with a remote virtual machine. The component will be installed in the remote machine.

Installing With Locally Staged Files on a Target Machine—To install Prime Central for HCS, you have to run five installers in five different machines, in the order specified in this document. This method installs the component in the local machine directly.

You can use alternative methods for each component. Help is available for populating mandatory and optional fields. You can run the help command before installing or upgrading your Prime Central for HCS software.

/prime_push.py --help

Note If you disable SELinux while installing or upgrading the Prime Central for HCS components, the virtual machine will reboot after this process to re-enable SELinux.


Installing With Remotely Staged Files

Using this method, you have to establish an SSH connection with the remote machine from which you are going to trigger the installation. To circumvent the scenario of having to give the password everytime you do an installation, follow the procedure outlined below. This procedure is optional.

Configuring SSH Agent

By configuring SSH Agent, you will not be asked for a password every time during the installation. However, with the use of --ssh-push-key, you will be asked for the target machine's root password for the first time you login to a user account on a particular machine.

If you do not want the SSH key pass phrase every time you run a script, you can use standard Linux SSH functionality and use ssh-agent to store your pre-authorized keys.


Step 1 The first step is to generate keys. If you do not have a key, log in as a root user and generate the key(s). This is done only once for a target machine to which the configuration is pushed.

test ~/.ssh/id_dsa || ssh-keygen -t dsa
test ~/.ssh/id_rsa || ssh-keygen -t rsa
 
   

Note We recommend you to use the pass phrase on your SSH key for security reasons though it is optional.


Step 2 Start SSH agent. This is applicable only for the first time or after the reboot.

Step 3 Run the following command to see if the SSH agent is running:

eval `ssh-agent`
 
   

Step 4 Add the key to the SSH Agent that is running:

ssh-add ~/.ssh/id_rsa
ssh-add ~/.ssh/id_dsa 
 
   

Note After performing the installations or upgrades, delete the SSH, SSL Keys or the pass phrases from the server.



You can begin the installation procedure of the various components. The following rules apply:

Log into the staging media VM as root user.

At instances where you have to type the password, specify the root password.

Installing Prime Central

Here are some recommendations for installing Prime Central component server:

Use the --ssh-push-key argument to limit the number of times you are prompted for passwords.

Provide the --admin-password and --prime-admin-password arguments.

Do not use the --prime-ip-address argument because the script can determine the IP address.

The following steps explain the procedure to install Prime Central component server:


Step 1 Log into the staging media VM as root user.

Step 2 Run cd hcm_installer/scripts/hcm_install_scripts

Step 3 Run ./prime_push.py --prime-hostname <prime-hostname> --ec-hostname <event-collector-host-or-ip> --hcm-f-hostname <hcm-f-hostname-or-ip> --hcm-f-admin-password <hcm-f-admin-password> --im-hostname <Infrastructure-Monitoring_hostname> --sv-hostname <service-visualizer-hostname-DO-NOT-USE-IP> --password <prime-vm-root-password> --ntp-servers <server1>,<server2>...
[
--admin-password <admin-password> --prime-admin-password <prime-admin-password> ]
[ --ssh-host <ssh-host-or-ip> --ssh-port <ssh-port> ] [ --ssh-push-key ]


Guidelines for Entering Passwords and Variables

The guidelines are listed below:

The hostnames of the components must not contain the special character _ (underscore).

The length of the hostname must not exceed 18 characters.

The hostname must contain only lowercase characters.

Prime hostname—In the above command, provide only the hostname for the --prime-hostname. Hostname must contain only lowercase characters. Do not enter the FQDN or IP address of the Prime Central server. The length of the hostname must not exceed 18 characters.

Admin Password—In the above command, against the --admin-password <admin-password>, provide the admin password of the server. The admin password must be the same across all Prime Central for HCS component servers and must follow the guidelines mentioned below:

Minimum 5 characters and maximum 14 characters

The special characters asterisk (*), hyphen (-), percentage (%), dollar ($) must not be used.

Single or double quotes must not be used.

Use only single quotes around any argument that has special characters such as exclamation mark (!), or ampersand (&).

Prime Admin Password and Prime VM Root PasswordIn the above command, the --prime-admin-password <prime-admin-password> and --password <prime-vm-root-password> should be a strong password and must be the same across all Prime Central for HCS component servers. If you do not specify the Prime Admin password on the command line, the install script will prompt you for the password. The Prime Admin password must follow the guidelines mentioned below:

Minimum 8 characters and maximum 12 characters

A character must not be repeated 3 times consecutively.

Must contain at least one uppercase letter (A-Z).

Must contain at least one lowercase letter (a-z)

Must contain at least one number (0-9)

Must contain at least one special character hyphen (-), at sign (@), or tilde (~).

The special characters exclamation mark (!), apostrophe ('), quotation mark ("), slash (/), dollar sign ($), question mark (?), accent grave (`), or underscore (_) must not be used.

Must not contain cisco or any other combination of the word.


Note Arguments within square brackets are optional. You can specify either an SSH host or IP address for <ssh-host-or-ip>. The commands --ssh-host and --ssh-port are required only if SSH access to the VM uses a different IP/hostname and a different port (that is not the default 22). For example, you would use the argument if the staging server is not behind NAT.


To see an example of the usage of the script, see Installing Prime Central—Example.


Installing Event Collector

Event Collector install requires that Prime Central be installed and running. Prime Central must also be reachable at the address given in the --prime-hostname argument for the Prime Central installer. Begin the installation of the Event Collector component server virtual machine only after the Prime Central virtual machine has rebooted and is fully operational. Cisco recommends that you do not use unencrypted passwords for security reasons while supplying the nco-pa-password.

Here are some guidelines for installing Event Collector component server:

Use the --ssh-push-key argument to limit the number of times you are prompted for passwords. You will be prompted for the Prime Central VM root password unless SSH is setup to not prompt for a password from Event Collector VM to Prime Central VM for root user.

Provide the --admin-password and --prime-admin-password arguments.

For security reasons, encrypt the OS root password in the --nco-pa-password argument. If you cannot encrypt the OS root password with --nco-pa-crypt from the previous install, then the recommended approach is to not use the --nco-pa-password argument. In such a case (of not using the --nco-pa-password argument), the installer prompts you for the unencrypted password. After you type the password, installer immediately encrypts the password.


Step 1 Log into the staging media VM as root user.

Step 2 Run cd hcm_installer/scripts/hcm_install_scripts

Step 3 Run ./ec_push.py --ec-hostname <event-collector-host-or-ip> --prime-hostname <prime-hostname-or-IP> --ntp-servers <server1>,<server2>...
[ --admin-password <admin-password> --prime-admin-password <prime-admin-password> ]

[ --ssh-host <ssh-host-or-ip> --ssh-port <ssh-port> ] [ --ssh-push-key ]


For password and variable related guidelines, see Guidelines for Entering Passwords and Variables. To see an example of the usage of the script, see Installing Event Collector—Example.

Installing Correlation Engine

Correlation Engine install requires Event Collector be installed and running. Begin the installation of the Correlation Engine component server virtual machine only after the Event Collector virtual machine has rebooted and is fully operational.

Here are some guidelines for installing Correlation Engine component server:

Use the --ssh-push-key argument to limit the number of times you are prompted for passwords.

Provide the --admin-password argument.

Use the same HCM-F hostname and HCM-F admin password as specified for the Prime Central installer.

The following steps explain the procedure to install Correlation Engine component server:


Step 1 Log into the staging media VM as root user.

Step 2 Run cd hcm_installer/scripts/hcm_install_scripts

Step 3 Run ./ce_push.py --ce-hostname <correlation-engine-host-with-domain-name-DO-NOT-USE-IP> --ec-hostname <event-collector-host-name-with-domain-name-or-ip>

--hcm-f-hostname <hcm-f-hostname-or-ip> --hcm-f-admin-password <hcm-f-admin-password>

--ntp-servers <server1>,<server2>...

[ --admin-password <admin_password> ]
[ --ssh-host <ssh-host-or-ip> --ssh-port <ssh-port> ] [ --ssh-push-key ]


For password and variable related guidelines, see Guidelines for Entering Passwords and Variables. To see an example of the usage of the script, see Installing Correlation Engine—Example.

Installing Service Visualizer

Service Visualizer install requires Prime Central and Event Collector be installed and running. Begin the installation of the Service Visualizer component server virtual machine only after the Prime Central and Event Collector virtual machines are rebooted and fully operational. Prime Central must also be reachable at the address given in the <prime-host-DO-NOT-USE-IP> argument for the Prime Central installer.

Here are some guidelines for installing Service Visualizer component server:

Use the --ssh-push-key argument to limit the number of times you are prompted for passwords.

Provide the --<admin-password> and --<prime-admin-password> arguments.

Use the same HCM-F hostname and HCM-F admin password as specified for the Prime Central installer.

The following steps explain the procedure to install Service Visualizer component:


Step 1 Log into the staging media VM as root user.

Step 2 Run cd hcm_installer/scripts/hcm_install_scripts

Step 3 Run ./sv_push.py --sv-hostname <service-visualizer-host-with-domain-name-Do-NOT-USE-IP> --ec-hostname <event-collector-host-or-ip>

--prime-hostname <prime-host-DO-NOT-USE-IP>

--hcm-f-hostname <hcm-f-host-or-ip> --hcm-f-admin-password <hcm-f-admin-password> --ntp-servers <server1>,<server2>...

[ --admin-password <admin-password> --prime-admin-password <prime-admin-password> ]
[ --ssh-host <ssh-host-or-ip> --ssh-port <ssh-port> ] [ --ssh-push-key ]


For password and variable related guidelines, see Guidelines for Entering Passwords and Variables. To see an example of the usage of the script, see Installing Service Visualizer—Example.

Installing Infrastructure Monitoring

Follow the procedure below to install Infrastructure Monitoring component. Here is a guideline for installing Infrastructure Monitoring component server:

Use the --ssh-push-key argument to limit the number of times you are prompted for passwords.


Step 1 Log into the staging media VM as root user.

Step 2 Run cd hcm_installer/scripts/hcm_install_scripts

Step 3 Run ./im_push.py --im-hostname <infrastructure-monitoring-host-or-ip> --ec-hostname <event-collector-host-or-ip> --prime-hostname <prime-central-host-or-ip> --ntp-servers <server1>,<server2>... --hcm-f-hostname <HCM-F-hostname-OR-IP> --hcm-f-admin-username <HCM-F-admin-cli-username> --hcm-f-admin-password <hcm-f-admin-cli-password> [ --admin-password <admin-password> ]

[ --ssh-host <ssh-host-or-ip> --ssh-port <ssh-port-or-ip>] [ --ssh-push-key ]


For password and variable related guidelines, see Guidelines for Entering Passwords and Variables. To see an example of the usage of the script, see Installing Infrastructure Monitoring—Example.

Installing With Locally Staged Files on a Target Machine

This section explains the steps involved in installing Prime Central for HCS 9.2.1 with locally staged installation files.

Installing Prime Central

Here are some recommendations for installing Prime Central component server:

Provide the --admin-password and --prime-admin-password arguments.

Do not use the --prime-ip-address argument as the script can determine the IP address.

Provide the --hcm-f-hostname-or-ip and --hcm-f-admin-password arguments.


Note The install media is available to the VMs (in which the Prime Central for HCS is installed) using NFS, CIFS, Local Disk, or ISO. The permission of the install media permission must be set to 755, where all read-only and executable files are accessible to all the users. Installation will fail if proper media permission is not set for the installer.


The following steps explain the procedure to install Prime Central component server:


Step 1 Log into the staging media VM as root user.

Step 2 Run cd hcm_installer/scripts/hcm_install_scripts

Step 3 Run ./prime_install.py --prime-hostname <prime-hostname-DO-NOT-USE-IP> --ec-hostname <event-collector-host-or-ip> --hcm-f-hostname <hcm-f-host-or-ip> --hcm-f-admin-password <hcm-f-admin-password> --im-hostname <infrastructure-monitoring_host-or-ip> --sv-hostname <service-visualizer-host-DO-NOT-USE-IP> --password <prime-vm-root-password> --ntp-servers <server1>,<server2>...

[ --admin-password <admin-password> --prime-admin-password <prime-admin-password> ]


For password and variable related guidelines, see Guidelines for Entering Passwords and Variables. To see an example of the usage of the script, see Installing Prime Central—Example.

Installing Event Collector

Event Collector install requires that Prime Central be installed and running. Prime Central must also be reachable at the address given in the prime-hostname argument for the Prime Central installer. Wait for the VM to restart before you begin installing Event Collector installer. Cisco recommends that you do not use unencrypted passwords for security reasons while supplying the nco-pa-password.

Here are some recommendations for installing Event Collector component server:

Use the --ssh-push-key argument to limit the number of times you are prompted for passwords. You will be prompted for the Prime Central VM root password unless SSH is setup to not prompt for a password from Event Collector VM to Prime Central VM for root user.

Provide the --admin-password and --prime-admin-password arguments.

For security reasons, encrypt the OS root password in the nco-pa-password argument. If you cannot encrypt the OS root password with nco-pa-crypt from a previous install, then the recommended approach is to not use the --nco-pa-password argument. In such a case (of not using the --nco-pa-password argument), the installer prompts you for the unencrypted password. After you type the password, installer immediately encrypts the password.


Step 1 Log into the staging media VM as root user.

Step 2 Run cd hcm_installer/scripts/hcm_install_scripts

Run ./ec_install.py --ec-hostname <event-collector-host-or-ip> --prime-hostname <prime-host-or-ip> --ntp-servers <server1>,<server2>...
[ --admin-password
<admin-password> --prime-admin-password <prime-admin-password> ]

[--nco-pa-password <ec-os-root-password-from-nco_pa_crypt> ]



Note If you install Event Collector afresh, the encrypted password from nco_pa_crypt will not be available. If you pass the password as an argument, it will not be encrypted; however, you enter the password when prompted, it will be encrypted.



Note You will be prompted for the Prime Central VM root password if you did not set up SSH to not prompt for a password from Service Visualizer VM to Prime Central VM for root user.


For password and variable related guidelines, see Guidelines for Entering Passwords and Variables. To see an example of the usage of the script, see Installing Event Collector—Example.

Installing Correlation Engine

Correlation Engine install requires Event Collector is installed and running. Begin installing the Correlation Engine installer only after the Event Collector VM restarts after the reboot.

Here are some recommendations for installing Correlation Engine component server:

Use the --ssh-push-key argument to limit the number of times you are prompted for passwords.

Provide the --admin-password argument.

Use the same HCM-F hostname and admin password as specified in the Prime Central installer.

The following steps explain the procedure to install Correlation Engine component server:


Step 1 Log into the staging media VM as root user.

Step 2 Run cd hcm_installer/scripts/hcm_install_scripts

Step 3 Run ./ce_install.py --ce-hostname <correlation-engine-host-with-domain-name-DO-NOT-USE-ip> --ec-hostname <event-collector-host-with-domain-name-or-ip>

--hcm-f-hostname <hcm-f-host-or-ip> --hcm-f-admin-password <hcm-f-admin-password> --ntp-servers <server1>,<server2>...
[
--admin-password <admin-password> ]


For password and variable related guidelines, see Guidelines for Entering Passwords and Variables. To see an example of the usage of the script, see Installing Correlation Engine—Example.

Installing Service Visualizer

Service Visualizer install requires Prime Central and Event Collector be installed and running. You must begin installing Service Visualizer component only after Prime Central and Event Collector restarts after the reboot. Prime Central must also be reachable at the address given in the prime-hostname argument for the Prime Central installer. Here are some recommendations for installing Service Visualizer component server:

Use the --ssh-push-key argument to limit the number of times you are prompted for passwords.

Provide the --admin-password and --prime-admin-password arguments.

Use the same HCM-F hostname and HCM-F admin password as specified for the Prime Central installer.

The following steps explain the procedure to install Service Visualizer component server:


Step 1 Log into the staging media VM as root user.

Step 2 Run cd hcm_installer/scripts/hcm_install_scripts

Run ./sv_install.py --sv-hostname <service-visualizer-host--with-domain-name-DO-NOT-USE-IP> --ec-hostname <event-collector-host-or-ip> --prime-hostname <prime-host-DO-NOT-USE-IP>

--hcm-f-hostname <hcm-f-host-or-ip> --hcm-f-admin-password <hcm-f-admin-password> --ntp-servers <server1>,<server2>...
[
--admin-password <admin-password> --prime-admin-password <prime-admin-password> ]


For password and variable related guidelines, see Guidelines for Entering Passwords and Variables. To see an example of the usage of the script, see Installing Service Visualizer—Example.

Installing Infrastructure Monitoring

Follow the procedure below to install Infrastructure Monitoring component server. Here is a recommendation for installing Infrastructure Monitoring component server:

Provide the --admin-password argument.


Step 1 Log into the staging media VM as root user.

Step 2 Run cd hcm_installer/scripts/hcm_install_scripts

Step 3 Run ./im_install.py --im-hostname <infrastructure-monitoring-host-or-ip> --ec-hostname <event-collector-host-or-ip> --prime-hostname <prime-central-host-or-ip>

--ntp-servers <server1>,<server2>... --hcm-f-hostname <HCM-F-hostname-or-IP-address> --hcm-f-admin-username <HCM-F-admin-CLI-username> --hcm-f-admin-password <HCM-F-admin- CLI-password> [ --admin-password <admin-password> ]


For password and variable related guidelines, see Guidelines for Entering Passwords and Variables. To see an example of the usage of the script, see Installing Infrastructure Monitoring—Example.