nutscan_scan_nut(3)

nutscan_scan_nut3

Scan network for available nut services.

Usage

        #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);

Overview

The nutscan_scan_nut() and nutscan_scan_ip_range_nut() functions try to detect available NUT services and their associated devices. The former issues a NUT request on every IP ranging from startIP to stopIP, where startIP is mandatory and stopIP is optional (one startIP address is scanned if stopIP is NULL); while the latter can walk several IP address ranges represented by a nutscan_ip_range_list_t structure.

Those IP arguments may be either IPv4 or IPv6 addresses or host names.

You MUST call nutscan_init(3) before using this function.

A specific port number may be passed, or NULL to use the default NUT port.

This function waits up to usec_timeout microseconds before considering an IP address does not respond to NUT queries.

Return value

The nutscan_scan_nut() 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.

Releases

8 releases since Debian 7 (Wheezy); the text changed 5 times.

  1. 7
  2. 8
  3. 9–11
  4. 12
  5. 13
  6. Arch

From nut 2.8.5-2 in Arch Linux 2026-11-01. Parsed by carta from the page's man source.