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 display any NUT
15       compatible device it has found.
16

OPTIONS

18       -h
19           Display the help text.
20

DISPLAY OPTIONS

22       -N | --disp_nut_conf
23           Display result in the ups.conf format.
24
25       -P | --disp_parsable
26           Display result in a parsable format.
27

BUS OPTIONS

29       -C | --complete_scan
30           Scan all available communication buses (default behavior)
31
32       -U | --usb_scan
33           List all NUT compatible USB devices currently plugged in.
34
35       -S | --snmp_scan
36           Scan SNMP devices. Require at least a start IP, and optionnaly an
37           end IP. See specific SNMP OPTIONS for community and security
38           settings.
39
40       -M | --xml_scan
41           Scan XML/HTTP devices. Broadcast a network message on the current
42           network interfaces to retrieve XML/HTTP capable devices. No IP
43           required.
44
45       -O | --oldnut_scan
46           Scan NUT devices (i.e. upsd daemon) on IP ranging from start IP to
47           end IP.
48
49       -A | --avahi_scan
50           Scan NUT servers using avahi request on the current network
51           interfaces. No IP required.
52
53       -I | --ipmi_scan
54           Scan NUT compatible devices available via IPMI on the current host.
55

NETWORK OPTIONS

57       -t | --timeout timeout
58           Set the network timeout in seconds. Default timeout is 5 seconds.
59
60       -s | --start_ip start IP
61           Set the first IP (IPv4 or IPv6) when a range of IP is required
62           (SNMP, old_nut).
63
64       -e | --end_ip end IP
65           Set the last IP (IPv4 or IPv6) when a range of IP is required
66           (SNMP, old_nut). If this parameter is omitted, only the start IP is
67           scanned. If end IP is lesser than start IP, both parameter are
68           internally permuted.
69

NUT DEVICE OPTION

71       -p | --port <port number port number
72           Set the port number of scanned NUT devices (default 3493).
73

SNMP V1 OPTION

75       -c | --community community
76           Set SNMP v1 community name (default = public).
77

SNMP V3 OPTIONS

79       -l | --secLevel security level
80           Set the security level used for SNMPv3 messages. Allowed values
81           are: noAuthNoPriv, authNoPriv and authPriv.
82
83       -u | --secName security name
84           Set the security name used for authenticated SNMPv3 messages. This
85           parameter is mandatory if you set security level.
86
87       -a | --authProtocol authentication protocol
88           Set the authentication protocol used for authenticated SNMPv3
89           messages. Allowed values are MD5 or SHA. Default value is MD5.
90
91       -A | --authPassword authentication pass phrase
92           Set the authentication pass phrase used for authenticated SNMPv3
93           messages. This parameter is mandatory if you set security level to
94           authNoPriv or authPriv.
95
96       -x | --privProtocol privacy protocol
97           Set the privacy protocol used for encrypted SNMPv3 messages.
98           Allowed values are DES or AES. Default value is DES.
99
100       -X | --privPassword privacy pass phrase
101           Set the privacy pass phrase used for encrypted SNMPv3 messages.
102           This parameter is mandatory if you set security level to authPriv.
103

INTERNET RESOURCES

108       The NUT (Network UPS Tools) home page: http://www.networkupstools.org/
109
110
111
112Network UPS Tools                 09/15/2011                    NUT-SCANNER(8)