-
Home
- Monitoring Studio Web Interface
Configure IBM Spectrum Protect KM
This section explains the settings required to configure IBM Spectrum Protect KM via the Monitoring Studio X Web interface.
Configuring Spectrum Protect Nodes Monitoring
IBM Spectrum Protect KM allows you to monitor several Spectrum Protect servers and storage nodes with one PATROL Agent.
To add a new node to your monitoring environment
- Access the Monitoring Studio X Web Interface.
- Click KMs > IBM Spectrum Protect.
- Click the New Node… button.
Identify the Node
Provide the following information to identify the Spectrum Protect Server/Storage Node:
| Property | Description |
|---|---|
| Server ID | Instance ID of the Spectrum Protect server to be monitored. This is used as the Internal ID to store the node configuration in the PATROL Agent configuration. |
| Hostname or IP Address | Enter the hostname or IP address of the Spectrum Protect Server/Storage Agent to be monitored. For a local host, you may enter localhost. |
| System Type | Specify whether the Spectrum Protect server is a UNIX/Linux or Windows system. |
| Enable Monitoring | Set to ON by default. Turn this property OFF to disable the monitoring of the node. |
| Create a Separate Device in TrueSight | Set to ON by default. Turn this property OFF if you do not want the Spectrum Protect node to appear as a separate device in TrueSight. |
Configure the KM User Accounts
An operating system user account with administrative privileges must be configured to read and execute IBM Spectrum Protect application programs and access file systems. Enter the Username and Password required to execute Spectrum Protect commands on the Spectrum Protect node. For SSH authentication, you can specify the path to a Private Key File on the PATROL Agent corresponding to the specified username and password. The passphrase should be entered in the password field.
Spectrum Protect commands can be executed as a sudo user on UNIX/Linux systems. To do so, turn the Use Sudo option ON and provide the full path of the Sudo Binary File.
Enter a valid Spectrum Protect Admin Client User ID and Password and indicate the DSM_CONFIG file (or opt file) path on the PATROL Agent system. The KM will automatically detect the default file, if it is left blank.
Node Status Monitoring
The Node Status parameter is set depending on the regular expressions defined in the NODE STATUS FILTERING…. Click on this button to change the default filter. These regular expressions will be used on the result returned by the DSMADMC command query status run on the Spectrum Protect server.
Monitored Components
All Spectrum Protect components are monitored, except for Clients, Domain Clients, Mount Requests and Manual Drives, which are disabled by default. Because there may be a very large number of instances to monitor that may represent an important workload to the agents and Monitoring Studio X, it is recommended to only monitor the critical ones. You can customize the monitoring of any component to better suit your requirements.
To configure the monitored components:
- Use the ON/OFF button to activate or deactivate the monitoring of any component in the list.
- Click on the relevant STATUS MAPPING… button to customize the status mapping for any status parameter available for that component.
- By default, alerts will automatically be acknowledged unless you modified the settings to allow manual acknowledgement. Click the AUTOMATIC button to switch to the MANUAL mode.
- The Job Monitoring properties can be fine-tuned by configuring the following properties:
| Properties | Description |
|---|---|
| Monitor Job Actions | Indicate the job actions to be monitored in a comma-separated list. These actions should match values selected in the client_schedules. Include ADMINISTRATIVE to monitor admin_schedules. Leave this field blank to use the default configuration or type [ALL] to monitor all jobs. |
| Job Instance Label Format | Enter the job instance label format to be used on the console. The keywords <domain>, <node>, <schedule>, <action> and <start-time> are supported. Leave this field blank to reset to the default configuration. |
| Monitoring Duration for OK Status Jobs | Enter the number of hours/days a job with an OK status will be monitored and enter the monitoring duration in hours/days. By default, this option is disabled (OFF). |
| Monitoring Duration for Suspicious Status Jobs | Enter the number of hours/days a job with a Suspicious status will be monitored. Turn this option OFF to disable the monitoring of jobs in suspicious status. By default, this option is enabled (ON). |
| Monitoring Duration for Failure Status Jobs | Enter the number of hours/days a job with a Failure status will be monitored. Turn this option OFF to disable the monitoring of jobs in failed status. By default, this option is enabled (ON). |
| Keep Monitoring Active Jobs Indefinitely | Turn ON to endlessly monitor active jobs. |
| Ignore Inactive Jobs Initially | Turn ON if you do not want the inactive jobs to be created during the initial discovery cycle. Initially discovering and monitoring inactive jobs may have impact on performance. |
| Collect Job Logs | Turn ON to collect job logs in TSMJobText parameter. |
| Collect Last Backup Information | Turn ON to collect the last backup related information under Domain and Domain Client instances. |
By default, only the Failure and Suspicious status of the Job Actions highlighted below are monitored:
INCREMENTAL,SELECTIVE,ARCHIVE,RESTORE,RETRIEVE,BACKUP,IMAGEBACKUP,IMAGERESTORE,COMMAND,MACRO,ADMINISTRATIVE
Similarly, the Retention Period for Mount Request Monitoring and Process Monitoring can be changed from the default settings. The Process Instance Label Format can be changed using the keywords <process-name>, <process-number> and <start-time>.
Configure Advanced Settings (Optional)
Monitoring Mode
By default, IBM Spectrum Protect KM is configured to operate in Single-node Mode. 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 a situation, you need to switch to Multi-node Mode, if you monitor IBM Spectrum Protect KM from cluster nodes.
-
Click the Single-node Mode button to switch to Multi-node Mode
-
Select the appropriate Cluster Application and provide the Failover Group Name which is online on one cluster node and offline on the others. Leave this field blank if you previously selected Veritas Cluster File System. The IBM Spectrum Protect KM will then monitor the entire cluster from the active system, which is identified by the
vxdctl -c modecommand. This method requiresvxconfigdin enable mode with its clustered state active -
Click the ADD NODE button to individually add the nodes you wish to monitor. Provide the following information:
- PATROL Agent Hostname: the host from where this node is monitored
- Server ID: the Spectrum Protect server instance ID
- Cluster Node Name: the hostname defined in the selected Cluster Application.
Click the Multi-node Mode button to switch back to Single-node Mode.
Spectrum Protect Discovery
IBM Spectrum Protect KM automatically discovers the application paths and the node type and the default values are set to comply with most of Spectrum Protect systems. However, you can customize these settings to better suit your requirements. Note that modifying discovery configurations should be used with caution as it affects the monitoring functionality.
To configure the Spectrum Protect Discovery settings, click the Automatic button to turn on the Custom mode and provide the following information:
- Spectrum Protect Installation Path: Provide the path to the directory where the Spectrum Protect software is installed. By default, IBM Spectrum Protect KM automatically locates the Spectrum Protect 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.
- Node Type: Select the appropriate node type: server or storage agent. By default, IBM Spectrum Protect KM automatically discovers the type of node, i.e. set to Autodetect.
- Admin Client Resource Files Directory Path (DSM_DIR): Provide the path to Spectrum Protect Administrative Client resource directory path. Leave this blank to use the default path.
- Admin Client Error Log Directory Path (DSM_LOG): Provide the path to Spectrum Protect Administrative Client log directory path. Leave this blank to use the default path, which is the temporary directory path on the PATROL Agent.
Click the CUSTOM button to switch back to AUTOMATIC mode and discard all custom settings.
Remote Connection settings
When you configure the monitoring of a remote host, you may want to specify the time after which the connection to the remote node will time out or the maximum number of simultaneous connections allowed to the remote node:
- In the Connection Timeout 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.
Important: Changing the values for these properties may impact the performance of your monitoring environment.
Spectrum Protect KM Temp Paths
The default Spectrum Protect KM temporary directory paths can be manually specified to better suit your requirements.
Click the DEFAULT button to switch to the CUSTOM mode and provide the following information:
- 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/TSM/tmpwhere<PATROL_HOME>is the PATROL Agent installation path)
Click the CUSTOM button to switch back to the DEFAULT mode and reset all paths to their default settings.
KM Settings
The KM Settings page enables you to define the configuration mode, Spectrum Protect Admin Client binary path and the Java Settings for IBM Spectrum Protect KM for PATROL.
Configuration Mode
IBM Spectrum Protect KM can be used with the Monitoring Studio Web interface. If the configuration is deployed using a BMC Helix/TrueSight Operations Management CMA policy, the KM will run in CMA Mode. In this mode, only the Status Mappings, Debug Settings and Java Settings can be changed via the Monitoring Studio Web interface. To allow full configuration from the Web interface, turn the Force Classic Configuration Mode option ON. This will force the KM to run in Classic Mode, ignoring any IBM Spectrum Protect KM configuration deployed from the CMA policy.
Admin Client
By default, the KM will detect the Spectrum Protect Admin Client binary file path (dsmadmc) on the PATROL Agent node, which is a prerequisite for the KM. If the software is installed under a custom path, the correct path to the Admin Client binary can be entered here.
Java Settings
To operate properly, IBM Spectrum Protect KM requires that Java 1.8.00 or higher and a Java Runtime Environment (JRE) are installed on the same system that runs the PATROL Agent.
The Java Settings page displays information about the JRE currently in use and a list of all the JREs installed on the monitored system. You can also configure the following options to fine-tune the Java properties:
| Options | Description |
|---|---|
| Automatically Select Appropriate JRE | To let IBM Spectrum Protect KM automatically find and use the most compatible JRE upon the initial discovery that occurs when the PATROL Agent and IBM Spectrum Protect KM start. |
| Execute the JVM as an Alternate User | By default, the Java process is launched with the same credentials as the PATROL Agent. If the PATROL Agent's default account does not have sufficient privileges to perform the operations required by the Java Collection Hub, another user account can be provided. |
| Java Minimum Heap Size | To customize the minimum size (in MB) of the Java Hub Heap Memory according to your environment requirements. By default, the minimum size is set to 128 MB. |
| Java Maximum Heap Size | To customize the maximum size (in MB) of the Java Hub Heap Memory according to your environment requirements. By default, the maximum size is set to 512 MB. |
| Disable JRE Pre-Validation | By default, IBM Spectrum Protect KM checks that the selected JRE meets the requirements. However, you can disable this option to bypass the compatibility check. Use this option only if you are certain that the provided JRE is compatible even if the compatibility check fails. An unsuitable JRE will prevent IBM Spectrum Protect KM to operate properly. |
| JVM Arguments | To provide arbitrary arguments to the java -jar … command line that IBM Spectrum Protect KM uses to launch the Java Collection Hub in the Command line options field. |
The JVM needs to be restarted for your new settings to be taken in account.
Download.CFG
You can export IBM Spectrum Protect KM configuration as a pconfig file (.CFG) that can be imported into a TrueSight/Helix CMA policy. All the Agents using the policy will therefore be able to monitor the same Spectrum Protect nodes.
Reinitializing IBM Spectrum Protect KM
Refer to the Troubleshooting section for details.