nut/docs/man/nut-scanner.txt
2011-09-29 20:14:46 +02:00

131 lines
3.3 KiB
Text

NUT-SCANNER(8)
==============
NAME
----
nut-scanner - scan communication buses for NUT devices
SYNOPSIS
--------
*nut-scanner* -h
*nut-scanner* ['OPTIONS']
DESCRIPTION
-----------
*nut-scanner* scans available communication buses and display any NUT compatible device it has found.
OPTIONS
-------
*-h*::
Display the help text.
DISPLAY OPTIONS
---------------
*-N* | *--disp_nut_conf*::
Display result in the 'ups.conf' format.
*-P* | *--disp_parsable*::
Display result in a parsable format.
BUS OPTIONS
-----------
*-C* | *--complete_scan*::
Scan all available communication buses (default behavior)
*-U* | *--usb_scan*::
List all NUT compatible USB devices currently plugged in.
*-S* | *--snmp_scan*::
Scan SNMP devices. Require at least a 'start IP', and optionnaly an 'end IP'. See specific SNMP OPTIONS for community and security settings.
*-M* | *--xml_scan*::
Scan XML/HTTP devices. Broadcast a network message on the current network interfaces to retrieve XML/HTTP capable devices. No IP required.
*-O* | *--oldnut_scan*::
Scan NUT devices (i.e. upsd daemon) on IP ranging from 'start IP' to 'end IP'.
*-A* | *--avahi_scan*::
Scan NUT servers using avahi request on the current network interfaces. No IP required.
*-I* | *--ipmi_scan*::
Scan NUT compatible devices available via IPMI on the current host.
NETWORK OPTIONS
---------------
*-t* | *--timeout* 'timeout'::
Set the network timeout in seconds. Default timeout is 5 seconds.
*-s* | *--start_ip* 'start IP'::
Set the first IP (IPv4 or IPv6) when a range of IP is required (SNMP, old_nut).
*-e* | *--end_ip* 'end IP'::
Set the last IP (IPv4 or IPv6) when a range of IP is required (SNMP, old_nut). If this parameter is omitted, only the 'start IP' is scanned. If 'end IP' is lesser than 'start IP', both parameter are internally permuted.
NUT DEVICE OPTION
-----------------
*-p* | *--port <port number* 'port number'::
Set the port number of scanned NUT devices (default 3493).
SNMP V1 OPTION
--------------
*-c* | *--community* 'community'::
Set SNMP v1 community name (default = public).
SNMP V3 OPTIONS
---------------
*-l* | *--secLevel* 'security level'::
Set the 'security level' used for SNMPv3 messages. Allowed values are: noAuthNoPriv, authNoPriv and authPriv.
*-u* | *--secName* 'security name'::
Set the 'security name' used for authenticated SNMPv3 messages. This parameter is mandatory if you set 'security level'.
*-a* | *--authProtocol* 'authentication protocol'::
Set the 'authentication protocol' used for authenticated SNMPv3 messages. Allowed values are MD5 or SHA. Default value is MD5.
*-A* | *--authPassword* 'authentication pass phrase'::
Set the 'authentication pass phrase' used for authenticated SNMPv3 messages. This parameter is mandatory if you set 'security level' to authNoPriv or authPriv.
*-x* | *--privProtocol* 'privacy protocol'::
Set the 'privacy protocol' used for encrypted SNMPv3 messages. Allowed values are DES or AES. Default value is DES.
*-X* | *--privPassword* 'privacy pass phrase'::
Set the 'privacy pass phrase' used for encrypted SNMPv3 messages. This parameter is mandatory if you set 'security level' to authPriv.
SEE ALSO
--------
linkman:ups.conf[5]
INTERNET RESOURCES
------------------
The NUT (Network UPS Tools) home page: http://www.networkupstools.org/