Module Management

The PrimeAlert WebPortal's Module Management functions allow modules to be loaded, unloaded, edited, enabled and disabled on any number of different hosts at once. In addition, multiple modules can be unloaded, enabled and disabled on multiple hosts. This document describes how to use these features.

Loading Modules

Modules can be loaded using the Module Loader window. This window can be launched from the Modules button on the Host Bar, or by selecting Load Module... from the Domain View's Context Popup Menus.

This window will first present a list of all modules installed on the host and the number of instances loaded, as shown below:

Figure 36 - The Module Loader's Module List

Select one of the modules in the list and click Continue to continue loading the selected module. Only one module may be loaded at a time.

Next, the module loader presents a form containing the module's parameters. A sample module parameter form is shown below:

Figure 37 - The Module Loader's Module Parameter Form

Parameters that can be used to customize the module can be specified here. These parameters are usually specific to the module. See the module's documentation for a description of the parameters.

The Apply To section can be used to load the module on additional hosts by specifying a list of host names in the Additional Hosts textfield, separated by spaces or commas. Also, the module may also be loaded on all hosts in a domain by selecting a domain from the picklist.

TIP: If any of the hosts specified in the Additional Hosts textfield are not using the default SNMP port (161), add the text ":<port>" after the hostname, where <port> is the port number of the agent on the host.

After the module parameter form is complete and any additional hosts have been specified, click the Apply button to load the module on all specified hosts. When the module loading is complete, a Module Loading Report will be presented, as shown below:

Figure 38 - The Module Loading Report

The first table lists all of the module parameters and their values. The second table lists all hosts where the module was loaded, and indicates if the module load request was successful or if it failed. If the attempt failed, a reason will be shown.

TIP: To navigate directly to the newly loaded module, or to the host where the module load attempt failed, click on the link in the Result column of the table.

Editing Modules

Some modules allow some of their parameters to be edited after the module has been loaded. This can be done using the Module Editor.

The Module Editor is launched directly from the module by selecting Edit Module... in the Host View's Context Popup Menu.

The Module Editor has a Module Parameter Form that appears similar to the Module Loader. It contains the values already specified for the module. Any editable parameters can be modified. The changes can also be applied to the same module on other hosts by using the Apply To section.

After modifying the module parameters and specifying any additional hosts, click the Apply button to edit the module. After the module editing is complete, a Module Editing Report will be presented. This report is similar to the Module Loading Report.

Unloading Modules

A single module can be unloaded by selecting Unload Module in the Host View's Context Popup Menu.

One or more modules can be unloaded in a single step on multiple hosts by launching the Module Unloader. This can be launched either by selecting the Modules button on the Host Bar, or by selecting Unload Modules... from the Domain View's Context Popup Menus.

A typical Module Unloader window is shown below:

Figure 39 - The Module Unloader

A list of all modules loaded on the agent is shown. One more modules can be selected for unloading. Selected modules can be unloaded on additional hosts using the Apply To section. A list of additional hosts can be specified by typing the host names in the Additional Hosts textfield, separated by spaces or commas. Also, a picklist of the server's Domains can be used to unload the modules on all hosts in the selected domain.

TIP: If any of the hosts specified in the Additional Hosts textfield are not using the default SNMP port (161), add the text ":<port>" after the hostname, where <port> is the port number of the agent on the host.

After the modules to be unloaded are selected, and any additional hosts are specified, click the Apply button to start unloading the modules. Once the unloading is complete, a Module Unloading Report will be presented. A sample report is shown below:

Figure 40 - The Module Unloading Report

The table lists each module that was unloaded on each host, and whether the unloading was successful or if it failed. If the unload failed, a reason will be specified.

TIP: To navigate directly to the host where the module was unloaded, or to the module that could not be unloaded, click on the link in the Result column of the table.

Disabling Modules

A module is enabled when it actively accumulates data and issues alarms. Modules can be disabled to temporarily stop data accumulation and to suppress alarms. This can be done at regular times by setting the Module Schedule, or can be done manually as described below.

A single module can be disabled by selecting Disable Module in the Host View's Context Popup Menu.

One or more modules can be disabled in a single step on multiple hosts by launching the Module Disable Manager. This can be launched either by selecting the Modules button on the Host Bar, or by selecting Disable Modules... from the Domain View's Context Popup Menus.

The Module Disable Manager appears similar to the Module Unloader, and works in the same manner, in that multiple modules on multiple hosts can be disabled in a single step.

A list of all modules loaded on the agent is shown. One more modules can be selected for disabling. Also, the selected modules can be disabled on additional hosts using the Apply To section.

After the modules to be disabled are selected, and any additional hosts are specified, click the Apply button to start disabling the modules. Once the disabling is complete, a Module Disabling Report will be presented. This report is similar to the Module Unloading Report.

Enabling Modules

A disabled module can be re-enabled to resume data accumulation and issuing alarms. This can be done on a single module by selecting Enable Module in the Host View's Context Popup Menu.

One or more modules can be enabled in a single step on multiple hosts by launching the Module Enable Manager. This can be launched either by selecting the Modules button on the Host Bar, or by selecting Enable Modules... from the Domain View's Context Popup Menus.

The Module Enable Manager appears similar to the Module Unloader, and works in the same manner, in that multiple modules on multiple hosts can be enabled in a single step.

A list of all modules loaded on the agent is shown. One more modules can be selected for enabling. Also, the selected modules can be enabled on additional hosts using the Apply To section.

After the modules to be enabled are selected, and any additional hosts are specified, click the Apply button to start enabling the modules. Once the enabling is complete, a Module Enabling Report will be presented. This report is similar to the Module Unloading Report.