1NUT-SCANNER(8) NUT Manual NUT-SCANNER(8)
2
6 nut-scanner - scan communication buses for NUT devices
7
9 nut-scanner -h
10 nut-scanner [OPTIONS]
12
14 nut-scanner scans available communication buses and displays any
15 NUT-compatible devices it has found.
16
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
26 -h
27 Display the help text.
28
30 -N | --disp_nut_conf
31 Display result in the ups.conf format.
32 -P | --disp_parsable
34 Display result in a parsable format.
35
37 -C | --complete_scan
38 Scan all available communication buses (default behavior)
39 -U | --usb_scan
41 List all NUT-compatible USB devices currently plugged in.
42 -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 -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 -O | --oldnut_scan
54 Scan NUT devices (i.e. upsd daemon) on IP ranging from start IP to
55 end IP.
56 -A | --avahi_scan
58 Scan NUT servers using Avahi request on the current network
59 interfaces. No IP required.
60 -I | --ipmi_scan
62 Scan NUT compatible power supplies available via IPMI on the
63 current host, or over the network.
64 -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 explicitely, even for a
68 complete scan. serial ports can be expressed in various forms:
69 · auto to scan all serial ports.
71 · a single charcater 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 · a range of N characters, hyphen separated, describing the range
77 of ports using X-Y, where X and Y are characters refering to
78 the port number.
79 · a single port name.
81 · a list of ports name, coma separated, like
83 /dev/ttyS1,/dev/ttyS4.
84
86 -t | --timeout timeout
87 Set the network timeout in seconds. Default timeout is 5 seconds.
88 -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 -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 -m | --mask_cidr IP address/mask
100 Set a range of IP using CIDR notation.
101
103 -p | --port port number
104 Set the port number of scanned NUT devices (default 3493).
105
107 -c | --community community
108 Set SNMP v1 community name (default = public).
109
111 -l | --secLevel security level
112 Set the security level used for SNMPv3 messages. Allowed values
113 are: noAuthNoPriv, authNoPriv and authPriv.
114 -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 -w | --authProtocol authentication protocol
120 Set the authentication protocol used for authenticated SNMPv3
121 messages. Allowed values are MD5 or SHA. Default value is MD5.
122 -W | --authPassword authentication pass phrase
124 Set the authentication pass phrase used for authenticated SNMPv3
125 messages. This parameter is mandatory if you set security level to
126 authNoPriv or authPriv.
127 -x | --privProtocol privacy protocol
129 Set the privacy protocol used for encrypted SNMPv3 messages.
130 Allowed values are DES or AES. Default value is DES.
131 -X | --privPassword privacy pass phrase
133 Set the privacy pass phrase used for encrypted SNMPv3 messages.
134 This parameter is mandatory if you set security level to authPriv.
135
137 -b | --username username
138 Set the username used for authenticating IPMI over LAN connections
139 (mandatory for IPMI over LAN. No default).
140 -B | --password password
142 Specify the password to use when authenticating with the remote
143 host (mandatory for IPMI over LAN. No default).
144 -d | --authType authentication type
146 Specify the IPMI 1.5 authentication type to use (NONE,
147 STRAIGHT_PASSWORD_KEY, MD2, and MD5) with the remote host
148 (default=MD5). This forces connection through the lan IPMI
149 interface , thus in IPMI 1.5 mode.
150 -D | --cipher_suite_id cipher suite identifier
152 Specify the IPMI 2.0 cipher suite ID to use. The Cipher Suite ID
153 identifies a set of authentication, integrity, and confidentiality
154 algorithms to use for IPMI 2.0 communication. The authentication
155 algorithm identifies the algorithm to use for session setup, the
156 integrity algorithm identifies the algorithm to use for session
157 packet signatures, and the confidentiality algorithm identifies the
158 algorithm to use for payload encryption (default=3).
159 The following cipher suite ids are currently supported
161 (Authentication; Integrity; Confidentiality):
162 · 0: None; None; None
164 · 1: HMAC-SHA1; None; None
166 · 2: HMAC-SHA1; HMAC-SHA1-96; None
168 · 3: HMAC-SHA1; HMAC-SHA1-96; AES-CBC-128
170 · 6: HMAC-MD5; None; None
172 · 7: HMAC-MD5; HMAC-MD5-128; None
174 · 8: HMAC-MD5; HMAC-MD5-128; AES-CBC-128
176 · 11: HMAC-MD5; MD5-128; None
178 · 12: HMAC-MD5; MD5-128; AES-CBC-128
180 · 15: HMAC-SHA256; None; None
182 · 16: HMAC-SHA256; HMAC_SHA256_128; None
184 · 17: HMAC-SHA256; HMAC_SHA256_128; AES-CBC-128
186
188 -V | --version
189 Display NUT version.
190 -a | --available
192 Display available bus that can be scanned , depending on how the
193 binary has been compiled. (OLDNUT, USB, SNMP, XML, AVAHI, IPMI).
194 -q | --quiet
196 Display only scan result. No information on currently scanned bus
197 is displayed.
198
200 To scan USB devices only:
201 nut-scanner -U
203 To scan SNMP v1 device with public community on address range
205 192.168.0.0 to 192.168.0.255:
206 nut-scanner -S -s 192.168.0.0 -e 192.168.0.255
208 The same using CIDR notation:
210 nut-scanner -S -m 192.168.0.0/24
212 To scan NUT servers with a timeout of 10 seconds on IP range
214 192.168.0.0 to 192.168.0.127 using CIDR notation:
215 nut-scanner -O -t 10 -m 192.168.0.0/25
217 To scan for power supplies, through IPMI (1.5 mode) over the network,
219 on address range 192.168.0.0 to 192.168.0.255:
220 nut-scanner -I -m 192.168.0.0/24 -b username -B password
222 To scan for Eaton serial devices on ports 0 and 1 (/dev/ttyS0,
224 /dev/ttyUSB0, /dev/ttyS1 and /dev/ttyUSB1 on Linux):
225 nut-scanner --eaton_serial 0-1
227 To scan for Eaton serial devices on ports 1 and 2 (COM1 and COM2 on
229 Windows):
230 nut-scanner --eaton_serial 1-2
232
234 ups.conf(5)
235
237 The NUT (Network UPS Tools) home page: http://www.networkupstools.org/
238Network UPS Tools 2.7.3. 12/29/2015 NUT-SCANNER(8)