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 58. Parameters for idrac.config_mgr.export_tsr
Parameter Name Type Allowed Values
tsr_store_path
FileOnShare—for CIFS and NFS
Share
Description This method collects the TSR i.e hardware, OS and App data, then compresses and saves the .zip
file to remote share path.
The FileOnShare API allows you to view the share path where file needs to be exported.
Example:
#Export TSR - 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.config_mgr.export_tsr(tsr_file, data_selector_array_in =
DataSelectorArrayInEnum.HW_Data)
# Export TSR - 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.config_mgr.export_tsr(tsr_file, data_selector_array_in =
DataSelectorArrayInEnum.HW_Data)
Returns: Success or Failure.
Return type: JSON
Server iDRAC Settings Configuration API list
This section lists the available Server iDRAC Settings Configuration APIs.
iDRAC User Configuration
idrac.user_mgr.Users.new
idrac.user_mgr.Users.new
API string/Method: idrac.user_mgr.Users.new.
Protocol Support: Redfish.
Description: The idrac.user_mgr.Users.new() returns a JSON to create the user. For more details about the properties
and values, refer to iDRAC Attribute Registry Guide.
Table 59. Parameters for idrac.user_mgr.Users.new
Parameter Name Type Allowed Values
UserName_Users
String User defined string
Description Allows you to create a user name.
22 OpenManage Python SDK API introduction