'\" t
.\"     Title: nutscan_scan_nut
.\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 06/21/2026
.\"    Manual: NUT Manual
.\"    Source: Network UPS Tools 2.8.5
.\"  Language: English
.\"
.TH "NUTSCAN_SCAN_NUT" "3" "06/21/2026" "Network UPS Tools 2\&.8\&.5" "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"
nutscan_scan_nut \- Scan network for available NUT services\&.
.SH "SYNOPSIS"
.sp
.nf
        #include <nut\-scan\&.h>
        #include <unistd\&.h> /* useconds_t */

        nutscan_device_t * nutscan_scan_nut(
                const char * startIP,
                const char * stopIP,
                const char * port,
                useconds_t usec_timeout);

        nutscan_device_t * nutscan_scan_ip_range_nut(
                nutscan_ip_range_list_t * irl,
                const char * port,
                useconds_t usec_timeout);
.fi
.SH "DESCRIPTION"
.sp
The \fBnutscan_scan_nut()\fR and \fBnutscan_scan_ip_range_nut()\fR functions try to detect available NUT services and their associated devices\&. The former issues a NUT request on every IP ranging from \fIstartIP\fR to \fIstopIP\fR, where \fIstartIP\fR is mandatory and \fIstopIP\fR is optional (one \fIstartIP\fR address is scanned if \fIstopIP\fR is NULL); while the latter can walk several IP address ranges represented by a nutscan_ip_range_list_t structure\&.
.sp
Those IP arguments may be either IPv4 or IPv6 addresses or host names\&.
.sp
You MUST call \fBnutscan_init\fR(3) before using this function\&.
.sp
A specific \fIport\fR number may be passed, or NULL to use the default NUT port\&.
.sp
This function waits up to \fIusec_timeout\fR microseconds before considering an IP address does not respond to NUT queries\&.
.SH "RETURN VALUE"
.sp
The \fBnutscan_scan_nut()\fR function returns a pointer to a nutscan_device_t structure containing all found devices or NULL if an error occurs or no device is found\&.
.SH "SEE ALSO"
.sp
\fBnutscan_init\fR(3), \fBnutscan_scan_usb\fR(3), \fBnutscan_scan_xml_http_range\fR(3), \fBnutscan_scan_snmp\fR(3), \fBnutscan_scan_avahi\fR(3), \fBnutscan_scan_ipmi\fR(3), \fBnutscan_display_sanity_check\fR(3), \fBnutscan_display_sanity_check_serial\fR(3), \fBnutscan_display_ups_conf_with_sanity_check\fR(3), \fBnutscan_display_ups_conf\fR(3), \fBnutscan_display_parsable\fR(3), \fBnutscan_new_device\fR(3), \fBnutscan_free_device\fR(3), \fBnutscan_add_option_to_device\fR(3), \fBnutscan_add_device_to_device\fR(3), \fBnutscan_scan_eaton_serial\fR(3), \fBnutscan_init_ip_ranges\fR(3), \fBnutscan_free_ip_ranges\fR(3), \fBnutscan_add_ip_range\fR(3), \fBnutscan_cidr_to_ip\fR(3)