Dell™ Client Configuration Toolkit Version 1.0.1 User’s Guide w w w. d e l l . c o m | s u p p o r t . d e l l .
Notes NOTE: A NOTE indicates important information that helps you make better use of your computer. ____________________ Information in this document is subject to change without notice. © 2009 Dell Inc. All rights reserved. Reproduction of these materials in any manner whatsoever without the written permission of Dell Inc. is strictly forbidden. Trademarks used in this text: Dell, the DELL logo, PowerEdge, PowerVault, OptiPlex, Precision, Latitude and OpenManage are trademarks of Dell Inc.
Contents 1 Introduction . . . . . . . . . . . . . . . . . . . . . . . Supported Operating Systems . . . . . . . . . . . . . . 11 . . . . . . . . . . . . . . . . . . . 11 . . . . . . . . . . . . . . . . . . . . . . . 11 Supported Systems What’s New 2 Windows Install/Uninstall . . . . . . . . . . . . 13 . . . . . . . . . . . . . . . . . . 13 . . . . . . . . . . . . . . . . . . . . . 13 Install Prerequisites . Installing CCTK . . . . . . . . . . . . . . . 15 . . . . . . . . . . . . . . .
Installing CCTK 4 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 Uninstalling CCTK . . . . . . . . . . . . . . . . . . . . 22 Upgrading CCTK . . . . . . . . . . . . . . . . . . . . . 22 CCTK Options . . . . . . . . . . . . . . . . . . . . . . 23 Command Syntax Overview . . . . . . . . . . . . . . . 23 . . . . . . . . . . . . . . . 23 . . . . . . . . . . . . . . . . . .
--asset . . . . . . . . . . . . . . . . . . . . . . . --audiomode --autoon 35 . . . . . . . . . . . . . . . . . . . . 35 . . . . . . . . . . . . . . . . . . . . . . 35 --bioscharacteristics . . . . . . . . . . . . . . . . 36 --bioscurrentlang . . . . . . . . . . . . . . . . . 37 --bioslistinstalllang . . . . . . . . . . . . . . . . . 37 --biosromsize . . . . . . . . . . . . . . . . . . . . 37 . . . . . . . . . . . . . . . . . . . . . . 38 . . . . . . . . . . . . . . . . . . . . . . .
--fastboot --floppy . . . . . . . . . . . . . . . . . . . . . . 49 . . . . . . . . . . . . . . . . . . . . . . . 49 --hddacousticmode . --hddfailover . . . . . . . . . . . . . . . . 51 . . . . . . . . . . . . . . . . . . . . 51 --hddprotection . --hotdock . . . . . . . . . . . . . . . . . . 51 . . . . . . . . . . . . . . . . . . . . . . 52 --hwprefetcher --idecdrom . . . . . . . . . . . . . . . . . . . 52 . . . . . . . . . . . . . . . . . . . . . 53 --infrareddevice . . . . . . . . . .
--onboard1394 . . . . . . . . . . . . . . . . . . . --onboardmodem . 62 . . . . . . . . . . . . . . . . . 63 --osmode . . . . . . . . . . . . . . . . . . . . . . 63 --ovrwrt . . . . . . . . . . . . . . . . . . . . . . . 63 --passwordbypass --pccard . . . . . . . . . . . . . . . . . 64 . . . . . . . . . . . . . . . . . . . . . . 64 --pccardand1394 --pci . . . . . . . . . . . . . . . . . . 64 . . . . . . . . . . . . . . . . . . . . . . . . 65 --pcislots . . . . . . . . . . . . . . . . .
--satadipm . . . . . . . . . . . . . . . . . . . . . --scndidemaster --scndideslave 75 . . . . . . . . . . . . . . . . . . . 75 --serial1 . . . . . . . . . . . . . . . . . . . . . . . 75 --serial2 . . . . . . . . . . . . . . . . . . . . . . . 76 --serialcomm . . . . . . . . . . . . . . . . . . . . 76 --serrdmimsg . . . . . . . . . . . . . . . . . . . . 77 . . . . . . . . . . . . . . . . . . . . . 77 . . . . . . . . . . . . . . . . . . . . . . . .
--usbport01 . . . . . . . . . . . . . . . . . . . . . 87 --usbport02 . . . . . . . . . . . . . . . . . . . . . 87 --usbport03 . . . . . . . . . . . . . . . . . . . . . 87 --usbport04 . . . . . . . . . . . . . . . . . . . . . 88 --usbport05 . . . . . . . . . . . . . . . . . . . . . 88 --usbport06 . . . . . . . . . . . . . . . . . . . . . 88 --usbport07 . . . . . . . . . . . . . . . . . . . . . 89 --usbport08 . . . . . . . . . . . . . . . . . . . . . 89 --usbport09 . . . . . . . . . .
--wirelesswitchchanges . . . . . . . . . . . . . . 99 --wirelesswitchnlanctrl . . . . . . . . . . . . . . 100 . . . . . . . . . . . . . . . . . . . . . . 101 . . . . . . . . . . . . . . . . . . . . . 102 PCI Reporting TPM Activation Completion Code . 5 . . . . . . . . . . . . . . . . . . . . Troubleshooting CCTK . . . . . . . . . . . . . . Running CCTK Displays Error Messages . . . . . . . . Running CCTK on 32-bit and 64-bit Supported System . . . . . . . . . . . . . . . . . . . . . . . .
1 Introduction Dell™ Client Configuration Toolkit (CCTK) is a packaged software offering that provides configuration capability to Dell business client platforms – OptiPlex™, Latitude™ and Precision™. This product consists of a command line utility (cctk) to configure various BIOS features, and documentation of the utility. CCTK can be used in a Microsoft Windows® Preinstallation Environment (Windows PE), Windows (XP, Vista, and Windows 7), and Enterprise - Red Hat® Linux® environments.
Introduction
Windows Install/Uninstall 2 This section describes how to install and uninstall CCTK on Microsoft® Windows XP®, Windows Vista®, Windows 7® operating systems. This section also describes how to create a bootable image with CCTK to configure systems in a pre-operating system environment. Install Prerequisites Ensure that you have: • The CCTK installation file • A Windows workstation Installing CCTK Installing CCTK creates the CCTK directory structure in the system.
To install CCTK: NOTE: Ensure that you have administrator privileges. 1 Download the latest CCTK 1.0.1 self-extractable installation file. 2 Extract the installation file. a Double-click the downloaded installation file. The Systems Management dialog box is displayed with information on software version, supported systems, supported operating systems, and supported languages. b In the Systems Management dialog box, click Continue.
The default CCTK installation directory for a 32-bit supported system is C:\Program Files\Dell\CCTK and for a 64-bit supported system, it is C:\Program Files (x86)\Dell\CCTK. During the installation, the files are copied to the default directory or selected directory with the files for 32-bit support in the \X86 subdirectory and for 64-bit support in the \X86_64 subdirectory. NOTE: To see the CCTK documentation, click Start →Program Files → Dell →CCTK →User’s Guide.
Uninstalling CCTK Uninstalling CCTK removes all CCTK-related directories from your system. NOTE: Uninstalling CCTK will not uninstall HAPI. To uninstall HAPI, navigate to the HAPI directory and run HAPIUninstall.bat. To uninstall CCTK, do any of the following: • Click Start →Programs →Dell →CCTK →Uninstall. • Click Start →Settings →Control Panel →Add or Remove Programs. Select Client Configuration Toolkit and click Remove.
a Navigate to the directory where the script is located. By default, the script for 32-bit systems is located in the cctk\X86 directory. The script for 64-bit systems is located in the cctk\X86_64 directory. b Run the appropriate script with the .wim file and CCTK directory locations entered as two arguments: cctk_winpe.bat If CCTK is installed on the default directory, the 32-bit system script, cctk-x86-winpe.bat, would be run as: cctk_x86_winpe.bat C:\winPE_x86 C:\Pro
oscdimg –n –b\etfsboot.com \ISO Example: oscdimg –n –bc:\winPE_x86\etfsboot.com c:\winPE_x86\ISO c:\winPE_x86\WinPE2.0.iso This command creates a bootable ISO image, WinPE2.0.iso, in the WIM file directory. Creating a Bootable Image Using Windows PE 3.0 Using Windows PE 3.0, you can integrate CCTK, HAPI, and related drivers directly into a bootable ISO image. Use the following steps to create a bootable image using Windows PE 3.
c Run the script with the path where you want to create the ISO file and the CCTK installation directory as two arguments. NOTE: The directory where you want to create the ISO image should not exist. Example for a 32-bit system: cctk_x86_WinPE_3.bat C:\winPE_x86 C:\Progra~1\Dell\CCTK Example for a 64-bit system: cctk_x86_64_WinPE_3.bat C:\winPE_x86 C:\Progra~2\Dell\CCTK This creates a directory, winPE_x86. The ISO image and the WIM file are created inside the WIM directory under winPE_x86.
Windows Install/Uninstall
3 Linux Install/Uninstall This section describes how to install and uninstall CCTK on Linux operating systems. Install Prerequisites Ensure that you have: • The CCTK installation file (cctk-linux-a.b.c.-buildnum.tar.gz) • A Linux workstation Installing CCTK To install CCTK, install the RPMs provided in the CCTK installation file. Prerequisite • You should be a user with root privileges. • CCTK can run only on a Dell™ system.
3 Install the RPMs in the following order: rpm –ivh srvadmin-ipmi-6.0.1-800.DUP.i386.rpm rpm –ivh srvadmin-omilcore-6.0.1-800.i386.rpm rpm –ivh srvadmin-hapi-6.0.1-800.i386.rpm rpm –ivh cctk-1.0.1.i386.rpm 4 Using the command prompt, navigate to the /opt/dell/toolkit/bin directory to run the CCTK commands. For more details on running the CCTK commands, see to CCTK Options. Uninstalling CCTK To uninstall CCTK, remove the CCTK RPMs. 1 Run the following command to uninstall CCTK: rpm -e cctk-1.0.1-buildnum.
4 CCTK Options This chapter documents a general overview of the Client Configuration Toolkit (CCTK) command line utility. It also describes the command line options, configuration file format, and individual executables used to configure client BIOS settings. Command Syntax Overview Syntax refers to the way a command and its parameters are entered. CCTK Command Line Interface (CLI) commands can be arranged in any order in a command line instance as long as they conform to the basic command line syntax.
Table 4-1. Command Line Syntax (continued) Element Description optionX Generic multi-character designation for a utility name, where X can be used to distinguish multiple options used in the same command line instance. argX Generic designation for an argument, where X can be used to distinguish multiple arguments used in the same command line instance. [mandatory option] Generic designation for a mandatory argument. Generic designation for a string.
Table 4-2. CCTK Command Line Examples Valid/ Invalid CCTK Command Line Example valid cctk --option1 --option2 cctk --asset --mem invalid cctk --option1=[argument] cctk --asset=1750 --floppy --biosromsize --option2 --option3 valid cctk -o=filename --option1 --option2 cctk -o=/tmp/myfile.txt --mem --sysname or or cctk -o filename --option1 --option2 cctk -o /tmp/myfile.txt --mem --sysname cctk -l=filename --option1 --option2 cctk -l=/tmp/myfile.txt --mem --sysname or cctk -l /tmp/myfile.
Read and Write Options Options that specify read and write actions should not be mixed in a command line instance. Table 4-3 provides examples for read and write commands. Table 4-3. Read and Write Command Examples Valid/Invalid CCTK Command Line Example valid cctk --option1 --option2 valid cctk --option1=arg --option2=arg invalid cctk --option1=arg --option2 File Input and Output Commands • File input is specified by the -i= command, where is the name of the input file.
Help Option The -h and --help options display general usage information for the utility. If the argument matches a valid option, that option's usage information is displayed. If the option has arguments, the arguments are displayed, separated by a | character. If the argument does not match a valid option, a usage error is given (and usage information is displayed). Error Checking and Error Messages The CCTK utilities check your commands for correct syntax when you enter them.
Description Without an argument, this option displays general usage information for the utility. If the argument matches a valid option, that option's usage information is displayed. If the option has arguments, the arguments are displayed, separated by a | character. If the option has suboptions, all suboptions, valid arguments, and a description are listed. If the argument does not match a valid option, a usage error is given (and usage information is displayed).
For example: bootorder=+pcmcia,+hdd.1,-floppy,+cdrom,hdd.2,+nic.1,-hdd.3,+nic.2 A plus (+) symbol with the device name indicates that the device is enabled and a minus (-) symbol indicates that the device is disabled. You can enable or disable the devices by changing the + or - symbol displayed with the device short name. These symbols are optional and if not present, the current status of the device is retained. Change the boot order by changing the order of the list.
Example A:>cctk Usage error. cctk Version 1.0.1 (Windows - December 10 2009, 17:46:37) Copyright (c) 2009 Dell Inc. Usage: cctk --option[=argument] For more information about a particular command, use the option '-h' followed by the command name. Example: cctk -h --asset -o or --outfile Valid Argument Description Writes all BIOS options, that you can replicate to another system’s BIOS, to the specified filename. The file name you specify should have .
You can enable or disable the devices by changing the + or - symbol displayed with the device. These symbols are optional and if not present, the current status of the device is retained. Example A:>cctk -o /filename.ini --version Valid Argument read-only argument Description Displays the version information, current time, and date for the utility. This is a read-only option. Example A:>cctk --version cctk Version 1.0.1 Windows - December 10 2009, 14:24:32) Copyright (c) 2009 Dell Inc.
BIOS Options The following list describes CCTK options and arguments along with a description of their expected behavior. Options and arguments are case sensitive. All options and pre-defined arguments are lowercase unless stated otherwise. NOTE: Some of the following options or arguments might not be available on all systems due to the BIOS version or hardware feature set. Entering CCTK on a command line without arguments will display only those options that are valid for your system.
Description Adds the specified device to the boot device list. At present, only the USB storage device is supported. This option is not valid in all the systems. The USB storage device is added at the end of the boot order. If the USB device is already added in the boot order list, executing the option does not change anything. If the USB storage device is already added in the boot order list, the following message is displayed while executing the option: “USB device is already present in this machine”.
--agpslot Valid Argument enable, disable Description Enables or disables on-board AGP slot. Example A:>cctk --agpslot=enable agpslot=enable --amblightsen Valid Argument enable, disable Description Enables or disables the ambient light sensor. Example A:>cctk --amblightsen=enable amblightsen=enable --asfmode Valid Argument on, off, alertingonly, dash Description Sets the alert standard format. The alertonly argument enables only error messages.
Example A:>cctk --asfmode=on asfmode=on --asset Valid Argument Description Reports or sets the customer-programmable asset tag number for a system. The maximum length of an asset tag is 10 characters. Asset tag values should not contain any spaces. Example A:>cctk --asset=ASSETTAG --audiomode Valid Argument disable, halfduplex, fullduplex Description Sets the audio mode to any of the following values: • disable: Completely releases the onboard hardware resources.
Description Sets the auto on configuration. Example A:>cctk --autoon=disable autoon=disable --bioscharacteristics Valid Argument read-only argument Description Displays the features supported by the specific version of the BIOS. This contains bit-flags which define support attributes for the BIOS and the system. The first 32-bits are from the reference specification available on the Distributed Management Task Force website at dmtf.org.
--bioscurrentlang Valid Argument read-only argument Description Displays the selected language for the BIOS. Example A:>cctk --bioscurrentlang bioscurrentlang=en|US|iso8859-1 --bioslistinstalllang Valid Argument read-only argument Description Displays a list of installable languages for the BIOS. Example A:>cctk --bioslistinstalllang bioslistinstalllang=en|US|iso8859-1 --biosromsize Valid Argument read-only argument Description Displays the physical size of this BIOS ROM device in kilobytes.
--biosver Valid Argument read-only argument Description Reports the BIOS version for a system. Example A:>cctk --biosver biosver=A08 --bisreq Valid Argument accept, deny, reset Description Enables or disables the Boot Integrity Services (BIS) in BIOS. Example A:>cctk --bisreq=accept bisreq=accept --bitsmart Valid Argument enable or disable Description Enables or disables Bitsmart.
--bltinpntdevice Valid Argument disable, enable Description Enables or disables built-in pointing device. Example A:>cctk --bltinpntdevice=disable bltinpntdevice=disable --bluetoothdevice Valid Argument enable, disable Description Enables or disables bluetooth device. Example A:>cctk --bluetoothdevice=enable bluetoothdevice=enable bootorder Valid Argument None Description Displays or sets the boot order sequence and enables or disables the supported devices.
• Device number—a unique number to identify the device on the system. • Device type—the device type. • Short form—short form of the device. If the system has many devices of the similar device type, the short form of the device is displayed with a . notation. For example, if the system has an internal HDD, a USB storage device, and a modular Bay HDD, the short forms will be displayed as hdd.1, hdd.2, and hdd.3 respectively. • Device description—description of the device.
Figure 4-2. Output of the bootorder Option Sub Options --sequence Sets the bootorder based on the arguments provided. Use the device number or device short form as the argument. Example A:>cctk bootorder --sequence=embnic,hdd.1 or A:>cctk bootorder --sequence=1,3 Example for Unknown Devices A:>cctk bootorder --sequence=x01.1,x01.2 --enabledevice Enables a device in the boot sequence. Use the device number or device short form as the argument. Example A:>cctk bootorder --enabledevice=embnic,hdd.
Example A:>cctk bootorder --disabledevice=embnic,hdd.1 or A:>cctk bootorder --disabledevice=1,3 Example With Sub Options A:>cctk bootorder --sequence=hdd.1,floppy -enabledevice=cdrom,hdd.2 --disabledevice= nic.1,hdd.3 --bootspeed Valid Argument default, compatible Description Sets CPU speed to Default or Compatible. Sets CPU speed to Compatible (significantly slower). This is implementation dependent. There is no set speed for Compatible, only that it is significantly slower than Default.
--cellularradio Valid Argument disable, enable Description Enables or disables the cellular radio, that is, the wwan module. Example A:>cctk --cellularradio=disable cellularradio=disable --charger Valid Argument enable, disable Description Enables or disables the battery charging system. NOTE: When the computer is turned off, the battery charger is enabled.
Example A:>cctk --chasintrusion=enable chasintrusion=enable --clearsel Valid Argument none Description Erases the contents of the system event log. Example A:>cctk --clearsel --cmosdefaults Valid Argument enable, disable Description Enables or disables the request for a default of CMOS values on the next booting.
Example A:>cctk --completioncode completioncode=0000h --coolnquiet Valid Argument enable, disable Description Enables or disables AMD cool and Quiet processor feature. Example A:>cctk --coolnquiet=enable coolnquiet=enable --cpucore Valid Argument 1, 2, 4, 6, 8, 10, 12, or all Description Controls the number of enabled cores in each processor. By default, maximum number of cores per processor will be enabled.
Example A:>cctk --cpucount cpucount=1 --cpuspeed Valid Argument read-only Description Reports the current speed of the processor. Example A:>cctk --cpuspeed cpuspeed=1600MHz --cpuxdsupport Valid Argument enable, disable Description Enables or disables the CPU eXecute Disable (XD) feature support. Example A:>cctk --cpuxdsupport=enable cpuxdsupport=enable --cstatesctrl Valid Argument enable, disableDescription Enables or disables the C states.
Example A:>cctk --cstatesctrl=enable cstatesctrl=enable --embnic1 Valid Argument off, on, onnopxe, onwithiscsi, onwithrplboot, onwithimageserverboot Description Defines whether built-in NIC is enabled or disabled. Enabled with ImageServer boot will be used in the deployment of Dell SmartClient products. Example A:>cctk --embnic1=off embnic1=off --embnic2 Valid Argument on, off, onnopxe, onwithiscsi, onwithrplboot, onwithimageserverboot Description Enables or disables the second embedded NIC.
Description Configures the embedded SATA RAID controller. Example A:>cctk --embsataraid=off embsataraid=off --esataports Valid Argument enable, disable Description Enables or disables all e-sata ports. If the system supports a dock, this status is also applicable to all e-sata ports on the dock. Example A:>cctk --esataports=enable esataports=enable --expresscharge Valid Argument enable, disable, once Description Enables or disables the express charge battery charge algorithm.
--externalhotkey Valid Argument disable, scrolllock Description Enables or disables the external keyboard hot-key feature. Scroll Lock allows the Scroll Lock key on an external keyboard to act as the FN key on the internal keyboard. Example A:>cctk --externalhotkey=disable externalhotkey=disable --fastboot Valid Argument thorough, minimal, automatic Description Enables fast booting. If set to minimal, sets POST to perform minimal hardware testing.
Description Configures the floppy diskette controller. auto: Enables the auto-configuration of the system’s built-in floppy controller. readonly: floppy controller becomes read-only, no write operations are permitted. usb: the built-in floppy controller is disabled but booting to a USB floppy is still allowed. Example A:>cctk --floppy=on floppy=on --forcepxenextboot Valid Argument enable, disable Description Enables or disables Force PXE on next boot in BIOS.
--hddacousticmode Valid Argument bypass, quiet, suggested, performance Description Sets the hard disk acoustic mode. If set to Bypass, BIOS does not modify the hard disks' currently set acoustic mode. Quiet sets the hard disks' acoustic mode to the quietest operation. Suggested sets the hard disks' acoustic mode to the manufacturer's suggested setting. Performance sets the hard disks' acoustic mode for the highest disk performance.
Description Enables or disables the HDD protection feature. The Hard Disk Protection is an advanced feature intended to keep the HDD data secure and unchangeable. See the documentation provided with your system for more details on this feature. Example A:>cctk --hddprotection=on hddprotection=on --hotdock Valid Argument on, off Description Enables or disables hot docking.
--idecdrom Valid Argument auto, off Description Enables or disables the CD drive. Example A:>cctk --idecdrom=auto idecdrom=auto --infrareddevice Valid Argument disabled, COM1, COM2, COM3, COM4 Description Sets the infrared port. Example A:>cctk --infrareddevice=COM1 infrareddevice=COM1 --integratedaudio Valid Argument enable, disable, auto Description Sets the status of the system’s integrated sound device.
--integratedraid Valid Argument enable, disable Description Enables or disables the integrated RAID. Example A:>cctk --integratedraid=enable integratedraid=enable --integratedsas Valid Argument enable, disable Description Enables or disables the integrated SAS controller. Example A:>cctk --integratedsas=enable integratedsas=enable --integratedusbhub Valid Argument compatible, high speed Description Sets the integrated USB hub to compatible or high speed.
--internalminipci Valid Argument enable, disable Description Enables or disables the internal mini PCI slot. Example A:>cctk --internalminipci=enable internalminipci=enable --internalusb Valid Argument on, off Description Enables or disables internal USB ports. Example A:>cctk --internalusb=on internalusb=on --keyboardclick Valid Argument enable, disable Description Enables or disables the keyboard click sound.
--keyboardillumination Valid Argument on, off, auto Description Sets the keyboard illumination to enabled, disabled, or auto status. If set to auto, illumination is set based on ambient light level. Example A:>cctk --keyboardillumination=on keyboardillumination=on --keypad Valid Argument enabledbynumlock, enabledbyfnkey Description Enables the keypad in two different ways: numlock and function key.
--limitcpuidvalue Valid Argument on, off Description Limits the maximum value the processor standard CPUID function supports. Some operating systems will be unable to install if the maximum CPUID function supported is greater than 3. If set to on, the CPUID function is limited to 3. If set to off, the CPUID function is not limited to 3.
Description Enables or disables the low power (S5) state. If set to enabled, the system will go into lowest-Power Off mode in S4 and S5, turning off as much of the power-consuming circuitry as required, to attempt to meet 1W power limit. This may disable things like PME, USB power, etc. If set to disabled, the system will be in a normal power-use mode when in S4 or S5.
at: enables the system’s built-in parallel port to operate in AT mode (output-only). ps2: enables the system’s built-in parallel port to operate in PS/2 mode (bi-directional). ecp: enables the system’s built-in parallel port to operate in ECP mode, no DMA channel assigned. epp: enables the system’s built-in parallel port to operate in EPP mode. ecpdma1: enables the system’s built-in parallel port to operate in ECP mode DMA channel 1.
Description Reports the amount of system memory physically installed in the system, not the amount of memory available to an operating system. The last two characters of the memory value indicate the order of magnitude used (KB or MB). Example A:>cctk --mem mem=256MB --microphone Valid Argument enable, disable Description Enables or disables Dell notebook’s internal or external microphone.
--monitortoggling Valid Argument enable, disable Description Enables or disables monitor toggling. Example A:>cctk --monitortoggling=enable monitortoggling=enable --mouse Valid Argument off, on Description Turns the mouse controller on or off. Example A:>cctk --mouse=off mouse=off --multicpucore Valid Argument enable, disable Description Allows the users to disable or enable Multiple CPU Cores if needed.
Example A:>cctk --multicpucore=enable multicpucore=enable --nmibutton Valid Argument enable, disable Description Enables or disables the front bezel NMI button. The NMI button can be used to alert the operating system in certain cases. Example A:>cctk --nmibutton=enable nmibutton=enable --numlock Valid Argument on, off Description Enables or disables the keyboard’s number lock.
Example A:>cctk --onboard1394=enable onboard1394=enable --onboardmodem Valid Argument enable, disable Description Enables or disables the onboard modem. Example A:>cctk --onboardmodem=enable onboardmodem=enable --osmode Valid Argument enable, disable Description Enables or disables the operating system installation mode.
Example A:>cctk -o=filename.ini --ovrwrt The file filename has been overwritten. --passwordbypass Valid Argument off, reboot bypass, resumebypass, rebootandresume bypass Description Sets the password bypass feature. Example A:>cctk --passwordbypass=off passwordbypass=off --pccard Valid Argument enable, disable Description Enables or disables the PC card.
Example A:>cctk --pccardand1394=enable pccardand1394=enable --pci Valid Argument read-only argument Description Performs a scan of all PCI buses and displays the results. The utility uses an open source pci.ids file for vendor/device name resolution. The utility looks for a file called pci.ids in the current working directory. If the file is not found in the current working directory, the directory containing the CCTK executable is searched.
Class: 06 - Bridge SubClass: 00 - CPU/PCI PCI Bus: 0, Device: 0, Function: 2 Vendor: 1166 - ServerWorks Device: 0000 - Unknown --pcislots Valid Argument enable, disable Description Enables or disables the system's add-in PCI slots. Example A:>cctk --pcislots=enable pcislots=enable --penmisindication Valid Argument enable, disable Description Enables or disables the missing pen indication. This property is used to control Tablet PC pen removal.
Description Enables or disables the resume on pen setting. Example A:>cctk --penresumeon=disable penresumeon=disable --pntdevice Valid Argument disable , disable Description Enables or disables the pointing device. Example A:>cctk --pntdevice=enable pntdevice=disable --postf12key Valid Argument enable, disable Description Enables or disables F12 boot menu on POST boot screen.
Description Enables or disables F2 boot menu on POST boot screen. Example A:>cctk --postf2key=enable postf2key=enable --posthelpdeskkey Valid Argument enable, disable Description Enables or disables display of the ctrl+h help desktop hotkey message on the post screen if Management Engine (ME) is alive and Client Initiated Remote Access (CIRA) is supported.
--powermgmt Valid Argument disabled, minimum, regular, maximum Description Defines the power management settings. Example A:>cctk --powermgmt=minimum powermgmt=minimum --primidemast Valid Argument auto, off Description Enables or disables primary IDE master channel. Example A:>cctk --primidemast=off primidemast=off --primideslav Valid Argument auto, off Description Enables or disables primary parallel IDE slave channel.
--pwdlock Valid Argument locked, unlocked Description Controls the ability to set the system password. If the password is locked, it cannot be changed. The locked argument locks the current state of the system password. If a system password has been set, it cannot be removed. If a system password has not been set, it cannot be set. On specific BIOS settings, this feature does not work. Refer to the BIOS documentation for more information.
Example A:>cctk --remotebiosupdate=enable remotebiosupdate=enable --rptkeyerr Valid Argument enable, disable Description Configures or reports whether the BIOS reports keyboard errors during POST. Example A:>cctk --rptkeyerr=disable rptkeyerr=disable --safeusb Valid Argument enable, disable Description Enables or disables selective USB feature to disable all USB ports, except the two selective USB ports.
Description Enables or disables SATA port 0. Example A:>cctk --sata0=auto sata0=auto --sata1 Valid Argument auto, off Description Enables or disables SATA port 1. Example A:>cctk --sata1=auto sata1=auto --sata2 Valid Argument auto, off Description Enables or disables SATA port 2.
Description Enables or disables SATA port 3. Example A:>cctk --sata3=auto sata3=auto --sata4 Valid Argument auto, off Description Enables or disables SATA port 4. Example A:>cctk --sata4=auto sata4=auto --sata5 Valid Argument auto, off Description Enables or disables SATA port 5.
Description Enables or disables SATA port 6. Example A:>cctk --sata6=auto sata6=auto --sata7 Valid Argument auto, off Description Enables or disables SATA port 7. Example A:>cctk --sata7=auto sata7=auto --satactrl Valid Argument enable, disable Description Enable or disable all the SATA controllers. The option applies to all SATA controllers.
Description Disables or enables the feature that allows SATA HDDs to initiate link power management transitions. Example A:>cctk --satadipm=enable satadipm=enable --scndidemaster Valid Argument auto, off Description Enables or disables secondary parallel IDE master channel. Example A:>cctk --scndidemaster=on scndidemaster=on --scndideslave Valid Argument auto, off Description Enables or disables secondary parallel IDE slave channel.
Description Defines the serial port 1 configuration. Example A:>cctk --serial1=disable serial1=disable --serial2 Valid Argument disable, auto, com2, com4 Description Defines the serial port 2 configuration. Example A:>cctk --serial2=disable serial2=disable --serialcomm Valid Argument off, on, com1cr, com2cr Description Sets the behavior of the serial port communication. When set to on, this option tells the BIOS to enable COM port 1 and COM port 2.
When set to off, this option tells the BIOS to disable COM port 1 and COM port 2. Example A:>cctk --serialcomm=on without console redirection serialcomm=on without console redirection --serrdmimsg Valid Argument on, off Description Enables or disables serr Dmi messages. Example A:>cctk --serrdmimsg=on serrdmimsg=on --setuppwd Valid Argument Description Sets the setup password. An argument is required. The password cannot be reported. Initially you can set the password.
--sma Valid Argument enable, disable Description Enables or disables processor sequential memory access. Example A:>cctk --sma=disable sma=disable --smartcardreader Valid Argument enable, disable Description Enables or disables the smart card reader. Example A:>cctk --smartcardreader=enabled smartcardreader=enable --smarterrors Valid Argument enable, disable Description Enables or disables SMART errors.
--snoopfilter Valid Argument enable, disable Description Enables or disables the snoop filter option from the system BIOS. Example A:>cctk --snoopfilter=enable snoopfilter=enable --speakervol Valid Argument enable, disable, low, medium, high Description Controls the volume of the speaker. enable: Enables the built-in speaker. The speaker is enabled at the single system-supported volume. This should be used only if the Speaker Volume Low/Medium/High attributes are not supported by the system.
Description Sets the speedstep status to automatic, disabled, max performance, or max battery. Example A:>cctk --speedstep=automatic speedstep=automatic --splashscreen Valid Argument enable or disable Description Enables or disables the display of the splash or summary screen, rather than the detail of the POST flow. Example A:>cctk --splashscreen=enable splashscreen=enable --svctag Valid Argument read-only Description Reports the service tag for a system.
--sysid Valid Argument read-only argument Description Defines the Dell Systems ID byte for systems that support it. The value of this feature is -1, if the system does not support it. Example A:>cctk --sysid sysid=0169 --sysname Valid Argument read-only argument Description This function command reports the system identification string for a server, which is the string displayed under the Dell logo during POST.
Example A:>cctk --syspwd= --valsyspwd= --sysrev Valid Argument read-only Description Reports the system revision. Example A:>cctk --sysrev sysrev=000 --sysbatcharger Valid Argument enable, disable Description Enables or disables the battery charging system. Example A:>cctk --sysbatcharger=enable sysbatcharger=enable --tabletbuttons Valid Argument enable, disable Description Enables or disables tablet buttons.
Example A:>cctk --tabletbuttons=enable tabletbuttons=enable --tpm Valid Argument on, off Description Enables or disables the trusted platform module (TPM). Example A:>cctk --tpm=on tpm=on --tpmactivation Valid Argument activate, deactivated Description Remotely activates the TPM depending on certain security criteria. The deactivated option is a read-only argument for reporting the current activation state of the TPM. For more details, see the section, TPM Activation.
Description Enables or disables single core-based turbo mode. When enabled, Intel® Turbo Boost Technology allows processor(s) to run at frequencies higher than the advertised frequency. Example A:>cctk --turbomode=enable turbomode=enable --uartpowerdown Valid Argument on, off Description Enables operating system to power down UART or disables operating system from powering down UART.
--usbflash Valid Argument auto, floppy, hard disk Description Sets the USB flash drive emulation to auto, floppy, or hard disk. Example A:>cctk --usbflash=auto usbflash=auto --usbports Valid Argument enable, disable, noboot Description Enables or disables user accessible USB ports. noboot: Enables BIOS emulation of all supported USB devices except for bootable devices (floppy, USB flash, etc.).
Example A:>cctk --usbportsexternal=enable usbportsexternal=enable --usbportsfront Valid Argument disable, enable Description Enables or disables the USB ports on the front of the chassis. Example A:>cctk --usbportsfront=disable usbportsfront=disable --usbpowershare Valid Argument enabled, disabled Description Enables or disables the USB power share.
Example A:>cctk --usbport00=enable usbport00=enable --usbport01 Valid Argument enable, disable Description Enables or disables USB port 01. Example A:>cctk --usbport01=enable usbport01=enable --usbport02 Valid Argument enable, disable Description Enables or disables USB port 02. Example A:>cctk --usbport02=enable usbport02=enable --usbport03 Valid Argument enable, disable Description Enables or disables USB port 03.
Example A:>cctk --usbport03=enable usbport03=enable --usbport04 Valid Argument enable, disable Description Enables or disables USB port 04. Example A:>cctk --usbport04=enable usbport04=enable --usbport05 Valid Argument enable, disable Description Enables or disables USB port 05. Example A:>cctk --usbport05=enable usbport05=enable --usbport06 Valid Argument enable, disable Description Enables or disables USB port 06.
Example A:>cctk --usbport06=enable usbport06=enable --usbport07 Valid Argument enable, disable Description Enables or disables USB port 07. Example A:>cctk --usbport07=enable usbport07=enable --usbport08 Valid Argument enable, disable Description Enables or disables USB port 08. Example A:>cctk --usbport08=enable usbport08=enable --usbport09 Valid Argument enable, disable Description Enables or disables USB port 09.
Example A:>cctk --usbport09=enable usbport09=enable --usbport10 Valid Argument enable, disable Description Enables or disables USB port 10. Example A:>cctk --usbport10=enable usbport10=enable --usbport11 Valid Argument enable, disable Description Enables or disables USB port 11. Example A:>cctk --usbport11=enable usbport11=enable --usbport12 Valid Argument enable, disable Description Enables or disables USB port 12.
Example A:>cctk --usbport12=enable usbport12=enable --usbport13 Valid Argument enable, disable Description Enables or disables USB port 13. Example A:>cctk --usbport13=enable usbport13=enable --usbport14 Valid Argument enable, disable Description Enables or disables USB port 14. Example A:>cctk --usbport14=enable usbport14=enable --usbport15 Valid Argument enable, disable Description Enables or disables USB port 15.
Example A:>cctk --usbport15=enable usbport15=enable --usbreardual Valid Argument on, off Description Enables or disables the rear dual stack if there is only one rear dual stack. Example A:>cctk --usbreardual=on usbreardual=on --usbreardual2stack Valid Argument on, off Description Enables or disables the second rear dual stack if there are two rear dual stacks.
Description Enables or disables rear Quad USB ports (or rear triple stack on the OptiPlex 740.) Example A:>cctk --usbrearquad=on usbrearquad=on --usbwake Valid Argument enable, disable Description Enables or disables USB wake setting in the next boot. Any USB input device can generate a wake event. Example A:>cctk --usbwake=enable usbwake=enable --uuid Valid Argument read-only argument Description Reports the UUID for a system. The UUID is a unique system identifier used in PXE requests.
--valsetuppwd Valid Argument password Description Validates the setup password while setting a value in the BIOS. This is applicable only if you set a setup password or both setup password and system password. Example A:>cctk --numlock=enable --valsetuppwd= numlock=enable --valsyspwd Valid Argument password Description Validates the system password while setting a value in the BIOS. This is applicable only if you set a system password and did not set a setup password.
Example A:>cctk --vgadacsnoop=enable vgadacsnoop=enable --videoexpansion Valid Argument enable, disable Description Enables or disables the video expansion. Example A:>cctk --videoexpansion=enable videoexpansion=enable --videomemsize Valid Argument auto, off, 12MB, 16MB, 32MB, 64MB, 128MB, 256MB, 512MB, 1GB Description Sets the video memory size to the given value. These arguments are used to configure the amount of memory allocated to the onboard video chipset.
Description Enables or disables the Intel virtualization technology for Direct I/O (vt-d) – new chipset feature that enhances I/O support (DMA), while running a virtual machine monitor. enable: enables the additional hardware capabilities provided by Virtualization Technology in applicable CPUs. disable: disables the additional hardware capabilities provided by Virtualization Technology.
enable: the system wake-on-LAN feature is enabled; either an onboard or an add-in NIC can wake the system up. disable: the system will not respond to magic packets or other means of wake-on-LAN. The NIC chip section that looks for packets will not be powered. network: when the system powers on due to a wake-on-LAN event, the NIC boot-ROM is automatically given the highest boot priority, pre-pending the PXE boot-ROM to the system current boot sequence.
Example A:>cctk --wificatcherchanges=permitted wificatcherchanges=permitted --wifilocator Valid Argument enable, disable Description Enables or disables the Wi-Fi locator. When enabled, the locator feature can be activated during S3 to indicate the presence and intensity of wireless network(s), without fully waking the system. Example A:>cctk --wifilocator=enable wifilocator=enable --wirelessdevice Valid Argument disable, enablectrlbyapp, enablectrlhotkeyapp Description Sets the wireless device.
--wirelesswitchbluetoothctrl Valid Argument enable, disable Description Enables or disables wireless switch bluetooth control. If set to disable, for systems that have a physical 'Wireless On/Off Switch', switch will have no effect on the state of the Bluetooth radio. If set to enable, switch will turn the Bluetooth radio on and off.
Description Permits or denies wireless switch changes. If the administrator password is not set, this setting will have no effect. Example A:>cctk --wirelesswitchchanges=permitted wirelesswitchchanges=permitted --wirelesswitchnlanctrl Valid Argument enable, disable Description Enables or disables wireless switch wireless LAN control. enable: if the systems have a physical 'Wireless On/Off Switch', switch will have no effect on the state of the wireless LAN radio.
PCI Reporting The scan of the PCI bus will use a file to resolve PCI vendor and device codes to vendor information strings. The format of the PCI output is as follows: PCI Bus: 2, Device: 4, Function: 0 Vendor: 8086 - Intel Corp. Device: 1229 - 82557/8/9 [Ethernet Pro 100] Sub Vendor:8086 - Intel Corp.
TPM Activation Trusted Platform Module (TPM) is an industry standard cryptographic module that provides attestation, integrity metrics and reporting, and a secure key hierarchy. Dell client systems use TPM to verify whether the system’s state has changed between two boot cycles. Do the following to activate TPM: 1 If not set, set up the BIOS password. cctk --setuppwd= 2 Enable TPM. cctk --tpm=on --valsetuppwd= 3 Activate TPM.
Completion Code Table 4-4 displays the completion code of an update operation performed by BIOS in the recent shutdown or reboot operation. Table 4-4. Completion and Explanation Code Explanation 0000h The update was completed successfully. 0001h The image failed one or more consistency checks. 0002h The BIOS could not access the flash-memory device. 0003h The flash-memory device was not ready when an erase was attempted.
CCTK Options
Troubleshooting CCTK 5 This section describes how to troubleshoot while running Client Configuration Toolkit. Running CCTK Displays Error Messages If you get any of the following error messages, uninstall and reinstall HAPI: "Required BIOS interface not found" or "HAPI load error." Running CCTK on 32-bit and 64-bit Supported System Ensure that you are running CCTK.exe based on the architecture of the system.
Running CCTK on Linux When you install CCTK on a Linux system, the entry, modprobe dcdbas, is added in the /etc/rc.modules file. After uninstalling CCTK, this entry will not be removed.
A Sample File Formats This appendix lists the sample CCTK utility .ini file. Sample CCTK Utility .ini File Format [cctk] sysname=Latitude D630 sysid=01F9 biosver=A13 ;svctag=H275Y1S ;do not edit information above this line amblightsen=enable asfmode=off asset=D630 autoon=disable bluetoothdevice=enable bootorder=+pcmcia,+hdd.1,-floppy,+cdrom,hdd.2,+nic.1,-hdd.3,+nic.2 ;Here '+' indicates Enabled device, '-' indicates Disabled device.You can use DeviceNumber also to set the boot order.
embsataraid=ata externalhotkey=scrolllock fastboot=minimal hddacousticmode=bypass hotdock=enable idecdrom=auto keyboardclick=disable keybrdillumination=auto keypad=enabledbyfnkey lpt=lpt1 microphone=enable modulebayDevice=enable multicpucore=enable numlock=on onboardmodem=enable passwordbypass=off pccardand1394=enable pntdevice=switchtotouchpad remotebiosupdate=disable satadipm=disable serial1=com1 speedstep=automatic tpm=off ;tpmactivation=activate turbomode=enable usbemu=enable 108 Sample File Formats
usbportsexternal=enable usbwake=disable ;uuid=44454C4C320010378035C8C04F593153 virtualization=disable wakeonlan=enable wificatcherchanges=deny wifilocator=enable wirelesswitchbluetoothctrl=enable wirelesswitchcellularctrl=enable wirelesswitchchanges=deny wirelesswitchnlanctrl=enable Sample File Formats 109
Sample File Formats
B Messages and Codes This section documents the error messages and codes used in Client Configuration Toolkit (CCTK). CCTK Error Codes and Messages The CCTK utility checks your commands for correct syntax and valid input. When you enter a command, a message is displayed stating the results of the command. On Windows operating systems, the error code file (cctkerrorcodes.txt) is provided in the installation directory.
Table B-1. CCTK Error Codes and Messages (continued) Error Code Message 8 Cannot execute duplicated request. 9 There was an error clearing the SEL. 10 Clear SEL cannot be accompanied with any other option. 11 racreset cannot be accompanied with any other option. 12 Cannot execute command. Command, or request parameter(s), not supported in present state. 13 Command not supported on given channel. 14 The community string may only contain printable ASCII characters. 15 Destination unavailable.
Table B-1. CCTK Error Codes and Messages (continued) Error Code Message 28 Reservation Canceled or Invalid Reservation ID. 29 Invalid Time to live value. 30 Invalid VLANID value. 31 Invalid Command. Used to indicate an unrecognized or unsupported command. 32 Command invalid for given LUN. 33 Load defaults cannot be accompanied with any other option. 34 There was an error loading the defaults. 35 Node Busy.
Table B-1. CCTK Error Codes and Messages (continued) Error Code Message 47 Command response could not be provided. Device in firmware update mode. 48 Command response could not be provided. SDR Repository in update mode. 49 Cannot execute command, SEL erase in progress. 50 Attempt to set the 'set in progress' value when not in the 'set in complete' state. 51 The SOL character accumulate interval is invalid. 52 The SOL character send threshold is invalid. 53 The SOL retry interval is invalid.
Table B-1. CCTK Error Codes and Messages (continued) Error Code Message 68 The asset tag cannot be more than 10 characters long. 69 The required BIOS interfaces cannot be found on this system. 70 The BIOS version information is not available. 71 There is not enough free system memory to complete the BIOS update. 72 The BIOS update file version is a different version class (A00, X00) than the\ncurrent system BIOS. Use the --force option to use this BIOS image.
Table B-1. CCTK Error Codes and Messages (continued) Error Code Message 83 The state byte must be a value between 0 and 255 decimal. 84 The CPU information is not available. 85 The dependent option '%s' required for this subcommand is missing in the command line. 86 Duplicate sub command '%s' has been entered. 87 The script file does contain not a valid DTK environment script signature. 88 The format of the environment variable is incorrect.
Table B-1. CCTK Error Codes and Messages (continued) Error Code Message 103 The -x (--hex) option can only be used with -b or -r. 104 Input file '%s' not found. 105 Input file '%s' cannot be read. 106 Invalid argument for option '%s'. 107 Function table lookup error. 108 The machine ID was not found in the file '%s'. 109 The system memory information is not available. 110 Mode can only be used with the --pci option. 111 The device name or index must be present in the boot order.
Table B-1. CCTK Error Codes and Messages (continued) Error Code Message 122 The password may only contain alphanumeric characters. 123 The BIOS passwords have been disabled via jumper. 124 The password length must be between 1 and 32. 125 This password is locked and can only be unlocked by the admin user. 126 There was an error setting the password. 127 The LCD string length must be between 1 and %s. 128 The LCD string may only contain alphanumeric characters.
Table B-1. CCTK Error Codes and Messages (continued) Error Code Message 143 The old password supplied is incorrect. The new password will not be set. Please try again. 144 Cannot stat /etc/omreg.cfg file. Please ensure /etc/omreg.cfg file is present and is valid for your environment. You can copy this file from the DTK iso. 145 Getting nic selection settings failed. 146 HAPI Driver Load Error. 147 Filter action power reduction is only supported for the system power warn/fail filters.
Table B-1. CCTK Error Codes and Messages (continued) Error Code Message 161 Invalid IPv6 address. The IPv6 address cannot be link-local or multicast. 162 Invalid IPv6 address. The IPv6 address specified has incorrect address format. 163 Invalid IPv6 address. The gateway address specified has incorrect address format. 164 Invalid IPv6 address. The Primary DNS server address specified has incorrect address format. 165 Invalid IPv6 address.
Table B-1. CCTK Error Codes and Messages (continued) Error Code Message 177 Unspecified error. 178 Unsupported device. Re-try with supported device. 179 Setup password is required. Re-try providing setup/admin password. 180 System password is required. Re-try providing system password. 181 The password supplied is incorrect. Please try again. 182 Password verification failed. 183 User input password does not fit system requirement. 184 Password not installed in the system.
Table B-1. CCTK Error Codes and Messages (continued) Error Code Message 196 The hardware revision information is not available for this system. 197 The completion code information is not available for this system. 198 The BIOS characteristics information is not available for this system. 199 The password should not contain special characters. 200 Please use 64-bit version of this application. 201 %s cannot be modified when TPM is OFF.
Index C CCTK creating a bootable image using Windows PE, 16 creating a bootable image using Windows PE 2.0, 16 creating a bootable image using Windows PE 3.
--hotdock, 52 --hwprefetcher, 52 -i, 28 --idecdrom, 53 --infile, 28 --infrareddevice, 53 --integratedaudio, 53 --integratedraid, 54 --integratedsas, 54 --integratedsatactrl, 54 --integratedusbhub, 54 --internalminipci, 55 --internalusb, 55 --keyboardclick, 55 --keybrdillumination, 56 --keypad, 56 --lastbiosupdate, 56 --limitcpuidvalue, 57 --logfile, 29 --logicproc, 57 --lowpowers5, 57 --lpt, 58 --lptmode, 58 --mediacardand1394, 59 --mem, 59 --microphone, 60 --modulebayDevice, 60 --monitortoggling, 61 --mous
--serial2, 76 --serialcomm, 76 --serrdmimsg, 77 --setuppwd, 77 --sma, 78 --smartcardreader, 78 --smarterrors, 78 --snoopfilter, 79 --speakervol, 79 --speedstep, 79 --splashscreen, 80 --svctag, 80 --sysbatcharger, 82 --sysid, 81 --sysname, 81 --syspwd, 81 --sysrev, 82 --tabletbuttons, 82 --tpm, 83 --tpmactivation, 83 --turbomode, 83 --uartpowerdown, 84 --usbemu, 84 --usbflash, 85 --usbports, 85 --usbportsexternal, 85 --usbportsfront, 86 --usbpowershare, 86 --usbprt00, 86 --usbprt01, 87 --usbprt02, 87 --usbpr
D Directory Structure of CCTK Windows Vista, XP, 13 E error codes, 111 error messages, 27, 111 H Help, 27 I installing on Linux CCTK, 16, 21 Microsoft Windows Automated Installation Kit (Windows AIK), 16 U uninstalling CCTK on Linux CCTK, 22 uninstalling CCTK on Windows XP and Windows Vista CCTK, 16 W WIM (Windows Imaging Format), 16 Windows AIK, 16 Windows Imaging Format, 16 installing on Windows XP and Windows Vista CCTK, 13 introduction CCTK, 11 L Log, 26 M messages and codes, 111 Index 126
