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.; Microsoft, MS-DOS, Windows, Windows NT,
Active Directory, and Windows Server are either trademarks or registered trademarks of Microsoft
Corporation in the United States and/or other countries; Novell, NetWare, and SUSE are registered
trademarks of Novell, Inc. in the United States and other countries; Red Hat and Red Hat Enterprise Linux are registered trademarks of Red Hat, Inc. in the United States and other countries.
Other trademarks and trade names may be used in this document to refer to either the entities claiming
the marks and names or their products. Dell Inc. disclaims any proprietary interest in trademarks and
trade names other than its own.
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 to configure various BIOS features,
and documentation of the utility. CCTK can be used in a Microsoft
Windows
Windows (XP, Vista, and Windows 7), and Enterprise - Red Hat
environments.
Supported Operating Systems
For the list of operating systems that the CCTK supports, see the readme.txt
available on the Dell Support website at support.dell.com.
Supported Systems
For the list of Dell client systems that the CCTK supports, see the readme.txt
available on the Dell Support website at support.dell.com.
®
Preinstallation Environment (Windows PE), Microsoft
®
Linux®
What’s New
•Support for systems with Unified Extensible Firmware Interface (UEFI)
enabled BIOS
•Support for new BIOS options
Introduction13
14Introduction
Windows Install/Uninstall
2
This section describes how to install and uninstall CCTK on Microsoft®
Windows XP
section also describes how to create a bootable image with CCTK to
configure systems in a pre-operating system environment.
®
, Windows Vista®, Windows 7® operating systems. This
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.
displays the directory structure of CCTK after the installation.
Table 2-1. Directory Structure of CCTK
DirectoryAssociated Files / Directories
X86cctk.exe
cctk_x86_WinPE.bat
cctk_x86_WinPE_3.bat
pci.ids
HAPI
X86_64cctk.exe
cctk_x86_64_WinPE.bat
cctk_x86_64_WinPE_3.bat
pci.ids
HAPI
Ta b l e 2 - 1
Windows Install/Uninstall15
To install C C T K:
NOTE: Ensure that you have administrator privileges.
1
Download the latest CCTK self-extractable zip (SEZ) installation file.
2
Extract the installation file.
a
Double-click the downloaded installation file.
The
Systems Management
dialog box is displayed with information
about the software version, supported systems, supported operating
systems, and supported languages.
b
In the
Systems Management
c
Specify the folder where you want to unzip the installation file and
click
OK
and follow the instructions on the screen.
NOTE: By default, the installation file is extracted to the C:\Dell\Drivers
directory.
d
Click
OK
after the files are extracted.
The
e
Close the file.
Readme.txt
file appears.
dialog box, click
Continue
The folder to which the files are extracted is displayed with
and
ReadMe.txt
3
Double-click the
a
On the
The
InstallShield Wizard
License Agreement
.msi
.
file.
screen, click Next.
screen appears.
.
cctk.msi
b
Read the license agreement and accept the agreement by clicking the
appropriate radio button. Click
The
Customer Information
c
Provide the requisite information (such as user name and organization
name). Select anyone who uses the computer as a user for CCTK or
only you as a user for CCTK. Click
The
Setup Type
d
Select the setup type. Select
screen appears.
directory and choose the directory to install CCTK in the next screen.
Click
Next
.
16Windows Install/Uninstall
Next.
screen appears.
Next.
Custom
to install CCTK in a customized
e
Click
Install
.
The default CCTK installation directory for a 32-bit supported system is
. During 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.
4
Using the command prompt, navigate to the
X86
or
X86_64
directory
depending on the architecture of the operating system.
5
Run the CCTK commands to configure the system.
For more details on running the CCTK commands, see CCTK Options.
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."
NOTE: For silent installation of CCTK, run the following command:
msiexec.exe /i cctk.msi /qn.
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.
In this scenario, HAPI will not be downgraded to the earlier version.
want to run the CCTK commands frequently, it is recommended that you
install HAPI on the system before you execute CCTK commands. To
HAPI, navigate to the HAPI directory and run HAPIinstall.bat.
If you
install
Windows Install/Uninstall17
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
•Click
Start → Programs → Dell → CCTK
Start → Settings → Control Panel → Add or Remove Programs
Select
Client Configuration Toolkit
→ Uninstall
and click
.
Remove
.
.
Creating a Bootable Image Using Windows PE
For 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 2.0 (Windows PE) or Windows PE
3.0. 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.
Creating a Bootable Image Using Windows PE 2.0
Using Windows PE 2.0, you can integrate CCTK, HAPI, and related drivers
into a Windows Imaging Format (WIM) file. Using the WIM file, you can
create a bootable ISO image.
Use the following steps to create a bootable image using Windows PE 2.0:
1
Download Microsoft Windows Automated Installation Kit (AIK) from the
Microsoft website.
2
Install AIK.
3
Download the CCTK installation file from the Dell Support website at
support.dell.com
4
Double-click
5
Integrate the CCTK directory structure in a WIM file using the
following steps:
CCTK provides the
to integrate CCTK, HAPI, and related Dell drivers into the WIM file.
and extract it.
cctk.msi
and follow the instructions.
cctk_x86_winpe.bat
and cctk_x86_64_winpe.bat
scripts
18Windows Install/Uninstall
a
Navigate to the directory where the script is located. By default, the
script for 32-bit systems is located in the
for 64-bit systems is located in the
b
Run the appropriate script with the
cctk\X86
cctk\X86_64
.wim
file and CCTK directory
directory. The script
directory.
locations entered as two arguments:
cctk_winpe.bat <path_of_wim_file><path_of_cctk>
If CCTK is installed on the default directory, the 32-bit system script,
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.0:
1
Download Microsoft Windows Automated Installation Kit (AIK) from the
Microsoft website.
2
Install AIK.
3
Download the CCTK installation file from the Dell Support website at
support.dell.com
4
Double-click
5
Integrate the CCTK directory structure to an ISO file using the
following steps:
CCTK provides the
scripts to integrate CCTK, HAPI, and related Dell drivers into the ISO
image.
a
Navigate to the directory where the script is located. By default, the
script for 32-bit systems is located in the
for 64-bit systems is located in the
b
If you installed AIK in a non-default directory, open the script, set the
AIKTOOLS
For example:
and extract it.
cctk.msi
and follow the instructions.
cctk_x86_winpe_3.bat
path, and save the file.
and cctk_x86_64_winpe_3.bat
cctk\X86
cctk\X86_64
directory. The script
directory.
Set AIKTOOLS=C:\WINAIK\Tools
20Windows Install/Uninstall
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
Follow the instructions on the screens to upgrade.
NOTE: For silent upgrading, use the following command: msiexec.exe /i
dialog box appears.
cctk.msi /qn REINSTALL=ALL REINSTALLMODE=vomus
To upgrade CCTK 1.0 to CCTK 1.1, uninstall CCTK 1.0 and then install
CCTK 1.1.
To upgrade CCTK 1.0 to CCTK 1.1, do the following:
1
Download the latest CCTK installation file from the Dell Support website.
2
Uninstall CCTK 1.0. For more information, see the Uninstalling CCTK
section.
3
Install CCTK 1.1. For more information, see the Installing CCTK section.
22Windows 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,
•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. It will generate the following
error on a non-Dell system: "This is not a Dell machine. CCTK supports
only Dell machines."
To install CCTK, do the following:
1
Download the
Dell Support website at
2
Untar the file.
For ex a mple:
cctk-linux-version-buildnum.tar.gz
cctk-linux-version-buildnum.tar.gz
file from the
support.dell.com
.
tar -zxvf cctk-linux-version-buildnum.tar.gz
The file contains the following:
srvadmin-ipmi-6.0.1-800.DUP.i386.rpm
and
cctk-linux-version-buildnum.i386.rpm.
srvadmin-omilcore-6.0.1-800.i386.rpm,
,
srvadmin-hapi-6.0.1-800.i386.rpm,
Linux Install/Uninstall23
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-version-buildnum.i386.rpm
4
Using the command prompt, navigate to the
directory to run the CCTK commands.
For more details on running the CCTK commands, see the CCTK Options
section.
/opt/dell/toolkit/bin
Uninstalling CCTK
To uninstall CCTK, remove the CCTK RPMs.
1
Run the following command to uninstall CCTK:
rpm -e cctk-linux-version-buildnum.i386
2
Run the following command to uninstall HAPI:
rpm -e srvadmin-hapi-6.0.1-800.i386
3
Run the following command to uninstall omilcore:
rpm -e srvadmin-omilcore-6.0.1-800.i386
4
Run the following command to uninstall the IPMI RPM:
rpm -e srvadmin-ipmi-6.0.1-800.DUP.i386
Upgrading CCTK
To upgrade CCTK 1.0.1 to CCTK 1.1, do the following:
1
Download the latest installation file from the Dell Support website at
support.dell.com
2
Untar the file.
3
Upgrade the CCTK rpm,
the following command:
rpm -U cctk-linux-version-buildnum.i386.rpm
24Linux Install/Uninstall
and save it on your system.
cctk-linux-version-buildnum.i386.rpm
, using
To upgrade CCTK 1.0 to CCTK 1.1, you need to uninstall the CCTK 1.0
rpm, and then install CCTK 1.1 rpm.
To upgrade CCTK 1.0 to CCTK 1.1, do the following:
1
Uninstall the CCTK RPM,
cctk-linux-1.0.0-buildnum.i386.rpm
. For more
information, see the Uninstalling CCTK section.
2
Download the latest installation file from the Dell Support website at
support.dell.com
3
Install the latest CCTK RPM. For more information, see Installing CCTK.
and save it on your system.
Linux Install/Uninstall25
26Linux Install/Uninstall
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.
Command Line Syntax
The general usage models of the CCTK utilities are as follows:
CCTK --option1=[arg1]
or
cctk --option1=[arg1]...--optionX=[argX]
NOTE: Some of the options in CCTK are followed by an asterisk. Such options
are used for reporting purposes only. Reporting options cannot be used with
set options.
Table 4-1 lists the generic command line characters and arguments present in
the command line options with a short description of these characters.
Table 4-1. Command Line Syntax
ElementDescription
- Single-character options are prefixed with a hyphen (-).
--Multi-character options are prefixed with two (2) hyphens (--).
utilnameGeneric designation for a CCTK utility name.
-oGeneric single-character designation for an option.
CCTK Options27
Table 4-1. Command Line Syntax
ElementDescription
optionXGeneric multi-character designation for a utility name, where X can
be used to distinguish multiple options used in the same command
line instance.
argXGeneric designation for an argument, where X can be used to distinguish
multiple arguments used in the same command line instance.
[mandatory
option]
<string> Generic designation for a string.
<filename>Generic designation for a filename.
[ ]Indicates a component of the command line. Enter only the
... Indicates that the previous argument can be repeated several times in
| Separates mutually exclusive choices in a syntax line. For example:
Generic designation for a mandatory argument.
information within the brackets, not the brackets themselves.
a command. Enter only the information, not the ellipsis (...) itself.
numlock: Turns the keyboard number lock on or
off.
Arguments: on | off
Enter only one choice: --numlock=on, --numlock=
off
(continued)
Case-Sensitivity
•Command line options, pre-defined and user-defined arguments,
and filenames given as arguments are all case-sensitive.
•Unless specified otherwise, enter all commands, options, arguments,
and command line switches in lowercase letters.
Command Line Option Delimiters
•Single-character options are
•Multi-character options are
Example: utilname -o --option
Table 4-2 lists some examples of valid and invalid CCTK command lines.
28CCTK Options
prefixed
with a preceding hyphen (-).
prefixed
with two (2) preceding hyphens (--).
Table 4-2. CCTK Command Line Examples
Valid/
Invalid
validcctk --option1 --option2cctk --asset --mem
invalidcctk --option1=[argument]
validcctk -o=filename
validcctk -l=filename
validcctk -i=filename
validcctk --option=argument cctk --embnic1=on
CCTK Command Line Example
cctk --asset=1750
--option2 --option3
--option1
--option2
or
cctk -o filename
--option1
--option2
--option1
--option2
or
cctk -l filename
--option1
--option2
--option1
--option2
or
cctk -i filename
--option1
--option2
--floppy --biosromsize
cctk -o=/tmp/myfile.txt -
--mem
--sysname
or
cctk -o /tmp/myfile.txt -
--mem
--sysname
cctk -l=/tmp/myfile.txt
--mem --sysname
or
cctk -l /tmp/myfile.txt
--mem --sysname
cctk -i=/tmp/myfile.txt -
--mem --sysname
or
cctk -i /tmp/myfile.txt -
--mem --sysname
NOTE: Options that specify report and set actions must not be combined in a
command line instance.
NOTE: Example 2 is invalid because the report and set actions are used in the
same command line.
NOTE: Examples 3, 4, and 5 are valid because report and set actions are not
combined.
CCTK Options29
Read and Write Options
Options that specify read and write actions should not be combined in a
command line instance. Table 4-3 provides examples for read and
write commands.
Table 4-3. Read and Write Command Examples
Valid/InvalidCCTK Command Line Example
validcctk --option1 --option2
validcctk --option1=arg --option2=arg
invalidcctk --option1=arg --option2
File Input and Output Commands
•File input is specified by the -i=<
where <
filename
> is the name of the input file.
•File output is specified by the
where <
filename
> is the name of the output file.
filename
> command,
-o=<filename
> command,
Log Files
The -l=<filename> or --logfile=<filename> option records
information output on the command line to the specified log file.
If the log file already exists, information is appended to the file. This allows
multiple tools to use the same log file to record information. This option
must be used instead of redirection to record a utility’s output, as time data
can assist with task diagnosis.
The log duplicates all standard output and error information to the specified
file. Each log file begins with a time stamp and utility name. For example,
YYYY/MM/DD HH:MM:SS <utilname> - <output text>.
The following is an example of the logging behavior:
2010/05/16 10:23:17 cctk - option1=on
2010/05/16 10:23:17 cctk - option2=on
2010/05/16 10:23:17 cctk - option3=off
30CCTK Options
Loading...
+ 114 hidden pages
You need points to download manuals.
1 point = 1 manual.
You can buy points or you can get point for every manual you upload.