Dell™ Client Configuration Toolkit Version 1.0 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 . Supported Systems 2 . . . . . . . . . . . . . 11 . . . . . . . . . . . . . . . . . . . 11 Windows Install/Uninstall . . . . . . . . . . . . 13 . . . . . . . . . . . . . . . . . . 13 . . . . . . . . . . . . . . . . . . . . . 13 . . . . . . . . . . . . . . . 15 . . . . . . . . . . . . . . . . . . . . 15 Install Prerequisites .
CCTK Options . . . . . . . . . . . . . . . . . . . . . . 21 . . . . . . . . . . . . . . . 21 . . . . . . . . . . . . . . . 21 . . . . . . . . . . . . . . . . . . 22 . . . . . . . . . 22 . . . . . . . . . . . . . . 24 Command Syntax Overview Command Line Syntax Case Sensitivity . Command Line Option Delimiters Read and Write Options File Input and Output Commands . . . . . . . . . . 24 . . . . . . . . . . . . . . . . . . . . . . 24 . . . . . . . . . . . . . . . . . . . . . 25 . . . .
--bisreq . . . . . . . . . . . . . . . . . . . . . . . 34 . . . . . . . . . . . . . . . . . . . . . . 35 . . . . . . . . . . . . . . . . . . 35 --bitsmart --bltinpntdevice . . . . . . . . . . . . . . . . . 35 . . . . . . . . . . . . . . . . . . . . . . 36 --bluetoothdevice bootorder . . . . . . . . . . . . . . . . . . . . 37 . . . . . . . . . . . . . . . . . . . . . . 37 --bootspeed --busratio . . . . . . . . . . . . . . . . . . . 37 . . . . . . . . . . . . . . . . . . . . . .
--idecdrom . . . . . . . . . . . . . . . . . . . . . 48 . . . . . . . . . . . . . . . . . . 48 --infrareddevice --integratedaudio . --integratedraid . --integratedsas 48 . . . . . . . . . . . . . . . . . . 49 . . . . . . . . . . . . . . . . . . . 49 . . . . . . . . . . . . . . . . . 49 . . . . . . . . . . . . . . . . . . 50 . . . . . . . . . . . . . . . . . . . . 50 --integratedusbhub --internalminipci --internalusb . . . . . . . . . . . . . . . . . --keyboardclick . . . . . . . . . . .
--pci . . . . . . . . . . . . . . . . . . . . . . . . 60 . . . . . . . . . . . . . . . . . . . . . . 61 . . . . . . . . . . . . . . . . . 61 --pcislots --penmisindication --penresumeon . --pntdevice . . . . . . . . . . . . . . . . . . 62 . . . . . . . . . . . . . . . . . . . . . 62 . . . . . . . . . . . . . . . . . . . . 62 . . . . . . . . . . . . . . . . . . . . . 63 --postf12key --postf2key . . . . . . . . . . . . . . . . . 63 . . . . . . . . . . . . . . . . . . . 63 --powermgmt . .
. . . . . . . . . . . . . . . . . . . . . 72 . . . . . . . . . . . . . . . . . . . . . . . . 73 . . . . . . . . . . . . . . . . . 73 --smarterrors . . . . . . . . . . . . . . . . . . . . 73 --snoopfilter . . . . . . . . . . . . . . . . . . . . 74 --speakervol . . . . . . . . . . . . . . . . . . . . 74 --speedstep . . . . . . . . . . . . . . . . . . . . . 75 --setuppwd --sma --smartcardreader . . . . . . . . . . . . . . . . . . . 75 . . . . . . . . . . . . . . . . . . . . . . 75 . . .
--usbport08 . . . . . . . . . . . . . . . . . . . . . 84 --usbport09 . . . . . . . . . . . . . . . . . . . . . 85 --usbport10 . . . . . . . . . . . . . . . . . . . . . 85 --usbport11 . . . . . . . . . . . . . . . . . . . . . 85 --usbport12 . . . . . . . . . . . . . . . . . . . . . 86 --usbport13 . . . . . . . . . . . . . . . . . . . . . 86 --usbport14 . . . . . . . . . . . . . . . . . . . . . 86 --usbport15 . . . . . . . . . . . . . . . . . . . . . 87 --usbreardual . . . . . . . . .
5 Troubleshooting CCTK Running CCTK . . . . . . . . . . . . . . . 99 . . . . . . . . . . . . . . . . . . . . . . 99 Running CCTK on 32-bit and 64-bit Supported System . . . . . . . . . . . . . . . . . Running CCTK on Windows Vista When User Account Control is Enabled Running CCTK on Linux . . . . . . . . 100 . . . . . . . . . . . . . . . . . 100 A Sample File Formats . . . . . . . . . . . . . . . Sample CCTK Utility .ini File Format B Messages and Codes Index 10 . . . . . . . . . . . . .
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 Red Hat Linux™ environment.
Introduction
Windows Install/Uninstall This section describes how to install and uninstall CCTK on Microsoft® Windows XP® and Windows Vista® 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 (cctk-win-a.b.c-buildnum.
Use the following procedure to install CCTK: NOTE: Ensure that you have administrator privileges to install CCTK. 1 Download the CCTK installation file, cctk-win-a.b.c-buildnum.msi, from the Dell Support website at support.dell.com and save it on your system. 2 Double-click the .msi file to install CCTK. a On the InstallShield Wizard screen, click Next. The License Agreement screen appears. b Read the license agreement and accept the agreement by clicking the appropriate radio button. Click Next.
Important Information CCTK requires Hardware Application Programming Interface version 5.9.2 (HAPI) or later installed on the system where you run the CCTK commands. If your system does not have HAPI installed, CCTK automatically installs HAPI when you run a CCTK command. After the option is configured, HAPI is uninstalled. If the system has an older version of HAPI, when you run a CCTK command, HAPI is automatically upgraded to the latest version.
Creating a Bootable Image Using Windows PE 2.0 For the client systems that do not have an operating system installed, you can create a bootable image that contains CCTK to run the CCTK commands on Windows Preinstallation Environment (Windows PE). Windows PE provides a standalone preinstallation environment that is used to prepare a system for Windows installation. Use Microsoft Windows Automated Installation Kit (Windows AIK) to create a Windows PE image.
A .wim file, winpe.wim, is created in the location that you provided. The files required to create the bootable ISO image file are also created in the same location. c Rename the \winpe.wim file as boot.wim. d Overwrite the \ISO\sources\boot.wim file with the \boot.wim file. Example: copy c:\winPE_x86\boot.wim c:\winPE_x86\ISO\sources\boot.wim 6 Create a bootable Windows PE image using Windows AIK.
Windows Install/Uninstall
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 work station Installing CCTK Use the following procedure to install CCTK on a Linux system: NOTE: You should be a user with root privileges to install CCTK. 1 Download the cctk-linux-a.b.c-buildnum.tar.gz file from the Dell Support website at support.dell.
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-linux-1.0.0-1.i386.rpm 4 Using the command prompt, navigate to the /opt/dell/toolkit/bin directory to run the CCTK commands. NOTE: CCTK can run only on a Dell system. It will generate the following error on a non-Dell system: "This is not a Dell machine. CCTK supports only Dell machines.
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 --option2 --option3 --floppy --biosromsize 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).
-l or --logfile Valid Argument Description Logs the command line output to a time-stamped file. The utility either appends the information to an existing log file or creates a new file. The log file contains the same information as the standard output, plus timestamp information. Users should use this option instead of redirection for task diagnosis.
-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 .ini extension. The format of the output is in a .ini format, with the utility name as the section header. If a file with the same name already exists, the information is appended to the file. If this option is used with other function commands, the commands are applied in the order in which they appear.
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 When this option is set to enabled, the processor fetches the cache line containing the currently requested data, and prefetches the following cache line. When this option is set to disabled, the processor fetches only the cache line containing the currently requested data. Example A:>cctk --adjcacheprefetch=enable adjcacheprefetch=enable --agpslot Valid Argument enable, disable Description Enables or disables on-board AGP slot.
--asfmode Valid Argument on, off, alertingonly, dash Description Sets the alert standard format. The alertonly argument enables only error messages. The dash argument enables LOM to have DASH and ASF 2.0 functionality. 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.
Description Sets the audio mode to any of the following values: • disable: Completely releases the onboard hardware resources. • halfduplex: Allows only record or playback at a time. • fullduplex: Allows record and playback simultaneously. Example A:>cctk --audiomode=halfduplex audiomode=halfduplex --autoon Valid Argument disable, everyday, weekdays Description Sets the auto on configuration.
32 to 47 are always set to 0 by Dell-developed BIOS. 48 sets to 1 if the built-in NIC supports MagicPacket. 49 sets to 1 if the system supports Wake-on-LAN. 50 sets to 1 if the system supports chassis intrusion. 51 sets to 1 if the built-in NIC supports pattern-matching. 52 sets to 1 if the system BIOS supports a 7-character service tag. 53 to 63 are reserved for future assignments.
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. Example A:>cctk --biosromsize biosromsize=2048kb --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. Example A:>cctk --bitsmart=enable bitsmart=enable --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 Gets or sets the boot order sequence (IPL sequence) and enables or disables the devices (IPL skip list). cctk bootorder or cctk bootorder -sequence will display the bootorder sequence. The asterisk(*) at the beginning of each device description indicates it is not a skip device. When there is no set up password set on the machine, "valsetuppw" is ignored.
--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. Example A:>cctk --bootspeed=default bootspeed=default --busratio Valid Argument max, 6.0x , 7.0x , 7.5x, 8.0x , 8.5x , 9.0x, or 9.5x Description Sets the bus ratio in CPU.
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 --charger=enable charger=enable --chasintrusion Valid Argument enable, disable, silentenable Description Enables or disables the system to detect and report chassis intrusion events to the system display on boot-up.
Description Erases the contents of the system event log file. 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 --cmosdefaults=enable cmosdefaults=enable --completioncode Valid Argument read-only argument Description Defines the completion code of an update operation performed by BIOS in the recent shutdown or reboot operation.
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 --cpucore=all cpucore=all --cpucount Valid Argument read-only Description Reports the number of processors in the system.
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. When set to enable, the processor can operate in all available Power C states.
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.
--envfile Valid Argument Description Sets the environment variables of system devices based on the .ini file. Example A:>cctk --envfile= --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.
--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.
--penresumeon Valid Argument enable, disable 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.
--postf2key Valid Argument enable, disable 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.
Example A:>cctk --postmebxkey=on postmebxkey=on --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.
Example A:>cctk --primideslav=auto primideslav=auto --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.
--remotebiosupdate Valid Argument enable, disable Description Enables or disables the remote BIOS update. 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 --safeusb=enable safeusb=enable --sata0 Valid Argument auto, off 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.
Example A:>cctk --sata2=auto sata2=auto --sata3 Valid Argument auto, off 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.
Example A:>cctk --sata5=auto sata5=auto --sata6 Valid Argument auto, off 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.
Example A:>cctk --satactrl=0 satactrl=0 --satadipm Valid Argument enable, disable 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 --scndideslave=auto scndideslave=auto --serial1 Valid Argument disable, auto, com1, com2, com3, com4 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.
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. These ports are made available for use by the operating system or applications. BIOS Console Redirection is disabled. When set to com1cr, this option tells the BIOS to enable COM port 1 and COM port 2. These ports are made available for use by the operating system or applications. BIOS Console Redirection is through COM port 1.
Description Sets the setup password. An argument is required. The password cannot be reported. Initially you can set the password. If you want to remove the password, provide one blank space and the old password. Example A:>cctk --setuppwd= --valsetuppwd= --sma Valid Argument enable, disable Description Enables or disables processor sequential memory access.
Description Enables or disables SMART errors. Example A:>cctk --smarterrors=enable smarterrors=enable --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.
Example A:>cctk --speakervol=off speakervol=off --speedstep Valid Argument automatic, disabled, max performance, max battery 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.
Description Reports the service tag for a system. Example A:>cctk --svctag svctag=113CD1S --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.
--syspwd Valid Argument Description Sets the system password. An argument is required. The password cannot be reported. Initially you can set the password using cctk. If you want to remove the password, provide one blank space and old password. Example A:>cctk --syspwd= --valsyspwd= --sysrev Valid Argument read-only Description Reports the system revision.
--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, dependent on certain security criteria.
Example A:>cctk --tpmactivation=activate tpmactivation=activate --turbomode Valid Argument enable, disable 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.
Description Enables or disables emulation of USB devices. Example A:>cctk --usbemu=enable usbemu=enable --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.).
--usbportsexternal Valid Argument enable, disable Description Enables or disables the external USB ports. 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.
--usbport00 Valid Argument enable, disable Description Enables or disables USB port 00. 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.
--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.
--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.
--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.
--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.
--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.
--usbrearquad Valid Argument on, off 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.
Example A:>cctk --uuid uuid=44454C4C5300104C8044B1C04F423131 --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.
--vgadacsnoop Valid Argument enable, disable Description Enables or disables the VGA DAC Snoop in BIOS. 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.
Example A:>cctk --videomemsize=auto videomemsize=auto --virtualization Valid Argument disable, enable 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.
--wakeonlan Valid Argument enable, disable, network, bootseq, addincard, onboard, enablewakeonwlan, lanorwlan Description Defines the wake-on-LAN feature. 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.
--wificatcherchanges Valid Argument permitted, denied Description Permits or denies Wi-Fi catcher changes. If the administrator password is not set, this setting will have no effect. Example A:>cctk --wificatcherchanges=permitted wificatcherchanges=permitted --wifilocator Valid Argument enable, disable Description Enables or disables the Wi-Fi locator.
Description Sets the wireless device. disable: disables wireless devices. enablectrlbyapp: enables controlling by an application such as QuickSet. enablectrlhotkeyapp: enables controlling by the hotkey or by an application such as QuickSet. Example A:>cctk --wirelessdevice=disable wirelessdevice=disable --wirelesswitchbluetoothctrl Valid Argument enable, disable Description Enables or disables wireless switch bluetooth control.
Description Enables or disables wireless switch cellular control. disable: If the systems that have a physical 'Wireless On/Off Switch', the switch will have no effect on the state of the cellular radio. enable: switch will turn the cellular (i.e. WWAN) radio on and off. Example A:>cctk --wirelesswitchcellularctrl=enable wirelesswitchcellularctrl=enable --wirelesswitchchanges Valid Argument permitted, denied Description Permits or denies wireless switch changes.
Example A:>cctk --wirelesswitchnlanctrl=enable wirelesswitchnlanctrl=enable 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.
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 This section describes how to troubleshoot while running Client Configuration Toolkit. Running CCTK If you are running CCTK on a Windows system, ensure that you have administrator privileges. If you are running CCTK on a Linux system, ensure that you are logged on as a root user. If you do not have administrator privilege on a 32-bit system where you run CCTK, the following error message is displayed: “Required BIOS interface not found.
Running CCTK on Windows Vista When User Account Control is Enabled If you are running CCTK on a Windows Vista system on which User Account Control (UAC) is enabled, run CCTK as an administrator. To run CCTK as an administrator: 1 Click Start → Run. Right-click on the icon and select Run as administrator. 2 Navigate to the CCTK directory and run CCTK commands.
Sample File Formats This appendix lists the sample CCTK utility .ini file. Sample CCTK Utility .
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 turbomode=enable usbemu=enable usbportsexternal=enable usbwake=disable ;uuid=44454C4C320010378035C8C04F593153 virtualization=disable wakeonlan=enable 102 Sample Fi
wificatcherchanges=deny wifilocator=enable wirelesswitchbluetoothctrl=enable wirelesswitchcellularctrl=enable wirelesswitchchanges=deny wirelesswitchnlanctrl=enable Sample File Formats 103
Sample File Formats
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. On Linux operating systems, this file is provided in the /opt/dell/toolkit/bin 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.
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.
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 bootable image, 16 creating a bootable image using Windows PE 2.
--infile, 26 --infrareddevice, 48 --integratedaudio, 48 --integratedraid, 49 --integratedsas, 49 --integratedsatactrl, 49 --integratedusbhub, 49 --internalminipci, 50 --internalusb, 50 --keyboardclick, 50 --keybrdillumination, 51 --keypad, 51 --lastbiosupdate, 51 --limitcpuidvalue, 52 --logfile, 27 --logicproc, 52 --lowpowers5, 52 --lpt, 53 --lptmode, 53 --mediacardand1394, 54 --mem, 54 --microphone, 55 --modulebayDevice, 55 --monitortoggling, 56 --mouse, 56 --multicpucore, 56 --nextboot, 57 --nmibutton, 57
--sma, 73 --smartcardreader, 73 --smarterrors, 73 --snoopfilter, 74 --speakervol, 74 --speedstep, 75 --splashscreen, 75 --svctag, 75 --sysbatcharger, 77 --sysid, 76 --sysname, 76 --syspwd, 77 --sysrev, 77 --tabletbuttons, 78 --tpm, 78 --tpmactivation, 78 --turbomode, 79 --uartpowerdown, 79 --usbemu, 79 --usbflash, 80 --usbports, 80 --usbportsexternal, 81 --usbportsfront, 81 --usbpowershare, 81 --usbprt00, 82 --usbprt01, 82 --usbprt02, 82 --usbprt03, 83 --usbprt04, 83 --usbprt05, 83 --usbprt06, 84 --usbprt07
D M Directory Structure of CCTK Windows Vista, XP, 13 messages and codes, 105 E error codes, 105 error messages, 25, 105 Microsoft Windows Automated Installation Kit (Windows AIK), 16 U uninstalling CCTK on Linux CCTK, 20 H Help, 25 I installing on Linux CCTK, 16, 19 installing on Windows XP and Windows Vista CCTK, 13 uninstalling CCTK on Windows XP and Windows Vista CCTK, 15 W WIM (Windows Imaging Format), 16 Windows AIK, 16 Windows Imaging Format, 16 introduction CCTK, 11 L Log, 24 Index 120
