Dell EMC OpenManage Python Software Development Kit Version 1.1 API Reference Guide

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 1. **Parameters for idrac.config_mgr.export_tsr** . This table lists the parameters for idrac.config_mgr.export_tsr
Parameter Name	Type	Allowed Values
`data_selector_array_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 2. **Parameters for idrac.config_mgr.export_tsr** . This table lists the 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.

Table 3. **Parameters for idrac.config_mgr.export_tsr** . This table lists the 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

Welcome

Welcome to Dell

Dell EMC OpenManage Python Software Development Kit Version 1.1 API Reference Guide

idrac.config_mgr.export_tsr

Rate this content