API Guide

Table 140. Monitoring API methods
Method Description
get_driver
This function creates and returns the driver instance based on the
input details including driver name and on successful connection.
User can specify a particular Driver type [e.g iDRAC, CMC, F10] and
get the driver instance back without looping through all the drivers
present inside omdrivers folder.
Parameters: driver_en Device driver enumerator. For example: iDRAC :
sd.driver_enum.iDRAC, CMC, Compellent.
ipaddr
Device IP address or the hostname.
creds
Device credentials - bundle of credentials for nding the device
driver.
protopref
The preferred protocol to be used if the device supports the
protocol.
pOptions
Other protocol specic parameters options to be passed. For
example: SNMP timeout, retry, port.
Returns The driver handle for further conguration or monitoring.
find_driver
This function creates and returns the driver instance based on the
input details without any specic driver name and on successful
connection. It queries with the given device by trying each available
driver in omdrivers directory until it nds a appropriate driver. Once
the driver is found, it returns the driver instance.
Parameters: ipaddr Device IP address or the hostname.
creds
Device credentials.
protopref
The preferred protocol to be used if the device supports the
protocol.
pOptions
Other protocol specic parameters options to be passed. For
example: SNMP timeout, retry, port.
Returns The device handle for further conguration or monitoring.
Table 141. Base Driver
Method Description
get_entityjson
Returns the complete entity details in JSON format.
Returns True if successful
get_partial_entityjson
Return the entity details in JSON format, after applying the
ltration criteria.
Paramaters: en List of Components of the device whose JSON is required
Returns JSON only the components passed in en.
60 Getting Started