1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
|
'\" t
.\" Title: nutscan_scan_xml_http_range
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 08/08/2025
.\" Manual: NUT Manual
.\" Source: Network UPS Tools 2.8.4
.\" Language: English
.\"
.TH "NUTSCAN_SCAN_XML_HTT" "3" "08/08/2025" "Network UPS Tools 2\&.8\&.4" "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_xml_http_range \- Scan network for XML/HTTP devices\&.
.SH "SYNOPSIS"
.sp
.nf
#include <nut\-scan\&.h>
#include <unistd\&.h> /* useconds_t */
nutscan_device_t * nutscan_scan_xml_http_range(
const char * start_ip,
const char * end_ip,
useconds_t usec_timeout,
nutscan_xml_t * sec)
nutscan_device_t * nutscan_scan_ip_range_xml_http(
nutscan_ip_range_list_t * irl,
useconds_t usec_timeout,
nutscan_xml_t * sec)
.fi
.SH "DESCRIPTION"
.sp
The \fBnutscan_scan_xml_http_range()\fR and \fBnutscan_scan_ip_range_xml_http()\fR functions try to detect NUT compatible XML/HTTP devices\&.
.sp
If \fIstart_ip\fR for the former or \fIirl\fR for the latter are NULL, the respective function does this by issuing a broadcast message on all currently configured network interfaces\&.
.sp
Otherwise, the former queries every IP ranging from \fIstart_ip\fR to \fIstop_ip\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
It waits up to \fIusec_timeout\fR microseconds for a response from potential devices\&.
.sp
You MUST call \fBnutscan_init\fR(3) before using this function\&.
.SH "RETURN VALUE"
.sp
The \fBnutscan_scan_xml_http_range()\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_snmp\fR(3), \fBnutscan_scan_nut\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)
|
