IBM Tivoli Monitoring, Version 6.3

tacmd settrace

Description

Use the settrace command to modiy the RAS1 logging level to the requested value on a remote managed system. Each tacmd settrace command returns a status message indicating whether the command completed successfully. If an error occurred, a status message provides diagnostic information. You could also use the tacmd listtrace command to verify that the requested logging level is now in effect. Before modifying the RAS1 logging level with the tacmd settrace command, display the current value with the tacmd listtrace command to determine if there are any active diagnostic traces that should be preserved in the tacmd settrace command. You must log in by using the tacmd login command before running the tacmd settrace command.

Note that all ITM processes in the RAS1 command flow must be at ITM v6.2.3 Fix Pack 2 (or higher), as only those releases support the RAS1 Dynamic Trace Facility. For example, if a tacmd settrace request must travel from hub to remote monitoring server to agent, all three processes must be at ITM v6.2.3 Fix Pack 2 (or higher) or the request will fail. In addition, if you want to disable the Dynamic Trace Facility, set the environment variable KBB_DISABLE_DYNAMIC_TRACE=N. With this setting, the tacmd settrace command will be ignored.

CLI syntax

Use this format to change the current tracing level:

tacmd settrace
                      {-m|--system} SYSTEM
                      {-p|--property} PROPERTY
                      {-o|--option} OPTION
                      {-d|--description} DESCRIPTION

Use this format to restore the original value by undoing any tracing changes that have been made:

tacmd settrace
                      {-m|--system} SYSTEM
                      {-p|--property} PROPERTY
                      {-r|--restore} RESTORE

where:
-m|--system
Specifies to which managed system to send the command.
-p|--property
Identifies the RAS1 trace property to set. Valid values include KBB_RAS1, KDC_DEBUG, KDE_DEBUG, KDH_DEBUG, KLX_DEBUG, and KBS_DEBUG. Note that KLX_DEBUG is only active on z/OS and Windows platforms.
-o|--option
Identifies the trace options to set for the -p property. Kxx_DEBUG trace properties support one-character values: Y for Yes, N for Normal, I for Inhibit (i.e., NONE), V for Verbose, S for State, T for Trace, D for Detail, M for Maximum, and A for All. KBB_RAS1 supports more complex options. For help with KBB_RAS1, refer to "Setting traces" in the IBM Tivoli Monitoring Troubleshooting Guide, or use the settings provided by your IBM Software Support representative. If a KBB_RAS1 string contains any embedded blanks, the entire string must be enclosed in double quotes.
-d|--description
Specifies an optional description text string to help identify the reason for changing the trace variable. If a description string contains any embedded blanks, the entire string must be enclosed in double quotes.
-r|--restore
Specifies that the RAS1 trace property should be restored back to the original value it had at product startup. If the -r flag is set, the -o and -d flags are ignored.

CLI example

This example modifies the RAS1 logging level for managed system AIX_RTEMS. Note that the new value of the RAS1 variable, containing embedded blanks, is enclosed in double quotes.
tacmd settrace -m AIX_RTEMS -p KBB_RAS1-o "ERROR (UNIT:kfasd ALL)"
This example activates debug tracing of the KDC component on the HUB. An optional description text string, "PMR 12345", is specified so that when the tracing change takes effect, the HUB's RAS1 log message will include the "PMR 12345" string to help explain why the debug tracing was activated.
tacmd settrace -m *HUB -p KDC_DEBUG -o Y -d "PMR 12345"
In this example, the KBB_RAS1 setting of an agent on SystemA is restored to its original value. This command would typically be issued after diagnostic trace data had been collected from the agent and it was no longer necessary to continue running with dynamic tracing active.
tacmd settrace -m SystemA:Agent1 -p KBB_RAS1 -r
Note: A hub monitoring system can be specified using either its CMS_NODEID value or as *HUB.
Note: In the case of an ITM process that spawns other child processes, the RAS1 tracing level of the child processes will not be altered by the tacmd settrace command. For example, if you run the tacmd settrace command on a UNIX OS agent, the RAS1 tracing level of the agent's child processes, such as kux_vmstat, ifstat, or stat_deamon, will remain the same. Only the kuxagent parent process will be affected by the tacmd settrace command.

Return values

See Table 1.

Related commands

tacmd listtrace

Return to Table 1.



Feedback