API Guide

Table 147. Monitoring API methods (continued)
creds
Device credentials - bundle of credentials for finding the
device driver.
protopref
The preferred protocol to be used if the device supports the
protocol.
pOptions
Other protocol specific parameters options to be passed. For
example: SNMP timeout, retry, port.
Returns The driver handle for further configuration or monitoring.
find_driver
This function creates and returns the driver instance based
on the input details without any specific driver name and on
successful connection. It queries with the given device by
trying each available driver in omdrivers directory until it
finds 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 specific parameters options to be passed. For
example: SNMP timeout, retry, port.
Returns The device handle for further configuration or monitoring.
Table 148. 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
filtration criteria.
Paramaters: en List of Components of the device whose JSON is required
Returns JSON only the components passed in en.
Table 149. Base Driver Properties
Method Description
driver_enum
Returns an python enumeration of the available drivers in the
system.
ComponentEnum
Returns the list of components supported for the device.
ContainmentTree
Returns the containment tree of iDRAC.
device_type
Returns the type of this device.
API to setup share
The following section provides information about the network share.
Setting up a remote network share
To setup a network file share run the following command:
Getting Started
49