Applies To: Windows Server 2008,Windows Vista

Update the properties of an existing API tracing data collector.

For examples of how this command can be used, see Examples.

Syntax

 Copy Code
logman update api <[-n] <name>> [options]

Parameters

Parameter Description

/?

Displays context-sensitive help.

-s <computer name>

Perform the command on the specified remote computer.

-config <value>

Specifies the settings file containing command options.

[-n] <name>

Name of the target object.

-f <bin|bincirc|csv|tsv|sql>

Specifies the log format for the data collector.

-[-]u <user [password]>

Specifies the user to Run As. Entering a * for the password produces a prompt for the password. The password is not displayed when you type it at the password prompt.

-m <[start] [stop] [[start] [stop] [...]]>

Change to manual start or stop instead of a scheduled begin or end time.

-rf <[[hh:]mm:]ss>

Run the data collector for the specified period of time.

-b <M/d/yyyy h:mm:ss[AM|PM]>

Begin collecting data at the specified time.

-e <M/d/yyyy h:mm:ss[AM|PM]>

End data collection at the specified time.

-si <[[hh:]mm:]ss>

Specifies the sample interval for performance counter data collectors.

-o <path|dsn!log>

Specifies the output log file or the DSN and log set name in a SQL database.

-[-]r

Repeat the data collector daily at the specified begin and end times.

-[-]a

Append to an existing log file.

-[-]ow

Overwrite an existing log file.

-[-]v <nnnnnn|mmddhhmm>

Attach file versioning information to the end of the log file name.

-[-]rc <task>

Run the command specified each time the log is closed.

-[-]max <value>

Maximum log file size in MB or maximum number of records for SQL logs.

-[-]cnf <[[hh:]mm:]ss>

When time is specified, create a new file when the specified time has elapsed. When time is not specified, create a new file when the maximum size is exceeded.

-y

Answer yes to all questions without prompting.

-mods <path [path [...]]>

Specifies the list of modules to log API calls from.

-inapis <module!api [module!api [...]]>

Specifies the list of API calls to include in logging.

-exapis <module!api [module!api [...]]>

Specifies the list of API calls to exclude from logging.

-[-]ano

Log (-ano) API names only, or do not log only (--ano) API names.

-[-]recursive

Log (-recursive) or do not log (--recursive) APIs recursively beyond the first layer.

-exe <value>

Specifies the full path to an executable for API Tracing.

Remarks

Where [-] is listed, an extra - negates the option.

Examples

The following command updates the existing API trace counter called trace_notepad for the executable file c:\windows\notepad.exe by excluding the API call TlsGetValue produced by the module kernel32.dll.

 Copy Code
logman create api trace_notepad -exe c:\windows\notepad.exe -exapis kernel32.dll!TlsGetValue

Additional references