[THIN] KB: CTX111961 - CDFControl
- From: "Jim Kenzig ThinHelp.com" <jkenzig@xxxxxxxxx>
- To: THIN <thin@xxxxxxxxxxxxx>
- Date: Thu, 11 Jan 2007 10:07:44 -0500
Another new utility from citrix support!
Jim
CTX111961 - CDFControl
This document was published at: http://support.citrix.com/article/CTX111961
Document ID: *CTX111961*, Created on: Jan 10, 2007, Updated: Jan 10, 2007
Products: N/A
<http://support.citrix.com/servlet/KbServlet/download/12104-102-15979/CDFControl.zip>Attachment:
CDFControl.zip<http://support.citrix.com/servlet/KbServlet/download/12104-102-15979/CDFControl.zip>(
234.2 K)
*CDFControl*
*Description*
CDFControl is a software debugging utility that captures Citrix Diagnostic
Facility (CDF) trace output messages that are output from the various Citrix
product modules.
*Note: *CDFControl does NOT serve as a replacement to any of the other CDF
tracing utilities, such as the Citrix Access Suite Console for tracing. It
is simply offered as an alternative utility to use, when attempting to
capture CDF traces.
*Prerequisites*
• Citrix MetaFrame XP with Service Pack 4, or later versions of Citrix
Presentation Server.
*This utility should work with other Citrix Access Suite products (such as
Password Manager); however, only the Citrix Presentation Server product line
was tested.*
*How To Use CDFControl*
This utility lists the modules that are available for tracing on the server
that it is being run on. Therefore, if you do not see a familiar module in
the list, that module is not available for tracing on that respective
server.
*Configuring the Trace Session*
By default, CDFControl is configured to start a trace with the following
properties:
• Sequential
• 50 MB Log File Size
• Outputs the Event Trace Log file in the current directory
• Configures the Flags and Level to the most detailed and advanced settings
available (Level 16, Flags: FFFFFF)
*All the above settings are configurable options on the user interface.*
*Trace by Category*
CDFControl also offers the ability to select tracing troubleshooting
categories. This feature allows the user to simply select a troubleshooting
category, and then CDFControl automatically checks the necessary tracing
modules – based on the selected category.
*For example:* If "Smart Cards" is selected from the drop list menu, modules
such as "MF_Hook_SmartCards" are checked automatically. Then all the user
has to do is click *Start Tracing*.
*Note: *The troubleshooting category selection is not available through the
command line.
*Using the CDFControl.ini file to load custom Trace Categories*
CDFControl is equipped with 15 preset tracing categories for troubleshooting
various components and issues. However, it is possible to load your own
custom tracing categories to this list by means of an .ini file. This allows
you to maintain your own personal list for tracing issues that pertain
specifically to your environment or to an issue that is not available with
the preset categories.
*Loading the custom Trace Categories*
You can create this file using a standard text editor such as Notepad.exe.
The file must be named: "CDFControl.ini"
The file must exist in the same directory as the CDFControl.exe program.
The format of the file should be as follows:
//
Name:Test
MF_Hook_SmartCard
MF_Driver_Cdm
MF_DLL_Ctxnotif
MF_Service_CdmSvc
MF_DLL_Wsxica
MF_Hook_MfApHook
MF_DLL_Cdmprov
MF_Driver_Wdica
THF_Hook_SCard_Client
//
Name:Random
MF_DLL_Cdmprov
MF_DLL_Cpmmon
MF_DLL_Ctxnotif
MF_DLL_Cutildll
MF_DLL_Vclipbd
//
An example CDFControl.ini file is included with this utility.
*Once you have configured your CDFControl.ini file*
Launch the CDFControl utility. CDFControl automatically loads the ini file
on startup, if one is present. If you choose to load the ini file after the
utility is started, in the "Trace by Category" section click the drop list
menu > select ** Load Custom ** > select *Yes* to load the custom categories
from the file.
You should now see your custom categories present.
*To Start a Trace*
Select the desired tracing modules, and click the *Start Tracing* button.
*To Stop a Trace*
Click the *Stop Tracing* button.
*Command Line Usage*
Because this is intended to be used as a graphical user interface
application, the command line features are limited.
*IMPORTANT* - The command line usage requires that *CDFCommand.ctl* file is
used to list the desired tracing modules. This file must be named
"CDFCommand.ctl" and it *must* be located in the same directory as *
CDFControl.exe*, otherwise the command line usage will fail.
*TIP* – you can use the "Create .ctl File" button from the user interface of
CDFControl, to create the "CDFCommand.ctl" file. This allows you to easily
check the desired tracing modules, and create your own ctl file based on it.
*To Start a Trace Session*
Example: *CDFControl /start FFFFFF 16 50 seq*
The parameters are:
*/start* [to determine if to start]
*/stop* [to determine if to stop]
*FFFFFF* [Flags: could be 0-FFFFFF]
*16* [Level: 0-16]
*50* [Max Log Size: user specified]
*Seq* [seq or cir: sequential or circular]
*/?* [Help syntax]
*To Stop a Trace Session*
CDFControl /stop
*Note: *The .ctl file must be named: *CDFCommand.ctl*
*New Enhancements In This Release*
• Default trace file naming convention based on timestamp. This ensures a
unique name with every trace file.
• Automatic generation of a .ctl file with each trace.
• Automatic loading of the custom ini file (CDFControl.ini)
--
Jim Kenzig
Microsoft MVP - Terminal Services
http://www.thinhelp.com
Citrix Technology Professional
Provision Networks VIP
CEO The Kenzig Group
http://www.kenzig.com
Blog: http://www.techblink.com
Other related posts:
- » [THIN] KB: CTX111961 - CDFControl
