Network UPS Tools User Manual

Recommendations

Info

Network UPS Tools User Manual 19 / 84 5.2.5 FreeBSD You can either install NUT as a binary package or as a port. Binary package To install the main component, use the following command: # pkg_add -r nut Port The port is located under /usr/ports/sysutils/nut. To install it, use the following command: # cd /usr/ports/sysutils/nut/ && make install clean You have to define WITH_NUT_CGI to build the optional CGI scripts. Optionaly, you can also install the following ports: • sysutils/nut-snmp, for the SNMP driver, • sysutils/nut-usb, for the USB drivers, • sysutils/nut-libupsclient, for the upsclient library. You are now ready to configure NUT, and start testing and using it. You can jump directly to the NUT configuration. 6 Configuration notes This chapter describe most of the configuration and use aspects of NUT, including establishing communication with the device and configuring safe shutdowns when the UPS battery runs out of power. There are many programs and features in this package. You should check out the NUT Overview and other accompanying documentation to see how it all works. Note NUT does not currently provide proper graphical configuration tools. However, there is now support for Augeas, which will enable the easier creation of configuration tools. Moreover, nut-scanner(8) is available to discover supported devices (USB, SNMP, Eaton XML/HTTP and IPMI) and NUT servers (using Avahi or the classic connection method). 6.1 Details about the configuration files 6.1.1 Generalities All configuration files within this package are parsed with a common state machine, which means they all can use a number of extras described here. First, most of the programs use an uppercase word to declare a configuration directive. This may be something like MONITOR, NOTIFYCMD, or ACCESS. The case does matter here. "monitor" won’t be recognized. Next, the parser does not care about whitespace between words. If you like to indent things with tabs or spaces, feel free to do it here. If you need to set a value to something containing spaces, it has to be contained within "quotes" to keep the parser from splitting up the line. That is, you want to use something like this:
Network UPS Tools User Manual 20 / 84 SHUTDOWNCMD "/sbin/shutdown -h +0" Without the quotes, it would only see the first word on the line. OK, so let’s say you really need to embed that kind of quote within your configuration directive for some reason. You can do that too. NOTIFYCMD "/bin/notifyme -foo -bar \"hi there\" -baz" In other words, \ can be used to escape the ". Finally, for the situation where you need to put the \ character into your string, you just escape it. NOTIFYCMD "/bin/notifyme c:\\dos\\style\\path" The \ can actually be used to escape any character, but you only really need it for \, ", and # as they have special meanings to the parser. When using file names with space characters, you may end up having tricky things since you need to write them inside "" which must be escaped: NOTIFYCMD "\"c:\\path with space\\notifyme\" \"c:\\path with space\\name\"" is the comment character. Anything after an unescaped is ignored. Something like this. . . identity = my#1ups i. will actually turn into "identity = my", since the stops the parsing. If you really need to have a in your configuration, then escape it. identity = my\#1ups Much better. The = character should be used with care too. There should be only one "simple" = character in a line: between the parameter name and its value. All other = characters should be either escaped or within "quotes". password = 123=123 i. is incorrect. You should use: password = 123\=123 ii. or : password = "123=123" 6.1.2 Line spanning You can put a backslash at the end of the line to join it to the next one. This creates one virtual line that is composed of more than one physical line. Also, if you leave the "" quote container open before a newline, it will keep scanning until it reaches another one. If you see bizarre behavior in your configuration files, check for an unintentional instance of quotes spanning multiple lines.
Page 1 and 2: Network UPS Tools User Manual i Net
Page 3 and 4: Network UPS Tools User Manual iii C
Page 5 and 6: Network UPS Tools User Manual v Ins
Page 7 and 8: Network UPS Tools User Manual vii 9
Page 9 and 10: Network UPS Tools User Manual ix F
Page 11 and 12: Network UPS Tools User Manual xi J.
Page 13 and 14: Network UPS Tools User Manual 2 / 8
Page 21 and 22: Network UPS Tools User Manual 10 /
Page 29: Network UPS Tools User Manual 18 /
Page 81 and 82:
Network UPS Tools User Manual 70 /
Page 83 and 84:
Page 85 and 86:
Page 87 and 88:
Page 89 and 90:
Page 91 and 92:
Page 93 and 94:
Page 95:
show all

Network UPS Tools User Manual

Create successful ePaper yourself

Delete template?

Save as template?