Net-SNMP

http://www.net-snmp.org/docs/
Admin
A suite of applications used to implement SNMP v1, SNMP v2c, and SNMP v3 using both IPv4 and IPv6....
Tokens:463,978
Snippets:4,100
Trust Score:10
Update:3 months ago
Show doc for...
Tokens:
Raw
### Build and Install Commands

Source: http://www.net-snmp.org/docs/README.win32.html

Standard commands to compile and install the package.

```shell
make
```

```shell
make install
```

--------------------------------

### Build and Install Net-SNMP

Source: http://www.net-snmp.org/docs/README.solaris.html

Standard commands to compile and install the software.

```bash
make
make test  (optional)
make install
/usr/local/net-snmp/bin/perl -V
```

--------------------------------

### Build and Install Net-SNMP

Source: http://www.net-snmp.org/docs/README.solaris.html

Standard commands to compile, test, and install the software.

```bash
make
```

```bash
make test
```

```bash
make install
```

--------------------------------

### Build and Install with nmake

Source: http://www.net-snmp.org/docs/README.win32.html

Execute build, clean, and install targets using nmake after generating configuration files.

```batch
nmake clean
nmake
nmake install
```

```batch
nmake libs_clean
nmake libs
nmake install
```

```batch
nmake perl_clean
nmake perl
nmake perl_test
nmake perl_install
```

--------------------------------

### Run snmpconf basic setup

Source: http://www.net-snmp.org/docs/man/snmpconf.html

Executes the basic setup group to walk the user through initial configuration questions.

```bash
snmpconf -g basic_setup
```

--------------------------------

### Quick Installation Commands

Source: http://www.net-snmp.org/docs/INSTALL.html

Standard sequence of commands to configure, build, and install the Net-SNMP package.

```bash
  1) Run ./configure
     (type "./configure --help" for a quick usage summary.)
     (--prefix=PATH will change the default /usr/local installation path.)
     (see "Compilers and Options" on changing the compiler to use)

  2) Optionally edit include/net-snmp/net-snmp-config.h
     (due to prompting done by the configure script, this is very rarely
      necessary.)

  3) make

  4) Run the next command as root:
  5) make install

  6) configure the agent
     (either using 'snmpconf' or by crafting an snmpd.conf file manually.
      The file 'EXAMPLE.conf' may be a suitable starting point)
```

--------------------------------

### Build Windows Binary Installer

Source: http://www.net-snmp.org/docs/README.win32.html

Steps to build the Net-SNMP Windows installer from the source directory.

```shell
.\build-binary.bat
```

--------------------------------

### Install ExtUtils-FakeConfig

Source: http://www.net-snmp.org/docs/perl-SNMP-README.html

Build and install commands for the ExtUtils-FakeConfig module required for MinGW builds.

```shell
perl Makefile.PL
dmake
dmake install
```

--------------------------------

### Install MinGW dependencies

Source: http://www.net-snmp.org/docs/README.win32.html

Install required libraries for MinGW build using mingw-get.

```bash
mingw-get install msys-libregex msys-libintl msys-libopenssl
mingw-get upgrade msys-libregex msys-libintl msys-libopenssl
```

--------------------------------

### Install agent binary with custom prefixes

Source: http://www.net-snmp.org/docs/FAQ.html

Use this command to specify target and temporary installation locations during the build process.

```bash
make install prefix={target location} INSTALL_PREFIX={temp location}
```

--------------------------------

### Registry Parameter Value Example

Source: http://www.net-snmp.org/docs/README.win32.html

Example of how command-line options are stored as ParamX values in the registry.

```text
HKLM\SYSTEM\CurrentControlSet\Services\
  Net-SNMP Trap Handler\Parameters\Param1 -Lf

HKLM\SYSTEM\CurrentControlSet\Services\
  Net-SNMP Trap Handler\Parameters\Param2 c:/usr/log/snmptrapd.log
```

--------------------------------

### Install NetSNMP::OID module

Source: http://www.net-snmp.org/docs/perl-OID-README.html

Standard commands to build and install the Perl module from source.

```bash
perl Makefile.PL
make
make test
make install
```

--------------------------------

### KeyChange Algorithm Implementation Example

Source: http://www.net-snmp.org/docs/mibs/SNMP-USER-BASED-SM-MIB.txt

Example logic for calculating the delta component using MD5 as the hash algorithm.

```pseudocode
iterations = (lenOfDelta - 1)/16; /* integer division */
              temp = keyOld;
              for (i = 0; i < iterations; i++) {
                  temp = MD5 (temp || random);
                  delta[i*16 .. (i*16)+15] = 
                         temp XOR keyNew[i*16 .. (i*16)+15];
              }
              temp = MD5 (temp || random);
              delta[i*16 .. lenOfDelta-1] = 
                     temp XOR keyNew[i*16 .. lenOfDelta-1];
```

--------------------------------

### Detailed Compilation Steps

Source: http://www.net-snmp.org/docs/INSTALL.html

Comprehensive steps for compiling the package, including testing and installation.

```bash
  1. `cd' to the directory containing the package's source code and type
     `./configure' to configure the package for your system.  If you're
     using `csh' on an old version of System V, you might need to type
     `sh ./configure' instead to prevent `csh' from trying to execute
     `configure' itself.

     Running `configure' takes awhile.  While running, it prints some
     messages telling which features it is checking for.  When it
     completes it prints a short message (also available in configure-summary)
     indicating what functionality will be available when compiled.

  2. If necessary, edit include/net-snmp/net-snmp-config.h (see above).  

  3. Type `make' to compile the package.

  4. Type `make test' which runs a variety of tests to see what functionality
     has been incorporated and if it works.

  5. Type `make install' to install the programs and any data files and
     documentation.
```

--------------------------------

### Define Installed Software Table Structure

Source: http://www.net-snmp.org/docs/mibs/HOST-RESOURCES-MIB.txt

Conceptual table and entry definitions for software installed on the host.

```SMIv2
hrSWInstalledTable OBJECT-TYPE
    SYNTAX     SEQUENCE OF HrSWInstalledEntry
    MAX-ACCESS not-accessible
    STATUS     current
    DESCRIPTION
        "The (conceptual) table of software installed on this
        host."
    ::= { hrSWInstalled 3 }

hrSWInstalledEntry OBJECT-TYPE
    SYNTAX     HrSWInstalledEntry
    MAX-ACCESS not-accessible
    STATUS     current
    DESCRIPTION
        "A (conceptual) entry for a piece of software
        installed on this host.

        As an example of how objects in this table are named,
        an instance of the hrSWInstalledName object might be
        named hrSWInstalledName.96"
    INDEX { hrSWInstalledIndex }
    ::= { hrSWInstalledTable 1 }

HrSWInstalledEntry ::= SEQUENCE {
        hrSWInstalledIndex       Integer32,
        hrSWInstalledName        InternationalDisplayString,
        hrSWInstalledID          ProductID,
        hrSWInstalledType        INTEGER,
        hrSWInstalledDate        DateAndTime
}
```

--------------------------------

### Install Net-SNMP Binary Package

Source: http://www.net-snmp.org/docs/README.solaris.html

Extract the downloaded tarball to the root directory to install binaries and libraries into /usr/local.

```bash
cd /
tar -xvf /usr/local/dist/net-snmp-5.0.9-SunOS_5.8_sun4u.tar
```

--------------------------------

### Generate SNMPv3 Keys Manually

Source: http://www.net-snmp.org/docs/man/snmpd.conf.html

Examples of using localized (-l) or master (-m) keys for SNMPv3 user creation. Note that these examples are for demonstration and should not be used in production.

```text
[these keys are *not* secure but are easy to visually parse for
counting purposes.  Please generate random keys instead of using
these examples]

createUser myuser SHA -l 0x0001020304050607080900010203040506070809 AES -l 0x00010203040506070809000102030405
createUser myuser SHA -m 0x0001020304050607080900010203040506070809 AES -m 0x0001020304050607080900010203040506070809
```

--------------------------------

### Start and Query SNMP Daemons

Source: http://www.net-snmp.org/docs/README.solaris.html

Commands to start Solaris SNMP services and verify the sub-agent integration via snmpget.

```bash
/etc/rc3.d/S76snmpdx start
/etc/rc3.d/S77dmi start
snmpget -v 1 -c whatever localhost sysDescr.0
snmpget -v 1 -c whatever localhost hrSystemUptime.0
```

--------------------------------

### Install Perl SNMP Modules from Source

Source: http://www.net-snmp.org/docs/FAQ.html

Standard procedure for building and installing the Perl SNMP module from the Net-SNMP source tree.

```bash
cd perl
perl Makefile.PL
    (press RETURN when prompted for host and community)
make
make test
make install  (probably as root)
```

--------------------------------

### Install Custom Net-SNMP Binary

Source: http://www.net-snmp.org/docs/README.solaris.html

Extract a custom-built tarball on the target machine.

```bash
cd /
tar -xvf /usr/local/dist/net-snmp-5.4.custom-SunOS_5.8_sun4u.tar
```

--------------------------------

### Test SNMP Connectivity

Source: http://www.net-snmp.org/docs/README.Panasonic_AM3X.txt.html

Use snmpwalk to verify the installation by querying the local agent.

```bash
snmpwalk -v 2c -m ALL -c public -t 100 localhost .1.3 > snmpwalk.txt
more snmpwalk.txt
```

--------------------------------

### Register Service with Logging

Source: http://www.net-snmp.org/docs/README.win32.html

Example of registering the trap daemon with specific logging options.

```shell
snmptrapd -register -Lf c:/usr/log/snmptrapd.log
```

--------------------------------

### View Help Documentation

Source: http://www.net-snmp.org/docs/README.win32.html

Access help information for the Configure script and nmake build targets.

```batch
perl Configure --help
```

```batch
nmake help
```

--------------------------------

### ifStackTable Relationship Example

Source: http://www.net-snmp.org/docs/mibs/ifMIBObjects.html

Example of how sub-layer relationships are represented in the ifStackTable.

```text
  ifStackStatus.x.y=active
```

```text
  ifStackStatus.0.x=active
  ifStackStatus.x.0=active
```

--------------------------------

### Start snmptrapd for Logging

Source: http://www.net-snmp.org/docs/FAQ.html

Commands to start the trap daemon for logging purposes.

```bash
snmptrapd -Ls 7
```

```bash
snmptrapd -f -Lo
```

--------------------------------

### Run Windows Configure Help

Source: http://www.net-snmp.org/docs/FAQ.html

Displays help information for the Windows-specific configuration script.

```bash
Configure --help
```

--------------------------------

### Install MSYS2 Dependencies

Source: http://www.net-snmp.org/docs/README.win32.html

Commands to install necessary build tools and libraries for MinGW-w64 on MSYS2.

```shell
pacman -S make diffutils
```

```shell
pacman -S mingw-w64-i686-gcc mingw-w64-i686-openssl
```

```shell
pacman -S mingw-w64-x86_64-gcc mingw-w64-x86_64-openssl
```

--------------------------------

### Initialize and Run an SNMP Agent

Source: http://www.net-snmp.org/docs/man/snmp_agent_api.html

Demonstrates the standard lifecycle of an SNMP agent, including initialization, role configuration, and the main processing loop.

```c
#include <net-snmp/net-snmp-config.h>
#include <net-snmp/net-snmp-includes.h>
#include <net-snmp/agent/net-snmp-agent-includes.h>

int
main (int argc, char *argv[])
{
  int agentx_subagent = 1;  /* Change this if you're a master agent.  */

  snmp_enable_stderrlog();

  /*  If we're an AgentX subagent...  */
  if (agentx_subagent) {
      /* ...make us an AgentX client.  */
      netsnmp_ds_set_boolean(NETSNMP_DS_APPLICATION_ID,
                             NETSNMP_DS_AGENT_ROLE, 1);
  }

  init_agent("yourappname");

  /*  Initialize your MIB code here.  */
  init_my_mib_code();

  /*  `yourappname' will be used to read yourappname.conf files.  */
  init_snmp("yourappname");

  /*  If we're going to be a SNMP master agent...  */
  if (!agentx_subagent)
      init_master_agent();  /*  Listen on default port (161).  */

  /*  Your main loop here...  */
  while (whatever) {
      /* if you use select(), see snmp_api(3) */
      /*     --- OR ---  */
      agent_check_and_process(0); /* 0 == don't block */
  }

  /*  At shutdown time:  */
  snmp_shutdown("yourappname");
}
```

--------------------------------

### smLaunchStart Definition

Source: http://www.net-snmp.org/docs/mibs/scriptMIB.html

Defines the mechanism for initiating script execution and the associated validation checks required for the operation.

```text
  
10   
**smLaunchStart** |  INTEGER32   
Legal values: 0 .. 2147483647 | Create |  
```

--------------------------------

### Define Example Notifications and Payloads

Source: http://www.net-snmp.org/docs/mibs/NET-SNMP-EXAMPLES-MIB.txt

Defines objects and a notification type for heartbeat signaling examples.

```MIB
netSnmpExampleHeartbeatRate OBJECT-TYPE
    SYNTAX      Integer32
    MAX-ACCESS  accessible-for-notify
    STATUS      current
    DESCRIPTION
        "A simple integer object, to act as a payload for the
         netSnmpExampleHeartbeatNotification.  The value has
         no real meaning, but is nominally the interval (in
         seconds) between successive heartbeat notifications."
::= { netSnmpExampleNotificationObjects 1 }

netSnmpExampleHeartbeatName OBJECT-TYPE
    SYNTAX      SnmpAdminString
    MAX-ACCESS  accessible-for-notify
    STATUS      current
    DESCRIPTION
        "A simple string object, to act as an optional payload
         for the netSnmpExampleHeartbeatNotification.  This varbind
         is not part of the notification definition, so is optional
         and need not be included in the notification payload. 
         The value has no real meaning, but the romantically inclined
         may take it to be the object of the sender's affection,
         and hence the cause of the heart beating faster."
::= { netSnmpExampleNotificationObjects 2 }

netSnmpExampleHeartbeatNotification NOTIFICATION-TYPE
    OBJECTS     { netSnmpExampleHeartbeatRate }
    STATUS      current
    DESCRIPTION
        "An example notification, used to illustrate the
         definition and generation of trap and inform PDUs
         (including the use of both standard and additional
         varbinds in the notification payload).
         This notification will typically be sent every
	 30 seconds, using the code found in the example module
             agent/mibgroup/examples/notification.c"
::= { netSnmpExampleNotificationPrefix 1 }
    
netSnmpExampleNotification OBJECT-TYPE
    SYNTAX      SnmpAdminString
    MAX-ACCESS  accessible-for-notify
    STATUS      obsolete
    DESCRIPTION
        "This object was improperly defined for its original purpose,
         and should no longer be used."
::= { netSnmpExampleNotifications 1 }

END
```

--------------------------------

### Configure Net-SNMP with Kerberos Support

Source: http://www.net-snmp.org/docs/README.krb5.html

Example ./configure command to enable the Kerberos Security Model with appropriate flags for libraries and headers.

```bash
./configure --with-cflags='-I/usr/krb5/include' \
   --with-ldflags='-L/usr/krb5/lib -lkrb5 -lcrypto -lcom_err -R/usr/krb5/lib'
```

--------------------------------

### Send SNMP GET request

Source: http://www.net-snmp.org/docs/man/snmptest.html

Demonstrates sending a GET request for specific OIDs using snmptest.

```text
Variable: system.sysDescr.0
Variable: system.sysContact.0
Variable:
Received Get Response from 128.2.56.220
requestid 0x7D9FCD63 errstat 0x0 errindex 0x0
SNMPv2-MIB::sysDescr.0 = STRING: SunOS testhost 5.9 Generic_112233-02 sun4u
SNMPv2-MIB::sysContact.0 = STRING: x1111

```

--------------------------------

### void netsnmp_init_mib (void)

Source: http://www.net-snmp.org/docs/man/netsnmp_mib_utilities.html

Initializes the MIB reader and reads all settings from the environment.

```APIDOC
## void netsnmp_init_mib (void)

### Description
Initialises the mib reader. Library API routines concerned with MIB files and objects, and OIDs. Reads in all settings from the environment.
```

--------------------------------

### Log SNMP Delta Data to File

Source: http://www.net-snmp.org/docs/man/snmpdelta.html

Example demonstrating the use of multiple options including file logging with the -Cl flag.

```bash
$ snmpdelta -c public -v 1 -Ct -Cs -CS -Cm -Cl -Cp 60 -CP 60
  interlink.sw.net.cmu.edu .1.3.6.1.2.1.2.2.1.16.3 .1.3.6.1.2.1.2.2.1.16.4
fi
```

--------------------------------

### Performing SNMP GET Operations

Source: http://www.net-snmp.org/docs/perl-SNMP-README.html

Retrieves values using SNMP GET, supporting both synchronous and asynchronous modes.

```perl
get(<vars>[,<callback>])
```

--------------------------------

### Configure Net-SNMP Build

Source: http://www.net-snmp.org/docs/README.solaris.html

Example command to generate the configuration script for the Net-SNMP build process.

```bash
./configure --with-mib-modules="ucd-snmp/lmSensors ucd-snmp/diskio \
   smux mibII/mta_sendmail" --with-cc=gcc
```

--------------------------------

### Define Installed Software Tracking Objects

Source: http://www.net-snmp.org/docs/mibs/HOST-RESOURCES-MIB.txt

Definitions for tracking the last change and update times of the installed software table.

```SMIv2
hrSWInstalledLastChange OBJECT-TYPE
    SYNTAX     TimeTicks
    MAX-ACCESS read-only
    STATUS     current
    DESCRIPTION
        "The value of sysUpTime when an entry in the
        hrSWInstalledTable was last added, renamed, or
        deleted.  Because this table is likely to contain many
        entries, polling of this object allows a management
        station to determine when re-downloading of the table
        might be useful."
    ::= { hrSWInstalled 1 }

hrSWInstalledLastUpdateTime OBJECT-TYPE
    SYNTAX     TimeTicks
    MAX-ACCESS read-only
    STATUS     current
    DESCRIPTION
        "The value of sysUpTime when the hrSWInstalledTable
        was last completely updated.  Because caching of this
        data will be a popular implementation strategy,
        retrieval of this object allows a management station
        to obtain a guarantee that no data in this table is
        older than the indicated time."
    ::= { hrSWInstalled 2 }
```

--------------------------------

### Create an initial SNMPv3 user

Source: http://www.net-snmp.org/docs/README.snmpv3.html

Use the net-snmp-config utility to generate a new user with read/write access.

```bash
net-snmp-config --create-snmpv3-user -a "my_password" myuser
```

--------------------------------

### Manual Perl Module Build

Source: http://www.net-snmp.org/docs/INSTALL.html

Sequence of commands to build and install Perl modules manually after the main package is installed.

```bash
cd perl
perl Makefile.PL
make
make test
make install (as root)
```

--------------------------------

### Define smLaunchTable and smLaunchEntry

Source: http://www.net-snmp.org/docs/mibs/DISMAN-SCRIPT-MIB.txt

Defines the table structure and entry index for script launch configurations.

```mib
smLaunchTable OBJECT-TYPE
    SYNTAX      SEQUENCE OF SmLaunchEntry
    MAX-ACCESS  not-accessible
    STATUS      current
    DESCRIPTION
        "This table lists and describes scripts that are ready
         to be executed together with their parameters."
    ::= { smRunObjects 1 }

smLaunchEntry OBJECT-TYPE
    SYNTAX      SmLaunchEntry
    MAX-ACCESS  not-accessible
    STATUS      current
    DESCRIPTION
        "An entry describing a particular executable script."
    INDEX { smLaunchOwner, smLaunchName }
    ::= { smLaunchTable 1 }
```

--------------------------------

### Start and Test Net-SNMP Daemon

Source: http://www.net-snmp.org/docs/README.solaris.html

Launch the daemon and verify functionality using standard SNMP tools.

```bash
/usr/local/sbin/snmpd
snmpget -v 1 -c whatever localhost sysUpTime.0
snmpwalk -v 2c -c whatever -m ALL localhost .1.3 | more
```

--------------------------------

### init_agent

Source: http://www.net-snmp.org/docs/man/netsnmp_library.html

Initializes the agent and sets the application's configuration file in the default storage space.

```APIDOC
## int init_agent (const char * app)

### Description
Initializes the agent. Calls into init_agent_read_config to set the app's configuration file in the appropriate default storage space (NETSNMP_DS_LIB_APPTYPE). This must be called before calling init_snmp.

### Parameters
- **app** (const char *) - Required - The configuration file to be read in.

### Returns
- **int** - Returns non-zero on failure and zero on success.
```

--------------------------------

### Start snmpd with Windows extension exclusions

Source: http://www.net-snmp.org/docs/README.win32.html

Starts the Net-SNMP agent while excluding modules that overlap with default Windows extensions.

```bash
snmpd.exe -I-udp,udpTable,tcp,tcpTable,icmp,ip,interfaces,snmp_mib,system_mib,sysORTable
```

--------------------------------

### Manually Initialize Loader Configuration

Source: http://www.net-snmp.org/docs/README.solaris.html

Create the necessary directory structure and configuration file if crle fails.

```bash
mkdir /var/ld
cd /var/ld
ln -s . 32
mkdir sparcv9
chgrp bin sparcv9
ln -s sparcv9 64
touch ld.config

crle -c /var/ld/ld.config -l /usr/lib:/usr/local/ssl/lib
```

--------------------------------

### Install Perl Tk module via CPAN

Source: http://www.net-snmp.org/docs/FAQ.html

Use this command to install the required Tk Perl package for tkmib functionality.

```bash
perl -MCPAN -e shell ; "install Tk"
```

--------------------------------

### Basic mib2c execution

Source: http://www.net-snmp.org/docs/man/mib2c.conf.html

Example command to run the mib2c utility with a specific configuration file.

```shell
% mib2c -c mib2c.test.conf internet
```

--------------------------------

### Configure Access Control for Contexts

Source: http://www.net-snmp.org/docs/FAQ.html

Examples of access control lines for specific or all contexts within the configuration file.

```text
access {group} "my_context" any noauth exact  ......
```

```text
access {group} ""           any noauth prefix ......
```

--------------------------------

### Install RPM package ignoring dependencies

Source: http://www.net-snmp.org/docs/FAQ.html

Use this command to force an RPM installation when dependencies are met manually but not registered in the RPM database.

```bash
rpm -i --nodeps {package}
```

--------------------------------

### Performing Formatted SNMP GET Operations

Source: http://www.net-snmp.org/docs/perl-SNMP-README.html

Retrieves values using SNMP GET and formats them based on session handlers. Asynchronous operation is not supported.

```perl
fget(<vars>[,<callback>])
```

--------------------------------

### Install Perl SNMP Module via CPAN

Source: http://www.net-snmp.org/docs/FAQ.html

Alternative installation method using the CPAN shell. This method is less reliable and requires a compatible Net-SNMP library version.

```bash
perl -MCPAN -e shell ; "install SNMP"
```

--------------------------------

### init_snmp(char *name)

Source: http://www.net-snmp.org/docs/man/snmp_agent_api.html

Initializes the SNMP library and reads configuration files based on the provided application name.

```APIDOC
## init_snmp(char *name)

### Description
Initializes the SNMP library and reads configuration files (e.g., snmpd.conf) to configure the application.

### Parameters
- **name** (char*) - Required - The application name used to identify configuration files.
```

--------------------------------

### Run snmpconf with default settings

Source: http://www.net-snmp.org/docs/man/snmpconf.html

Starts the interactive configuration tool in its default mode.

```bash
snmpconf
```

--------------------------------

### Define netSnmpPassGauge scalar

Source: http://www.net-snmp.org/docs/mibs/netSnmpPassExamples.html

Example Gauge object.

```text
Example Gauge object.
```

--------------------------------

### Start SNMP Daemon

Source: http://www.net-snmp.org/docs/README.Panasonic_AM3X.txt.html

Commands to navigate to the binary directory and execute the snmpd daemon.

```bash
cd /usr/local/sbin
./snmpd
```

--------------------------------

### Define netSnmpPassTimeTicks scalar

Source: http://www.net-snmp.org/docs/mibs/netSnmpPassExamples.html

Example timetick object.

```text
Example timetick object.
```
Tokens:
Raw