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 12. Return Type
Returns Return type
JSON
JSON Only the components passed in enumeration.
Sdkbase.iBaseDriver.ContainmentTree
API string/Method: Sdkbase.iBaseDriver.ContainmentTree.
Description: The Sdkbase.iBaseDriver.ContainmentTree() is used to create and return the component tree of the
device with keys of the Components organized in a tree structure.
Sdkdevice.iDeviceDriver.get_json_device
API string/Method: Sdkdevice.iDeviceDriver.get_json_device.
Description: The Sdkdevice.iDeviceDriver.get_json_device() is used to apply the monitor filter on the raw
entityJSON and also filter the category of the attributes and components required for the client.
Table 13. Parameters for Sdkdevice.iDeviceDriver.get_json_device
Parameter Name Type Allowed Values
monitorfilter
MonitorScope
MonitorScope.BasicInventory
MonitorScope.ConfigState
MonitorScope.Health
MonitorScope.Inventory
MonitorScope.Key
MonitorScope.MainHealth
MonitorScope.Metrics
MonitorScope.OtherHealth
MonitorScope.OtherInventory
Description The category of filters to apply.
Table 14. Parameter for Component
Parameter Name Type Allowed Values
compScope
String or Enum iDRAC CMC
iDRACCompEnum.BIOS
iDRACCompEnum.ControllerBat
tery
iDRACCompEnum.Controller
iDRACCompEnum.CPU
iDRACCompEnum.Enclosure
iDRACCompEnum.EnclosureEMM
iDRACCompEnum.EnclosurePSU
iDRACCompEnum.EnclosureFanS
ensor
iDRACCompEnum.EnclosureTemp
Sensor
iDRACCompEnum.Fan
iDRACCompEnum.FC
iDRACCompEnum.HostNIC
iDRACCompEnum.iDRAC
iDRACCompEnum.iDRACNIC
iDRACCompEnum.License
iDRACCompEnum.LogicalSystem
CMCCompEnum.BladeSlot
CMCCompEnum.CMC
CMCCompEnum.ComputeModule
CMCCompEnum.Controller
CMCCompEnum.ControllerBatt
ery
CMCCompEnum.Enclosure
CMCCompEnum.EnclosureEMM
CMCCompEnum.EnclosurePSU
CMCCompEnum.Fan
CMCCompEnum.IOModule
CMCCompEnum.KVM
CMCCompEnum.License
CMCCompEnum.PowerSupply
CMCCompEnum.PhysicalDisk
CMCCompEnum.PCIDevice
CMCCompEnum.StorageModule
CMCCompEnum.Slots_Summary
10 OpenManage Python SDK API introduction