CA Technologies

CA Service Operations Insight r3.2 CA Catalyst Connector Backward Compatibility Readme File


1.0 Introduction

2.0 Enable Backward Compatibility with CA Catalyst r3.2 Connectors
2.1 CA Catalyst Installation Considerations
2.2 Event Management Considerations
2.3 Install the IFW Proxy
2.4 Verify Connector Data in CA SOI
2.5 Connector Data Considerations
2.6 IFW Proxy Using CA Catalyst Connector Controls

3.0 Interacting with CA Catalyst r3.2 Connectors
3.1 Connector Configuration
3.2 Configure Connector Administration Settings
3.3 Change Encrypted Connector Property Values from CA SOI Administration Tab
3.4 Change the CA SOI Password on a CA Catalyst Connector System
3.5 Remove the Connector and Connector Data from CA SOI

4.0 Install the CA Catalyst Container

5.0 Contact CA Technologies


1.0 Introduction

This file contains information about the IFW Proxy component, which provides backward compatibility with CA Catalyst r3.2 connectors.


2.0 Enable Backward Compatibility with CA Catalyst r3.2 Connectors

CA Service Operations Insight (CA SOI) r3.2 provides native support for connectors developed for its embedded version of the CA Catalyst platform (r2.5). These connectors are accessible from the CA Service Operations Insight product page on CA Support Online using the CA Spectrum Service Assurance/Service Operations Insight - Connectors, Solutions, & Patches link under Recommended Reading.

Other connectors are available for the CA Catalyst r3.0 platform (and subsequent releases). CA Catalyst controls the administration and management of these connectors independent of CA SOI, and current releases of CA SOI do not embed or support this CA Catalyst version. CA SOI administrators require the IFW Proxy backward compatibility module to use these connectors with CA SOI. The IFW Proxy runs in a CA Catalyst node, collects the connector data, and transmits it to the CA SOI IFW for visualization and management in CA SOI. These connectors are accessible from their specific individual connector packages.

The following versions of CA SOI support viewing CA Catalyst r3.2 connector data using the IFW Proxy:

Note: For information about support for the latest version of the CA Catalyst r3.0 platform in future CA SOI releases, see the documentation for that release.

Do the following to enable backward compatibility with CA Catalyst r3.2 connectors:

Note: The phrase "CA Catalyst r3.2 connectors" denotes connectors developed specifically for all releases of the CA Catalyst r3.0 platform, starting with r3.1.

  1. Install CA SOI according to the instructions in the CA SOI Implementation Guide.
  2. Download the IFW Proxy patch from CA Support Online. This patch includes the IFW Proxy and CA Catalyst Container.
  3. Install the CA Catalyst Container (CA Catalyst Installation Considerations, Install the CA Catalyst Container) on each system where you plan to install a CA Catalyst r3.2 connector.
  4. Install CA Catalyst r3.2 connectors to integrate with the installed CA Catalyst Container and with CA SOI through the IFW Proxy.
  5. Install the IFW Proxy on all CA Catalyst Container systems where you plan to install connectors to manage in CA SOI.
  6. Verify the connector data in CA SOI.

2.1 CA Catalyst Installation Considerations

Consider the following before installing the IFW Proxy when installing the prerequisite CA Catalyst components:

2.2 Event Management Considerations

CA SOI r3.0 introduced a new Event Management component. CA Catalyst r3.2 does not contain this Event Management functionality by default. The CA Catalyst Container provided with the IFW Proxy enables event collection and exposure in CA Catalyst r3.2 connectors for CA SOI Event Management searches and policies.

2.3 Install the IFW Proxy

The IFW Proxy enables CA SOI to visualize and manage data provided by CA Catalyst r3.2 connectors. Install the IFW Proxy on each CA Catalyst Container system that hosts connectors that you want to manage in CA SOI. A CA Catalyst Container is required on the system on which you install the IFW Proxy. If you have multiple CA Catalyst Containers hosting connectors on a single system, install a separate IFW Proxy to communicate with each Container.

We recommend that all connectors are installed on the CA Catalyst Container system before you install the IFW Proxy. However, you can install a connector on a Container system after installing the IFW Proxy.

Follow these steps:

  1. Run soi.ifwproxy.exe from the IFW Proxy Patch on the CA Catalyst Container system that hosts connectors that you want to manage in CA SOI.

    Note: If multiple CA Catalyst Containers are available on the system, the IFW Proxy installer prompts you to select the appropriate Container.

    The IFW Proxy installer opens to the Introduction page.

  2. Accept both license agreements and click Next.
  3. Enter SA Manager information as follows, and click Next.

    Note: Refer to your Installation Worksheet in the SA Manager section for these values.

  4. Click Install.

    The IFW Proxy installs, and the Install Complete page opens. If errors display, check the CA_IFWProxy_InstallLog.log file installed to CATALYST_HOME\containerName\logs for details.

    Note: CATALYST_HOME denotes the root CA Catalyst installation directory, which is C:\Program Files\CA\Catalyst by default.

    (Optional) Repeat Steps 1-4 for all local or remote CA Catalyst Containers that host connectors that you want to manage in CA SOI.

2.4 Verify Connector Data in CA SOI

After IFW Proxy installation, the CA Catalyst connector data appears in the CA SOI instance that you provided during the IFW Proxy installation.

Follow these steps:

  1. Access the CA SOI Dashboard, and click the Administration tab.
  2. Expand Connector Configuration, and expand the entry for the CA Catalyst connector system.
  3. Select the CA Catalyst connector entry.

    The details of the integrated CA Catalyst connector appear on the right pane. The Connector Description clarifies that the connector is a "Connector_Name running in Catalyst node Node_Name." If the Connector Status displays as Online, the integration was successful.

    This page also contains connector configuration information.

  4. Perform any of the following actions to verify that the connector data is accessible in the Operations Console:

2.5 Connector Data Considerations

Data from CA Catalyst r3.2 connectors differs from traditional CA SOI connectors as follows:

2.6 IFW Proxy Using CA Catalyst Connector Controls

CA Catalyst adds various connector controls (that correspond to the connector controls in the IFW) to the connector configurations. The IFW Proxy uses these new CA Catalyst parameters to set the connector controls and determine how to use the connector. These CA Catalyst connector controls are available in the connector configuration files. For example, the dns_resolution property is available under the InterceptorChainConfig, Interceptor, Config section of the connector configuration file.

The new CA Catalyst connector controls that the IFW Proxy uses are mentioned in the following table. The table also includes the corresponding IFW connector controls:

New CA Catalyst Connector Controls Old IFW Connector Controls
DisableGetRelationshipsAtStartup getRelationshipsAtStartup
DisableGetItemsAtStartup getCIsAtStartUp
DisableDelta performDeltaProcessing
dns_resolution dns_resolution

The IFW Proxy includes default values for all the IFW connector controls in its configuration file (CATALYST_HOME\registry\topology\physical\nodename\ifw\ifw.properties). If a CA Catalyst connector configuration contains one of those CA Catalyst connector controls, the IFW Proxy uses it when interacting with that connector. Otherwise, the IFW Proxy uses its default value. If the connector configuration is changed using the CA SOI Administration UI, all the connector controls for that connector are saved into the CA Catalyst connector configuration.

Changes are saved as follows:

For the other IFW connector controls that do not have CA Catalyst equivalents (the ones not in the table), the IFW Proxy uses the IFW defaults, until the connector configuration is changed from the Administration UI. In that case, they are written to the CA Catalyst connector configuration.


3.0 Interacting with CA Catalyst r3.2 Connectors

This section lists methods of interaction with CA Catalyst r3.2 connectors that are different than those for traditional connectors.

3.1 Connector Configuration

You can perform the following CA Catalyst r3.2 connector configuration from the CA SOI Administration UI:

3.2 Configure Connector Administration Settings

By default, you can start or stop a CA Catalyst r3.2 connector from the CA SOI Administration UI using the Start and Stop buttons. You can configure whether these buttons actually start or stop the connector or simply stop the flow of connector data into CA SOI.

Follow these steps:

  1. Access the ifw.properties file located at CATALYST_HOME\containerName\registry\topology\physical\connectorserver\ifw on the CA Catalyst connector system.

    Note: If your CA Catalyst deployment includes a CA Catalyst Server, log in to the Registry Administration UI to access and modify this file.

  2. Set the connectorAdmin value to one of the following, and save and close the file:
  3. Restart the CA Catalyst Container ContainerName service on the connector system if you made a change to the file.

3.3 Change Encrypted Connector Property Values from CA SOI Administration Tab

The CA SOI Administration tab supports modifying CA Catalyst connector properties. However, if you change the value of an encrypted property, use CA Catalyst encryption so that CA Catalyst can process the new encrypted value.

Follow these steps:

  1. Open a command prompt on a system with CA Catalyst r3.2 components installed.
  2. Navigate to CATALYST_HOME\containerName\tools\encrypt and run the following command:
    encrypter password
    

    An encrypted string appears.

  3. Copy the encrypted string, and paste it into the property field on the CA SOI Administration UI.
  4. Save the changes, and restart the connector.

    The encrypted value change takes effect.

3.4 Change the CA SOI Password on a CA Catalyst Connector System

If you change the CA SOI administrator password using the instructions in the CA SOI Implementation Guide, also change the password in the IFW Proxy on the CA Catalyst Container. Keep this password synchronized in CA SOI and the IFW Proxy to avoid connection issues.

Follow these steps:

  1. Open a command prompt on the connector system, navigate to CATALYST_HOME\containerName\ifw, and run the following command:
    EncryptSAMCreds newpassword
    

    The command generates an encrypted password.

  2. Copy the password.
  3. Open the CATALYST_HOME\containerName\ifw\resources\configurations\SSA_IFW_servername.xml file, paste the new encrypted password into the password property, and save and close the file.
  4. Open the CATALYST_HOME\containerName\registry\topology\physical\connectorserver\ifw\eventManagementServer.properties file, paste the new encrypted password into the password property, and save and close the file.

    Note: If your CA Catalyst deployment includes a CA Catalyst Server, log in to the Registry Administration UI to access and modify this file.

  5. Restart the CA Catalyst Container ContainerName service.

    The password change takes effect.

3.5 Remove the Connector and Connector Data from CA SOI

Removing CA Catalyst r3.2 connectors and their data from CA SOI does not require uninstalling the connector. Uninstalling the IFW Proxy deletes the connection between CA SOI and CA Catalyst, and you can remove existing connector data from CA SOI.

Follow these steps:

  1. Uninstall the IFW Proxy on the CA Catalyst connector system by selecting Uninstall CA Service Operations Insight IFW Proxy from the Start menu.

    Uninstalling the IFW Proxy removes the connection between CA SOI and the CA Catalyst connector.

  2. Find the connector entry in the CA SOI Administration UI and click Remove Connector.

    The connector data is deleted from the SA Store database, and the entry disappears from the tree when the operation is complete.

  3. (Optional) Uninstall the connector if it is not required for other CA Catalyst solutions.

If you need to maintain a connection between CA SOI and other connectors on the same system, retain the IFW Proxy. Clicking Remove Connector on the CA SOI Administration UI still removes the CA Catalyst r3.2 connector data and updates the connector configuration to prevent subsequent use of the connector in CA SOI.

To enable a disabled connector, set the SOIState property to Enabled or remove the property altogether in the connectorname.conf file located at CATALYST_HOME\containerName\registry\topology\physical\nodename\modules\configuration.

Note: If your CA Catalyst deployment includes a CA Catalyst Server, log in to the Registry Administration UI to access and modify this file.


4.0 Install the CA Catalyst Container

Install a CA Catalyst Container (r3.2 Build 535 or higher) on the systems where you plan to install CA Catalyst r3.2 connectors. You can install multiple CA Catalyst r3.2 connectors on the same system into the same CA Catalyst Container.

For an IFW Proxy implementation, we recommend a Container-only CA Catalyst deployment. This procedure reflects the recommended selections to make in a Container-only environment. The CA Catalyst Server is not required.

Follow these steps:

  1. Run catalyst_install.bat from the IFW Proxy Patch.

    The CA Catalyst Container installation wizard opens.

    Note: For all installation pages not mentioned in this procedure, leave the default selections unless the default port numbers are in use. For the simplest deployment experience, complete the Installation Worksheet for the CA Catalyst Container for CA SOI with the values that you enter during installation.

  2. Proceed through the wizard, and perform the following actions to prepare for CA SOI integration:
  3. Click Install on the Install Summary page.

    The CA Catalyst Container installs. The Install Complete page displays the results of the installation. To troubleshoot installation errors, see the CATALYST_HOME\containerName\logs\CA_Container_InstallLog.log file, or see the CA Catalyst Installation Guide.

    Repeat this process on all systems where CA Catalyst Container installation is required for hosting CA Catalyst r3.2 connectors.


5.0 Contact CA Technologies

Contact CA Support

For your convenience, CA Technologies provides one site where you can access the information that you need for your Home Office, Small Business, and Enterprise CA Technologies products. At http://ca.com/support, you can access the following resources:

Providing Feedback About Product Documentation

If you have comments or questions about CA Technologies product documentation, you can send a message to techpubs@ca.com.

To provide feedback about CA Technologies product documentation, complete our short customer survey which is available on the CA Support website at http://ca.com/docs.