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
idrac.config_mgr.configure_email_alerts
(
alert_number = 4, state=Enable_EmailAlertTypes.Enabled,
address = "test@abc.com", custom_message = "test"
)
apply_status = idrac.config_mgr.apply_changes(reboot=False)
Returns: True or False.
Return Type: JSON.
Boot Settings Configuration API list
This section lists the available Boot settings configuration APIs.
idrac.config_mgr.configure_boot_mode
API string/Method: idrac.config_mgr.configure_boot_mode.
Protocol Support: Redfish.
Description: The idrac.config_mgr.configure_boot_mode() allows you to configure the boot Mode.
Table 115. Parameters for idrac.config_mgr.configure_boot_mode
Parameter Name Type Allowed Values
boot_mode
Enum
Bios - BootModeTypes.BIOS
Uefi - BootModeTypes.Uefi
Description Configures the boot mode to BIOS or UEFI.
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)
# Configure Boot Mode
msg = idrac.config_mgr.configure_boot_mode(BootModeTypes.Uefi)
apply_status = idrac.config_mgr.apply_changes(reboot=True)
Returns: Success or Failure.
Return Type: JSON.
idrac.config_mgr.configure_onetime_boot_mode
API string/Method: idrac.config_mgr.configure_onetime_boot_mode.
Protocol Support: Redfish.
Description: The idrac.config_mgr.configure_onetime_boot_mode() allows you to set the specified device as the
first device in the boot order for the next boot cycle only. The device must be a device from the bootseq option device list.
Table 116. Parameters for idrac.config_mgr.configure_onetime_boot_mode
Parameter Name Type Allowed Values
onetime_boot_mode
Enum
OneTimeBootModeTypes.Disabled
OneTimeBootModeTypes.OneTimeBootSeq
OneTimeBootModeTypes.OneTimeCustomBootS
eqStr
38 OpenManage Python SDK API introduction