Intel® System Support Utility for Linux* operating system Version 2.5 Release Notes ================================================================ March 30, 2017 Intel® System Support Utility for the Linux* operating system is a standalone script that performs a detailed scan and report of the computer system information to assist you with customer support troubleshooting. Intel® SSU for Linux produces an output file that can be saved, viewed and shared by the user. Note: No personal information is collected. Intel is committed to protecting your privacy. For more information about Intel's Privacy Notice, please visit http://www.intel.com/privacy. Contents ======== - Operating System Support - Output file supported in the Intel® System Support Utility for Windows User Interface - Intel® SSU for Linux Script File - Root Access Requirement - Help Information - Exit Codes - 3rd Party Logging - ssu.sh Parameter List & Definitions - How to run ssu.sh from the terminal & command line examples - Additional Library or Tool Requirement Operating System Support ========================== Operating System (IA32 & X64) Linux RedHat Enterprise Linux 6.7 Linux RedHat Enterprise Linux 7.2 Linux SLES 11 SP4 Linux SLES 12 SP1 Ubuntu 16.04.1 Note: If the operating system is not supported, the following message is displayed This product is not supported on this operating system. Would you like to try to scan? Y/N Respond with “Y” and the SSU script will attempt to complete a system scan. Respond with “N” and the SSU script exits with a non-zero exit code. If the “--quiet” option has been input, the prompt is not displayed, and SSU will exit with a non-zero exit code. ssu.sh Output File ========================== The output file can be viewed/opened in most text editors, however it is recommended to view the file in a word processing software such as WordPad for better formatted viewing. In addition, the output file can be opened by the Intel ®System Support Utility for Windows. This provides the user the capability of viewing the Linux information in an easy to view User Interface. Intel® SSU for Linux Script File ========================== Intel® SSU for Linux is a standalone script named ssu.sh. The script provides basic functionality and does not require additional libraries or tools installed on the system. Root Access Requirement ========================== The ssu.sh script verifies that the logged in user is root. If the current user is not root, the following message will display and SSU will exit with a non-zero exit code. Message: "Root access is required to run this program." Note: If the “--quiet” option has been input, the prompt shall not be displayed. The following command can be used to determine if the current user is root: $ id -u Help Information ========================== Using these parameters will allow you to view the help information about the script. --help -h -? Exit Codes ========================== Unique exit codes are available to help identify the cause of any issues that may occur. The following exit codes are supported: Exit Code Meaning 0 SUCCESS 1 Operation not permitted - user is not root 2 Unknown options - unexpected parameters, wrong number of arguments, etc. 64 Unable to write to the designated output file 3rd Party Logging ========================== By default third party logging is NOT be included in the default scan and must be specified [logs=1]. The following logs are gathered when the logs parameter is enabled: System Messages, Boot Messages, Interrupts, PCI-E Config Space, Networking – EEPROM, Networking - Statistics Note: The collection of the log information may take several minutes. ssu.sh Parameter List & Definitions ========================== When a help parameter is input, the following text is displayed and the script exits with an exit code of zero. Usage: ssu.sh Note: Please be aware that some systems may require "Bash" to precede ssu.sh [bash ssu.sh] [--about] [--display=0|1] [--help] [--logs=0|1] [--memory=0|1] [--motherboard=0|1] [--network=0|1] [--operatingsystem=0|1] [--output=] [--platform=0|1] [--processor=0|1] [--quiet] [--storage=0|1] [--version] ssu.sh Parameter Definitions ========================== Note: Running ssu.sh with no parameters will capture all system information detailed below with the exception of 3rd party logs which must be specified. Note: Please be aware that some systems may require "Bash" to precede ssu.sh [bash ssu.sh] -a, --about View details about this tool -d, --display=0|1 Retrieve the display adapter information. 1 by default -l, --logs=0|1 Retrieve 3rd party logs. 0 by default. -m, --memory=0|1 Retrieve the memory information. 1 by default. -b, --motherboard=0|1 Retrieve the motherboard information. 1 by default. -n, --network=0|1 Retrieve the networking adapter information. 1 by default -os, --operatingsystem=0|1 Retrieve the operating system information. 1 by default. -o, --output= Specify the output file. -p, --platform=0|1 Retrieve the platform information. 1 by default. -c, --processor=0|1 Retrieve the processor information. 1 by default -s, --storage=0|1 Retrieve the storage information. 1 by default. --quiet Suppress all output --version View the version information How to run ssu.sh from the terminal ========================== 1. Open Applications -> Accessories -> Terminal 2. From the current director, navigate to the current folder where the ssu.sh file resides. For example if you saved the ssu.sh to a folder called "SSU File" the command would be: cd "SSU File" 3. Run the ssu.sh file using this command: ./ssu.sh where 0 = off and 1 = enabled 4. Use the parameter definitions included in the readme to determine which parameter to use. 5. If no parameter is specified and only ./ssu.sh is run, it will capture all system information with the exception of 3rd party logs which must be specified. If no output file is specified, the SSU will write the output to file .txt. ssu.sh command line examples (Assumes ssu.sh in in current directory) ========================== "All Information" Note: 3rd Party Logs not included (set to 0 by default and must be specified to capture) ./ssu.sh -o=All_Information.txt "Display_Only" ./ssu.sh -d=1 -l=0 -m=0 -b=0 -n=0 -os=0 -o=Display_Only.txt -p=0 -c=0 -s=0 "Memory_Only" ./ssu.sh -d=0 -l=0 -m=1 -b=0 -n=0 -os=0 -o=Memory_Only.txt -p=0 -c=0 -s=0 "Motherboard_Only" ./ssu.sh -d=0 -l=0 -m=0 -b=1 -n=0 -os=0 -o=Motherboard_Only.txt -p=0 -c=0 -s=0 "Network_Only" ./ssu.sh -d=0 -l=0 -m=0 -b=0 -n=1 -os=0 -o=Network_Only.txt -p=0 -c=0 -s=0 "OS_Only" ./ssu.sh -d=0 -l=0 -m=0 -b=0 -n=0 -os=1 -o=OS_Only.txt -p=0 -c=0 -s=0 "Platform_Only" ./ssu.sh -d=0 -l=0 -m=0 -b=0 -n=0 -os=0 -o=Platform_Only.txt -p=1 -c=0 -s=0 "CPU_Only" ./ssu.sh -d=0 -l=0 -m=0 -b=0 -n=0 -os=0 -o=CPU_Only.txt -p=0 -c=1 -s=0 "Storage_Only" ./ssu.sh -d=0 -l=0 -m=0 -b=0 -n=0 -os=0 -o=Storage_Only.txt -p=0 -c=0 -s=1 "Log_Only" ./ssu.sh -d=0 -l=1 -m=0 -b=0 -n=0 -os=0 -o=Log_Only.txt -p=0 -c=0 -s=0 Additional Library or Tool Requirement ========================== If additional libraries or tools are required to complete the system scan, the SSU script provides the option to install the required tools. Sample Message: The is recommended to retrieve additional details. Would you like to try and install it now? Y/N Respond with “Y” to attempt to connect to the appropriate download location and install the required library or tool. Respond with “N” and proceed to scan without using the additional required tools. For information that cannot be retrieved due to missing packages, SSU will use the designation of “Not Available”. Note: If the “--quiet” option has been input, the prompt is not displayed, and no attempt is made to download additional tools.