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
Protocol Support: WSMAN.
Description: The delete_job(jobid) method is used to delete a job.
Return type: String
Example:
# Delete a job
job_status = idrac.job_mgr.delete_job(jobid=”jid_1234”)
idrac.job_mgr.delete_all_jobs
API string/Method: idrac.job_mgr.delete_all_jobs.
Protocol Support: WSMAN.
Description: The delete_all_jobs() is used to delete all jobs.
Return type: String
Example:
# Delete all jobs
job_status = idrac.job_mgr.delete_all_jobs()
iDRAC LC Status Check API list
This section lists the available iDRAC LC Status Check APIs.
idrac.config_mgr.LCStatus
API string/Method: idrac.config_mgr.LCStatus.
Protocol Support: Redfish.
Description: The GetRemoteServicesAPIStatus() method is used to obtain the overall remote services API status that
includes host system status. The remote services - (Data Manager) status, and Real Time Status. The overall rolled up status
shall be reflected in the Status output parameter.
Return type: String
Example:
# Check the LC status
msg = idrac.config_mgr.LCStatus
idrac.config_mgr.LCReady
API string/Method: idrac.config_mgr.LCReady.
Protocol Support: WSMAN.
Description: This property provides the information regarding whether the LC is Ready.
Example:
msg = idrac.config_mgr.LCReady
OpenManage Python SDK API introduction
47