upsrw(8) - f34

1UPSRW(8)                          NUT Manual                          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

DESCRIPTION

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

OPTIONS

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

UNATTENDED MODE

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

DIAGNOSTICS

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

VALUE FORMAT

79       When using upsrw to modify a numeric float value, that values must be
80       given using decimal (base 10) english-based representation, so using a
81       dot, in non-scientific notation. So hexadecimal, exponents, and comma
82       for thousands separator are forbiden. For example: "1200.20" is valid,
83       while "1,200.20" and "1200,20" are invalid.
84

HISTORY

86       This program used to be called upsct2, which was ambiguous and
87       confusing.
88