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

idrac.log_mgr.lclog_export

API string/Method: idrac.log_mgr.lclog_export

Protocol Support: WSMAN.

Description: The ExportLCLog() method is used to export the log from the Lifecycle Controller to a remote share.

Parameters:

Table 1. **Parameters for idrac.log_mgr.lclog_export** . This table displays the parameters for idrac.log_mgr.lclog_export
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 2. **Parameters for idrac.log_mgr.lclog_export** . This table displays the parameters for idrac.log_mgr.lclog_export
Parameter Name	Type
`share_path`	`FileOnShare (for CIFS & NFS Share)` `LocalFile (For Local Share)`
Description	LC log exports can be directed to local file systems and network shares NFS - Network File System `IPAddress` - Name of the NFS share server. `Sharename` - The NFS share name. `Mountpoint` - To mount the shared file. `UserCredentials` - Username and password for accessing the shared filed. CIFS - Common Internet File System `IPAddress` - Name of the CIFS share server. `Sharename` - The CIFS share name. `Sharepath` - The share path where file needs to be exported. `UserCredentials` - Username and password for accessing the shared file.

Example:

NOTE: Use the Export LC Logs as required along with the FileOnShare API.

NOTE: The export format is filename.gz.

#localpath = LocalFile(local='/newfolder/completelclogs.gz')
                                    status=idrac.log_mgr.complete_lclog_export(job_wait=True,share_path=localpath)
                                    
                                    # Export LC Logs - NFS Share
                                    nfs_share = FileOnShare(remote=<IP OR HOSTNAME>:/<NFS-SHARE-PATH>,
                                    mount_point=<MOUNT-DRIVE>:\>, isFolder=<True/False>,
                                    creds=UserCredentials(<USERNAME>, <PASSWORD>))
                                    
                                    lclog_file = nfs_share.new_file(<FILE-NAME>)
                                    
                                    msg = idrac.log_mgr.lclog_export(lclog_file)
                                    
                                    # Export LC Logs - CIFS Share
                                    cifs_share = FileOnShare(remote=\\<IP OR HOSTNAME>\<CIFS-SHARE-PATH>, isFolder=<True/False>,
                                    creds=UserCredentials(<USERNAME>, <PASSWORD>))
                                    
                                    lclog_file = cifs_share.new_file(<FILE-NAME>)
                                    
                                    msg = idrac.log_mgr.lclog_export(lclog_file)
                                    
                                    # Export LC Logs - Local Share
                                    local_share = LocalFile(local=os.path.join(, "path", "to", "lc-logs-file.xml"))
                                    export_lclog_streaming = idrac.log_mgr.lclog_export(share_path=local_share)

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.log_mgr.lclog_export

Rate this content