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.disable_system_lockdown
API string/Method: idrac.config_mgr.disable_system_lockdown.
Protocol Support: WSMAN, Redfish.
Description: The idrac.config_mgr.disable_system_lockdown() performs a Lockdown disable operation.
NOTE: Lockdown is supported only on 14th Generation of PowerEdge Servers.
Return type: JSON
Example:
# Enable System Lockdown
msg = idrac.config_mgr.disable_system_lockdown()
CSIOR
idrac.config_mgr.enable_csior
API string/Method: idrac.config_mgr.enable_csior.
Protocol Support: WSMAN.
Description: The idrac.config_mgr.enable_csior() method allows you to enable the CSIOR option in iDRAC which
enables the collection of system inventory on reboot.
CSIOR is an option in iDRAC which enables collecting of system inventory on reboot. It allows you the CSIOR to perform
configuration.
Return type: JSON
idrac.config_mgr.disable_csior
API string/Method: idrac.config_mgr.disable_csior.
Protocol Support: WSMAN.
Description: The idrac.config_mgr.disable_csior() method allows you to disable the CSIOR option in iDRAC which
disables the collection of system inventory on reboot.
Return type: JSON
idrac.config_mgr.configure_idrac_alerts
API string/Method: idrac.config_mgr.configure_idrac_alerts.
Protocol Support: Redfish.
Description: The idrac.config_mgr.configure_idrac_alerts() allows you to enable or disable the iDRAC alerts
Settings.
Table 101. Parameters for idrac.config_mgr.configure_idrac_alerts
Parameter Name Type Allowed Values
enable_alerts
Number
AlertEnable_IPMILanTypes.Enabled
AlertEnable_IPMILanTypes.Disabled
Description Configure the iDRAC alert settings.
Example:
#Set liason share
myshare = FileOnShare(remote="<IP OR HOSTNAME>:/<NFS-SHARE-PATH>/<FILE-NAME>",
mount_point='Z:\', isFolder=False,
creds=UserCredentials(<USERNAME>, <PASSWORD>))
34
OpenManage Python SDK API introduction