CoreAsp.SnmpRqst

Этот объект используется для отправки запросов SNMP на удаленное устройство.

Команды Initialize или Initialize2 следует вызывать до любых других элементов.

CoreAsp.SnmpRqst выполняется в виде трехэтапного процесса:

  1. Осуществляется вызов команд Initialize или Initialize2 для инициализации объекта на конкретном устройстве.
  2. Задаются необязательные параметры, такие как значение тайм-аута, порт и т.п.
  3. Выполняется любое количество операций Get, GetNext, GetMultiple или Set для устройства. Эти операции возвращают объект ComSnmpResponse, который включает состояние операции и значение непосредственно (используйте Failed/GetValue/GetOid) или в виде списка связанных переменных SNMP, возвращенных как данные XML (используйте GetPayload).

    Метод

    Описание

    Возвращает

    Инициализировать(
    nDeviceID
    )

    Инициализирует объект SnmpRqst для устройства с ID, указанным в nDeviceID. Если устройство не настроено с допустимыми учетными данными SNMP, операция не выполняется.

    • nDeviceID. Положительное целое число, соответствующее ID устройства, настроенного в WhatsUp Gold.

    Tip: В мониторах активного сценария и производительности сценария ID устройства, которому назначен монитор, можно получить из контекстного объекта:
    Context.GetProperty("DeviceID")

    Объект ComResult

    Initialize2(
    sDeviceAddress,
    nCredentialID
    )

    Инициализирует объект SnmpRqst , создавая подключение к устройству при помощи IP-адреса устройства и учетных данных, которые хранятся в WhatsUp Gold. Этот метод можно использовать для инициализации SnmpRqst для устройства, не настроенного в WhatsUp Gold, если учетные данные устройства настроены в библиотеке учетных данных.

    • sDeviceAddress. Адрес или имя узла запрашиваемого устройства.
    • nCredentialID. Положительное целое число, соответствующее ID учетных данных, настроенных в WhatsUp Gold.

    Объект ComResult

    SetTimeoutMs(
    nTimeoutInMilliSec
    )

    Устанавливает значение тайм-аута в миллисекундах. Если не указан, стандартный тайм-аут составляет 2000 миллисекунд.

    • nTimeoutInMilliSec. Положительное целое число, представляющее количество миллисекунд, после которых прекращаются неразрешенные запросы.

      Note: Этот метод возвращает значение, если метод возвращает сбой и требует переменную объекта для получения значения. Например: varComResult = SnmpRqst.SetTimeoutMs(5000); где varComResult - это объект ComResult.

    Объект ComResult

    SetNumRetries(
    nNumberRetries
    )

    Устанавливает количество попыток запроса с тайм-аутом. Если не указано, запрос, возвративший сбой, повторяется один раз.

    • nNumberRetries. Положительное целое число, представляющее количество попыток для запросов с тайм-аутом.

    Tip: Для отправки только одного пакета SNMP в запросе, установите nNumberRetries на 0 (ноль).

    Объект ComResult

    SetPort(
    nPort
    )

    Устанавливает порт TCP/IP для использования SnmpRqst. Если не указан, используется порт 161.

    • nPort. Положительное целое число от 1 до 65535, соответствующее используемому порту.

    Объект ComResult

    Get(
    sOid
    )

    Выдает команду SNMP Get для получения значения указанного объекта.

    • sOid. Строка, содержащая допустимый OID.

    Объект ComSnmpResponse

    GetNext(
    sOid
    )

    Выдает команду SNMP GetNext для получения значения объекта, следующего за указанным в словарном порядке.

    • sOid. Строка, содержащая допустимый OID.

    Объект ComSnmpResponse

    GetMultiple(
    sListOfOids
    )

    Выдает команду SNMP Get для каждого указанного объекта. GetMultiple отправляет все команды в одном блоке данных протокола SNMP, что более эффективно, чем отправка нескольких независимых команд Get.

    • sListOfOids. Список допустимых OID, разделенных запятой.

    Объект ComSnmpResponse

    Set(
    sOid,
    sType,
    sValue
    )

    Выдает команду SNMP Set для установки значения OID на устройстве.

    • sOid. Строка, содержащая допустимый OID для объекта, которому необходимо установить значение.
    • sType. Отдельный символ, соответствующий типу устанавливаемого значения.

      i = целое число

      u = целое число без знака

      s = строка

      x = шестнадцатеричная строка

      d = десятичная строка

      n = пустой объект

      o = ID объекта

      t = метки времени

      a = IPv4-адрес

      b = биты

    • sValue. Строка, содержащая устанавливаемое значение.

    Объект ComSnmpResponse

Note: Функция "Set" не работает, если объект MIB и строка сообщества устройства имеют права доступа для записи и чтения.

См. также

Использование SNMP API

CoreAsp.ComResult

CoreAsp.ComSnmpResponse

Примеры сценариев использования SNMP API

Устранение неполадок SNMP API