Dell EMC OpenManage Python Software Development Kit Version 1.1 API Reference Guide

PDF

OMPSDK Infrastructure

This section provides information to initialize to OMPSDK infrastructure.

Initialization of OMPSDK Infrastructure

Run the following command to initialize the OMPSDK infrastructure

sdkinfra

importPath

The above two methods initialize the SDK Infrastructure and loads the device drivers such as iDRAC, CMC, F10 etc present in the path <python_lib> omdrivers.

Table 1. Drivers list. The following table describes the method name and the responsibility of the methods.
Method	Description
`importPath`	This function reads all the driver files that exist in the omdrivers directory.

Table 2. Monitoring API methods. The following table describes the method name and the responsibility of the 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 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 3. Base Driver. The following commands describes the various properties and their responsibility.
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 4. Base Driver Properties. The following commands describes the various properties and their responsibility.
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.