This verb specifies the types of information that SNAplus2
records in log files on a particular server. It can be used to override
the default settings specified on SET_GLOBAL_LOG_TYPE, or to remove
the override so that this server reverts to using the default settings.
For more information about log files, see “SET_LOG_FILE”.
SNAplus2 logs messages for the following types of event:
- Problem
An abnormal event that degrades the system in a
way perceptible to a user (such as abnormal termination of a session).
- Exception
An abnormal event that degrades the system but that is
not immediately perceptible to a user (such as a resource shortage),
or an event that does not degrade the system but may indicate the
cause of later exceptions or problems (such as receiving an unexpected
message from the remote system).
- Audit
A normal event (such as starting a session).
Problem and exception messages are logged to the error log
file; audit messages are logged to the audit log file. Problem messages
are always logged and cannot be disabled, but you can specify whether
to log each of the other two message types. For each of the two
files (audit and error), you can specify whether to use succinct
logging (including only the text of the message and a summary of
the message source) or full logging (including full details of the
message source, cause, and any action required).
VCB
Structure |
 |
typedef struct set_log_type
{
AP_UINT16 opcode; /* verb operation code */
unsigned char reserv2; /* reserved */
unsigned char format; /* reserved */
AP_UINT16 primary_rc; /* primary return code */
AP_UINT32 secondary_rc; /* secondary return code */
unsigned char override; /* override global defaults? */
unsigned char audit; /* audit logging on or off */
unsigned char exception; /* exception logging on or off */
unsigned char succinct_audits; /* use succinct logging in audit file?*/
unsigned char succinct_errors; /* use succinct logging in error file?*/
} SET_LOG_TYPE;
|
Supplied
Parameters |
|
The application supplies the following parameters:
- opcode
AP_SET_LOG_TYPE
- override
Specifies whether this verb is being used to override the
global log types specified on SET_GLOBAL_LOG_TYPE, or to revert
to using these defaults. Possible values are:
- AP_YES
Override the global log types. The log types to
be used on this server are specified by the audit and exception parameters below, and the choice of succinct or full
logging is specified by the succinct_* parameters below.
- AP_NO
Revert to using the global log types. The audit, exception, and succinct_* parameters below are ignored.
- audit
Specify whether audit messages are recorded on this server.
Possible values are:
- AP_YES
Audit messages are recorded.
- AP_NO
Audit messages are not recorded.
- AP_LEAVE_UNCHANGED
Leave audit logging unchanged from the existing
definition.
- exception
Specify whether exception messages are recorded
on this server. Possible values are:
- AP_YES
Exception messages are recorded.
- AP_NO
Exception messages are not recorded.
- AP_LEAVE_UNCHANGED
Leave exception logging unchanged from the existing
definition.
- succinct_audits
Specifies whether to use succinct logging or full
logging in the audit log file on this server. Possible values are:
- AP_YES
Succinct logging: each message in the log file contains
a summary of the message header information (such as the message
number, log type, and system name) and the message text string and
parameters. To obtain more details of the cause of the log and any
action required, you can use the snaphelp utility.
- AP_NO
Full logging: each message in the log file includes
a full listing of the message header information, the message text
string and parameters, and additional information about the cause
of the log and any action required.
- AP_LEAVE_UNCHANGED
Leave succinct logging or full logging unchanged
from the existing definition.
If you are using central logging, the choice of succinct or
full logging for messages from all computers is determined by the
setting of this parameter on the server acting as the central logger;
this setting may either be from the SET_GLOBAL_LOG_TYPE verb, or from
a SET_LOG_TYPE verb issued to that server to override the default.
- succinct_errors
Specifies whether to use succinct logging or full
logging in the error log file on this server; this applies to both exception
logs and problem logs. The allowed values and their meanings are
the same as for the succinct_audits parameter.
Returned
Parameters: Successful Execution |
|
If the verb executes successfully, SNAplus2 returns the following parameters:
- primary_rc
AP_OK
- secondary_rc
Not used.
Returned
Parameters: Parameter Check |
|
If the verb does not execute because of a parameter error,
SNAplus2 returns the following parameters:
- primary_rc
AP_PARAMETER_CHECK
- secondary_rc
- AP_INVALID_SUCCINCT_SETTING
The succinct_audits or succinct_errors parameter was not set to a valid value.
Returned
Parameters: Other Conditions |
|
Appendix A “Common
Return Codes” lists further
combinations of primary and secondary return codes that are common
to all NOF verbs.
Printable version
