Configuring EMC NetWorker KM for PATROL

This section describes the configuration operations that can be performed with EMC NetWorker KM.

Performing Post-Installation Operations

Once EMC NetWorker KM is installed, you will have to configure the EMC NetWorker KM Monitor Types through policies. Policies enable you to deploy configurations on PATROL Agents and monitoring solutions, such as EMC NetWorker KM in an automated way. Policies are designed to define and configure monitoring criteria and apply them to the specified PATROL Agents. The configuration criteria are automatically pushed to the PATROL Agents on which the policy is applied. When a monitoring policy is applied to a PATROL Agent, the device is automatically added to the list of monitored devices.

To create a monitoring policy:

  1. Log on to the TrueSight console.
  2. In the navigation pane, expand Configuration and select Infrastructure Policies.
  3. In the Infrastructure Policies page, ensure that the Monitoring tab is selected and click Create Policy.
  4. In the Create Monitoring Policy page, specify the monitoring policy properties:

Step 1 - Define the General Properties

Property Description
Name Name for the policy. The policy names must be unique. In an environment with tenants, the policy names must be unique for a single tenant. It is a mandatory field.
Description (Optional) A brief description about the policy.
Associated User Group Name of the user group that is associated with the PATROL Agents as defined in the Authorization Profile or in the PATROL Agent ACLs. The policy is applicable to these PATROL Agents.
Share with User Group Specify whether this policy is to be shared with the users across the associated user group or not. This property can be viewed in READ-ONLY mode by other users of the associated user group. Only the owner of the policy can modify this property.
Precedence Priority of the policy. Based on the precedence number that you configure, the configuration is applied to the PATROL Agents and the Infrastructure Management servers. The precedence number ranges from 0 to 999. A lower number indicates a higher precedence. The default value is 900. The configuration from a policy with a higher precedence overrides the configuration from a policy with a lower precedence. If two policies have the same precedence number, then the configuration from the latest created policy takes priority.
Enable Policy Indicates whether the policy is enabled or disabled. By default, the policy is disabled. If you do not enable a policy when you create it, the policy configurations are not applied to the PATROL Agents and the Infrastructure Management Servers. If you disable any existing policy, the policy configurations are removed from the PATROL Agents and the Infrastructure Management servers, where the policy was applied.

Step 2 - Select the PATROL Agents

Define conditions to select the PATROL Agents on which you want to apply the policy:

  1. Select a property.
  2. Select an operator to create the condition. The available operators depend on the property that you select.
  3. Specify a value for the selected property.
  4. (Optional) To add more than one condition, click the inline button, and perform the earlier steps.
  5. (Optional) To group the conditions, use the parentheses and Boolean operators from their corresponding lists.

The Add Monitor Types dialog box presents configuration fields for compatible BMC PATROL monitoring solutions that are located in the Central Monitoring Repository.

Step 3 - Select the Required Monitor Type

  1. Click the Monitoring tab.
  2. Click Add Monitoring Configuration.
  3. In the Add Monitoring Configuration dialog box, configure the properties:
  • From the Monitoring Solution menu, select EMC NetWorker KM.
  • From the Version menu, select the required version.

The Monitor Profile EMC NetWorker KM is automatically selected.

Selecting the Required Monitor Type

  • Refer to the table below to know which monitor types are available and their function:
Monitor Type Description
[EMC NetWorker KM] (REQUIRED) To set the general settings of the EMC NetWorker monitoring solution (credentials, debug mode, instances, multi-node mode, etc.). Once this monitor type is configured, all other monitor types are automatically monitored. Their default behavior can however be modified by selecting them from the Monitor Type list. No other monitor types can be configured as long as EMC NetWorker KM is not configured.
[NetWorker Client] To modify the clients default monitoring.
[NetWorker Daemon] To modify the daemons default monitoring.
[NetWorker Group] To modify the groups default monitoring and set backup restrictions.
[NetWorker Group Client] To modify the group clients default monitoring.
[NetWorker Jukebox To modify the jukeboxes default monitoring.
[NetWorker Jukebox Devices To modify the jukebox devices default monitoring.
[NetWorker Log] To modify the logs default monitoring and set the log scan limit.
[NetWorker Pending Request To modify the pending requests default monitoring and specify the date/time format to use in NetWorker pending request messages.
[NetWorker Save Group To modify the save groups default monitoring and set the monitoring duration for save groups in OK, Suspicious, and Failure status.
[NetWorker Standalone Device To modify the standalone devices default monitoring.
[NetWorker Storage Node To modify the storage nodes default monitoring.
[NetWorker Volume Pool] To modify the volume pools default monitoring.

Step 4 - Configure the Selected Monitor Type

  1. Depending on the selected Monitor Type, the available fields will vary. Refer to appropriate section to know how to configure them.
  2. Click Save to apply your changes to the selected PATROL Agent(s).

To edit a monitoring policy

  1. Log on to the TrueSight console.
  2. In the navigation pane, expand Configuration and select Infrastructure Policies.
  3. In the Infrastructure Policies page, locate the monitoring policy you wish to modify, click its action button inline and click Edit.
  4. In the Edit Monitoring Policy page, locate the monitoring configuration you wish to modify and click its action button inline to access the monitoring options panel.
  5. Customize the configuration.
  6. Click Save to apply your changes to the selected PATROL Agent(s).

Configuring EMC NetWorker Servers Settings

Before using EMC NetWorker KM, you need to configure the monitoring settings for the EMC NetWorker KM Monitor Type. You will then be able to create and customize other Monitor Types according to the component(s) you wish to monitor.

To specify the options that will constitute the EMC NetWorker monitoring settings:

  1. Create your monitoring policy.
  2. In the Add Monitoring Configuration dialog box, configure the properties:
    • From the Monitoring Solution menu, select EMC NetWorker KM
    • From the Version menu, select the required version

    The Monitor Profile EMC NetWorker KM is automatically selected.

  3. In the NetWorker Monitoring Settings section, click Add.
  4. Specify the settings for the NetWorker Host to be monitored:
    • In the Hostname/IP Address/FQDN field:
      • for a local host, enter localhost to apply these settings to all PATROL Agents installed on the NetWorker Servers
      • for a remote host, enter the hostname or IP address of the remote NetWorker Host to monitor it remotely from the PATROL Agent
    • (Optional - Remote Monitoring Only) Click the Create a Device in the Console box if you want the NetWorker server to appear as a separate device in TrueSight.

    Adding a NetWorker Host to the Monitoring Environment

  5. Set the NetWorker Credentials:
    • To use the default PATROL Agent Account, check the Use Agent Default Account option
    • To use a different user account, enter the login details in the Username and Password fields
    • (Unix Only) If the user account has sudo privileges, check the Use Sudo box and indicate the sudo binary file path (by default: /usr/local/bin/sudo)

    Configuring NetWorker User Account

  6. (Optional - Remote Monitoring Only) Set the Remote Connection Settings:

    Configuring the Remote Connection Settings

    • In the Connection Timeout (in Seconds) field, enter the number of seconds after which the connection to the remote node will time out
    • In the Maximum Connections field, enter the maximum number of simultaneous connections allowed to the remote node
  7. (Optional) Define the Advanced Settings:
  8. Click OK twice.

  9. Click Save.

Configuring Advanced Settings

Once the EMC NetWorker server to be monitored and the account to be used are specified, you can configure the following advanced settings:

Enabling the Debug

When you encounter an issue and wish to report it to Sentry Software, you will be asked to enable the Debug and provide the debug output to the Sentry Support team.

To enable the debug mode:

  1. Edit your monitoring policy.
  2. Click the action button inline of the EMC NetWorker system for which you wish to enable the Debug Mode and click Edit.
  3. In the NetWorker Monitoring Settings panel, scroll down to the Debug section.
  4. Select all the elements for which you want to obtain debug information.

    Configuring the Debug Mode Settings

  5. In the Options section, indicate:

    • when the system must stop logging debug information. The required format is: YYYY/MM/DD HH:MM:SS
    • where the debug file will be stored. The default path is: <PATROL_HOME>/lib/NSR/debug

    Setting the Debug End Time and Directory Path

  6. Click OK to validate.

When the debug end time is reached, a tar/zip file is automatically created under <PATROL_HOME>/lib/NSR/ and can be sent to the Sentry Support team for help. It is also recommended to check the NSR_<port>.log file, stored in <PATROL_HOME>/log, for any error.

Configuring the Maximum Number of Instances

By default, the solution discovers and monitors all the instances. Because there may be a very large number of instances to monitor and this may represent a important workload to the agents and the TrueSight servers, it is recommended to only monitor the critical ones. This can be done by configuring the instance limits.

To configure the maximum number of instances:

  1. Edit your monitoring policy.
  2. Click the action button inline of the NetWorker server for which you wish to configure the maximum number of instances and click Edit.
  3. In the NetWorker Monitoring Settings panel, scroll down to the Maximum Number of Instances section.
  4. For each monitored element, indicate the maximum number of instances to be displayed, or enter 0 (zero) in the relevant field to disable the monitoring of a specific element. (By default, the maximum number of instances is left empty to allow an unlimited number of instances).

    Configuring the Maximum Number of Instances

  5. Click OK twice.

  6. Click Save.

Configuring the Multi-Node Monitoring Mode

When an application is installed in a cluster environment, i.e. active on one cluster node and passive on others, false alarms and duplicate alerts may occur. To avoid such situation, users need to configure EMC NetWorker KM in multi-node monitoring mode, if NetWorker is installed in a supported cluster.

Note: The procedure below is generic. To learn more about all the configuration methods available, see Configuring the Multi-node Monitoring Mode with the VCS KM. Although the article refers to Veritas Cluster Server KM for PATROL, the monitoring concepts and principles remain valid for EMC NetWorker KM.

To configure the multi-node monitoring mode:

  1. Edit your monitoring policy.
  2. Click the action button inline of the NetWorker server for which you wish to configure the multi-node monitoring mode and click Edit.
  3. In the NetWorker Monitoring Settings panel, scroll down to the Multi-node Monitoring Mode section.

    Configuring the Multi-Node Mode

  4. Check the Enable Multi-node Monitoring Mode option.

  5. Configure the Multi-node Mode:
    • Select the appropriate Cluster Application
    • Indicate the Failover Group Name. Leave this field blank if you have previously selected Veritas Cluster File System. The EMC NetWorker KM will then monitor the NetWorker system from the active master system, which is identified by vxdctl -c mode command. This method requires vxconfigd in enable mode with its clustered state active.
  6. (Optional) Check the Enable Remote PATROL Agent Checking option to allow the solution to check the monitoring mode of the remote PATROL Agents. If the Remote PATROL Agent Checking is disabled, the solution will monitor actively through active cluster node or on the node where failover group is online and will not check the monitoring status of the EMC NetWorker KM on the other PATROL Agent nodes.
  7. In the Monitoring Nodes section:
    • Click Add to configure the details of all managed nodes of the cluster to be configured in the multi-node mode

    Identifying the Node to Monitor

    • Provide the PATROL Agent Hostname (host where the PATROL agent is installed), the Node ID (the unique ID of the NetWorker node derived from the hostname in the NetWorker Server configuration), and Cluster Node Name (the hostname defined in the selected Cluster Application)
    • Click OK
    • Repeat the procedure for each NetWorker node that is part of the multi-node mode configuration
  8. If the Enable Remote PATROL Agent Checking option is selected, click Add in the Remote Agent Configuration section, to provide all the information required to communicate with the PATROL Agents. There should be one entry per each PATROL Agent.

    Configuring the Remote Agent Communication Settings

    • Provide the PATROL Agent Hostname
    • Select the Protocol you wish to use to connect to the PATROL Agent
    • Enter the Port number you wish to use to connect to the PATROL Agent
    • Provide the Username and Password you wish to use to connect to the PATROL Agent
    • In the Number of Attempts field, specify the number of times the solution will try to communicate with the remote PATROL Agent before failing over
    • Enter the timeout you wish to set, in seconds, between each attempt
  9. Click OK twice.

  10. Click Save.

The NetWorker server will then be monitored through the master or online node in Active Multi-node Mode. The other nodes, which are standing by for a failover, will be in Passive Multi-node Mode, monitoring only the components that are not visible from the active node.

If a managed node is unable to check the monitoring status of the active managed node, it will change to Temporary Single-node Mode allowing a full NetWorker monitoring. It will remain in Temporary Single-node Mode until it finds the active node in full monitoring mode again.

If the Remote PATROL Agent Checking is Disabled, while there are more than one PATROL Agent involved, the managed node on the master or online node will be in Active Multi-node Mode and all others will be in Passive Multi-node Mode, without checking the monitoring status of the active node. In addition, the above procedure to configure Multi-node Mode needs to be repeated from each PATROL Agent involved.

Configuring the NetWorker Server Discovery Overrides (Optional)

The solution automatically discovers the NetWorker installation, the temporary directory paths used by the EMC NetWorker KM, and the node status. This information can however be overridden.

Warning! Altering these paths may impact the operation of the EMC NetWorker KM.

To configure NetWorker server discovery overrides:

  1. Edit your monitoring policy.
  2. Click the action button inline of the NetWorker server for which you wish to configure the discovery overrides and click Edit.
  3. In the NetWorker Monitoring Settings panel, scroll down to the Discovery Overrides section.

    Configuring NetWorker Discovery Overrides

  4. Specify the NetWorker Server Discovery Overrides options:

    • NetWorker Installation Path: Provide the path to the directory where the NetWorker software is installed. By default, EMC NetWorker KM automatically locates the NetWorker software installation directory if you have installed the solution with the default recommended settings. If you have chosen to install the solution in a custom directory, you are required to provide its location.
    • Remote Temp Directory Path: Provide the path to the directory where the temporary files are saved on remote nodes. Default is /var/tmp (on UNIX/Linux) or C:\Windows\Temp (on Windows).
    • Local Temp Directory Path: Provide the path to the directory where the temporary files are saved on the PATROL Agent node (Default is <PATROL_HOME>/lib/NSR/tmp where PATROL_HOME is the PATROL Agent installation path)
    • Node Type: Select the appropriate node type: media or master server. By default, EMC NetWorker KM automatically discovers the type of node when the type is not user-specified.
    • Node Status Daemons: Specify the critical NetWorker node daemons in order to detect the node status. Daemon names must be comma-delimited. By default, daemons are automatically selected according on the node type.
  5. Click OK twice.
  6. Click Save.

4. Configuring Other Monitor Types

By default, the solution monitors all the elements discovered, which may represent an important workload to the agents and the TrueSight OM servers. Because the monitoring of some elements may be irrelevant for various reasons, you can apply filters to indicate which elements will be monitored or not.

Filtering options are available for the following monitor types: NetWorker Client, NetWorker Daemon, NetWorker Group, NetWorker Group Client, NetWorker Jukebox, NetWorker Jukebox Device, NetWorker Log, NetWorker Standalone Device, NetWorker Storage Node and NetWorker Volume Pool.

To configure elements to be monitored:

  1. Edit your monitoring policy.
  2. Select the Monitor Type for which you wish to apply filters.
  3. In the Monitor panel, click Add.
  4. In the Hostname field, enter:
    • localhost to apply these settings to all PATROL Agents installed on NetWorker Servers
    • a hostname or IP address to apply these settings to a specific server.
  5. Configure the Filtering options:

    • In the Keep Only… section, click Add and identify the element you wish to monitor. Enter the name of the element or identify it by using a regular expression (example: prod-client*). Click OK to validate. Repeat the operation for any other element you wish to include in the monitoring process.
    • In the Exclude… section, click Add and identify the element you do not want to monitor. Enter the name of the element or identify it by using a regular expression (example: test-client*). Click OK to validate. Repeat the operation for any other element you wish to exclude from the monitoring process.
  6. The Additional <Elements>(manual discovery) section allows you to add elements manually, when they are not automatically discovered:

    • Click Add and enter the name of the element you wish to add to the monitoring environment. Click OK to validate. Repeat the operation for each element you want to monitor.
    • (Optional) Enter a short description that will allow you to quickly identify the added element.
  7. Click OK to validate.

Configuring Logs

By default, EMC NetWorker KM monitors the Daily Messages Log found under the NetWorker Log Path and the UNIX/Linux System Log files. A log filter is configured by default for these log files to ensure warnings or alarms are triggered when a specific error message is found. This default configuration can however be modified in TrueSight if you need to monitor:

Configuring the Log Scan Limit

EMC NetWorker KM scans log files by reading the new log entries since the last data collection cycle. By default, only 500 KBytes of data is scanned for each log file during each data collection cycle. This log scan limit can however be modified to better suit your requirements.

Warning! Increasing the Log Scan Limit may impact the performance of the data collector (NSRLogCollector), the monitoring solution, and the PATROL Agent.

To customize the log scan limit:

  1. From the Add Monitoring Configuration panel, select NetWorker Log from the Monitor Type list.
  2. In the NetWorker Log Settings panel, click Add.

    Customizing the Log Scan Limit

  3. In the Hostname field, enter:

    • localhost to apply these settings to all PATROL Agents installed on the NetWorker server
    • a hostname or IP address to apply these settings to a specific server
  4. In the Scan Limit (in KBytes) field, indicate the amount of data (in KBytes) that will be read by the monitoring solution during each data collection cycle.
  5. Click OK twice.
  6. Click Save.

Configuring Event Log Query Limit

By default, EMC NetWorker KM limits the time allocated to execute event queries to 300 minutes during each data collection cycle. This limit can however be modified to better suit your requirements.

Warning! Increasing the Raw Log or Event Log Query Limit may impact the performance of the data collector (NSRLogCollector), the KM, and the PATROL Agent.

To customize the log query limit:

  1. From the Add Monitoring Configuration panel, select NetWorker Log from the Monitor Type list.
  2. In the NetWorker Log Settings panel, click Add.

    Customizing the Query Limit

  3. In the Hostname field, enter:

    • localhost to apply these settings to all PATROL Agents installed on the NetWorker server
    • a hostname or IP address to apply these settings to a specific server
  4. In the Query Limit (in minutes) field, indicate the time (in minutes) you wish to allocate for executing event log queries during each data collection cycle.
  5. Click OK twice.
  6. Click Save.

Customizing the Log Filter

By default, EMC NetWorker KM only monitors the daily NetWorker messages file and the system log file. A log filter is configured by default to ensure warnings or alarms are triggered when a specific error message is found. You can however customize this default log filter to monitor any other error message in the NetWorker daily log or any other log files.

To customize the log filter:

  1. From the Add Monitoring Configuration panel, select NetWorker Log from the Monitor Type list.
  2. In the NetWorker Log Settings panel, click Add.
  3. In the Log Filter section, configure the conditions that will trigger a warning and/or an alarm:

    Customizing the Log Filter

    • In the Warnings section:
      • Click Add
      • Select the type of regular expression. Include will select all matching lines; Exclude will remove all matching lines
      • In the Regular Expression field, enter the expression that will trigger a warning
      • Provide your warning filter with an Internal ID
      • Click OK to validate.

    Expressions to Generate a Warning

    • In the Alarms section
      • Click Add
      • Select the type of regular expression. Include will select all matching lines; Exclude will remove all matching lines
      • In the Regular Expression field, enter the expression that will trigger an alarm
      • Provide your alarm filter with an Internal ID
      • Click OK to validate

    Expressions to Generate an Alarm

  4. Click OK twice.
  5. Click Save.

Configuring Custom NetWorker Logs Monitoring

To override the default configuration and add additional log files, you will have to configure the custom NetWorker Logs monitoring as follows:

  1. From the Add Monitoring Configuration panel, select NetWorker Log from the Monitor Type list.
  2. In the NetWorker Log Settings panel, click Add.
  3. In the Custom NetWorker Logs section, click Add.

    Configuring Custom NetWorker Logs

  4. In the Filename (Full Path) field, enter the full path to the NetWorker Log file to be monitored using backslash (/) as the file path separator (example:\var\adm\messages). For Windows events, prefix the filename with Events - (example: Events - Systems).

  5. (Optional) Enter a brief description of the NetWorker log.
  6. Click OK.
  7. Customize the log filter to indicate the regular expressions that will generate a warning and/or an alarm when found in the custom NetWorker log.
  8. Click OK twice.
  9. Click Save.

Configuring NetWorker Pending Requests

By default, EMC NetWorker KM monitors all mount requests for 24 hours. This monitoring duration can however be modified to better suit your requirements.

Warning! Increasing the monitoring duration may affect the performance of the application.

To configure NetWorker pending requests:

  1. From the Add Monitoring Configuration panel, select NetWorker Pending Request from the Monitor Type list.
  2. In the NetWorker Pending Request panel, click Add.

    Configuring NetWorker Pending Request

  3. In the Hostname field, enter:

    • localhost to apply these settings to all PATROL Agents installed on NetWorker servers
    • a hostname or IP address to apply these settings to a specific server
  4. In the Pending Request Configuration section, indicate how many hours the pending requests will be monitored

  5. If the date/time format returned by EMC NetWorker commands is different from your local system time zone, you will have to configure it in the Date/Time Format Configuration section:

    • In the Expected Format field, provide a valid format as detailed in the table below:
    Format Description
    ————————– ————————————————————————————————————-
    Default Date/Time Format Leave blank.
    EPOCH Set EPOCH, if the time format is the number of seconds that have elapsed since 00:00:00 GMT January 1, 1970
    Year Formats
    YY Two digit figure (Example: 12 for the year 2012)
    YYYY Four digit figure (Example: 2012)
    Month Formats
    MO Two digit figure (Example: 02 for February)
    MONTH Month full name (Example: February)
    MON Three character name (Example: Feb)
    Date Formats
    DD Two digit figure (Example: 05)
    Day Formats
    DAYFULL Day full name (Example: Friday)
    DAY Three character name (Example: Fri)
    Hour Formats
    HH Two digit figure
    Minute Formats
    MM Two digit figure
    Second Formats
    SS Two digit figure
    Time Formats
    [blank] Time is in 24-hour format
    PM Time is in 12-hour format; am/pm is displayed (Example: 10:15:00pm)
    P.M Time is in 12-hour format; a.m/p.m is displayed (Example: 10:15:00p.m)
    • In the Time Zone String field, provide a PSL-compatible time zone (e.g.: NZDT, NZST, EDT, EST, GMT-1200, etc.).
  6. Click OK to validate.

Configuring NetWorker Save Groups

By default, EMC NetWorker KM monitors all save groups that completed successfully for 24 hours and any other save groups for 72 hours. This monitoring duration can however be modified to better suit your requirements.

Warning! Increasing the monitoring duration may affect the performance of the application.

To configure NetWorker save groups:

  1. From the Add Monitoring Configuration panel, select NetWorker Save Group from the Monitor Type list.
  2. In the NetWorker Save Group panel, click Add.

    Configuring  NetWorker Save Group

  3. In the Hostname field, enter:
    • localhost to apply these settings to all PATROL Agents installed on NetWorker servers
    • a hostname or IP address to apply these settings to a specific server
  4. In the Monitoring Duration section:
    • indicate how many hours the save groups in OK, Suspicious, and Failure status will be monitored
    • Select Keep Monitoring Active Save Groups Indefinitely if you prefer to endlessly monitor active save groups
  5. If the Monitored Save Sets field, select the proper level of monitoring:
    • None: to disable the save clients monitoring feature
    • Failed Only (default): to only monitor failed save groups
    • Succeed Only: to only monitor successful save groups
    • All: to monitor all the save groups
  6. Click OK to validate.

Blocking the Monitoring of Hosts

The server owner/administrator may want to stop the monitoring of a remote NetWorker server when performing maintenance work on this server. The monitoring can be blocked from the relevant NetWorker server and will not require making any change from the monitoring PATROL Agent system(s). The administrator will just have to create a file named NSR_block under the Remote Temp Directory Path. By default, this path is set to /var/tmp (on UNIX/Linux) or C:\Windows\Temp (on Windows).

The PATROL Agent monitoring this NetWorker server will detect the block file during the next discovery cycle and turn the node instance to EMC NetWorker Setup: (Monitoring Blocked).

To resume monitoring, simply delete the NSR_block file.

Keywords:
storage networker km patrol