NAME

upsd.users - Administrative user definitions for NUT upsd

NOTE ABOUT HISTORIC NUT RELEASE

Note
Two NUT websites

This version of the page reflects NUT release v2.8.1 with codebase commited 4ba352d8f at 2023-10-31T21:46:20+01:00

Options, features and capabilities in current development (and future releases) are detailed on the main site and may differ from ones described here.

DESCRIPTION

Administrative commands such as setting variables and the instant commands are powerful, and access to them needs to be restricted. This file defines who may access them, and what is available.

Each user gets its own section. The fields in that section set the parameters associated with that user’s privileges. The section begins with the name of the user in brackets, and continues until the next user name in brackets or EOF. These users are independent of /etc/passwd.

Here are some examples to get you started:

[admin]
        password = mypass
        actions = set
        actions = fsd
        instcmds = all
[pfy]
        password = duh
        instcmds = test.panel.start
        instcmds = test.panel.stop
[upswired]
        password = blah
        upsmon primary
[observer]
        password = abcd
        upsmon secondary

FIELDS

password

Set the password for this user.

actions

Allow the user to do certain things with upsd. To specify multiple actions, use multiple instances of the actions field. Valid actions are:

SET

change the value of certain variables in the UPS

FSD

set the forced shutdown flag in the UPS. This is equivalent to an "on battery + low battery" situation for the purposes of monitoring.

The list of actions is expected to grow in the future.

instcmds

Let a user initiate specific instant commands. Use "ALL" to grant all commands automatically. To specify multiple commands, use multiple instances of the instcmds field. For the full list of what your UPS supports, use "upscmd -l".

The cmdvartab file supplied with the distribution contains a list of most of the known command names.

upsmon

Add the necessary actions for a upsmon process to work. This is either set to "primary" or "secondary".

Do not attempt to assign actions to upsmon by hand, as you may miss something important. This method of designating a "upsmon user" was created so internal capabilities could be changed later on without breaking existing installations.

SEE ALSO

upsd(8), upsd.conf(5)

Internet resources:

The NUT (Network UPS Tools) home page: https://www.networkupstools.org/