Dell System E-Support Tool Version 3.
Notes and Cautions NOTE: A NOTE indicates important information that helps you make better use of your computer. CAUTION: A CAUTION indicates potential damage to hardware or loss of data if instructions are not followed. _________________ Information in this publication is subject to change without notice. © 2012 Dell Inc. All rights reserved. Reproduction of these materials in any manner whatsoever without the written permission of Dell Inc. is strictly forbidden.
Contents 1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . What’s New In This Release. . . . . . . . . . . . . . . . Supported Platforms and Operating Systems . Installation Types 7 . . . . . . 8 . . . . . . . . . . . . . . . . . . . . . 8 Other Documents You May Need 2 7 . . . . . . . . . . . . . Installing, Upgrading, and Running DSET On Windows Operating System . . . . . . . . . . . . . . . . . . Installation Prerequisite For Windows Operating System . . . . . . . . . . . .
Using Installer For Windows Operating System . . . . . . . . . . . . . . . . . . . . . . 18 . . . . . . . . 19 Using GUI For Windows Operating System . Extracting MSI Package For Large Site Automated Deployment . . . . . . . . . Upgrading DSET On Windows Operating System . Using The Installer 3 . . . 19 . . . . . . . . . . . . . . . . . 20 Installing, Upgrading, and Running DSET On Linux Operating System . . . . . . . . . . . . . . . . . .
CLI Options . . . . . . . . . . . . . . . . . . . . . . . . For Windows Operating System For Linux Operating System . . . . . . . . . . . . 36 36 Usage Examples . . . . . . . . . . . . . . . . . . 41 Viewing DSET Report . . . . . . . . . . . . . . . . . . 42 Maintaining DSET . . . . . . . . . . . . . . . . . . 43 Modifying Installed DSET Features . . . . . . . . . . . 43 . . . . . . . . . . . . 44 . . . . . . . . . . . . . . . . . . . . .
For Windows Operating System For Linux Operating System . 6 Contents . . . . . . . . . . 28 . . . . . . . . . . . .
1 Introduction Dell System E-Support Tool (DSET) is a utility that collects configuration and log data for various chassis hardware, storage, software, and operating system components of a Dell PowerEdge server and consolidates the data into a .zip file.
Supported Platforms and Operating Systems For information on the supported platforms and operating systems (Windows and Linux), see the Readme available with the installer or go to support.dell.com/manuals. Click Software Serviceability Tools Dell System E-Support Tool.
Other Documents You May Need In addition to this user’s guide, you can view the Readme: • • During installation: – For Windows, available in the installer. – For Linux, run the ./dell-dset-lx(bit)-(Version Number).bin file and select option 1. After permanently installing DSET: – For Windows, in the Start menu, navigate to DSET 3.2View Readme. The Readme is displayed. – On Linux, Readme.txt is available at /opt/dell/advdiags/ dset/ folder.
Introduction
2 Installing, Upgrading, and Running DSET On Windows Operating System This chapter provides information to install DSET on Windows operating system. You can install and run DSET using the GUI or the Command Line Interface (CLI). Installation Prerequisite For Windows Operating System Before installing DSET, make sure that: • WMI service is installed and running. – If WMI service is stopped, DSET starts the service automatically and continues with installation.
Creating One-time Report (Zero Footprint Report Collection) On Windows Operating System DSET enables you to generate configuration report without permanently installing DSET. This is also known as zero footprint report collection. After the report is generated and saved on the system, all files used to create the report are removed from the system.
NOTE: The default location for Windows (x86) systems is C:\Program Files\Dell and for Windows (x86_64) systems is C:\Program Files (x86)\Dell. • Filter out sensitive data from the report — Select this option to filter the sensitive data (PII) from the report. To include any of the sensitive data to the report, specify ’No’ in the C:\Program Files(x86)\Dell\AdvDiags\DSET\config\ privacy_presetlist.cfg file (in 64-bit systems) or C:\Program Files\Dell\AdvDiags\DSET\config\privacy_presetlist.
8 Clear the options for which information is not required to be collected in the report. The options are: • Hardware Information • Storage Information • Software Information • Log Files 9 Select the Gather Advanced Log Files Information option to collect all the log information in the report. NOTE: Selecting the Advanced option may create large size reports. When selected, the Log Files are also included. 10 Click Next. The Ready to Collect Report window is displayed. 11 Click Start.
hw = All hardware information sw = All software (and operating system) information st = All storage information lg = All logs from the operating system and various applications ad = Include advanced log items For more information on the commands, see "Using DSET". Permanently Installing DSET and Generating Report On Windows Operating System Before installing DSET, make sure that the installation prerequisites are met. For more information, see "Installation Prerequisite For Windows Operating System".
6 Select one of the following options and click Next: • DSET Collector and DSET CIM Provider (default) • DSET Collector • DSET CIM Provider The Destination Folder window is displayed. 7 Click Browse and select the folder to install DSET or use the default location and click Next. The User Information window is displayed. NOTE: The default location for Windows (x86) systems is C:\Program Files\Dell and for Windows (x86_64) systems is C:\Program Files (x86)\Dell.
Using CLI For Windows Operating System To install DSET, run the following command: • Dell_DSET_(version number).exe INSTALL= INSTALLDIR= — This invokes the GUI. • Dell_DSET_(version number).exe INSTALL= INSTALLDIR= /qn —This performs silent installation that does not display any graphical progress bar.
The Readme Information is displayed. 4 Click Next. The Installation Type window is displayed. 5 Select Clear Hardware Log Only and click Next. The User Information window is displayed. 6 Enter the following: • Full Name — Enter your full name. • Organization — Enter your organization information. 7 Click Next. The Ready to Install the Application window is displayed 8 Click Next. The Updating System window is displayed.
Do you want to continue? Y/N: 2 Enter ’Y’ to clear the logs. The following messages are displayed: System event logs are cleared. Press Any Key To Continue 3 Press any key. The command window closes. Extracting MSI Package For Large Site Automated Deployment To extract the MSI file from DSET EXE: 1 Run the Dell_DSET_(Version Number).exe file. The Welcome to the Dell System E-Support Tool (3.2) Installation Wizard window is displayed.
• DSET 2.1 • DSET 2.2 NOTE: For versions below DSET 1.8 automatic upgrade to DSET 3.2 is not possible. When the DSET 3.2 installer is run, the installer terminates with an error message. In such cases, uninstall previous versions of DSET and then install DSET 3.2. NOTE: DSET does not require a system reboot. Using The Installer To automatically upgrade to DSET 3.2 using the installer: 1 Run the Dell_DSET_(Version Number).exe file. The Welcome to the Dell System E-Support Tool (3.
9 Enter the following: • Full Name — Enter your full name. • Organization — Enter your organization information. 10 Click Next. The Ready to Install the Application window is displayed. 11 Click Next. The Updating System window is displayed indicating the installation status. After installation, the Dell System E-Support Tool (3.
Installing, Upgrading, and Running DSET On Windows Operating System
2 Installing, Upgrading, and Running DSET On Linux Operating System This section provides information to install, upgrade and run DSET on Linux operating systems. During installation, DSET checks if OpenPegasus CIMOM or SFCB service is installed or running. The following table provides more information. Table 2-1.
– Platform is Dell PowerEdge 9, 10, 11, or 12th generation server. – OpenManage Server Administrator (if installed)version is between 5.5 to 7.0. Device Dependency On Linux Operating System The following table lists the devices and the dependencies that are required for Linux operating system to run DSET. If these device dependencies are not met, DSET exhibits the default behavior. Table 2-2.
Creating One-time Report (Zero Footprint Report Collection) On Linux Operating System DSET enables you to generate configuration report without permanently installing DSET. This is also known as zero footprint report collection. After the report is generated and saved on the system, all files used to create the report are removed from the system. To run DSET and create one-time report: NOTE: You must be logged in as root user to run DSET. 1 At the Linux shell prompt, run the .
Do you want store this report in a default name and location [y|n]: If you enter n, provide the report name or full path where the generated report must be saved. If the path is not specified, the report is saved in the root directory. NOTE: You can only save the report to an internal network path and not a HTTP path. 6 Enter y to enable privacy when the following message is displayed. Else enter n. If enabled, it filters the sensitive data (PII) from the report.
To proceed further with DSET report collection, it requires the root credentials of the system as it collects the Hardware data via Common Information Model Object Model. Dell System E-Support Tool @Copyright Dell Inc. 2004-2012 Version 3.2 Please enter "root" password: The data collection starts, the report is generated and saved as specified in step 5. If you chose to automatically upload the report, the report is uploaded and the Report uploaded successfully message is displayed.
Do you agree to the above license terms? ('y' for yes | 'Enter' to exit): 2 Enter y. The installation types are displayed. 3 Enter 3 to select Install/Upgrade DSET Collector and DSET CIM Provider option. If SFCB or OpenPegasus is not installed or running, the following message is displayed: The Small Footprint CIM Broker (SFCB) is a network service that enables remote collection of system configuration information.
For silent installation, run the command: dell-dset-lx(bit)-(Version Number).bin -qi Installing DSET Collector To permanently install DSET Collector: NOTE: You must be logged in as root to install DSET Collector. 1 At the Linux shell prompt, run the ./dell-dset-lx(bit)-(Version Number).bin file. The License Agreement is displayed along with the following message: Do you agree to the above license terms? ('y' for yes | 'Enter' to exit): 2 Enter y. The installation types are displayed.
The Small Footprint CIM Broker (SFCB) is a network service that enables remote collection of system configuration information. To perform the option that you selected, it is necessary to install and start this service and leave it running in background for future configuration collection. Continue installing/activating the SFCB on this system to listen for incoming collection requests from clients. Do you want proceed[y|n]? 4 Enter y.
The License Agreement is displayed along with the following message: Do you agree to the above license terms? ('y' for yes | 'Enter' to exit): 2 Enter y. The installation types are displayed. 3 Enter 6 to select Clear ESM Hardware Log option. *Going to clear the ESM Logs now Do you want to continue? Y/N: 4 Enter y to clear the logs. The following messages are displayed: System Event Logs are cleared. Press Any Key To Continue 5 Press any key. DSET exits and the Linux shell prompt appears.
Do you agree to the above license terms? ('y' for yes | 'Enter' to exit): 2 Enter y. Dell System E-Support Tool (DSET) options are displayed 3 Enter 2 to select Install/Upgrade DSET Collector and DSET CIM Provider option. The following messages are displayed: DSET (Version number)is already installed. Do you want to upgrade to DSET 3.2 [y|n]? 4 Enter y.
Wait for the installation to complete. The DSET installation completed successfully message is displayed. DSET is upgraded to version 3.2 and is installed at /opt/dell location by default.
Installing, Upgrading, and Running DSET On Linux Operating System
3 Using DSET You can generate reports on local and remote systems: • Local systems using GUI or CLI • Remote systems using CLI The data collection is allowed for the following operating systems on client and server: • Windows client to Windows server • Windows client to Linux server • Linux client to Linux server NOTE: The data collection is not allowed from Linux Client to Windows Server. Event viewer and application logs are generated that can be used for troubleshooting purpose.
NOTE: For few Windows operating systems (2003 R2, 2008, 2008 SBS, and 2011 SBS), you must run DSET in elevated previlege mode, where User Access Control (UAC) is enabled. To do this, right-click on Create Basic DSET Report or Create Advanced DSET Report, select Run As Administrator, and provide administrator password. For Linux, see "CLI Options". CLI Options This section provides the CLI options for Windows and Linux operating systems.
Command Description -h, --help Display the help text and exit. -s, --server Specify the server to connect to. Use ’.’ to specify the local server. For local report collection, the default setting is used and this parameter is not required. For remote report collection, the remote server's IP address must be provided. -u, --username For Windows, the current username is used by default. For Linux, specify the user name. For local report collection, this parameter is optional.
Command Description -d, --collect Specify the type of data to be collected (one or more of the following) separated by a comma without any space: • hw: Server • st: Storage • sw: Software • lg: Logs • ad: Advanced logs NOTE: If Advance logs option is selected, larger report is created and by default log files (hw, st, sw, lg) are created. -n, --namespace Specify the namespace to connect.
Command Description -c, --className Provide the class name to retrieve the data for a specific component. If class name is provided, specify the Namespace. For example, to retrieve data for CPU: For Windows: DellSystemInfo.exe -n root/dsetcim -c DCIM_CPUViewExt For Linux: dellsysteminfo -n root/dsetcim -c DCIM_CPUViewExt -r, --reportname Specify the default location for generated report (.zip) file. The default location is desktop for Windows and /root for Linux.
Order of Connection for Data Source The DSET Collector uses the following data sources based on the namespace to collect hardware and storage information: 1 DSET Provider (Linux or Windows) 2 OMSA Native (Linux or Windows) 3 ESX with SMASH profile 4 ESXi with OMSA installed The following table provides the data sources are supported for DSET Collector on Windows and Linux based system.
Usage Examples This section provides examples to generate report on your local and remote systems. On Local System Example 1: To collect software information and save it in the specified location, run the following command: • For Windows C:\Program Files\Dell\AdvDiags\DSET\bin> DellSystemInfo.exe -d sw -r C:\temp\software.zip • For Linux dellsysteminfo -d sw -r /opt/dell/myreports/software.
• For Linux dellsysteminfo -v yes -a auto -r /opt/dell/myreports/dsetreport.zip NOTE: If -d option is not specified, then hw, st, sw, and lg data categories are collected by default. On Remote System To run the report on a remote system, provide the Fully Qualified Domain Name (FQDN) or IP address of the remote system and administrator credentials.
4 Maintaining DSET After installing the DSET application, you can modify the components that are installed. The application maintainance window is available only when DSET permanently installed on your system. You can also reinstall the corrupt files, registry keys, and shortcuts of the application. Modifying Installed DSET Features The installed features that can be modified are: • Common — Installs all the files common to Provider and Collector. • Collector — Installs DSET Collector only.
For Linux Operating System To modify the installed components, run the ./dell-dset-lx(bit)-(Version Number).bin file at the shell prompt and choose the required option. You can: • Install another component(s). • Uninstall the current component(s) and reinstall the component(s) again. For more information see "Installing, Upgrading, and Running DSET On Linux Operating System".
6 Uninstalling DSET DSET can be uninstalled using the GUI or the CLI option. Using GUI For Windows Operating System To uninstall DSET, use one of the following options: From the Start Menu To uninstall DSET from the Start Menu on Windows operating systems: 1 Click Start Programs DSET 3.2 Uninstall DSET 3.2. The Are you sure you want to uninstall this product window is displayed. 2 Click Yes to uninstall DSET.
3 Click Next. The Updating System window is displayed. 4 Click Finish on the Dell System E-Support Tool (3.2) has been successfully uninstalled window. Using CLI For Windows and Linux Operating Systems To uninstall DSET using the CLI, run the following command from the command prompt: For Windows Operating System Msiexec /x{F3DBD63F-287B-4BF5-9B6C-BD3B70E107F4} The Windows Installer window displays Are you sure you want to uninstall this product? message. Click Yes to uninstall DSET.
A Error Codes This appendix provides the list of DSET error codes and Installer error codes. DSET Error Codes DSET Collector returns custom error codes on collection of reports. List of Error Codes on Report The list of error codes returned by dellsysteminfo are: Table 7-1.
Table 7-1.
Table 7-2. Installer Error Codes and Description Error Code Description 2 Unsupported OMSA version is installed on the system. NOTE: On a 32-bit Linux system, supported OMSA version for 32bit DSET installation is 5.5 to 7.0. NOTE: On a 64-bit Linux system, supported OMSA version for 64bit DSET installation is 6.3 to 7.0. In case, the installed OMSA version is between 5.5 to 6.2, 64-bit DSET cannot be installed and it is recommended to install 32-bit DSET. 3 Unsupported Operating System.
Table 7-2. Installer Error Codes and Description Error Code Description 20 Failed to install collector rpm. 21 Failed to install provider rpm. 22 User has not selected any option, hence aborted ZFP report collection. 23 Only collector is installed, but user has passed -qi or -qn option. 24 Only provider is installed, but user has passed -qi or -qn option.
