glpi-netdiscovery(1)

GLPI-NETDISCOVERY(1) User Contributed Perl Documentation GLPI-NETDISCOVERY(1)

NAME

glpi-netdiscovery - Standalone network discovery

SYNOPSIS

glpi-netdiscovery [options] --first <address> --last <address>

  Options:
    --host <ADDRESS>       Host IP address to scan or IP range first address
    --first <ADDRESS>      IP range first address
    --last <ADDRESS>       IP range last address
    --port <PORT[,PORT2]>  SNMP port (161)
    --protocol <PROT[,P2]> SNMP protocol/domain (udp/ipv4)
    --community <STRING>   SNMP community string (public)
    --v1                   select SNMP version 1 (the default)
    --v2c                  select SNMP version 2c (1 by default)
    --credentials <STRING> SNMP credentials (version:1,community:public)
    --timeout <TIME>       SNMP timeout, in seconds (1)
    --retries              SNMP requets maximum retries (0)
    --backend-collect-timeout <TIME>
                           base expiration timeout, in seconds (180)
    --entity <ENTITY>      GLPI entity
    --threads <COUNT>      number of discovery threads (1)
    --glpi-version VERSION set targeted glpi version to enable supported features
    --control              output control messages
    --file <FILE>          snmpwalk input file
    -i --inventory         chain with netinventory task for discovered devices
    -s --save <FOLDER>     base folder where to save discovery and inventory xmls
                            - netdiscovery xmls will go in <FOLDER>/netdiscovery
                            - netinventory xmls will go in <FOLDER>/netinventory
    --debug                debug output
    -h --help              print this message and exit
    --version              print the task version and exit

DESCRIPTION

glpi-netdiscovery can be used to run a network discovery task without a GLPI server.

OPTIONS

--first|--host ADDRESS
Set the first IP address of the network range to scan.
--last ADDRESS
Set the last IP address of the network range to scan.

If not set, it is set with the value of the --first or --host option.

--port PORT[,PORT2]
List of ports to try, defaults to: 161

Set it to 161,16100 to first try on default port and then on 16100.

--protocol PROTOCOL[,PROTOCOL2]
List of protocols to try, defaults to: udp/ipv4

Possible values are: udp/ipv4,udp/ipv6,tcp/ipv4,tcp/ipv6

--file FILE
Run an offline discovery against snmpwalk output, stored in the given file.

If no host or first ip is provided, ip is set to emulate 1.1.1.1 ip scan.

--community STRING
Use given string as SNMP community (assume SNMPv1). This option can be used multiple times to try different communities.
--v1
Use SNMP v1. This is the default, but you can use the option to try SNMP v1 & SNMP v2c.
--v2c
Use SNMP v2c. Can be used in combination with --v1 to try the 2 versions.
--credentials STRING
Use given string as SNMP credentials specification. This specification is a comma-separated list of key:value authentication parameters, such as:
  • version:2c,community:public
  • version:3,username:admin,authpassword:s3cr3t,privpassword:s3cr3t
  • etc.

Supported keys are:

version with value set to 1, 2c or 3

In the case version is set to 1 or 2c:

community

In the case version is set to 3:

  • username (required)
  • authpassword
  • authprotocol with value set to md5 (the default if not set) or sha
  • privpassword (required if authpassword is set)
  • privprotocol with value set to des (the default if not set), aes or 3des
--timeout TIME
Set SNMP timeout, in seconds.
--retries NUMBER
Set maximum number of retries a SNMP request can be sent again after no response.
--backend-collect-timeout TIME
Set base expiration timeout, in seconds. Global task expiration will depend on the number of ips.
--entity ENTITY
Set GLPI entity.
--threads COUNT
Use given number of inventory threads.
--control
Output server-agent control messages, in addition to inventory result itself.
--debug
Turn the debug mode on. Multiple usage allowed, for additional verbosity.

EXAMPLES

Run a discovery against a network range, using SNMP version 1:

    $> glpi-netdiscovery --first 192.168.0.1 --last 192.168.0.254 --community public

Run a discovery against a network range, using multiple SNMP credentials:

    $> glpi-netdiscovery --first 192.168.0.1 --last 192.168.0.254 \
    --credentials version:2c,community:public \
    --credentials version:3,username:admin,authpassword:s3cr3t,privpassword:s3cr3t

Emulate discovery using a snmpwalk file:

    $> glpi-netdiscovery --file device.walk
2026-06-24 perl v5.38.4