lagertonne/nut
1
0
Fork 0
Code Issues Pull requests Projects Releases 2 Wiki Activity

Imported Upstream version 2.6.3

Browse source
This commit is contained in:
Arnaud Quette 2012-01-24 11:22:33 +01:00
parent 45043b58d0
commit fad6ced6f6
255 changed files with 11081 additions and 4629 deletions
Download patch file Download diff file Expand all files Collapse all files

62
docs/man/nut-scanner.8
View file

@ -2,12 +2,12 @@
.\" Title: nut-scanner
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 09/15/2011
.\" Date: 01/03/2012
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "NUT\-SCANNER" "8" "09/15/2011" "Network UPS Tools" "NUT Manual"
.TH "NUT\-SCANNER" "8" "01/03/2012" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@ -36,7 +36,7 @@ nut-scanner \- scan communication buses for NUT devices
\fBnut\-scanner\fR [\fIOPTIONS\fR]
.SH "DESCRIPTION"
.sp
\fBnut\-scanner\fR scans available communication buses and display any NUT compatible device it has found\&.
\fBnut\-scanner\fR scans available communication buses and displays any NUT\-compatible devices it has found\&.
.SH "OPTIONS"
.PP
\fB\-h\fR
@ -65,13 +65,13 @@ Scan all available communication buses (default behavior)
.PP
\fB\-U\fR | \fB\-\-usb_scan\fR
.RS 4
List all NUT compatible USB devices currently plugged in\&.
List all NUT\-compatible USB devices currently plugged in\&.
.RE
.PP
\fB\-S\fR | \fB\-\-snmp_scan\fR
.RS 4
Scan SNMP devices\&. Require at least a
\fIstart IP\fR, and optionnaly an
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
@ -90,7 +90,7 @@ to
.PP
\fB\-A\fR | \fB\-\-avahi_scan\fR
.RS 4
Scan NUT servers using avahi request on the current network interfaces\&. No IP required\&.
Scan NUT servers using Avahi request on the current network interfaces\&. No IP required\&.
.RE
.PP
\fB\-I\fR | \fB\-\-ipmi_scan\fR
@ -115,12 +115,17 @@ Set the last IP (IPv4 or IPv6) when a range of IP is required (SNMP, old_nut)\&.
\fIstart IP\fR
is scanned\&. If
\fIend IP\fR
is lesser than
\fIstart IP\fR, both parameter are internally permuted\&.
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 <port number\fR \fIport number\fR
\fB\-p\fR | \fB\-\-port\fR \fIport number\fR
.RS 4
Set the port number of scanned NUT devices (default 3493)\&.
.RE
@ -147,14 +152,14 @@ used for authenticated SNMPv3 messages\&. This parameter is mandatory if you set
\fIsecurity level\fR\&.
.RE
.PP
\fB\-a\fR | \fB\-\-authProtocol\fR \fIauthentication protocol\fR
\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\-A\fR | \fB\-\-authPassword\fR \fIauthentication pass phrase\fR
\fB\-W\fR | \fB\-\-authPassword\fR \fIauthentication pass phrase\fR
.RS 4
Set the
\fIauthentication pass phrase\fR
@ -178,6 +183,39 @@ 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)