SnmpHelper Class Documentation

Introduction

The SnmpHelper class is a part of the EonaCat.Snmp library and provides helper methods for performing SNMP (Simple Network Management Protocol) operations. This class allows you to send SNMP requests, retrieve SNMP variables, and interact with SNMP managers and agents. The SnmpHelper class provides a set of methods for performing SNMP operations asynchronously. It includes methods for sending SNMP requests, retrieving SNMP variables, and sending SNMP traps and informs.

Methods

GetRequestAsync

public async Task<IList<Variable>> GetRequestAsync(string oid, Version version = Version.V2, Snmp3Properties snmp3Properties = null, int timeoutInMilliSeconds = 5000)

• Description: Sends an SNMP Get Request asynchronously to retrieve a single OID value.
• Parameters:
  • oid (string): The Object Identifier (OID) of the variable to retrieve.
  • version (Version, optional): The SNMP version to use (default is Version 2).
  • snmp3Properties (Snmp3Properties, optional): Optional SNMPv3 properties for authentication and privacy.
  • timeoutInMilliSeconds (int, optional): The timeout for the request in milliseconds (default is 5000ms).
• Returns:
  • Task<IList<Variable>>: A list of Variable objects containing the retrieved values.

GetTableRequest

public Variable[,] GetTableRequest(string oid, Version version = Version.V2, int timeoutInMilliSeconds = 5000, int maxRepetitions = 50)

• Description: Retrieves an SNMP table using a Get-Table request for a specified Object Identifier (OID) and SNMP version.
• Parameters:
  • oid (string): The root OID of the table to retrieve.
  • version (Version, optional): The SNMP protocol version to use (default is SNMP Version 2).
  • timeoutInMilliSeconds (int, optional): The timeout for the request in milliseconds (default is 5000 milliseconds).
  • maxRepetitions (int, optional): The maximum repetitions for the request (default is 50).
• Returns:
  • Variable[,]: A two-dimensional array of Variable objects representing the retrieved SNMP table, where the first dimension represents rows, and the second dimension represents columns.

GetNextRequestAsync

public async Task<IList<Variable>> GetNextRequestAsync(string oid, Version version = Version.V2, int requestId = -1, int messageId = -1, int timeoutInMilliSeconds = 5000, Snmp3Properties snmp3Properties = null)

• Description: Asynchronously performs an SNMP Get-Next request for the specified Object Identifier (OID) or a list of OIDs.
• Parameters:
  • oid (string): The Object Identifier (OID) for which to perform the Get-Next request.
  • version (Version, optional): The SNMP protocol version to use (default is SNMP Version 2).
  • requestId (int, optional): The SNMP request ID to use (default is -1, allowing automatic assignment).
  • messageId (int, optional): The SNMP message ID to use (default is -1, allowing automatic assignment).
  • timeoutInMilliSeconds (int, optional): The timeout for the request in milliseconds (default is 5000 milliseconds).
  • snmp3Properties (Snmp3Properties, optional): The SNMPv3 properties if using SNMPv3 (default is null).
• Returns:
  • Task<IList<Variable>>: A list of Variable objects representing the SNMP variables retrieved in response to the Get-Next request.

WalkRequestAsync

public async Task<IList<Variable>> WalkRequestAsync(string oid, Version version = Version.V2, WalkMode walkMode = WalkMode.SubTree, int maxRepetitions = 50, int timeoutInMilliSeconds = 30000, Snmp3Properties snmp3Properties = null)

• Description: Performs an SNMP walk request asynchronously to retrieve SNMP variables in a tree-like fashion.
• Parameters:
  • oid (string): The Object Identifier (OID) representing the starting point of the walk.
  • version (Version, optional): The SNMP protocol version to use (default is SNMP Version 2).
  • walkMode (WalkMode, optional): The walk mode for traversing the SNMP tree (default is SubTree).
  • maxRepetitions (int, optional): The maximum number of repetitions for bulk requests (default is 50).
  • timeoutInMilliSeconds (int, optional): The timeout for the request in milliseconds (default is 30000 milliseconds).
  • snmp3Properties (Snmp3Properties, optional): The SNMPv3 properties if using

SNMPv3 (default is null).

• Returns:
  • Task<IList<Variable>>: A list of Variable objects containing the retrieved SNMP variables.

WalkBulkRequestAsync

public async Task<IList<Variable>> WalkBulkRequestAsync(string oid, Version version = Version.V2, int maxRepetitions = 50, int timeoutInMilliSeconds = 30000, Snmp3Properties snmp3Properties = null)

• Description: Performs an SNMP bulk walk request asynchronously to retrieve SNMP variables in a tree-like fashion.
• Parameters:
  • oid (string): The Object Identifier (OID) representing the starting point of the walk.
  • version (Version, optional): The SNMP protocol version to use (default is SNMP Version 2).
  • maxRepetitions (int, optional): The maximum number of repetitions for bulk requests (default is 50).
  • timeoutInMilliSeconds (int, optional): The timeout for the request in milliseconds (default is 30000 milliseconds).
  • snmp3Properties (Snmp3Properties, optional): The SNMPv3 properties if using SNMPv3 (default is null).
• Returns:
  • Task<IList<Variable>>: A list of Variable objects containing the retrieved SNMP variables.

SendTrapRequestV1Async

public async Task SendTrapRequestV1Async(string ipAddress, string community, TrapV1 trapV1)

• Description: Sends an SNMPv1 Trap asynchronously to the specified IP address with the given community string and SNMPv1 trap data.
• Parameters:
  • ipAddress (string): The IP address of the SNMP manager to which the trap is sent.
  • community (string): The SNMP community string to use.
  • trapV1 (TrapV1): The SNMPv1 trap data to send.
• Returns:
  • Task: An asynchronous task that represents the sending of the SNMPv1 trap.

SendTrapRequestV2Async

public async Task SendTrapRequestV2Async(string ipAddress, Trap trapV2)

• Description: Sends an SNMPv2c Trap asynchronously to the specified IP address with the given SNMPv2c trap data.
• Parameters:
  • ipAddress (string): The IP address of the SNMP manager to which the trap is sent.
  • trapV2 (TrapV2): The SNMPv2c trap data to send.
• Returns:
  • Task: An asynchronous task that represents the sending of the SNMPv2c trap.

SendTrapRequestV3Async

public async Task SendTrapRequestV3Async(string ipAddress, Trap trapV3)

• Description: Sends an SNMPv3 Trap asynchronously to the specified IP address with the given SNMPv3 trap data.
• Parameters:
  • ipAddress (string): The IP address of the SNMP manager to which the trap is sent.
  • trapV3 (TrapV3): The SNMPv3 trap data to send.
• Returns:
  • Task: An asynchronous task that represents the sending of the SNMPv3 trap.

SendInformRequestAsync

public async Task SendInformRequestAsync(string ipAddress, string community, TrapV2 informV2)

• Description: Sends an SNMP Inform request asynchronously to the specified IP address with the given community string and SNMPv2c Inform data.
• Parameters:
  • ipAddress (string): The IP address of the SNMP manager to which the Inform request is sent.
  • community (string): The SNMP community string to use.
  • informV2 (TrapV2): The SNMPv2c Inform data to send.
• Returns:
  • Task: An asynchronous task that represents the sending of the SNMP Inform request.

GetBulkRequestAsync

public async Task<IList<Variable>> GetBulkRequestAsync(string oid, Version version = Version.V2, Snmp3Properties snmp3Properties = null, int maxRepetitions = 50, int timeoutInMilliSeconds = 5000)

• Description: Sends an SNMP GetBulk request asynchronously to retrieve multiple SNMP variables.
• Parameters:
  • oid (string): The Object Identifier (OID) for which to perform the GetBulk request.
  • version (Version, optional): The SNMP protocol version to use (default is SNMP Version 2).
  • snmp3Properties (Snmp3Properties, optional): The SNMPv3 properties if using SNMPv3 (default is null).
  • maxRepetitions (int, optional): The maximum number of repetitions for bulk requests (default is 50).
  • timeoutInMilliSeconds (int, optional): The timeout for the request in milliseconds (default is 5000 milliseconds).
• Returns:
  • Task<IList<Variable>>: A list of Variable objects containing the retrieved SNMP variables.

SetRequestAsync

public async Task SetRequestAsync(string oid, Version version = Version.V2, Snmp3Properties snmp3Properties = null, IList<Variable> variables = null, int timeoutInMilliSeconds = 5000)

• Description: Sends an SNMP Set Request asynchronously to set the values of SNMP variables.
• Parameters:
  • oid (string): The Object Identifier (OID) of the variable to set.
  • version (Version, optional): The SNMP protocol version to use (default is SNMP Version 2).
  • snmp3Properties (Snmp3Properties, optional): The SNMPv3 properties if using SNMPv3 (default is null).
  • variables (IList<Variable>, optional): A list of Variable objects representing the variables to set (default is null).
  • timeoutInMilliSeconds (int, optional): The timeout for the request in milliseconds (default is 5000 milliseconds).

Additional Notes

• SNMPv3 authentication and privacy settings can be configured using the Snmp3Properties parameter in methods that support SNMPv3.
• Error handling is not provided in the method signatures. It is recommended to handle exceptions and errors according to your application's requirements.

Example Usage

Here is an example of how to use the SnmpHelper class to perform an SNMP Get Request asynchronously:

using EonaCat.Snmp;
using EonaCat.Snmp.Exceptions;
using EonaCat.Snmp.Extensions.Message;
using EonaCat.Snmp.Models;
using EonaCat.Snmp.Models.Messages;
using EonaCat.Snmp.Models.Types;
using EonaCat.Snmp.Security.PrivacyProvider;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Net;
using System.Security.Cryptography;
using System.Text;
using System.Threading.Tasks;

class Program
{
    static async Task Main(string[] args)
    {
        // Create an instance of SnmpHelper
        var snmpHelper = new SnmpHelper();

        try
        {
            // Perform an SNMP Get Request to retrieve the value of a specific OID
            var oid = "1.3.6.1.2.1.1.1.0"; // SysDescr
            IList<Variable> result = await snmpHelper.GetRequestAsync(oid);

            // Print the retrieved variables
            foreach (var variable in result)
            {
                Console.WriteLine($"{variable.Id} ({variable.Type}): {variable.Data}");
            }
        }
        catch (SnmpTimeoutException ex)
        {
            Console.WriteLine($"SNMP request timed out: {ex.Message}");
        }
        catch (SnmpException ex)
        {
            Console.WriteLine($"SNMP error: {ex.Message}");
        }
        catch (Exception ex)
        {
            Console.WriteLine($"An error occurred: {ex.Message}");
        }
    }
}

In this example, we perform an SNMP Get Request to retrieve the value of the SysDescr OID (1.3.6.1.2.1.1.1.0). The retrieved variables are then printed to the console. Be sure to handle exceptions and errors according to your application's requirements.