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
Example:
# Export LC Full Logs - NFS Share
nfs_share = FileOnShare(remote=<IP OR HOSTNAME>:/<NFS-SHARE-PATH>,
mount_point=<MOUNT-DRIVE>:\>, isFolder=<True/False>,
creds=UserCredentials(<USERNAME>, <PASSWORD>))
tsr_file = nfs_share.new_file(<FILE-NAME>)
idrac.log_mgr.complete_lclog_export(tsr_file)
# Export LC Full Logs - CIFS Share
cifs_share = FileOnShare(remote=\\<IP OR HOSTNAME>\<CIFS-SHARE-PATH>, isFolder=<True/
False>,
creds=UserCredentials(<USERNAME>, <PASSWORD>))
tsr_file = cifs_share.new_file(<FILE-NAME>)
idrac.log_mgr.complete_lclog_export(tsr_file)
# Export LC Full Logs - Local Share
local_share = LocalFile(local=os.path.join(, "path", "to", <FILE_NAME>))
idrac.log_mgr.complete_lclog_export(local_share)
Returns: Success or Failure.
Return type: JSON
idrac.config_mgr.export_tsr
API string/Method: idrac.config_mgr.export_tsr.
Protocol Support: WSMAN.
Description: The idrac.config_mgr.export_tsr is used to collects the TSR i.e hardware, OS and App data, then
compressed the .zip file saves into the respective remote share path—cifs/nfs.
Parameters:
Table 56. Parameters for idrac.config_mgr.export_tsr
Parameter Name Type Allowed Values
data_selector_arr
ay_in
DataSelectorArrayInEnum DataSelectorArrayInEnum.HW_Data
DataSelectorArrayInEnum.OSApp_Data
DataSelectorArrayInEnum.TTY_Logs
DataSelectorArrayInEnum.Debug_Logs
Description
The DataSelectorArrayIn allows you to select the one of the data
DataSelectorArrayInEnum.HW_Data - Technical support report for Hardware Data.
DataSelectorArrayInEnum.OSApp_Data - Technical support report for OSApp Data Without
PII.
DataSelectorArrayInEnum.TTY_Logs - Technical support report for TTY Logs.
DataSelectorArrayInEnum.Debug_Logs - Technical support report for OSApp Data.
Table 57. Parameters for idrac.config_mgr.export_tsr
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 21