Previous Topic: Log StorageNext Topic: Filters and Profiles


Subscription

This section contains the following topics:

Upgrading to CA User Activity Reporting Module Version 12.5 through Subscription

View Global Subscription Status

View a Server's Subscription Status

Edit the Global Subscription Configuration

Edit a Server's Local Subscription Configuration

Download & Select Modules for Offline Subscription

About On-Demand Updates

Free Disk Space for Updates

About Subscription Public Keys

Self-Monitoring Events for Subscription

Apply Subscription Updates to Agents and Connectors

Upgrading to CA User Activity Reporting Module Version 12.5 through Subscription

To upgrade CA User Activity Reporting Module to version 12.5, first upgrade to version 12.5 of the Log Manager product, then update all other CA User Activity Reporting Module modules, such as Content, Integration and Agent modules. You perform all upgrade tasks through Subscription.

Important! Upgrade the management CA User Activity Reporting Module server before you install any new CA User Activity Reporting Module servers in your network. Doing so allows the new servers to register properly.

To upgrade to CA User Activity Reporting Module version 12.5

  1. Upgrade to Log Manager version 12.5.

    Note: The upgraded CA User Activity Reporting Module 12.5 user interface lists both Subscription Module and Subscription Service under the Administration tab, Services subtab. Subscription Module reflects the interface and functionality previous to the 12.5 update, and is present to help ensure proper communication between all CA User Activity Reporting Module servers during the upgrade to 12.5. Once you have upgraded the Log Manager product on a given CA User Activity Reporting Module server to version 12.5, use only Subscription Service to perform all further subscription tasks and configuration changes.

  2. Update all other CA User Activity Reporting Module modules.

    Important! After you have performed Step 1, the upgraded CA User Activity Reporting Module 12.5 user interface lists both Subscription Module and Subscription Service. Use only Subscription Service, and not Subscription Module, to perform all further subscriptions tasks, including this step. Subscription Module is present only to help ensure proper communication between all CA User Activity Reporting Module servers during the upgrade to 12.5; do not use it to perform subscription functions post-upgrade.

  3. If Agent or Connector modules were among the updates, install updated agents or connectors.
  4. Reregister third-party and other CA Technologies products, like CA Access Control, that display CA User Activity Reporting Module reports in their native interfaces using the Open API calls.

    Completing this step updates the certificates that changed in this release.

More information:

How to Register a Product with CA User Activity Reporting Module

Apply Subscription Updates to Agents and Connectors

View Global Subscription Status

The Subscription Service downloads and distributes selected subscription modules to your CA User Activity Reporting Module servers, either according to a schedule you configure or upon an on demand update. You can view the current subscription status of your CA User Activity Reporting Module servers through the Subscription Dashboard.

The Subscription Dashboard displays the progress of any updates a CA User Activity Reporting Module server is current downloading or installing. You can also see the state of any content updates currently in progress, and a list of all content updates previously installed.

To view the global status of subscriptions

  1. Click the Administration tab and the Services subtab.
  2. Click Subscription Service.

    The Global Service Configuration for the Subscription Service appears, with the Subscription Dashboard tab selected.

  3. To view the status of content updates, examine the Content Subscription Status window.

    If a content update is currently in progress, a progress bar and status messages indicate the status of the update. Click the Refresh button to display the most recent progress of the update.

  4. To view a list of all content updates installed to date, click Browse Catalog.

    The Content window appears. Click on a content type to display the name, date and version of all associated updates installed to date.

  5. To view the subscription status of any CA User Activity Reporting Module server, examine the Servers window.

    If an update is in progress on any CA User Activity Reporting Module server, a progress bar appears in the Progress column for that server. Click the Refresh button to display the most recent progress of the update.

    The Servers window also displays information for each CA User Activity Reporting Module server, including the following:

    State

    Displays the subscription state of a given CA User Activity Reporting Module server. Subscription states are Idle, Waiting, Downloading, Installing, Completed, and Failed.

    Message

    Displays any message relating to the subscription status of a given CA User Activity Reporting Module server.

    Date

    Displays the date of the last update action taken by a given CA User Activity Reporting Module server.

View a Server's Subscription Status

The Subscription Service downloads and distributes selected subscription modules to your CA User Activity Reporting Module servers, either according to a schedule you configure or upon an on demand update. You can view the current subscription status of a specific CA User Activity Reporting Module server through the global Subscription Dashboard, or through the local State window of that server.

To view the subscription status of a CA User Activity Reporting Module server

  1. Click the Administration tab and the Services subtab.
  2. Click Subscription Service.

    The Global Service Configuration for the Subscription Service appears, with the Subscription Dashboard tab selected.

  3. Do one of the following:

    or

Edit the Global Subscription Configuration

During the implementation phase, you can configure global subscription settings for your environment. All CA User Activity Reporting Module servers inherit and use these global settings, unless you override a global setting by configuring local settings for an individual server.

By default, the first server installed is the Default Subscription Proxy and all servers installed after the first are configured as subscription clients. If no other proxy is configured or available, the default proxy downloads updates to subscription clients.

You can change the global settings at any time. All servers inherit any changes you make, unless a specific server is configured locally to override those settings.

Settings that can only be made and edited at the global level include:

To edit the global subscription configuration

  1. Click the Administration tab and the Services subtab.
  2. Click Subscription Service.

    The Global Service Configuration for the Subscription Service appears.

  3. Click the Administration tab.
  4. Examine the Global Services Configuration: Subscription Service settings in the right pane. Review the settings and make any required changes.

    Note: See online help for field-level details.

  5. Click Save.

More information:

How to Apply Subscription Updates

Edit a Server's Local Subscription Configuration

During subscription implementation, you can configure global subscription settings, such as a subscription schedule and proxy list, for your environment. Individual CA User Activity Reporting Module servers inherit these global settings.

At any time, you can override global settings by configuring local settings for an individual server. Consider the subscription role of a server when planning to override global settings.

To edit a server's subscription configuration

  1. Click the Administration tab and the Services subtab.
  2. Expand Subscription Service and select the server to configure.

    The Subscription Service Configuration for the selected CA User Activity Reporting Module server appears.

  3. Click the Administration tab.
  4. If you want to change the subscription role of the server, do one of the following:

    Note: Before changing a server's role from subscription proxy to subscription client, consider the configurations of the subscription clients that use this proxy. If you change a server from proxy to client, immediately remove the server from global and local Subscription Proxy(s) for Client Updates lists.

    Important! Before changing a server's role to offline subscription proxy, consider whether it is included in any proxy lists. In a mixed subscription environment, where you have configured both online and offline subscription proxies, do not include offline proxies in the proxy list for any online subscription client.

  5. To override an inherited global setting, click the global/local button to switch to local service configuration for the selected field.

    Note: To restore the global setting, click the button again. The global setting is restored at the next update start time.

  6. If the modules you want to download for this server are different from the settings inherited from the global settings, switch to local configuration, click Browse, and select the desired modules.

    Note: Be sure that the modules selected for a subscription proxy include at minimum all modules selected in the download lists of any clients that receive updates from this proxy.

  7. If this server is to download subscription updates through an HTTP proxy server that is different from the inherited one, switch to local configuration and configure the desired HTTP proxy.
  8. If this server is to download updates on a schedule different from the inherited one, switch to local configuration and edit the schedule.
  9. If this server is to download updates from another CA User Activity Reporting Module subscription proxy switch to local configuration and add the desired CA User Activity Reporting Module proxy servers to the Subscription Proxy(s) for Client Updates list.

    This server contacts the specified proxy servers to download subscription updates, creating a tiered proxy structure.

  10. Click Save.

Download & Select Modules for Offline Subscription

Offline subscription update files are available at the CA Technologies offline subscription FTP site, packaged in .zip files. As new modules become available, they appear on the FTP site. Periodically monitor the list of available modules to be sure that you have downloaded the most recent updates. You can also check the CA Support Site at http://ca.com/support to learn when new Log Manager service packs and versions are available.

Before you can select modules to download for offline subscription proxies, download the offline update file package from the CA Technologies FTP site and manually copy it to your offline proxies. You can then select which modules to download and install. Offline subscription clients, by contrast, automatically receive all updates that are manually installed on their offline proxy, regardless of any modules selected for the client at the local level.

To download and select offline subscription modules

  1. On a system with Internet or FTP access, navigate to the FTP offline subscription site:

    ftp://ftp.ca.com/pub/elm/connectors/ftp/outgoing/pub/elm/ELM_Offline_Subscription

    The directory index displays a folder for each major CA User Activity Reporting Module release.

  2. Download the appropriate .zip file for the update you want to perform.

    Note: The folder for the CA User Activity Reporting Module r12.5 release contains a subfolder as well as a .zip file. The subfolder contains modules for upgrading from any previous version to version r12.5. The .zip file contains the modules for performing routine, periodic updates to version r12.5. If you are performing a routine update, select the .zip file.

  3. Using physical media such as a disk, or using scp, manually copy the .zip file to the following file path on your offline proxies:

    /opt/CA/LogManager/data/subscription/offline.

  4. Log in to a system in your CA User Activity Reporting Module environment.
  5. Click the Administration tab and the Services subtab.
  6. Expand Subscription Service and select an offline proxy server to configure.

    The Subscription Service Configuration for the selected CA User Activity Reporting Module server appears.

    Note: Offline subscription clients automatically receive all modules that are manually installed on their offline proxy. The contents of the proxy server control which updates the subscription client receives. Modules selected at the local level for an offline client have no effect.

  7. Click the Administration tab.
  8. In the File drop-down, select the offline update .zip file you copied to the server, and click Browse.

    The Modules Available for Download dialog appears.

  9. Select the modules you want to download.
  10. Click OK.

    The Modules Available for Download dialog closes, and the modules you selected appear in the Modules Selected for Download list.

  11. Click Save.

    Offline subscription clients can now download these modules automatically according to the subscription schedule you set, or on demand when you begin a manual update.

  12. (Optional) Click Update Now.

    The offline proxy server updates itself with the selected modules.

    Note: Though you can allow the offline proxy to update itself according to the subscription schedule you set, it is good practice to perform a manual update whenever you transfer new files. This practice ensures that the updates are available when offline subscription clients request them.

More information

About Modules to Download

How to Configure Subscription

About On-Demand Updates

An on-demand update is different from a scheduled update in that it is performed immediately and updates only the selected server. You can invoke an on-demand update for only one CA User Activity Reporting Module server at a time. Before you perform an on demand update on a subscription client, first update its proxy server.

Typically, scheduled updates keep all of your servers updated with the latest binary files and your management server updated with the latest configuration and content files. However, it is sometimes appropriate to invoke an off-schedule update to a single server.

Consider using on-demand updates in the following cases:

Start an On-Demand Update

You can update servers on demand using the Update Now function. When you update two or more servers in a series, be sure to verify that processing completes on one before beginning processing on the next. Review self-monitoring events for confirmation.

If you recently changed any subscription configurations, be sure to wait for the update interval (300 seconds by default) to elapse before running an on-demand update. CA User Activity Reporting Module generates a self-monitoring event after the update completes.

Note: If a scheduled update is currently in progress, clicking Update Now has no effect. If the start time for a scheduled update occurs while update now processing is in progress, the scheduled process does not run. When the on-demand processing completes, the scheduled update cycle resumes.

Important! If the modules to download contain Content updates, update the content proxy before performing any other on-demand update.

To update a server on demand

  1. Click the Administration tab and then click the Services subtab.
  2. Expand Subscription Service in the Service List
  3. Select the server that is the proxy for content updates and examine the modules selected for download. If they include Content updates, click Update Now.

    The server retrieves updates from the CA Technologies Subscription Server. As proxy for content updates, it pushes content updates to the content repository. As an online proxy, it downloads binary updates as well.

  4. Select the server to update and examine its role.
  5. If it is a subscription proxy for client updates, click Update Now.

    The server is updated with the modules selected for download.

  6. If it is a client with an online proxy, do the following:
    1. Identify a proxy for this client from the selected items on the Subscription Proxy for Client list.
    2. Select the proxy for the client and click Update Now.
    3. Select the client and click Update Now.

    The server is updated with the modules selected for download.

  7. If it is an offline subscription proxy, do the following:
    1. Download the offline update package from the CA Technologies offline subscription FTP site.
    2. Manually copy the updates to the download path of the offline proxy:

      .../data/subscription/offline

    3. Select the offline proxy, select the offline update .zip file, click Browse and select the desired modules.
    4. Click Update Now.

    The server is updated with the modules selected for download.

  8. If it is a client with an offline proxy, do the following:
    1. Update the offline proxy as described in step 7.
    2. Select the client and click Update Now.

    The server is updated with all modules installed to its offline proxy.

    Note: Offline subscription clients automatically receive all modules that are manually installed on their offline proxy. Modules selected at the local level for an offline client have no effect.

Free Disk Space for Updates

You can help ensure successful subscription updates on CA User Activity Reporting Module servers by regularly cleaning up the disk. If available disk space is less than 5 GB when the subscription update process begins, the Subscription Service issues a self-monitoring event and suspends the download process.

To ensure sufficient disk space for subscription updates

  1. Monitor available disk space on a regular basis. Alternatively, set up an action alert to notify you when available disk space drops below a specified amount.
  2. Free disk space with a disk cleanup tool.
  3. If you are warned of the need for cleanup with a self-monitoring event, free enough disk space to allow the download to succeed.

More information:

Example: Create an Action Alert for Low Disk Space

About Subscription Public Keys

The subscription proxy maintains a set of public keys corresponding to the private keys used by the CA Subscription server. The subscription proxy downloads subscription updates as a zip file that is digitally signed using a private key. The update identifies the public key to be used to check the signature of the update. Verifying the signature is how the subscription proxy ensures the update is from the CA Subscription server. There is only one public-private key pair used for a given subscription operation. A private key is used in signing the update; a public key is used for verifying the signature. The public key is stored at each CA User Activity Reporting Module server and can be updated.

CA User Activity Reporting Module stores the initial version of the public key in the Subscription Config file during installation. If a new private key is required, the associated public key is downloaded with the subscription update prior to the update cycle where the new key is needed.

Important! Do not manually update the Public Key field for subscription without explicit directions from CA Technical Support.

Self-Monitoring Events for Subscription

You can monitor the successes and failures of the subscription update processes that involve CA User Activity Reporting Module servers configured as the following:

Note: The events described here do not track subscription updates for agents.

Successes are reported for the following:

Failures and errors are reported for the following:

More information:

Example: Create an Alert for a Self-Monitoring Event

Monitor Subscription Events

You can monitor the successes and failures of the subscription update processes by viewing self-monitoring events for subscription.

To monitor subscription processing events

  1. Click the Administration tab and the Services subtab.
  2. Click Subscription Service in the Service List.
  3. Click the Self Monitoring Events tab for either the Subscription Service or for a host listed under Subscription Service.
  4. Review the displayed event details.

    Some of the fields displayed for self monitoring events reflect the CEG standard way of referring to common actions across vendors. The Ideal Model is based on this hierarchy: event_category, event_class (within the category), event_action (within the class), event_result, and event_severity. The CA Severity shown in this report is the CA interpretation of the severity.

    CA Severity

    The severity of the event, where

    • Unknown - Unknown events, events not mapped to CEG, or unclassified events
    • Information - General system operations information, security related information, or a notice
    • Warning - Unusual changes, a normal but significant condition, failed operations, or degraded performance
    • Minor Impact - Minor impact to a system, a function, or security
    • Major Impact - Major impact to a system, a function, or security
    • Critical - Immediate action is required; there is a likely security breach.
    Date

    When the event occurred.

    Receiver

    The component that failed to successfully complete the current process. This could be either a subscription proxy or a subscription client. If it is a subscription proxy, it could be the default proxy, an online proxy, or an offline proxy.

    Receiver Host

    The host name of the CA User Activity Reporting Module server that is the Receiver.

    Category

    The category of the event. Configuration Management is the event_category for subscription service events.

    User

    The username or identity that initiated the action expressed in the event information. This is the source_username field in CEG.

    Action

    The action that caused the event to be generated. This is the event_action field in CEG.

    Result

    S for Success; F for Failure. The result of the event action is the event_result field in CEG. Other actions are Accept, Reject, Drop, and Unknown.

    Result Description

    The message text. If the Result column displays Failure, view the Result Description text.

  5. View details in the Event Viewer. Here you can view changes such as those made to a configuration value such as update start time.

    Sample event details displayed in the event viewer.

View Subscription Event Details

After you configure subscription, you can view the self-monitoring events. After a subscription update, you can verify that the update to each server completed successfully. As upgrades complete, look for the following self-monitoring event messages on each affected server:

You can also view subscription self-monitoring events for troubleshooting purposes.

To view subscription event details in the event viewer

  1. Click the Administration tab and the Services subtab.
  2. Click Subscription Service in the Service List.
  3. Click the Self Monitoring Events tab for either the Subscription Service or for a host listed under Subscription Service.
  4. Examine the Result Description column. For example, this column can display events such as "Subscription client has no modules selected for getting updates."

    Suscription clielnt has not moduels selected.

  5. Double-click the result description for which you would like to review details.

    The event viewer opens.

  6. Scroll down to the results section and review the text displayed for result_string.

    The result string shows the event details.

Apply Subscription Updates to Agents and Connectors

Periodic updates, service packs, and point releases are all delivered by subscription. Often the modules to download include Agents and Integrations. When these modules are downloaded to a subscription client that manages agents, you must apply these updates to the agents after verifying that the subscription client that manages the agents has been successfully updated. Updates to agents must be applied before updates to connectors.

To upgrade CA User Activity Reporting Module agents with subscription updates

  1. If the upgrade includes the Agents module, update your agents by platform as follows:
    1. Click the Administration tab and click the Log Collection subtab.
    2. Determine whether to apply agent updates to all agents at once, a selected agent group, or an individual agent, depending on the level on which a single platform applies.
      • If all of your agents are installed on the same platform, select Agent Explorer and then click Subscription.
      • If your agent groups are composed of agents installed on the same platform, expand Agent Explorer, select an agent group, and then click Subscription.
      • Otherwise, expand Agent Explorer, expand an agent group, select an agent, and then click Subscription.

      The Subscription Wizard appears.

    3. If you selected Agent Explorer or an agent group, select Agent Updates, select the platform from the Platform drop-down list, click Search, and click the Version Selection Step.
    4. If you selected an agent, select Agent Updates and click the Version Selection step.
    5. Select the Update Version for each listed agent.
    6. Click Save and Close.
    7. Verify success. Click Status and Command. Click Configuration success. Note the version of the configuration that was applied.
    8. Repeat as needed to update all agents.
  2. If the upgrade includes the Integrations module, update connectors for your agents as follows:
    1. Click the Administration tab and click the Log Collection subtab.
    2. Determine whether to apply connector updates to all connectors on all agents at once, connectors on agents in a selected agent group, connectors on an individual agent.
    3. Select Agent Explorer, an agent group, or an agent. Then, click Subscription.
    4. Select Connector Updates on the Updates Selection List.
    5. Optionally, select a value from one or more of the following drop-down lists to change the default, All: Agent Group, Platform, Integration. Click Search.
    6. Click the Version Selection step.
    7. Click Select all to select all members of the list or select each row corresponding to a connector you want to update. For each selected row, select the update version to apply.
    8. Click Save and Close.
  3. Verify the updates. Run the Subscription Wizard again. Select the Version Selection step to view the current version and verify that it is the version you selected for update. Click Cancel.

More information:

How to Apply Subscription Updates

Open Updates List Wizard

Select Agents or Connectors for Update

Update Agent or Connector Integration Versions