API Guide
Table Of Contents
- Dell EMC OpenManage Python Software Development Kit Version 1.0 API Reference Guide
- Introduction to OpenManage python software development toolkit
- Installation and Uninstallation of OMPSDK
- OpenManage Python SDK API introduction
- OpenManage Python SDK API list
- Monitoring API list
- Administration tasks API list
- Export and Import Tasks API list
- Server iDRAC Settings Configuration API list
- Boot Settings Configuration API list
- RAID Configuration API list
- iDRAC LC Jobs API list
- iDRAC LC Status Check API list
- OpenManage Python SDK API list
- Getting Started
Table 7. Parameters for credentials
Parameter Name Type Allowed Values
creds
Dictionary of credentials
Snmpv2Credentials
UserCredentials
Description A bundle of credentials to find the device driver.
Snmpv2Credentials
UserCredentials
Table 8. Parameters for preferred protocol
Parameter Name Type Allowed Values
protopref
Enumeration of preferred
protocol
NA
Description The preferred protocol used if the device supports the protocol.
Table 9. Parameters for protocol specific options
Parameter Name Type Allowed Values
pOptions
Dictionary of protocol-specific
options
SNMPOptions
WSMANOptions
REFISHOptions
Description A protocol-specific option for passed, port, timeout and so on.
SNMPOptions
WSMANOptions
REFISHOptions
Return type:
ObjectDevice driver: A driver handle to configure or monitor the drivers.
Example:
get_driver(driver_en, ipaddr, creds, protopref=None, pOptions=None)
Sdkbase.iBaseDriver.get_entityjson
API string/Method: Sdkbase.iBaseDriver.get_entityjson.
Description: The Sdkbase.iBaseDriver.get_entityjson() is used to create the JSON of the device by fetching the
attributes from the device using the protocol. It internally creates the raw JSON of the device.
Return type:
Table 10. Return type
Returns Return type
True
Boolean
Sdkbase.iBaseDriver.get_partial_entityjson
API string/Method: Sdkbase.iBaseDriver.get_partial_entityjson.
Description: The Sdkbase.iBaseDriver.get_partial_entityjson() is used to get the JOSN with the components
which are passed as an argument for the function.
8
OpenManage Python SDK API introduction