Collecting Service Data on Lenovo ThinkSystem Servers

This document provides the instructions for the various methods of collecting service data on Lenovo servers. Users might be asked to collect service data by Lenovo service personnel or from a qualified business partner when opening a service ticket. This is sometimes referred to as collecting FFDC – short for First Failure Data Capture.

This guide provides simple instruction for users who are new to Lenovo ThinkSystem servers. It will explain the new service data log feature, guide you to choose the right tool and show how to complete the task of collecting service data, which you can send to the qualified service personnel as the next step in the troubleshooting journey.

This guide covers the following servers:

• All ThinkSystem V4 servers
• All ThinkSystem V3 servers, except ST45 V3
• All ThinkSystem V2 servers, except the ST50 V2
• All ThinkSystem servers, except SR635, SR655, ST50
• ThinkEdge servers (includes ThinkSystem SE350)

SR635, SR655: These servers have a firmware stack that is different from other ThinkSystem servers, so the tools and instructions in this guide don’t apply to those servers. You can use the embedded ThinkSystem System Manager to collect service data as documented in https://pubs.lenovo.com/tsm/download_service_data.

ST50, ST50 V2, ST45 V3: These entry tower servers don’t have a BMC onboard for collecting service data, so the tools and instructions in this guide don’t apply to those servers.

Service data log used to be saved as proprietary file format. It required a proprietary tool to open the file and specialized skills to make sense of the content.

ThinkSystem servers now offer a service data log (mini log) that is user-friendly and significantly more compact. This new service log feature is available with all new ThinkSystem V3 and V4 servers and also with ThinkSystem and ThinkSystem V2 servers that have XCC firmware dated May 2023 or later.

The log is now saved as zip format and shrunk to a much smaller size (about 500KB). You can expand the zip file to read the export.html content in any browser, while individual log files are also provided side-by-side in json format for easy parsing.

The naming convention for the service data log file is: MachineType+Model_SerialNumber_xcc_mini-log_date_time.zip

e.g., 7D76WCC_1234567890_xcc_mini-log_20221024-023341.zip

Figure 1. XCC2 download dialog showing the new service data log and the debug log (aka FFDC)

You can decompress the zip file using Windows Explorer or a third-party tool (unzip, 7zip) to view all the files. Here is an example of the new service data log content.

Figure 2. Expanded file list from the new service data log file

Figure 3. Sample content from the export.html file

While it is great that the new service data log is user-readable and compact, it doesn’t contain the debugging data that is sometimes required for deeper troubleshooting. As a result, the former proprietary log file will be continue to be available but is now called debug log. The file format and content remain exactly as before. When XCC captures a service data log (zip file), it automatically captures a debug log (tzz file) in parallel just in case it might be needed.

The naming convention for the debug log file is: MachineType+Model_SerialNumber_xcc_date_time.tzz

e.g., 7D76WCC_1234567890_xcc_20221024-023341.tzz

The XCC service data file *.tzz cannot be extracted using a generic decompression tool, such as unzip or 7zip. Send the service data file to an authorized technical service personnel for further analysis.

Lenovo is continuing to enhance the many service tools to take advantage of this new service data log and debug log to improve customer experience and service experience.

It is recommended that you understand all methods for collecting service data that Lenovo provides so that you can quickly collect the data before calling for technical support. This way, you can avoid or minimize workload disruption while capturing the critical information that is needed, at a decisive moment, for precise and efficient troubleshooting.

However, if you are in a hurry, the following table allows you to quickly jump to the section that best suits your current situation. Choose a row at the first column based on what you have access to, then choose one of the server brand columns to link to the right tool and steps.

XClarity Controller 3 is the integrated baseboard management controller (BMC) available in all ThinkSystem V4 servers. It continuously monitors the server hardware health status and handle alerts immediately. It plays a key role in ensuring the server firmware authenticity, safety, and integrity. Finally, it also helps to collect service data log and debug log.

Accessing the tool:

• Download: This tool is embedded in the firmware of Lenovo ThinkSystem V4 servers
• Documentation: https://pubs.lenovo.com/xcc3/

Use the following steps to collect service data using XClarity Controller 3 (XCC3):

1. Log in to web management interface.
2. At the Home page, look for the Service Log button at the top banner or in the Quick Actions card as shown in the following figure.

   
   Figure 4. XClarity Controller 3 home page

3. Select the Debug Log (default) or Service Data Log.

   
   Figure 5. Select the type of service log to collect

4. Click Export to collect the data. This may take around 15 seconds to complete, then you will be prompted by the browser to save the file to your workstation.

XClarity Controller 2 is the integrated baseboard management controller (BMC) available in all ThinkSystem V3 servers. It continuously monitors the server hardware health status and handle alerts immediately. It plays a key role in ensuring the server firmware authenticity, safety, and integrity. Finally, it also helps to collect service data log and debug log.

Accessing the tool:

• Download: This tool is embedded in the firmware of Lenovo ThinkSystem V3 servers.
• Documentation: https://pubs.lenovo.com/xcc2/

Use the following steps to collect service data using XClarity Controller 2 (XCC2):

1. Log in to web management interface.
2. At the Home page, look for the Service Log button at the top banner or in the Quick Actions card as shown in the following figure.

   
   Figure 6. XClarity Controller 2 home page

3. Select the Service Data Log (default) or Debug Log, pay attention to the optional data that could be collected as well if needed.

   
   Figure 7. Select the type of service log to collect

4. Click Export to collect the data. This may take around 15 seconds to complete, then you will be prompted by the browser to save the file to your workstation.
5. At any time, you may click on the Browse History button to download previously collected service logs.

   
   Figure 8. Go to Browse History to download previously collected service logs

XClarity Controller is the integrated baseboard management controller (BMC) available in all ThinkSystem V1 and V2 servers, with the exception of the ST50, ST50 V2, SR655, and SR635 servers. It continuously monitors the server hardware health status and handle alerts immediately. It plays a key role in ensuring the server firmware authenticity, safety, and integrity. Finally, it also helps to collect service data log and debug log.

Accessing the tool:

• Download: This tool is embedded in the firmware of the server
• Documentation:
  • Lenovo XClarity Controller with Intel Xeon SP (1st, 2nd Gen)
  • Lenovo XClarity Controller with Intel Xeon SP (3rd Gen) and AMD EPYC (2nd, 3rd Gen)

Use the following steps to collect service data using XClarity Controller (XCC):

1. Log in to XClarity Controller web management interface.
2. At the Home page, look for the Quick Actions card as illustrated in Figure 1.
3. Click on the Service dropdown menu, then Download Service Data.
4. Click OK when prompted.
5. This may take a few minutes to complete, then you will be prompted by the browser to save the file to your workstation.

   
   Figure 9. XClarity Controller home page

XClarity Essentials provides a collection of graphical interface and command line tools for viewing, configuring, and updating ThinkSystem servers. The tools can run inside the target server OS to act on itself, or they can run on a remote PC to act on one or many servers.

This guide provides instruction for the command line tool called OneCLI, running inside the target server OS. But it is also possible to run the same OneCLI command from a remote Windows or Linux PC, provide that the target server’s XClarity Controller is accessible on the network and that you have the administrative credentials.

Accessing the tool:

• Download: https://datacentersupport.lenovo.com/us/en/solutions/lnvo-tcli
• Documentation: https://pubs.lenovo.com/lxce-onecli/

Use the following steps to collect service data using XClarity Essentials OneCLI (LXCE).

Instruction for Windows:

1. Download the latest version of OneCLI from the above location.
2. Decompress the downloaded zip file into a new directory.
3. Open a command prompt as Administrator and change to the directory where the expanded version of OneCLI is found.
4. Run this command to collect service data log: (must have XCC2 and OneCLI V4.0 or later)
   OneCli.exe inventory getinfor --servicelog
5. Run this command to collect debug log: (applicable to all servers and all versions of OneCLI)
   OneCli.exe inventory getinfor --ffdc
6. It will take a minute for the service data log and approximatively 15-45 minutes for the debug log to complete.

Instruction for Linux:

1. Download the latest version of OneCLI from the above location.
2. Decompress the downloaded .tgz file into a new directory.
3. Open a shell as root privilege and change to the directory where the expanded version of OneCLI is found.
4. Run this command to collect service data log: (must have XCC2 and OneCLI V4.0 or later)
   ./OneCli inventory getinfor --servicelog
5. Run this command to collect service data: (applicable to all servers and all versions of OneCLI)
   ./OneCli inventory getinfor --ffdc
6. It will take a minute for the service data log and approximatively 15-45 minutes for the debug log to complete.

Additional information:

• A new directory will be created under the current execution directory to store the result of each run at logs/OneCli-pid-date-time
  e.g. logs/OneCli-5460-20190326-141910
• The resulting directory contains the service data log (zip) or the debug log (tzz) that was gotten from the XClarity Controller, same as by downloading service data from the web interface.
• The directory also contains a detailed server inventory file that could be useful to technical support. If you’d like to have the detailed inventory in HTML instead of the XML, you can run this command:
  OneCli.exe inventory getinfor --ffdc --htmlreport
• You can compress the result directory as a file to send to technical support.
• To run this command from a remote PC, add the BMC address and credentials to the command, or see this command example.

XClarity Provisioning Manager (LXPM) V4 is an application preloaded in ThinkSystem V3 servers. LXPM V5 is preloaded in ThinkSystem V4 servers. It provides the essential functions to initialize a brand-new system all the way to OS installation wizard, including view hardware inventory, set date/time, BMC networking, RAID volume creation, UEFI setting and OS installation assistance, clone configuration. There are also functions for maintenance service, including collect service data, hardware diagnostics, firmware update, and system event log viewing.

XClarity Provisioning Manager can be used when physically in front of the server via a keyboard, video and mouse (KVM), or it can be accessed via XClarity Controller remote console.

Accessing the tool:

• Download: This tool is embedded in the firmware of the server.
• Documentation: https://pubs.lenovo.com/lxpm-overview/

Follow these steps to collect service data using XClarity Provisioning Manager. You will need a USB memory stick to save the service data to.

1. Boot or reboot the server, wait until the POST splash screen is displayed.
2. Press F1:System Setup.

   
   Figure 10. ThinkSystem server POST splash screen

3. If it shows the text mode UEFI setup, choose the option to Launch Graphical System Setup.

   
   Figure 11. ThinkSystem server text mode UEFI setup utility

4. After launching into XClarity Provisioning Manager (LXPM), click on Diagnostics.

   
   Figure 12. XClarity Provisioning Manager system summary page

5. Choose Collect Service Data.

   
   Figure 13. XClarity Provisioning Manager Diagnostics page

6. Wait until the task is completed then save the file to a local storage device.

   
   Figure 14. XClarity Provisioning Manager collect service data in progress

XClarity Provisioning Manager V3 is an application preloaded in ThinkSystem V1 or V2 servers. It provides the essential functions to initialize a brand-new system all the way to OS installation wizard, including view hardware inventory, set date/time, BMC networking, RAID volume creation, UEFI setting and OS installation assistance, clone configuration. There are also functions for maintenance service, including collect service data, hardware diagnostics, firmware update, and system event log viewing.

XClarity Provisioning Manager can be used when physically in front of the server via a keyboard, video and mouse (KVM), or it can be accessed via XClarity Controller remote console.

Accessing the tool:

• Download: This tool is embedded in the firmware of the server.
• Documentation: https://pubs.lenovo.com/lxpm-overview/

Follow these steps to collect service data using XClarity Provisioning Manager. You will need a USB memory stick to save the service data to.

1. Boot or reboot the server, wait until the POST splash screen is displayed.
2. Press F1:System Setup.

   
   Figure 15. ThinkSystem server POST splash screen

3. If it shows the text mode UEFI setup, choose the option to Launch Graphical System Setup as shown in Figure 3.

   
   Figure 16. ThinkSystem server text mode UEFI setup utility

4. After launching into XClarity Provisioning Manager (LXPM), click on Diagnostics.

   
   Figure 17. XClarity Provisioning Manager system summary page

5. Choose Collect Service Data and click on the right arrow.

   
   Figure 18. XClarity Provisioning Manager diagnostics page

6. Wait until the task is completed then click on the right arrow.

   
   Figure 19. XClarity Provisioning Manager collecting service data

7. Choose a USB drive in the list; then click Save.

   
   Figure 20. XClarity Provisioning Manager save service data

XClarity Administrator provides centralized management, monitoring and provisioning of several hundreds of Lenovo devices, such as ThinkSystem servers, ThinkEdge servers, ThinkSystem storage, and ThinkSystem networking switches.

Accessing the tool:

• Download: https://datacentersupport.lenovo.com/us/en/solutions/lnvo-lxcaupd
• Documentation: https://pubs.lenovo.com/lxca/

Use the following steps to collect service data using XClarity Administrator :

1. Log in to the XClarity Administrator management interface.
2. Click on the menu Administration > Service and Support, then on the Endpoint Actions.
3. Select one or more endpoints on which you’d like to collect service logs, then click the menu All Actions > Collect Service Data, confirm the action when prompted.

   
   Figure 21. XClarity Administrator endpoint actions

4. The task will be launched in the background and should take a few minutes to complete.
5. To download the service data file to your workstation, navigate to Endpoint Service Data.
6. Select a file then click on the toolbar button or the equivalent menu in All Actions > Download Selected Service Files.

   
   Figure 22. XClarity Administrator endpoint service data

7. With XClarity Administrator V4.0 or higher, there would be a new File Type column displayed, the zip file type is the new service data log while the tzz file type is the debug log.

XClarity Orchestrator provides federated management of several XClarity Administrator instances for large environments that have tens of thousands of managed devices. It also provides advanced analytics for data visualization and failure prediction.

Accessing the tool:

• Download: https://datacentersupport.lenovo.com/us/en/solutions/lnvo-lxco
• Documentation: https://pubs.lenovo.com/lxco/

Use the following steps to collect service data using XClarity Orchestrator:

1. Log in to the XClarity Orchestrator management interface.
2. Click on the menu Administration > Service and Support, then on the Device Actions.

   
   Figure 23. XClarity Orchestrator Device Actions page

3. Select one or more devices on which you’d like to collect service logs, then click the toolbar button or the equivalent menu All Actions > Collect Service Data.

   
   Figure 24. XClarity Orchestrator collect service data action

4. To download the service data file to your workstation, go to Service Data.
5. Select a file then click on the toolbar button or the equivalent menu All Actions > Save service files.

   
   Figure 25. XClarity Orchestrator Device Service Data page

XClarity Integrator provides centralized management and monitoring of ThinkSystem servers running on Microsoft Windows Server. It provides additional hardware visibility that complement the software platform, including better hardware inventory, events and alerting, and collect service data.

Accessing the tool:

• Download: https://datacentersupport.lenovo.com/us/en/solutions/lnvo-lxci-wac
• Documentation: https://pubs.lenovo.com/lxci-wac/

Use the following steps to collect service data using XClarity Integrator for Windows Admin Center:

1. Login to the Windows Admin Center then choose the Server Manager view and pick the server that you’d like to collect service logs.
2. At the left navigation tree, look for Lenovo XClarity Integrator under Extensions.
3. Inside the XClarity Integrator page, navigate to Service Data page.
4. Now you can click on the Collect Service Data button to trigger the action.
5. Or you may select a file that was previously collected and click on Download Files to transfer it to your local workstation.

   
   Figure 26. XClarity Integrator for Windows Admin Center

The XClarity Mobile app can be used as a client to XClarity Administrator server. It can view all the managed devices status and inventory, receive alerts, take power actions, and collect service data.

The XClarity Mobile app can also be used in standalone mode connecting directly to the server via the management USB port. It provides direct access to XClarity Controller to view hardware inventory, setup BMC networking, take power actions and collect service data.

Accessing the tool:

• From the phone’s app store: search for “XClarity Mobile” or use the following links:
  • Google Play: https://play.google.com/store/apps/details?id=com.lenovo.xcmob
  • Apple Store: https://apps.apple.com/us/app/lenovo-xclarity-mobile/id1023231345
• Documentation: https://pubs.lenovo.com/lxca/lxca_usemobileapp.html

Using the Mobile app as client to XClarity Administrator

Instruction for the mobile app acting as client to XClarity Administrator:

1. Connect to the XClarity Administrator then go to the Hardware

   
   Figure 27. XClarity Mobile app Hardware tab

2. Select the target server, then open the top right options menu (3 vertical dots icon), select Service options in the menu.

   
   Figure 28. XClarity Mobile app server options menu

3. Finally, select Collect service data.

   
   Figure 29. XClarity Mobile app Service options menu

4. The debug data file will be collected and stored on XClarity Administrator, follow the instruction in the XClarity Administrator section to download the data file to your workstation if you need it.

Using the mobile app to connect to the server via USB

Instruction for the mobile app connecting directly to the server via USB:

1. Launch the app, then click on the USB icon at the upper right.

   
   Figure 30. XClarity Mobile app Newsfeed page

2. Connect the phone to the server front management USB port (the port with a wrench sign), enable USB tethering on the phone OS setting if it wasn’t already done. The mobile app continuously verifies the connection and setting until they are satisfied (indicate by check mark).

   
   Figure 31. XClarity Mobile app USB Discovery page

3. Click on Discover.
4. An item will be available under the section for USB attached server. Expand it to select the discovered server.

   
   Figure 32. XClarity Mobile app USB attached server discovered

5. Open the top right options menu (3 vertical dots icon) and choose Login. Input the server’s XClarity Controller login credentials (e.g. USERID / xxx).

   
   Figure 33. XClarity Mobile app server options menu

6. After successful login, open the top right options menu again, choose Service options and then Download service data. Answer Yes to the confirmation prompt.

   
   Figure 34. XClarity Mobile app Service options menu

7. When the data collection is completed, you will be given the option to save the file locally or hand it over to another app (send email, cloud storage, etc.).

   
   Figure 35. XClarity Mobile app file handling prompt

Some ThinkSystem servers have an external diagnostics connector on the server front that you can use it to collect service data. It enables you to collect the debug log and write the file to a USB storage device. When writing files to a USB storage device, the device should be formatted as FAT, FAT32 or exFAT, and be plugged to the XCC controlled USB port at the server front.

Some servers have an integrated diagnostics panel at the server front that can be pulled out when needed. The instruction is same for both external and integrated devices, except that you don’t need to connect the integrated device manually.

Accessing the tool:

• Hardware: The external diagnostics handset must be purchased from Lenovo using part number 4TA7A64874. The integrated diagnostics panel is available in some server models.
• Documentation: In the Lenovo documentation home page, navigate to the desired server model, expand the section Server components > Front view > External diagnostics handset.

Instructions:

1. Connect the USB storage device to the XCC controlled USB port (with the wrench icon).

   
   Figure 36. Front view of the ThinkSystem SR650 V2

2. Connect the external diagnostics handset to the external diagnostics connector.

   
   Figure 37. Connecting the external diagnostics handset to the connector

3. Scroll to the Actions menu, and then to Generate / Download FFDC Service Data.

   
   Figure 38. External diagnostics handset navigation flow

4. Trigger the action and follow the instruction on screen.

   
   Figure 39. External diagnostics handset instruction on screen

Standard Redfish API can be used to collect the service data log from XCC and XCC2. Only the full service data log, a.k.a. debug log, FFDC, can be collected from this method.

Documentation: https://pubs.lenovo.com/xcc2-restapi/collect_bmc_diagnostic_data_post 

Follow these steps to collect service data using this API.

1. Initiate the service data collection task.

   curl -L -s -k -u USERID:password -X POST 'https://10.1.1.224/redfish/v1/Systems/1/LogServices/DiagnosticLog/Actions/LogService.CollectDiagnosticData' -H 'Content-Type: application/json' --data '{"DiagnosticDataType" : "Manager"}' | jq
   

   Response:

   {
       "TaskMonitor": "/redfish/v1/TaskService/f152fee2-1877-41ab-8614-3e7010dc5adb",
       "@odata.etag": "\"1708987633087\"",
       "Description": "This resource represents a task for a Redfish implementation.",
       "Messages": [],
       "HidePayload": true,
       "@odata.id": "/redfish/v1/TaskService/Tasks/9bceab02-d75e-441d-9fc7-cc4cecc96558",
       "StartTime": "2024-04-06T22:47:13+00:00",
       "@odata.context": "/redfish/v1/$metadata#Task.Task",
       "Id": "9bceab02-d75e-441d-9fc7-cc4cecc96558",
       "Name": "Task 9bceab02-d75e-441d-9fc7-cc4cecc96558",
       "@odata.type": "#Task.v1_6_1.Task",
       "TaskState": "New"
   }
   

2. Retrieve task status

   curl -L -s -k -u USERID:Passw0rd1234 -X GET 'https://10.1.1.224/redfish/v1/TaskService/Tasks/9bceab02-d75e-441d-9fc7-cc4cecc96558' | jq
   

   Response:

   {
       "TaskMonitor": "/redfish/v1/TaskService/f152fee2-1877-41ab-8614-3e7010dc5adb",
       "@odata.etag": "\"1708987633158\"",
       "Description": "This resource represents a task for a Redfish implementation.",
       "Messages": [],
       "HidePayload": true,
       "TaskState": "Running",
       "StartTime": "2024-04-06T22:47:13+00:00",
       "@odata.context": "/redfish/v1/$metadata#Task.Task",
       "Id": "9bceab02-d75e-441d-9fc7-cc4cecc96558",
       "Name": "Task 9bceab02-d75e-441d-9fc7-cc4cecc96558",
       "@odata.type": "#Task.v1_6_1.Task",
       "@odata.id": "/redfish/v1/TaskService/Tasks/9bceab02-d75e-441d-9fc7-cc4cecc96558"
   }
   

   When data collection finishes, the response looks like this:

   {
       "EndTime": "2024-04-06T22:48:05+00:00",
       "TaskMonitor": "/redfish/v1/TaskService/f152fee2-1877-41ab-8614-3e7010dc5adb",
       "@odata.etag": "\"1708987685412\"",
       "Description": "This resource represents a task for a Redfish implementation.",
       "TaskState": "Completed",
       "Messages": [
           {
               "MessageArgs": [],
               "@odata.type": "#Message.v1_1_2.Message",
               "MessageId": "Base.1.14.Success",
               "Message": "The request completed successfully.",
               "MessageSeverity": "OK",
               "Resolution": "None"
           },
           {
               "MessageArgs": ["FFDC"],
               "@odata.type": "#Message.v1_1_2.Message",
               "MessageId": "LogService.1.0.DiagnosticDataCollected",
               "Message": "'FFDC' diagnostic data collected.",
               "MessageSeverity": "OK",
               "Resolution": "None."
           }
       ],
       "HidePayload": true,
       "StartTime": "2024-04-06T22:47:13+00:00",
       "TaskStatus": "OK",
       "@odata.context": "/redfish/v1/$metadata#Task.Task",
       "Id": "9bceab02-d75e-441d-9fc7-cc4cecc96558",
       "Name": "Task 9bceab02-d75e-441d-9fc7-cc4cecc96558",
       "@odata.type": "#Task.v1_6_1.Task",
       "@odata.id": "/redfish/v1/TaskService/Tasks/9bceab02-d75e-441d-9fc7-cc4cecc96558"
   }
   

3. Find the location of the service data file produced.

   curl -L -s -k -u USERID:Passw0rd1234 -X GET 'https://10.1.1.224/redfish/v1/Systems/1/LogServices/DiagnosticLog/Entries' | jq
   

   Response:

   {
       "Description": "A collection of DiagnosticLogEntry resource instances.",
       "Members@odata.count": 3,
       "@odata.id": "/redfish/v1/Systems/1/LogServices/DiagnosticLog/Entries",
       "@odata.context": "/redfish/v1/$metadata#LogEntryCollection.LogEntryCollection",
       "@odata.etag": "\"b99a3f5cb05232c73e0e1\"",
       "Name": "DiagnosticLogEntryCollection",
       "@odata.type": "#LogEntryCollection.LogEntryCollection",
       "Members": [
           {
               "EntryType": "Oem",
               "OemRecordFormat": "Lenovo",
               "AdditionalDataSizeBytes": 18458411,
               "Description": "This resource is used to represent a log entry for log services for a Redfish implementation.",
               "Created": "2024-04-06T22:48:00+00:00",
               "DiagnosticDataType": "Manager",
               "AdditionalDataURI": "/imm_dump/FFDC/7D75_J1111111_xcc_240406-224717.tzz",
               "@odata.etag": "\"3bf9b21a8f3d27e8a1d\"",
               "@odata.context": "/redfish/v1/$metadata#LogEntry.LogEntry",
               "Id": "FFDC",
               "Name": "FFDC",
               "@odata.type": "#LogEntry.v1_13_0.LogEntry",
               "@odata.id": "/redfish/v1/Systems/1/LogServices/DiagnosticLog/Entries/FFDC"
           },
           {
               "EntryType": "Oem",
               "OemRecordFormat": "Lenovo",
               "AdditionalDataSizeBytes": 0,
               "Description": "This resource is used to represent a log entry for log services for a Redfish implementation.",
               "DiagnosticDataType": "OS",
               "AdditionalDataURI": null,
               "@odata.etag": "\"3829a0dfb400266551b\"",
               "@odata.context": "/redfish/v1/$metadata#LogEntry.LogEntry",
               "Id": "FailureScreen",
               "Name": "Failure Screen",
               "@odata.type": "#LogEntry.v1_13_0.LogEntry",
               "@odata.id": "/redfish/v1/Systems/1/LogServices/DiagnosticLog/Entries/FailureScreen"
           },
           {
               "@odata.etag": "\"12629f2da6cf2ae17ee\"",
               "@odata.context": "/redfish/v1/$metadata#LogEntry.LogEntry",
               "@odata.type": "#LogEntry.v1_13_0.LogEntry",
               "@odata.id": "/redfish/v1/Systems/1/LogServices/DiagnosticLog/Entries/MPFA"
           }
       ]
   }
   

4. Create a Redfish X-Auth-Token to be used for downloading the service data file.

   curl -D header.txt -L -s -k -u USERID:password -X POST 'https://10.1.1.224/redfish/v1/SessionService/Sessions' -H 'Content-Type: application/json' --data ' {    "UserName" : "USERID",    "Password" : "password" }
   

   Response:

   {
       "UserName": "USERID",
       "@odata.etag": "\"1d08af338c332a22cf6\"",
       "Context": "",
       "Oem": {
           "Lenovo": {
           }
       },
       "CreatedTime": "2024-04-06T22:53:42+00:00",
       "SessionType": "Redfish",
       "@odata.context": "/redfish/v1/$metadata#Session.Session",
       "Password": null,
       "Id": "25",
       "Name": "25",
       "@odata.type": "#Session.v1_5_0.Session",
       "@odata.id": "/redfish/v1/SessionService/Sessions/25"
   }
   

5. Find the X-Auth-Token in header.txt file.

   cat header.txt
   

   Response:

   HTTP/1.1 201 Created
   Date: Sat, 06 Apr 2024 22:53:42 GMT
   Content-Type: application/json
   Transfer-Encoding: chunked
   Connection: keep-alive
   Location: /redfish/v1/SessionService/Sessions/25
   X-Auth-Token: 552B0845264B078EEE52204EA11071CD0486134B
   ETag: "1d08af338c332a22cf6"
   OData-Version: 4.0
   Content-Language: en
   Cache-Control: no-store
   Server: XCC Web Server
   Strict-Transport-Security: max-age=31536000; includeSubDomains
   Content-Security-Policy: default-src 'self'; connect-src *; script-src 'self'; img-src 'self' data:; style-src 'self'; font-src 'self'; child-src 'self'; object-src 'none'; frame-ancestors 'none'
   X-XSS-Protection: 1; mode=block
   X-Content-Type-Options: nosniff
   Cache-Control: no-cache, no-store, must-revalidate, private
   X-Frame-Options: DENY
   Referrer-Policy: same-origin
   X-Permitted-Cross-Domain-Policies: value
   X-Download-Options: value
   

6. Download the service data file.

   wget --header="X-Auth-Token: 552B0845264B078EEE52204EA11071CD0486134B" https://10.1.1.224/imm_dump/FFDC/7D75_J1111111_xcc_240406-224717.tzz --no-check-certificate
   

   Response:

   Connecting to 10.1.1.224:443... connected.
   HTTP request sent, awaiting response... 200 OK
   Length: 18458411 (18M) [application/octet-stream]
   Saving to: ‘7D75_J1111111_xcc_240406-224717.tzz’
   7D75_J1111111_xcc_240406-2 100%[========================================>]  17.60M  4.35MB/s    in 4.0s
   

This section provides a summary of the links to all the tools covered in this document.

XClarity Controller 3 (XCC3)

• Download: This tool is embedded in the firmware of Lenovo ThinkSystem V4 servers
• Documentation: https://pubs.lenovo.com/xcc3/

XClarity Controller 2 (XCC2)

• Download: This tool is embedded in the firmware of Lenovo ThinkSystem V3 servers.
• Documentation: https://pubs.lenovo.com/xcc2/

XClarity Controller (XCC)

• Download: This tool is embedded in the firmware of Lenovo ThinkSystem V1 and V2 servers (except ST50, ST50 V2, SR635, SR655).
• Documentation: https://pubs.lenovo.com/xcc/

XClarity Essentials OneCLI (LXCE)

• Download: https://datacentersupport.lenovo.com/us/en/solutions/lnvo-tcli
• Documentation: https://pubs.lenovo.com/lxce-overview/

XClarity Provisioning Manager (LXPM)

• Download: This tool is embedded in the firmware of Lenovo ThinkSystem servers.
• Documentation: https://pubs.lenovo.com/lxpm-overview/

XClarity Administrator (LXCA)

• Download: https://datacentersupport.lenovo.com/us/en/solutions/lnvo-lxcaupd
• Documentation: https://pubs.lenovo.com/lxca/

XClarity Orchestrator (LXCO)

• Download: https://datacentersupport.lenovo.com/us/en/solutions/lnvo-lxco 
• Documentation: https://pubs.lenovo.com/lxco/

XClarity Integrator (LXCI) for Windows Admin Center

• Download: https://datacentersupport.lenovo.com/us/en/solutions/lnvo-lxci-wac
• Documentation: https://pubs.lenovo.com/lxci-overview/

XClarity Mobile app (LXCM)

• Download: From the phone’s app store: search for “XClarity Mobile” or use the following links:
  • Google Play: https://play.google.com/store/apps/details?id=com.lenovo.xcmob
  • Apple Store: https://apps.apple.com/us/app/lenovo-xclarity-mobile/id1023231345
• Documentation: https://pubs.lenovo.com/lxca/lxca_usemobileapp.html

External diagnostics handset or integrated diagnostics panel

• Download: The external diagnostics handset must be purchased from Lenovo. The integrated diagnostics panel is available in some server models by default or as an option.
• Documentation: Go to https://pubs.lenovo.com, navigate to the desired server model, expand the section Server components > Front view > External diagnostics handset.