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 14. Parameter for Component (continued)
Parameter Name Type Allowed Values
iDRACCompEnum.NIC
iDRACCompEnum.PCIDevice
iDRACCompEnum.PowerSupply
iDRACCompEnum.PresenceAndSt
atusSensor
iDRACCompEnum.PhysicalDisk
iDRACCompEnum.Sensors_Amper
age
iDRACCompEnum.Sensors_Batte
ry
iDRACCompEnum.Sensors_Fan
iDRACCompEnum.Sensors_Intru
sion
iDRACCompEnum.Sensors_Tempe
rature
iDRACCompEnum.Sensors_Volta
ge
iDRACCompEnum.SystemMetrics
iDRACCompEnum.VFlash
iDRACCompEnum.Video
iDRACCompEnum.VirtualDisk
CMCCompEnum.System
CMCCompEnum.VirtualDisk
Description The required components.
Return type:
Table 15. Parameter for return type
Returns Return type
JSON The formatted JSON of the device with all the applied process attributes—mapping, units
conversion.
NOTE: Before utilizing the APIs, ensure to apply the sdkinfra.find_driver or sdkinfra.get_driver.
Sdkcreds.Snmpv2Credentials
API string/Method: Sdkcreds.Snmpv2Credentials.
Description: Credentials for SNMP version 1 and version 2.
Table 16. Parameters for Sdkcreds.Snmpv2Credentials
Parameter Name Type
community
String
Description Community string for the SNMP device.
Table 17. Parameter for write community
Parameter Name Type Allowed Values
writeCommunity
String NA
Description Write community string for the SNMP device.
Sdkcreds.UserCredentials
API string/Method: Sdkcreds.UserCredentials .
OpenManage Python SDK API introduction
11