Install Operator Console (OC)

CA UIM features an Operator Console (OC) that presents the performance and availability data CA UIM collects. OC contains several modules, which are webapps.
CA UIM features an Operator Console (OC) that presents the performance and availability data CA UIM collects. OC contains several modules, which are webapps. Operator Console Installer installs Operator Console and supporting Webapps that presents:
  • Account Admin
    - for managing accounts and users
  • Dashboard Designer
    - for creating and editing custom dashboards
  • SLM
    - for creating, monitoring, and validating SLAs for internal or external customers
  • Alarm Viewer
    - for monitoring, and managing alarms
  • CABI
    - for custom/out-of-box dashboards
    UIM 20.3.3 has removed dependency on CA Business Intelligence (CABI) for rendering the native OC screens: Home page, Group view page, Device view page, and Monitoring Technologies (probes) view page. Custom and Out-of-the-Box dashboards and reports are still rendered by using CABI; that is, they have a dependency on CABI. However, the native OC screens are no longer dependent on CABI (Jaspersoft) and are rendered by using HTML5. For more information about the native OC screens using HTML5, see the Configuring and Viewing Monitoring Data article or the "Removing CABI Dependency (Native Operator Console)" section in the UIM 20.3.3 article.
For a full list of the webapps available for Operator Console, see Operator Console in the Configuring and Viewing Monitoring Data page.
Installation Overview
The following diagram shows the high-level steps for Operator Console Installation:
Install Operator Console
Install Unified Management Portal
(For UMP) The OC installer must be used to upgrade UMP, as UMP is no longer available in UIM 20.3.0 (and later). The OC installer will uninstall deprecated components and upgrade valid components.
  • In an upgrade scenario, if you are upgrading UMP/OC to Operator Console in a secure setup, ensure that you bring your UMP/OC robot to the secure state by deploying the appropriate certificates and then updating the robot version to the secure state (9.20S or later). After that, you upgrade UMP/OC to OC. For more information about the secure setup and how to deploy certificates, see Secure Hub and Robot.
  • To upgrade from a previous version of OC to OC 20.3.3, use the OC 20.3.3 upgrade installer that is released as part of the UIM 20.3.3 release. For more information about the UIM 20.3.3 release, see the UIM 20.3.3 article.
  • To upgrade from a previous version of OC to OC 20.3.2, use the OC 20.3.2 upgrade installer. OC 20.3.2 is a patch release. For more information about the OC 20.3.2 patch, see the OC 20.3.2 Patch article.
  • To upgrade from a previous version of OC to OC 20.3.1, use the upgrade installer for OC that the UIM 20.3.1 patch contains. Note that UIM 20.3.1 is a patch release over UIM 20.3.0. The UIM 20.3.1 patch does not include any upgrade installer for the UIM Server. The patch includes the OC upgrade installer along with the separate standalone artifacts that you can use to upgrade the respective components to 20.3.1. For more information about the artifacts that are available as part of the UIM 20.3.1 patch release, see the UIM 20.3.1 article.
Installation Steps
The following steps help you install OC:
Your UIM environment contains the following components before you install OC:
  • Database Server:
    The database server is the location of the UIM database. The QoS data and other required system information is written to the database server.
  • Primary Hub Server:
    The primary hub server is the location of the robot that controls the UIM primary hub.
  • (Optional) Secondary Hub Servers
    : Your UIM environment can also have extra servers for load-balancing and failover capability.
You have several options for the location of OC in your environment.
  • A new server, which is known as the
    OC server.
    All of the probes that are required for basic OC functionality are installed on the OC server.
  • An existing secondary hub server that has services such as nas or discovery_server located on a different secondary hub. In such a scenario, you can configure OC to connect to the service probes on a secondary hub.
  • On the primary hub server. Only install OC on the primary hub server if you have a small environment to monitor. Generally, a small environment is classified as one that has 1 hub and fewer than 100 robots. See the article Pre-Installation Planning for more information about deployment size classifications.
Verify Prerequisites
Complete the following tasks before running the OC installer.
Verify Administrator Privileges for a User
OC can be installed successfully only by a user with administrator privileges. This user setting can be changed in Windows with the following steps.
Follow these steps:
  1. Open
    Administrative Tools
  2. Right click on the Nimsoft Robot Watcher and select
  3. Select the
    Log On
  4. Select the
    This account
    radio button.
  5. Enter the account and password for an administrator.
Verify the Requirements in the Pre-Installation Articles
OC has specific requirements that will impact both the server hardware and database software that you are using in your CA UIM environment. Ensure that you have met all of the OC-specific requirements in Pre-Installation Planning before you continue with your OC installation.
Verify the Required Probes on the Primary Hub Server
Verify that the following probes are installed, active, and responsive on your primary hub server when the OC installer runs:
  • ace
    The ace probe has been deprecated in 20.3.3.
  • automated_deployment_engine (ade)
  • data_engine
  • discovery_server
  • ems
  • maintenance_mode
  • mpse
  • nas
  • sla_engine
  • cdm
The OC installer attempts to launch the cdm probe to gather system specifications for the robot you select. If the cdm probe is not installed or fails to start, a warning message displays. If this warning occurs, you can proceed with the OC installation. However, the installer cannot inform you that the robot does not meet the minimum recommended specifications for running OC. Therefore, before you install OC, it is recommended you verify that the cdm probe is installed, active, and responsive.
Download the UIM JRE Package
Verify that the JRE package for your OS is present in the Archive folder in Admin Console or Infrastructure Manager. For Windows and Linux, the packed is named
java_jre package
. If necessary, right-click on the package for your OS, and download it before installing OC. If the JRE package for your OS is not present at installation, the OC installer prompts you to download it. If the installer cannot contact these probes, an error message appears. Use Infrastructure Manager or Admin Console to activate, restart, or download and deploy these probes as necessary.
Deactivate distsrv Forwarding
If you have package forwarding set up for the distsrv probe, deactivate it before installing OC. The distsrv probe can be configured to forward packages to other hubs. By default, forwarding is activated but no hubs are specified, so packages are not forwarded.
Follow these steps:
  1. In Admin Console, click the black arrow next to the distsrv probe, select
  2. Click the
    folder. If any Forwarding records have
    in the
    column, deactivate forwarding. For other types of records (
    , or
    ) you do not need to deactivate forwarding.
  3. Deselect
    Forwarding active
From CA UIM 9.2.0 onward, hub/robot- and probe-level licensing requirements have been removed. Deploy the hub, robot, and distsrv versions released with CA UIM 9.2.0 (or later) to remove the license dependency. If you want to continue with the older versions of hub and probes that require an extension of the license, contact Support so that they can assist you in extending the license (if required).
Set the OC Server Locale
The locale on the server that hosts OC must match the locale set on the UIM database server. For example, if the database server locale is set to Spanish, the OC server locale must also be set to Spanish.
Turn off Anti-Virus Scanning on the Primary Hub Server
Active anti-virus scanners slow down OC installation significantly. Before you begin installation, turn off any anti-virus scanning on the primary hub server.
(Optional) Secure Hub and Robot
The secure hub and robot provide robust hub-to-hub and robot-to-hub communication. To upgrade OC from UMP/OC in a secure setup, upgrade the UMP/OC robot to a secure state and then perform the OC upgrade. For more information about the secure setup and how to deploy certificates, see Secure Hub and Robot.
Deploy a Robot to the OC Server
If you are installing OC on a new server, deploy a robot. For more information about robot deployment, see the article Deploy Robots. Once the robot is deployed, you can continue with OC installation.
The UIM Server installer creates a .pem file (certificate.pem) in the <Nimsoft>\security folder. The .pem file is a symmetric key that is shared with the required robots, which is then used for communication with the data_engine probe. You copy this .pem file to the remote OC and CABI robots and provide the location of the file in the robot.cfg file (cryptkey = <.pem file location>). Furthermore, if any impacted probe is not on the same computer where data_engine is present, copy the generated .pem file to the robot computer (where data_engine is not available) and update the robot.cfg file with the .pem file location on that computer. For more information about the robot.cfg file configuration, see Configure the robot.cfg File.
(Microsoft SQL Server Windows Authentication Only) Set up Windows Authentication in OC
If you are using Microsoft SQL Server with Windows authentication, ensure that the UIM, OC, and CABI Servers are on Windows servers.
Windows authentication must be set up both in UIM and OC.
Follow these steps:
  1. After the OC robot is installed, go to
    Administrative Tools > Services
    and double-click on
    Nimsoft Robot Watcher.
  2. Select the
    Log On
  3. Use Windows "SYSTEM" user to login to your DB from the data_engine.
    For MS SQL with AD Authentication, Change the logon account to the same account and password used in the data_engine and the primary UIM server.
  4. Click
  5. Right-click on
    Nimbus Robot Watcher
    and select the
  6. Close the windows.
  7. Restart the wasp.
Download the OC Install Package to the Primary Hub Server
Log in to and locate the OC installation package in Download Management.
Run the OC Installer from the Primary Hub Server
The following description is for a first-time installation of OC. By default, the OC installer runs as a wizard with a GUI. You can also run the installer in console mode.
Once OC has been installed, the system IP address cannot be changed.
GUI Mode
Graphical user interface (GUI) mode walks you through the installation process.
Follow these steps:
  1. Run the installer from the primary hub server.
  2. Select the language to use.
  3. Select the installation folder location.
  4. Enter the user name and password to log in to the primary hub. The user name can be any user with administrative rights.
  5. Follow the required steps based on your requirements:
    1. (For 20.3.3) Specify the IP address of the required robot, where you want to install OC, in the
      Specify IP
      field. This robot must be reporting to the primary hub. Alternatively, you can also use the
      option to select the robot that you deployed for your OC installation
      • It is recommended to use the
        Specify IP
        field if you have a large number of robots connected to the primary hub.
      • If you try to perform the installation on the primary hub, you receive a message prompting you to confirm whether you want to proceed with the installation on the primary hub. It is not recommended to install OC on a primary hub.
      • The OC installer displays an error message if you do not provide the valid IP address or the robot is not connected to the primary hub.
      • If wasp is down or cryptkey is not configured, the OC installer displays the appropriate error.
      • If the same OC version is already installed, the OC installer prompts you to reinstall or uninstall the instance.
      • If a previous version of OC is detected, the OC installer prompts you to upgrade to the latest OC version.
      • If the cdm probe fails to gather system specifications, or if the specifications do not meet requirements, a warning message is displayed. In either case, you can proceed with the installation.
    2. (Prior to 20.3.3) Choose the robot that you deployed for your OC installation. Systems in the list appear by host name.
      If the cdm probe fails to gather system specifications, or if the specifications do not meet requirements, a warning message is displayed. In either case, you can proceed with the installation.
  6. Confirm or update the locations of the probes that are listed on the screen.
  7. Specify the ports for OC to use.
    • HTTP/Web port
      - The port that is used by the browser when sending requests to OC. The default is 80 for new installations.
    • AJP DMZ port
      - This port is used by the OC Server to receive requests from the Apache web server in a DMZ implementation. The default is 8009 for new installations. For more information about DMZ implementations with OC, see Set up Access to OC through a DMZ.
  8. (Windows only)
    Choose where you want shortcuts to be created.
  9. Review the information on the screen and click
    . The installer updates the archive (copies the files to the system) and installs OC. While it installs OC, a status bar displays progress for each phase. Each phase is validated before the installer continues. If there are errors, you can try that phase again, ignore the errors and continue, or cancel the installation.
  10. Click
    to exit the installer.
  11. Turn any anti-virus scanners back on.
  12. Reactivate distsrv forwarding if you disabled it prior to installation.
Console Mode
Console mode provides an interactive command-line interface.
Follow these steps:
From a command line or terminal, add the following parameter when running the installer:
-i console
For example, the Linux command is:
./oc-installer_linux.bin -i console
The installer asks for the same information in console mode as in GUI mode.
Log in to OC
Before you log in to OC, ensure that:
  • Cookies are enabled in your browser.
To access OC, open a supported web browser and enter the IP address or the host name of the OC Server. See the Unified Infrastructure Management Compatibility Matrix for the current list of supported browsers.
After a user is authenticated, OC opens the default home page.