Default language.

Important This documentation space contains information about the SaaS version of BMC Helix Discovery. If you are using the on-premises version of BMC Helix Discovery, see BMC Helix Discovery 25.2 (On-Premises).

discovery.snmpGet


discovery.snmpGet(target, oid_table, [binary_oid_list])


Performs an SNMP query on the target and returns a DiscoveredSNMP node.

The oid_table is a table that lists the SNMP OIDs to retrieve, mapped to the attribute names to set. Binary data (SNMP octet strings with embedded nuls) such as IP or MAC addresses must be flagged before they can be recovered correctly. The optional binary_oid_list parameter (available in BMC Discovery 10.0 and later) is a list of OIDs that contain binary data. For example:



*table* oids 1.0
 "1.3.6.1.2.1.1.1" -> "one";
 "1.3.6.1.2.3.4.5" -> "two";
*end table*;

DiscoveredSNMPnode := discovery.snmpGet(target, oids, ["1.3.6.1.2.3.4.5"]);

When binary data is successfully retrieved, you can only use the binary functions to process the data.

The call succeeds if any of the requested OIDs are available; the attributes corresponding to any OIDs that were not available are not set on the DiscoveredSNMP node. If none of the OIDs are available, the discovery request fails and the snmpGet function returns none.


The target node can be one of the following:

  • DeviceInfo
  • DirectoryListing
  • DiscoveryAccess
  • FileSystemList
  • FQDNList
  • HBAInfoList
  • Host
  • HostInfo
  • IntegrationResult
  • InterfaceList
  • NetworkConnectionList
  • NetworkDevice
  • ProcessList
  • RegistryListing
  • ServiceList
  • SQLResultRow
  • DiscoveredAggregatedPorts
  • DiscoveredAggregatedPortsList
  • DiscoveredATMVirtualCircuit
  • DiscoveredATMVirtualCircuitList
  • DiscoveredATMVirtualPath
  • DiscoveredATMVirtualPathList
  • DiscoveredBridge
  • DiscoveredBridgeList
  • DiscoveredCard
  • DiscoveredCardList
  • DiscoveredChassis
  • DiscoveredChassisList
  • DiscoveredCommandResult
  • DiscoveredDevicePort
  • DiscoveredDevicePortList
  • DiscoveredDirectoryEntry
  • DiscoveredFile
  • DiscoveredFileSystem
  • DiscoveredFQDN
  • DiscoveredFrameRelayDLCI
  • DiscoveredFrameRelayDLCIList
  • DiscoveredFrameRelayLMI
  • DiscoveredFrameRelayLMIList
  • DiscoveredHBA
  • DiscoveredListeningPort
  • DiscoveredNeighbours
  • DiscoveredNetworkConnection
  • DiscoveredNetworkDevice
  • DiscoveredNetworkInterface
  • DiscoveredPackages
  • DiscoveredPatches
  • DiscoveredProcess
  • DiscoveredRegistryEntry
  • DiscoveredRegistryValue
  • DiscoveredService
  • DiscoveredSNMP
  • DiscoveredSNMPRow
  • DiscoveredSNMPTable
  • DiscoveredVLAN
  • DiscoveredVLANList
  • DiscoveredWMI
  • DiscoveredWMIQuery


 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*