~ubuntu-branches/ubuntu/hardy/net-snmp/hardy-proposed

« back to all changes in this revision

Viewing changes to man/netsnmp_snmp_logging.3

  • Committer: Bazaar Package Importer
  • Author(s): Scott James Remnant
  • Date: 2006-11-28 12:29:34 UTC
  • mfrom: (1.1.4 upstream)
  • Revision ID: james.westby@ubuntu.com-20061128122934-82xxzy2zcvypnvy7
Tags: 5.2.3-4ubuntu1
* Merge from debian unstable, remaining changes:
  - remove stop links from rc0 and rc6

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
.TH "generic logging for net-snmp" 3 "28 Nov 2005" "Version 5.2.1.rc3" "net-snmp" \" -*- nroff -*-
 
1
.TH "generic logging for net-snmp" 3 "14 Jul 2006" "Version 5.2.3" "net-snmp" \" -*- nroff -*-
2
2
.ad l
3
3
.nh
4
4
.SH NAME
73
73
.ti -1c
74
74
.RI "int \fBsnmp_get_do_logging\fP (void)"
75
75
.br
76
 
.RI "\fIThis snmp logging function allows variable argument list given the specified priority, format and a populated va_list structure. \fP"
 
76
.RI "\fIIs logging done? \fP"
77
77
.ti -1c
78
78
.RI "void \fBsnmp_disable_syslog_entry\fP (\fBnetsnmp_log_handler\fP *logh)"
79
79
.br
87
87
.RI "void \fBsnmp_disable_filelog\fP (void)"
88
88
.br
89
89
.ti -1c
90
 
.RI "\fBsnmp_stderrlog_status\fP (void)"
 
90
.RI "int \fBsnmp_stderrlog_status\fP (void)"
91
91
.br
92
92
.ti -1c
93
93
.RI "void \fBsnmp_disable_stderrlog\fP (void)"
155
155
.ti -1c
156
156
.RI "int \fBsnmp_vlog\fP (int priority, const char *format, va_list ap)"
157
157
.br
 
158
.RI "\fIThis snmp logging function allows variable argument list given the specified priority, format and a populated va_list structure. \fP"
158
159
.ti -1c
159
 
.RI "int \fBsnmp_log\fP (va_alist)"
 
160
.RI "int \fBsnmp_log\fP (int priority, const char *format,...)"
160
161
.br
161
162
.RI "\fIThis snmp logging function allows variable argument list given the specified format and priority. \fP"
162
163
.ti -1c
180
181
.PP 
181
182
.SS "int snmp_get_do_logging (void)"
182
183
.PP
 
184
Is logging done? 
 
185
.PP
 
186
\fBReturns:\fP
 
187
.RS 4
 
188
Returns 0 if logging is off, 1 when it is done. 
 
189
.RE
 
190
.PP
 
191
 
 
192
.PP
 
193
Definition at line 445 of file snmp_logging.c.
 
194
.PP
 
195
References netsnmp_log_handler_s::enabled, logh_head, and netsnmp_log_handler_s::next.
 
196
.PP
 
197
Referenced by netsnmp_agent_check_parse().
 
198
.SS "int snmp_log (int priority, const char * format,  ...)"
 
199
.PP
 
200
This snmp logging function allows variable argument list given the specified format and priority. 
 
201
.PP
 
202
Calls the snmp_vlog function. The default logfile this function writes to is /var/log/snmpd.log.
 
203
.PP
 
204
\fBSee also:\fP
 
205
.RS 4
 
206
\fBsnmp_vlog\fP 
 
207
.RE
 
208
.PP
 
209
 
 
210
.PP
 
211
\fBExamples: \fP
 
212
.in +1c
 
213
\fBdelayed_instance.c\fP.
 
214
.PP
 
215
Definition at line 1177 of file snmp_logging.c.
 
216
.PP
 
217
References snmp_vlog().
 
218
.PP
 
219
Referenced by _request_set_error(), _sess_read(), agent_check_and_process(), clear_callback(), config_perror(), config_pwarn(), convert_v1pdu_to_v2(), convert_v2pdu_to_v1(), copy_word(), init_agent(), init_master_agent(), netsnmp_agent_check_packet(), netsnmp_agent_check_parse(), netsnmp_baby_steps_handler_get(), netsnmp_cache_create(), netsnmp_cache_helper_handler(), netsnmp_cache_timer_start(), netsnmp_cache_timer_stop(), netsnmp_call_handler(), netsnmp_call_handlers(), netsnmp_call_next_handler(), netsnmp_call_next_handler_one_request(), netsnmp_config_parse_add_row(), netsnmp_config_parse_table_set(), netsnmp_container_get_null(), netsnmp_container_iterator_get(), netsnmp_container_table_handler_get(), netsnmp_container_table_register(), netsnmp_data_list_add_data(), netsnmp_data_list_add_node(), netsnmp_ds_handle_config(), netsnmp_get_multiplexer_handler(), netsnmp_get_table_data_handler(), netsnmp_get_table_data_set_handler(), netsnmp_get_table_handler(), netsnmp_inject_handler_before(), netsnmp_instance_counter32_handler(), netsnmp_mark_row_column_writable(), netsnmp_multiplexer_helper_handler(), netsnmp_read_data_callback(), netsnmp_register_callback(), netsnmp_register_handler(), netsnmp_register_handler_nocallback(), netsnmp_register_mib(), netsnmp_register_save_list(), netsnmp_request_set_error_all(), netsnmp_save_all_data_callback(), netsnmp_send_traps(), netsnmp_sess_log_error(), netsnmp_set_row_column(), netsnmp_table_container_register(), netsnmp_table_data_add_row(), netsnmp_table_data_set_helper_handler(), netsnmp_table_iterator_helper_handler(), netsnmp_table_set_add_default_row(), netsnmp_wrap_up_request(), read_config_print_usage(), read_config_read_octet_string(), read_config_store(), register_exceptfd(), register_readfd(), register_signal(), register_writefd(), snmp_call_callbacks(), snmp_clean_persistent(), snmp_log_perror(), snmp_pdu_parse(), snmp_perror(), snmp_save_persistent(), snmp_set_var_value(), snmp_unregister_callback(), snmpd_parse_config_authtrap(), snmpv3_make_report(), snmpv3_packet_build(), snmpv3_parse(), and table_helper_handler().
 
220
.SS "int snmp_vlog (int priority, const char * format, va_list ap)"
 
221
.PP
183
222
This snmp logging function allows variable argument list given the specified priority, format and a populated va_list structure. 
184
223
.PP
185
224
The default logfile this function writes to is /var/log/snmpd.log.
186
225
.PP
187
226
\fBParameters:\fP
188
227
.RS 4
189
 
\fIpriority\fP is an integer representing the type of message to be written to the snmp log file. The types are errors, warning, and information. The error types are:
 
228
\fIpriority\fP is an integer representing the type of message to be written to the snmp log file. The types are errors, warning, and information.
190
229
.IP "\(bu" 2
 
230
The error types are:
 
231
.IP "  \(bu" 4
191
232
LOG_EMERG system is unusable
192
 
.IP "\(bu" 2
 
233
.IP "  \(bu" 4
193
234
LOG_ALERT action must be taken immediately
194
 
.IP "\(bu" 2
 
235
.IP "  \(bu" 4
195
236
LOG_CRIT critical conditions
196
 
.IP "\(bu" 2
197
 
LOG_ERR error conditions The warning type is:
198
 
.PP
199
 
.RE
200
 
.PP
201
 
.IP "\(bu" 2
202
 
LOG_WARNING warning conditions The information types are:
 
237
.IP "  \(bu" 4
 
238
LOG_ERR error conditions
 
239
.PP
 
240
 
 
241
.IP "\(bu" 2
 
242
The warning type is:
 
243
.IP "  \(bu" 4
 
244
LOG_WARNING warning conditions
 
245
.PP
 
246
 
 
247
.IP "\(bu" 2
 
248
The information types are:
203
249
.IP "  \(bu" 4
204
250
LOG_NOTICE normal but significant condition
205
251
.IP "  \(bu" 4
206
252
LOG_INFO informational
207
 
.PP
208
 
 
209
 
.PP
210
 
.PP
 
253
.IP "  \(bu" 4
211
254
LOG_DEBUG debug-level messages
212
255
.PP
213
 
\fBParameters:\fP
214
 
.RS 4
 
256
 
 
257
.PP
 
258
.br
215
259
\fIformat\fP is a pointer to a char representing the variable argument list format used.
216
260
.br
217
261
\fIap\fP is a va_list type used to traverse the list of arguments.
224
268
.PP
225
269
\fBSee also:\fP
226
270
.RS 4
227
 
\fBsnmp_log\fP
228
 
.RE
229
 
.PP
230
 
 
231
 
.PP
232
 
Definition at line 470 of file snmp_logging.c.
233
 
.PP
234
 
References netsnmp_log_handler_s::enabled, and netsnmp_log_handler_s::next.
235
 
.PP
236
 
Referenced by netsnmp_agent_check_parse().
237
 
.SS "int snmp_log (va_alist)"
238
 
.PP
239
 
This snmp logging function allows variable argument list given the specified format and priority. 
240
 
.PP
241
 
Calls the snmp_vlog function. The default logfile this function writes to is /var/log/snmpd.log.
242
 
.PP
243
 
\fBSee also:\fP
244
 
.RS 4
245
 
\fBsnmp_vlog\fP
246
 
.RE
247
 
.PP
248
 
 
249
 
.PP
250
 
\fBExamples: \fP
251
 
.in +1c
252
 
\fBdelayed_instance.c\fP.
253
 
.PP
254
 
Definition at line 1172 of file snmp_logging.c.
255
 
.PP
256
 
References snmp_log_message::priority, and snmp_vlog().
257
 
.PP
258
 
Referenced by _request_set_error(), _sess_read(), agent_check_and_process(), clear_callback(), config_perror(), config_pwarn(), convert_v1pdu_to_v2(), convert_v2pdu_to_v1(), copy_word(), init_agent(), init_master_agent(), netsnmp_addrcache_add(), netsnmp_agent_check_packet(), netsnmp_agent_check_parse(), netsnmp_baby_steps_handler_get(), netsnmp_cache_create(), netsnmp_cache_helper_handler(), netsnmp_cache_timer_start(), netsnmp_cache_timer_stop(), netsnmp_call_handler(), netsnmp_call_handlers(), netsnmp_call_next_handler(), netsnmp_call_next_handler_one_request(), netsnmp_config_parse_add_row(), netsnmp_config_parse_table_set(), netsnmp_container_get_null(), netsnmp_container_iterator_get(), netsnmp_container_table_handler_get(), netsnmp_container_table_register(), netsnmp_data_list_add_data(), netsnmp_data_list_add_node(), netsnmp_ds_handle_config(), netsnmp_get_multiplexer_handler(), netsnmp_get_table_data_handler(), netsnmp_get_table_data_set_handler(), netsnmp_get_table_handler(), netsnmp_inject_handler_before(), netsnmp_instance_counter32_handler(), netsnmp_mark_row_column_writable(), netsnmp_multiplexer_helper_handler(), netsnmp_read_data_callback(), netsnmp_register_callback(), netsnmp_register_handler(), netsnmp_register_handler_nocallback(), netsnmp_register_mib(), netsnmp_register_save_list(), netsnmp_request_set_error_all(), netsnmp_save_all_data_callback(), netsnmp_send_traps(), netsnmp_sess_log_error(), netsnmp_set_row_column(), netsnmp_table_container_register(), netsnmp_table_data_add_row(), netsnmp_table_data_set_helper_handler(), netsnmp_table_iterator_helper_handler(), netsnmp_table_set_add_default_row(), netsnmp_wrap_up_request(), read_config_files(), read_config_print_usage(), read_config_read_octet_string(), read_config_store(), register_exceptfd(), register_readfd(), register_signal(), register_writefd(), snmp_call_callbacks(), snmp_clean_persistent(), snmp_log_perror(), snmp_pdu_parse(), snmp_perror(), snmp_save_persistent(), snmp_set_var_value(), snmp_unregister_callback(), snmpd_parse_config_authtrap(), snmpv3_make_report(), snmpv3_packet_build(), snmpv3_parse(), and table_helper_handler().
 
271
\fBsnmp_log\fP 
 
272
.RE
 
273
.PP
 
274
 
 
275
.PP
 
276
Definition at line 1133 of file snmp_logging.c.
 
277
.PP
 
278
References LOGLENGTH, NULL, snmp_log_string(), and vsnprintf().
 
279
.PP
 
280
Referenced by snmp_log().