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
RAIDforeignConfig=RAIDforeignConfigTypes.Clear,
RAIDreconstructRate="30",
RAIDccMode=RAIDccModeTypes.Normal
)
apply_status = idrac.config_mgr.apply_changes(reboot=True)
Returns: Success or Failure.
Return Type: JSON.
idrac.config_mgr.RaidHelper.delete_virtual_disk
API string/Method: idrac.config_mgr.RaidHelper.delete_virtual_disk.
Protocol Support: WSMAN, Redfish.
Description: The idrac.config_mgr.RaidHelper.delete_virtual_disk() allows you to create a RAID.
Table 145. Parameters for idrac.config_mgr.RaidHelper.delete_virtual_disk
Parameter Name Type Allowed Values
Name
String User defined
Description Name of the virtual disk.
Example:
#Set liason share
myshare = FileOnShare(remote="<IP OR HOSTNAME>:/<NFS-SHARE-PATH>/<FILE-NAME>",
mount_point='Z:\', isFolder=False,
creds=UserCredentials(<USERNAME>, <PASSWORD>))
liason_share_status = idrac.config_mgr.set_liason_share(myshare)
idrac.config_mgr.RaidHelper.delete_virtual_disk
(
Name="Virtual Disk 0"
)
apply_status = idrac.config_mgr.apply_changes(reboot=True)
Returns: None.
Return Type: None.
iDRAC LC Jobs API list
This section lists the available iDRAC LC Jobs APIs.
idrac.job_mgr.get_job_status
API string/Method: idrac.job_mgr.get_job_status.
Protocol Support: WSMAN.
Description: The get_job_status(jobid) method is used to get the job status for the provided job ID.
Return type: String
Example:
# Get Job Status
job_status = idrac.job_mgr.get_job_status(jobid=”jid_1234”)
idrac.job_mgr.delete_job
API string/Method: idrac.job_mgr.delete_job.
46
OpenManage Python SDK API introduction