nut-scanner(8)

1NUT-SCANNER(8)                    NUT Manual                    NUT-SCANNER(8)
2
3
4

NAME

6       nut-scanner - scan communication buses for NUT devices
7

SYNOPSIS

9       nut-scanner -h
10
11       nut-scanner [OPTIONS]
12

DESCRIPTION

14       nut-scanner scans available communication buses and displays any
15       NUT-compatible devices it has found.
16

INSTALLATION

18       nut-scanner is only built if libltdl (part of libtool development
19       suite) is available. Available options (USB, SNMP, IPMI, ...) will vary
20       according to the available compile time and runtime dependencies. For
21       example, if Net-SNMP is installed, thus providing libsnmp (.so or .dll)
22       and headers, both during compilation and runtime, then SNMP discovery
23       will be available.
24

OPTIONS

26       -h
27           Display the help text.
28

DISPLAY OPTIONS

30       -N | --disp_nut_conf
31           Display result in the ups.conf format.
32
33       -P | --disp_parsable
34           Display result in a parsable format.
35

BUS OPTIONS

37       -C | --complete_scan
38           Scan all available communication buses (default behavior)
39
40       -U | --usb_scan
41           List all NUT-compatible USB devices currently plugged in.
42
43       -S | --snmp_scan
44           Scan SNMP devices. Requires at least a start IP, and optionally, an
45           end IP. See specific SNMP OPTIONS for community and security
46           settings.
47
48       -M | --xml_scan
49           Scan XML/HTTP devices. Broadcast a network message on the current
50           network interfaces to retrieve XML/HTTP capable devices. No IP
51           required.
52
53       -O | --oldnut_scan
54           Scan NUT devices (i.e. upsd daemon) on IP ranging from start IP to
55           end IP.
56
57       -A | --avahi_scan
58           Scan NUT servers using Avahi request on the current network
59           interfaces. No IP required.
60
61       -I | --ipmi_scan
62           Scan NUT compatible power supplies available via IPMI on the
63           current host, or over the network.
64
65       -E | --eaton_serial serial ports
66           Scan Eaton devices (XCP and SHUT) available via serial bus on the
67           current host. This option must be requested explicitly, even for a
68           complete scan.  serial ports can be expressed in various forms:
69
70           •   auto to scan all serial ports.
71
72           •   a single character indicating a port number (0 (zero) for
73               /dev/ttyS0 and /dev/ttyUSB0 on Linux, 1 for COM1 on Windows, a
74               for /dev/ttya on Solaris...)
75
76           •   a range of N characters, hyphen separated, describing the range
77               of ports using X-Y, where X and Y are characters referring to
78               the port number.
79
80           •   a single port name.
81
82           •   a list of ports name, coma separated, like
83               /dev/ttyS1,/dev/ttyS4.
84

NETWORK OPTIONS

86       -t | --timeout timeout
87           Set the network timeout in seconds. Default timeout is 5 seconds.
88
89       -s | --start_ip start IP
90           Set the first IP (IPv4 or IPv6) when a range of IP is required
91           (SNMP, old_nut).
92
93       -e | --end_ip end IP
94           Set the last IP (IPv4 or IPv6) when a range of IP is required
95           (SNMP, old_nut). If this parameter is omitted, only the start IP is
96           scanned. If end IP is less than start IP, both parameters are
97           internally permuted.
98
99       -m | --mask_cidr IP address/mask
100           Set a range of IP using CIDR notation.
101

NUT DEVICE OPTION

103       -p | --port port number
104           Set the port number of scanned NUT devices (default 3493).
105

SNMP V1 OPTION

107       -c | --community community
108           Set SNMP v1 community name (default = public).
109

SNMP V3 OPTIONS

111       -l | --secLevel security level
112           Set the security level used for SNMPv3 messages. Allowed values
113           are: noAuthNoPriv, authNoPriv and authPriv.
114
115       -u | --secName security name
116           Set the security name used for authenticated SNMPv3 messages. This
117           parameter is mandatory if you set security level.
118
119       -w | --authProtocol authentication protocol
120           Set the authentication protocol used for authenticated SNMPv3
121           messages. Allowed values are MD5, SHA, SHA256, SHA384 or SHA512
122           (depending on Net-SNMP library capabilities; check help of the
123           nut-scanner binary program for the run-time supported list).
124           Default value is MD5.
125
126       -W | --authPassword authentication pass phrase
127           Set the authentication pass phrase used for authenticated SNMPv3
128           messages. This parameter is mandatory if you set security level to
129           authNoPriv or authPriv.
130
131       -x | --privProtocol privacy protocol
132           Set the privacy protocol used for encrypted SNMPv3 messages.
133           Allowed values are DES, AES, AES192 or AES256 (depending on
134           Net-SNMP library capabilities; check help of the nut-scanner binary
135           program for the run-time supported list). Default value is DES.
136
137       -X | --privPassword privacy pass phrase
138           Set the privacy pass phrase used for encrypted SNMPv3 messages.
139           This parameter is mandatory if you set security level to authPriv.
140

IPMI OPTIONS

142       -b | --username username
143           Set the username used for authenticating IPMI over LAN connections
144           (mandatory for IPMI over LAN. No default).
145
146       -B | --password password
147           Specify the password to use when authenticating with the remote
148           host (mandatory for IPMI over LAN. No default).
149
150       -d | --authType authentication type
151           Specify the IPMI 1.5 authentication type to use (NONE,
152           STRAIGHT_PASSWORD_KEY, MD2, and MD5) with the remote host
153           (default=MD5). This forces connection through the lan IPMI
154           interface , thus in IPMI 1.5 mode.
155
156       -L | --cipher_suite_id cipher suite identifier
157           Specify the IPMI 2.0 cipher suite ID to use. The Cipher Suite ID
158           identifies a set of authentication, integrity, and confidentiality
159           algorithms to use for IPMI 2.0 communication. The authentication
160           algorithm identifies the algorithm to use for session setup, the
161           integrity algorithm identifies the algorithm to use for session
162           packet signatures, and the confidentiality algorithm identifies the
163           algorithm to use for payload encryption (default=3).
164
165           The following cipher suite ids are currently supported
166           (Authentication; Integrity; Confidentiality):
167
168           •   0: None; None; None
169
170           •   1: HMAC-SHA1; None; None
171
172           •   2: HMAC-SHA1; HMAC-SHA1-96; None
173
174           •   3: HMAC-SHA1; HMAC-SHA1-96; AES-CBC-128
175
176           •   6: HMAC-MD5; None; None
177
178           •   7: HMAC-MD5; HMAC-MD5-128; None
179
180           •   8: HMAC-MD5; HMAC-MD5-128; AES-CBC-128
181
182           •   11: HMAC-MD5; MD5-128; None
183
184           •   12: HMAC-MD5; MD5-128; AES-CBC-128
185
186           •   15: HMAC-SHA256; None; None
187
188           •   16: HMAC-SHA256; HMAC_SHA256_128; None
189
190           •   17: HMAC-SHA256; HMAC_SHA256_128; AES-CBC-128
191

MISCELLANEOUS OPTIONS

193       -V | --version
194           Display NUT version.
195
196       -a | --available
197           Display available bus that can be scanned , depending on how the
198           binary has been compiled. (OLDNUT, USB, SNMP, XML, AVAHI, IPMI).
199
200       -q | --quiet
201           Display only scan result. No information on currently scanned bus
202           is displayed.
203
204       -D | --nut_debug_level
205           Raise the debugging level. Use this multiple times to see more
206           details.
207

EXAMPLES

209       To scan USB devices only:
210
211       nut-scanner -U
212
213       To scan SNMP v1 device with public community on address range
214       192.168.0.0 to 192.168.0.255:
215
216       nut-scanner -S -s 192.168.0.0 -e 192.168.0.255
217
218       The same using CIDR notation:
219
220       nut-scanner -S -m 192.168.0.0/24
221
222       To scan NUT servers with a timeout of 10 seconds on IP range
223       192.168.0.0 to 192.168.0.127 using CIDR notation:
224
225       nut-scanner -O -t 10 -m 192.168.0.0/25
226
227       To scan for power supplies, through IPMI (1.5 mode) over the network,
228       on address range 192.168.0.0 to 192.168.0.255:
229
230       nut-scanner -I -m 192.168.0.0/24 -b username -B password
231
232       To scan for Eaton serial devices on ports 0 and 1 (/dev/ttyS0,
233       /dev/ttyUSB0, /dev/ttyS1 and /dev/ttyUSB1 on Linux):
234
235       nut-scanner --eaton_serial 0-1
236
237       To scan for Eaton serial devices on ports 1 and 2 (COM1 and COM2 on
238       Windows):
239
240       nut-scanner --eaton_serial 1-2
241