upsrw(8)

1UPSRW(8)                    Network UPS Tools (NUT)                   UPSRW(8)
2
3
4

NAME

6       upsrw - UPS variable administration tool
7

SYNOPSIS

9       upsrw ups
10
11       upsrw -h
12
13       upsrw -s variable [-u username] [-p password] ups
14
15

DESCRIPTION

17       upsrw  allows  you  to  view and change the read/write variables inside
18       your UPS.  It sends commands via the server  upsd(8)  to  your  driver,
19       which configures the hardware for you.
20
21       The list of variables that allow you to change their values is based on
22       the capabilities of your UPS equipment.  Not all  models  support  this
23       feature.   Typically,  cheaper  hardware  does not support any of them.
24       Run upsrw with a UPS identifier to see what will work for you.
25
26

OPTIONS

28       -h     Display the help message.
29
30
31       -s variable
32              Specify the variable to be changed inside the  UPS.   For  unat‐
33              tended  mode  such as in shell scripts, use the format VAR=VALUE
34              to specify both the variable and the value, for example:
35
36              -s input.transfer.high=129
37
38              Without this argument, upsrw will just display the list  of  the
39              variables and their possible values.
40
41              Some  variables  are strings, and can be set to any value within
42              the length limit.  Others are enumerated types and can  only  be
43              set  to  one  of those values.  Refer to the list to know what's
44              available in your hardware.
45
46
47       -u username
48              Set the username for the connection  to  the  server.   This  is
49              optional,  and  you  will be prompted for this when using the -s
50              option if you don't specify -u on the command line.
51
52
53       -p password
54              Set the password to authenticate to the server.   This  is  also
55              optional like -u, and you will be prompted for it if necessary.
56
57
58       ups    View  or  change  the settings on this UPS.  The format for this
59              option is upsname@hostname[:port].
60
61

UNATTENDED MODE

63       If you run this program inside a shell script or similar to  set  vari‐
64       ables,  you  will need to specify all of the information on the command
65       line.  This means using -s VAR=VALUE, -u and -p.  Otherwise it will put
66       up a prompt and your program will hang.
67
68       This  is  not  necessary  when displaying the list, as the username and
69       password are not required for read‐only mode.
70
71

DIAGNOSTICS

73       upsrw can't set variables on your UPS unless you provide a valid  user‐
74       name  and  password.  If you get "access denied" errors, make sure that
75       your upsd.users(5) has an entry for you, and that the username you  are
76       using has permissions to SET variables.
77
78

HISTORY

80       This  program used to be called upsct2, which was ambiguous and confus‐
81       ing.
82
83