'\" t .\" Title: nut-scanner .\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] .\" Generator: DocBook XSL Stylesheets v1.75.2 .\" Date: 05/21/2012 .\" Manual: NUT Manual .\" Source: Network UPS Tools .\" Language: English .\" .TH "NUT\-SCANNER" "8" "05/21/2012" "Network UPS Tools" "NUT Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .\" http://bugs.debian.org/507673 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" ----------------------------------------------------------------- .\" * set default formatting .\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l .\" ----------------------------------------------------------------- .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- .SH "NAME" nut-scanner \- scan communication buses for NUT devices .SH "SYNOPSIS" .sp \fBnut\-scanner\fR \-h .sp \fBnut\-scanner\fR [\fIOPTIONS\fR] .SH "DESCRIPTION" .sp \fBnut\-scanner\fR scans available communication buses and displays any NUT\-compatible devices it has found\&. .SH "INSTALLATION" .sp \fBnut\-scanner\fR is always built by default\&. However, available options (USB, SNMP, IPMI, \&...) will vary according to the available compile time and runtime dependencies\&. For example, if Net\-SNMP is installed, thus providing libsnmp (\&.so or \&.dll) and headers, both during compilation and runtime, then SNMP discovery will be available\&. .SH "OPTIONS" .PP \fB\-h\fR .RS 4 Display the help text\&. .RE .SH "DISPLAY OPTIONS" .PP \fB\-N\fR | \fB\-\-disp_nut_conf\fR .RS 4 Display result in the \fIups\&.conf\fR format\&. .RE .PP \fB\-P\fR | \fB\-\-disp_parsable\fR .RS 4 Display result in a parsable format\&. .RE .SH "BUS OPTIONS" .PP \fB\-C\fR | \fB\-\-complete_scan\fR .RS 4 Scan all available communication buses (default behavior) .RE .PP \fB\-U\fR | \fB\-\-usb_scan\fR .RS 4 List all NUT\-compatible USB devices currently plugged in\&. .RE .PP \fB\-S\fR | \fB\-\-snmp_scan\fR .RS 4 Scan SNMP devices\&. Requires at least a \fIstart IP\fR, and optionally, an \fIend IP\fR\&. See specific SNMP OPTIONS for community and security settings\&. .RE .PP \fB\-M\fR | \fB\-\-xml_scan\fR .RS 4 Scan XML/HTTP devices\&. Broadcast a network message on the current network interfaces to retrieve XML/HTTP capable devices\&. No IP required\&. .RE .PP \fB\-O\fR | \fB\-\-oldnut_scan\fR .RS 4 Scan NUT devices (i\&.e\&. upsd daemon) on IP ranging from \fIstart IP\fR to \fIend IP\fR\&. .RE .PP \fB\-A\fR | \fB\-\-avahi_scan\fR .RS 4 Scan NUT servers using Avahi request on the current network interfaces\&. No IP required\&. .RE .PP \fB\-I\fR | \fB\-\-ipmi_scan\fR .RS 4 Scan NUT compatible devices available via IPMI on the current host\&. .RE .SH "NETWORK OPTIONS" .PP \fB\-t\fR | \fB\-\-timeout\fR \fItimeout\fR .RS 4 Set the network timeout in seconds\&. Default timeout is 5 seconds\&. .RE .PP \fB\-s\fR | \fB\-\-start_ip\fR \fIstart IP\fR .RS 4 Set the first IP (IPv4 or IPv6) when a range of IP is required (SNMP, old_nut)\&. .RE .PP \fB\-e\fR | \fB\-\-end_ip\fR \fIend IP\fR .RS 4 Set the last IP (IPv4 or IPv6) when a range of IP is required (SNMP, old_nut)\&. If this parameter is omitted, only the \fIstart IP\fR is scanned\&. If \fIend IP\fR is less than \fIstart IP\fR, both parameters are internally permuted\&. .RE .PP \fB\-m\fR | \fB\-\-mask_cidr\fR \fIIP address/mask\fR .RS 4 Set a range of IP using CIDR notation\&. .RE .SH "NUT DEVICE OPTION" .PP \fB\-p\fR | \fB\-\-port\fR \fIport number\fR .RS 4 Set the port number of scanned NUT devices (default 3493)\&. .RE .SH "SNMP V1 OPTION" .PP \fB\-c\fR | \fB\-\-community\fR \fIcommunity\fR .RS 4 Set SNMP v1 community name (default = public)\&. .RE .SH "SNMP V3 OPTIONS" .PP \fB\-l\fR | \fB\-\-secLevel\fR \fIsecurity level\fR .RS 4 Set the \fIsecurity level\fR used for SNMPv3 messages\&. Allowed values are: noAuthNoPriv, authNoPriv and authPriv\&. .RE .PP \fB\-u\fR | \fB\-\-secName\fR \fIsecurity name\fR .RS 4 Set the \fIsecurity name\fR used for authenticated SNMPv3 messages\&. This parameter is mandatory if you set \fIsecurity level\fR\&. .RE .PP \fB\-w\fR | \fB\-\-authProtocol\fR \fIauthentication protocol\fR .RS 4 Set the \fIauthentication protocol\fR used for authenticated SNMPv3 messages\&. Allowed values are MD5 or SHA\&. Default value is MD5\&. .RE .PP \fB\-W\fR | \fB\-\-authPassword\fR \fIauthentication pass phrase\fR .RS 4 Set the \fIauthentication pass phrase\fR used for authenticated SNMPv3 messages\&. This parameter is mandatory if you set \fIsecurity level\fR to authNoPriv or authPriv\&. .RE .PP \fB\-x\fR | \fB\-\-privProtocol\fR \fIprivacy protocol\fR .RS 4 Set the \fIprivacy protocol\fR used for encrypted SNMPv3 messages\&. Allowed values are DES or AES\&. Default value is DES\&. .RE .PP \fB\-X\fR | \fB\-\-privPassword\fR \fIprivacy pass phrase\fR .RS 4 Set the \fIprivacy pass phrase\fR used for encrypted SNMPv3 messages\&. This parameter is mandatory if you set \fIsecurity level\fR to authPriv\&. .RE .SH "MISCELLANEOUS OPTIONS" .PP \fB\-V\fR | \fB\-\-version\fR .RS 4 Display NUT version\&. .RE .PP \fB\-a\fR | \fB\-\-available\fR .RS 4 Display available bus that can be scanned , depending on how the binary has been compiled\&. (OLDNUT, USB, SNMP, XML, AVAHI, IPMI)\&. .RE .PP \fB\-q\fR | \fB\-\-quiet\fR .RS 4 Display only scan result\&. No information on currently scanned bus is displayed\&. .RE .SH "EXAMPLES" .sp To scan USB devices only: .sp \fBnut\-scanner \-U\fR .sp To scan SNMP v1 device with public community on address range 192\&.168\&.0\&.0 to 192\&.168\&.0\&.255: .sp \fBnut\-scanner \-S \-s 192\&.168\&.0\&.0 \-e 192\&.168\&.0\&.255\fR .sp The same using CIDR notation: .sp \fBnut\-scanner \-S \-m 192\&.168\&.0\&.0/24\fR .sp To scan NUT servers with a timeout of 10 seconds on IP range 192\&.168\&.0\&.0 to 192\&.168\&.0\&.128 using CIDR notation: .sp \fBnut\-scanner \-O \-t 10 \-m 192\&.168\&.0\&.0/25\fR .SH "SEE ALSO" .sp \fBups.conf\fR(5) .SH "INTERNET RESOURCES" .sp The NUT (Network UPS Tools) home page: http://www\&.networkupstools\&.org/