Penguin
Recent Changes
Blame: upsdrvctl(8)
EditPageHistoryDiffInfoLikePages
Annotated edit history of upsdrvctl(8) version 2, including all changes. View license author blame.
Rev Author # Line
1 perry 1 UPSDRVCTL
2 !!!UPSDRVCTL
3 NAME
4 SYNOPSIS
5 DESCRIPTION
6 OPTIONS
7 COMMANDS
8 OLD DRIVERS
9 BUGS
10 SEE ALSO
11 ----
12 !!NAME
13
14
15 upsdrvctl - UPS driver controller
16 !!SYNOPSIS
17
18
19 __upsdrvctl -h__
20
21
22 __upsdrvctl [[-t] [[-v] (start | stop | shutdown | status)
23 [[__''ups''__]__
24 !!DESCRIPTION
25
26
27 upsdrvctl provides a uniform interface for controlling your
28 UPS drivers. The intention is for users to always use
29 upsdrvctl for starting and stopping them rather than
30 hard-coding driver calls into their startup
31 scripts.
32
33
34 When used properly, upsdrvctl lets you maintain identical
35 startup scripts across multiple systems with different UPS
36 configurations.
37 !!OPTIONS
38
39
40 -h
41
42
43 Display the help message.
44
45
46 -t
47
48
49 Enable testing mode. This also enables verbose mode. Testing
50 mode makes upsdrvctl display the actions it would execute
51 without actually doing them. Use this to test out your
52 configuration without actually doing anything to your UPS
53 drivers. This may be helpful when defining the 'sdorder'
2 perry 54 directive in your ups.conf(5).
1 perry 55
56
57 -v
58
59
60 Enable verbose messages.
61 !!COMMANDS
62
63
64 upsdrvctl supports three commands - start, stop, and status.
65 They take an optional argument which is a UPS name from
2 perry 66 ups.conf(5). Without that argument, they operate on
1 perry 67 every UPS that is currently configured.
68
69
70 start
71
72
73 Start the UPS driver(s).
74
75
76 stop
77
78
79 Stop the UPS driver(s).
80
81
82 shutdown
83
84
85 Command the UPS driver(s) to run their shutdown sequence.
86 This is equivalent to manually starting each driver with the
87 -k argument. Drivers are stopped according to their sdorder
2 perry 88 value - see ups.conf(5).
1 perry 89
90
91 status
92
93
94 Check the status of the UPS driver(s).
95
96
97 If every UPS that has been checked is running, then the
98 exitcode will be 0. If one seems to be missing, the exitcode
99 will be 1.
100 !!OLD DRIVERS
101
102
103 Old drivers can't be controlled with upsdrvctl. While many
104 popular drivers have been converted, there are still a
105 number that have not. If your hardware uses an older driver,
106 you must call it directly.
107
108
109 You can find out if your driver is new or old by starting it
110 with -h to see the help text. If it mentions '-a' to
111 autoconfigure, then you have a new driver. Otherwise, it's
112 old.
113
114
115 In this case, consider converting the driver yourself, then
116 send in a patch.
117 !!BUGS
118
119
120 The status checking is rudimentary, and really only looks
121 for the presence of .pid files. If you really want to know
122 if your UPS drivers are alive and well, upsmon(8)'s
123 NOCOMM notifier does a fine job.
124 !!SEE ALSO
125
126
127 nutupsdrv(8), upsd(8)
2 perry 128 ups.conf(5)
1 perry 129
130
131 __Internet resources:__
132
133
134 The NUT (Network UPS Tools) home page:
135 http://www.exploits.org/nut/
136
137
138 NUT mailing list archives and information:
139 http://lists.exploits.org/
140 ----
This page is a man page (or other imported legacy content). We are unable to automatically determine the license status of this page.