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 41. Parameters for idrac.config_mgr.scp_export (continued)
Parameter Name Type Allowed Values
SCPTargetEnum.IDRAC - The module exports only the iDRAC component in SCP file.
SCPTargetEnum.BIOS - The module exports BIOS configuration in SCP file.
SCPTargetEnum.NIC - The module exports NIC configuration in SCP file.
SCPTargetEnum.RAID - The module exports RAID configuration in SCP file.
This module will import the configuration component from the exported SCP
Default - SCPTargetEnum.ALL - This module exports the complete system configuration from the
Lifecycle Controller to a file on local or remote share location.
Table 42. Parameters for idrac.config_mgr.scp_export
Parameter Name Type
time_to_wait
unit16
Description The time to wait for the host to shut down. Default and minimum value is 300 seconds. Maximum
value is 3600 seconds.
Table 43. Parameters for idrac.config_mgr.scp_export
Parameter Name Type
Workgroup
String
Description The applicable workgroup.
Returns: Success or Failure
Return type: JSON
idrac.config_mgr.scp_import
API string/Method: idrac.config_mgr.scp_import.
Protocol Support: WSMAN, Redfish.
Description: This method is used to import the system configuration.
Parameters:
Table 44. Parameters for idrac.config_mgr.scp_import
Parameter Name Type Allowed Values
end_host_power_state EndHostPowerStateEnum
EndHostPowerStateEnum.Off
EndHostPowerStateEnum.On
Description The desired host power state after the import operation is complete.
0 - Off
1 - On
Default value is 0
Table 45. Parameters for idrac.config_mgr.scp_import
Parameter Name Type Allowed Values
job_wait
Boolean True/False
Description
This API raises a flag to wait for the job to complete. A false value will return the Job ID.
OpenManage Python SDK API introduction 17