API Guide

OpenManage Python SDK API introduction
OpenManage Python SDK (OMPSDK) API Module allows data center and IT administrators to automate and orchestrate the
provisioning, configuration, deployment, and update of Dell EMC PowerEdge Servers (12th generation of PowerEdge servers
and later) by using the management automation capabilities in-built into the integrated Dell remote access controller (iDRAC).
This product evolves conservatively and values simplicity in design and setup.
The traditional approach for creating a plug-in always starts from scratch, such as building communication module, business
logic module, user interface module, and native console data translation module. In most of the plug-ins the native console data
translation module varies, but all other modules remain more or less same. As a result, every plug-in maintains their own set of
libraries which adds no uniformity in implementation across plug-ins. Indirectly it increases the overhead sustaining cost of the
plug-ins.
OMPSDK is targeted to provide
● A uniform implementation of communication module and core business logic module
● Abstraction of multiple communication protocols with data messaging
● Macro services as per use case—Monitoring, configuration, and more
● Optionally automatic code generating capability
● Quick integration to other DevOps.
Topics:
• OpenManage Python SDK API list
OpenManage Python SDK API list
This section describes the resource URIs and related operations that are available in the OpenManage Python SDK(OMPSDK)
implementation.
Monitoring API list
sdkinfra.find_driver
API string/Method: sdkinfra.find_driver.
Description: The sdkinfra.find_driver() method is used to initialize and load the device drivers.
Table 1. Parameters for sdkinfra.find_driver
Parameter Name Type Allowed Values
ipaddr
String NA
Description The IP address or hostname of the device.
Table 2. Parameters for the Credentials
Parameter Name Type Allowed Values
creds
Dictionary of credentials
Snmpv2Credentials
UserCredentials
Description A bundle of credentials required to communicate to the device driver.
Snmpv2Credentials
UserCredentials
3
6 OpenManage Python SDK API introduction