Using UPS with a Serial Port

For general information about Uninterruptible Power Supplies, see Uninterruptible Power Supply (UPS).

Use ups_aio.nlm when you use a serial port to monitor an uninterruptible power supply.

The UPS_AIO module for the serial port does not allow you to change parameter settings after loading the module. You must specify the parameter settings you need when you load the module. If you want to change the settings, reload the module with the new parameter values.

To display a help screen that explains the parameters, enter the following command:

UPS_AIO ?

The UPS_AIO command with the ? parameter displays a help screen, but does not load the UPS_AIO module.

You do not need to enter any parameters if the default values are acceptable. Before loading UPS_AIO, review the following table to determine the parameters you might want to enter.

Table 1. Parameter values for UPS_AIO

Parameter Use to
path

Specify the path to UPS_AIO only if you moved it from the default directory (sys:system) and if there is no server search path to the directory where the file is located.

DOWNTIME=number

Specify the amount of time to run on battery before system shutdown. If power is restored before this time elapses, no shutdown will occur. If a low battery condition occurs before this time elapses, an immediate shutdown will occur.
Supported values: 30 seconds minimum, no practical maximum limit
Default: 300 seconds

MSGDELAY=number

Specify the elapsed time before a broadcast message is sent to all clients logged into the server.
Supported values: 0 seconds minimum, no practical maximum limit
Default: 5 seconds
The broadcast message states the time remaining until shutdown.

MSGINTERVAL=number

Specify the time interval between broadcast messages sent to users. The message is repeated at this interval.
Supported values: 20 seconds minimum, no practical maximum limit
Default: 30 seconds
The broadcast message states the time remaining until shutdown.

DRIVERTYPE=number

Specify the AIO device driver type.
Supported values: 1, 2, 3
Default: 1
The default value of 1 represents the AIOCOMX driver, which is included with NetWare. Other drivers might be represented by other numbers. Refer to the documentation that came with the driver.

BOARD=number

Specify the AIO board number.
Supported values: Determined by the driver manufacturer
Default: 0
To determine the board number, read the driver information when the AIOCOMX driver is loaded. The information includes both the board and port numbers.
If you do not use the AIOCOMX driver, refer to the driver documentation to determine the board number.

PORT=number

Specify the port number.
Supported values: Determined by the driver manufacturer
Default: 0
To determine the port number, read the driver information when the AIOCOMX driver is loaded. The information includes both the port and board numbers.
If you do not use the AIOCOMX driver, refer to the driver documentation to determine the port number.

SIGNAL_HIGH

Set the normal RS-232 signaling state to high.
Supported values: SIGNAL_HIGH or no value
Default: none
Use this parameter only if your UPS system uses high values, instead of low values, to determine if power is off or the battery is low. Most UPS systems use low values. Refer to your UPS hardware documentation to determine whether you need to use the parameter.

?

Display a help screen that explains the other parameters. When you use this parameter, the UPS_AIO module is not loaded. To load the module, execute LOAD UPS_AIO without the ? parameter.

Parameter	Use to
path	Specify the path to UPS_AIO only if you moved it from the default directory (sys:system) and if there is no server search path to the directory where the file is located.
DOWNTIME=number	Specify the amount of time to run on battery before system shutdown. If power is restored before this time elapses, no shutdown will occur. If a low battery condition occurs before this time elapses, an immediate shutdown will occur. Supported values: 30 seconds minimum, no practical maximum limit Default: 300 seconds
MSGDELAY=number	Specify the elapsed time before a broadcast message is sent to all clients logged into the server. Supported values: 0 seconds minimum, no practical maximum limit Default: 5 seconds The broadcast message states the time remaining until shutdown.
MSGINTERVAL=number	Specify the time interval between broadcast messages sent to users. The message is repeated at this interval. Supported values: 20 seconds minimum, no practical maximum limit Default: 30 seconds The broadcast message states the time remaining until shutdown.
DRIVERTYPE=number	Specify the AIO device driver type. Supported values: 1, 2, 3 Default: 1 The default value of 1 represents the AIOCOMX driver, which is included with NetWare. Other drivers might be represented by other numbers. Refer to the documentation that came with the driver.
BOARD=number	Specify the AIO board number. Supported values: Determined by the driver manufacturer Default: 0 To determine the board number, read the driver information when the AIOCOMX driver is loaded. The information includes both the board and port numbers. If you do not use the AIOCOMX driver, refer to the driver documentation to determine the board number.
PORT=number	Specify the port number. Supported values: Determined by the driver manufacturer Default: 0 To determine the port number, read the driver information when the AIOCOMX driver is loaded. The information includes both the port and board numbers. If you do not use the AIOCOMX driver, refer to the driver documentation to determine the port number.
SIGNAL_HIGH	Set the normal RS-232 signaling state to high. Supported values: SIGNAL_HIGH or no value Default: none Use this parameter only if your UPS system uses high values, instead of low values, to determine if power is off or the battery is low. Most UPS systems use low values. Refer to your UPS hardware documentation to determine whether you need to use the parameter.
?	Display a help screen that explains the other parameters. When you use this parameter, the UPS_AIO module is not loaded. To load the module, execute LOAD UPS_AIO without the ? parameter.

Prerequisites

A serial port must be available.

The UPS_AIO module requires an AIO device driver, such as AIOCOMX, which is included with NetWare.

You should know which parameters, if any, you want to specify when you load the UPS_AIO module. See Table 1.

Procedure

To load the AIOCOMX driver, enter
[LOAD] [ path]\AIOCOMX

You can use another AIO driver, if specified by your hardware manufacturer.

When you load AIOCOMX, the screen displays the board and port numbers. If either the board or port number is not 0, note the number. You will enter the number as a parameter in the next step.
To load the UPS_AIO module, enter
[LOAD] [ path]UPS_AIO [ parameter= value...]

If you do not enter a parameter, the default value for that parameter takes effect. For a description of parameters and their values, see Table 1.

For example:
[LOAD] UPS_AIO DOWNTIME=60

Once UPS_AIO is loaded, the UPS screen displays the current status and activity of the module. These messages are also logged to the system error log, sys$log.err, in the sys:system directory.
(Optional) To toggle from the status screen to other screens, press Alt + Esc.

To load the driver and the UPS_AIO module automatically whenever you start the server, enter the commands into the autoexec.ncf file. You can use NWCONFIG or EDIT to add the commands to the file.