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

« back to all changes in this revision

Viewing changes to man/netsnmp_default_store.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 "storage space for defaults" 3 "28 Nov 2005" "Version 5.2.1.rc3" "net-snmp" \" -*- nroff -*-
 
1
.TH "storage space for defaults" 3 "14 Jul 2006" "Version 5.2.3" "net-snmp" \" -*- nroff -*-
2
2
.ad l
3
3
.nh
4
4
.SH NAME
79
79
.PP
80
80
These definitions correspond with the 'storid' argument to the API
81
81
.IP "\(bu" 2
82
 
define NETSNMP_DS_LIBRARY_ID 0
83
 
.IP "\(bu" 2
84
 
define NETSNMP_DS_APPLICATION_ID 1
85
 
.IP "\(bu" 2
86
 
define NETSNMP_DS_TOKEN_ID 2
 
82
#define NETSNMP_DS_LIBRARY_ID 0
 
83
.IP "\(bu" 2
 
84
#define NETSNMP_DS_APPLICATION_ID 1
 
85
.IP "\(bu" 2
 
86
#define NETSNMP_DS_TOKEN_ID 2
87
87
.PP
88
88
.PP
89
89
These definitions correspond with the 'which' argument to the API, when the storeid argument is NETSNMP_DS_LIBRARY_ID
91
91
library booleans
92
92
.PP
93
93
.IP "\(bu" 2
94
 
define NETSNMP_DS_LIB_MIB_ERRORS 0
95
 
.IP "\(bu" 2
96
 
define NETSNMP_DS_LIB_SAVE_MIB_DESCRS 1
97
 
.IP "\(bu" 2
98
 
define NETSNMP_DS_LIB_MIB_COMMENT_TERM 2
99
 
.IP "\(bu" 2
100
 
define NETSNMP_DS_LIB_MIB_PARSE_LABEL 3
101
 
.IP "\(bu" 2
102
 
define NETSNMP_DS_LIB_DUMP_PACKET 4
103
 
.IP "\(bu" 2
104
 
define NETSNMP_DS_LIB_LOG_TIMESTAMP 5
105
 
.IP "\(bu" 2
106
 
define NETSNMP_DS_LIB_DONT_READ_CONFIGS 6
107
 
.IP "\(bu" 2
108
 
define NETSNMP_DS_LIB_MIB_REPLACE 7 replace objects from latest module
109
 
.IP "\(bu" 2
110
 
define NETSNMP_DS_LIB_PRINT_NUMERIC_ENUM 8 print only numeric enum values
111
 
.IP "\(bu" 2
112
 
define NETSNMP_DS_LIB_PRINT_NUMERIC_OIDS 9 print only numeric enum values
113
 
.IP "\(bu" 2
114
 
define NETSNMP_DS_LIB_DONT_BREAKDOWN_OIDS 10 dont print oid indexes specially
115
 
.IP "\(bu" 2
116
 
define NETSNMP_DS_LIB_ALARM_DONT_USE_SIG 11 don't use the alarm() signal
117
 
.IP "\(bu" 2
118
 
define NETSNMP_DS_LIB_PRINT_FULL_OID 12 print fully qualified oids
119
 
.IP "\(bu" 2
120
 
define NETSNMP_DS_LIB_QUICK_PRINT 13 print very brief output for parsing
121
 
.IP "\(bu" 2
122
 
define NETSNMP_DS_LIB_RANDOM_ACCESS 14 random access to oid labels
123
 
.IP "\(bu" 2
124
 
define NETSNMP_DS_LIB_REGEX_ACCESS 15 regex matching to oid labels
125
 
.IP "\(bu" 2
126
 
define NETSNMP_DS_LIB_DONT_CHECK_RANGE 16 don't check values for ranges on send
127
 
.IP "\(bu" 2
128
 
define NETSNMP_DS_LIB_NO_TOKEN_WARNINGS 17 no warn about unknown config tokens
129
 
.IP "\(bu" 2
130
 
define NETSNMP_DS_LIB_NUMERIC_TIMETICKS 18 print timeticks as a number
131
 
.IP "\(bu" 2
132
 
define NETSNMP_DS_LIB_ESCAPE_QUOTES 19 shell escape quote marks in oids
133
 
.IP "\(bu" 2
134
 
define NETSNMP_DS_LIB_REVERSE_ENCODE 20 encode packets from back to front
135
 
.IP "\(bu" 2
136
 
define NETSNMP_DS_LIB_PRINT_BARE_VALUE 21 just print value (not OID = value)
137
 
.IP "\(bu" 2
138
 
define NETSNMP_DS_LIB_EXTENDED_INDEX 22 print extended index format [x1][x2]
139
 
.IP "\(bu" 2
140
 
define NETSNMP_DS_LIB_PRINT_HEX_TEXT 23 print ASCII text along with hex strings
141
 
.IP "\(bu" 2
142
 
define NETSNMP_DS_LIB_PRINT_UCD_STYLE_OID 24 print OID's using the UCD-style prefix suppression
143
 
.IP "\(bu" 2
144
 
define NETSNMP_DS_LIB_READ_UCD_STYLE_OID 25 require top-level OIDs to be prefixed with a dot
145
 
.IP "\(bu" 2
146
 
define NETSNMP_DS_LIB_HAVE_READ_PREMIB_CONFIG 26 have the pre-mib parsing config tokens been processed
147
 
.IP "\(bu" 2
148
 
define NETSNMP_DS_LIB_HAVE_READ_CONFIG 27 have the config tokens been processed
149
 
.IP "\(bu" 2
150
 
define NETSNMP_DS_LIB_QUICKE_PRINT 28
151
 
.IP "\(bu" 2
152
 
define NETSNMP_DS_LIB_DONT_PRINT_UNITS 29 don't print UNITS suffix
153
 
.IP "\(bu" 2
154
 
define NETSNMP_DS_LIB_NO_DISPLAY_HINT 30 don't apply DISPLAY-HINTs
155
 
.IP "\(bu" 2
156
 
define NETSNMP_DS_LIB_16BIT_IDS 31 restrict requestIDs, etc to 16-bit values
157
 
.IP "\(bu" 2
158
 
define NETSNMP_DS_LIB_DONT_PERSIST_STATE 32 don't save/load any persistant state
159
 
.IP "\(bu" 2
160
 
define NETSNMP_DS_LIB_2DIGIT_HEX_OUTPUT 33 print a leading 0 on hex values <= 'f'
 
94
#define NETSNMP_DS_LIB_MIB_ERRORS 0
 
95
.IP "\(bu" 2
 
96
#define NETSNMP_DS_LIB_SAVE_MIB_DESCRS 1
 
97
.IP "\(bu" 2
 
98
#define NETSNMP_DS_LIB_MIB_COMMENT_TERM 2
 
99
.IP "\(bu" 2
 
100
#define NETSNMP_DS_LIB_MIB_PARSE_LABEL 3
 
101
.IP "\(bu" 2
 
102
#define NETSNMP_DS_LIB_DUMP_PACKET 4
 
103
.IP "\(bu" 2
 
104
#define NETSNMP_DS_LIB_LOG_TIMESTAMP 5
 
105
.IP "\(bu" 2
 
106
#define NETSNMP_DS_LIB_DONT_READ_CONFIGS 6
 
107
.IP "\(bu" 2
 
108
#define NETSNMP_DS_LIB_MIB_REPLACE 7 replace objects from latest module
 
109
.IP "\(bu" 2
 
110
#define NETSNMP_DS_LIB_PRINT_NUMERIC_ENUM 8 print only numeric enum values
 
111
.IP "\(bu" 2
 
112
#define NETSNMP_DS_LIB_PRINT_NUMERIC_OIDS 9 print only numeric enum values
 
113
.IP "\(bu" 2
 
114
#define NETSNMP_DS_LIB_DONT_BREAKDOWN_OIDS 10 dont print oid indexes specially
 
115
.IP "\(bu" 2
 
116
#define NETSNMP_DS_LIB_ALARM_DONT_USE_SIG 11 don't use the alarm() signal
 
117
.IP "\(bu" 2
 
118
#define NETSNMP_DS_LIB_PRINT_FULL_OID 12 print fully qualified oids
 
119
.IP "\(bu" 2
 
120
#define NETSNMP_DS_LIB_QUICK_PRINT 13 print very brief output for parsing
 
121
.IP "\(bu" 2
 
122
#define NETSNMP_DS_LIB_RANDOM_ACCESS 14 random access to oid labels
 
123
.IP "\(bu" 2
 
124
#define NETSNMP_DS_LIB_REGEX_ACCESS 15 regex matching to oid labels
 
125
.IP "\(bu" 2
 
126
#define NETSNMP_DS_LIB_DONT_CHECK_RANGE 16 don't check values for ranges on send
 
127
.IP "\(bu" 2
 
128
#define NETSNMP_DS_LIB_NO_TOKEN_WARNINGS 17 no warn about unknown config tokens
 
129
.IP "\(bu" 2
 
130
#define NETSNMP_DS_LIB_NUMERIC_TIMETICKS 18 print timeticks as a number
 
131
.IP "\(bu" 2
 
132
#define NETSNMP_DS_LIB_ESCAPE_QUOTES 19 shell escape quote marks in oids
 
133
.IP "\(bu" 2
 
134
#define NETSNMP_DS_LIB_REVERSE_ENCODE 20 encode packets from back to front
 
135
.IP "\(bu" 2
 
136
#define NETSNMP_DS_LIB_PRINT_BARE_VALUE 21 just print value (not OID = value)
 
137
.IP "\(bu" 2
 
138
#define NETSNMP_DS_LIB_EXTENDED_INDEX 22 print extended index format [x1][x2]
 
139
.IP "\(bu" 2
 
140
#define NETSNMP_DS_LIB_PRINT_HEX_TEXT 23 print ASCII text along with hex strings
 
141
.IP "\(bu" 2
 
142
#define NETSNMP_DS_LIB_PRINT_UCD_STYLE_OID 24 print OID's using the UCD-style prefix suppression
 
143
.IP "\(bu" 2
 
144
#define NETSNMP_DS_LIB_READ_UCD_STYLE_OID 25 require top-level OIDs to be prefixed with a dot
 
145
.IP "\(bu" 2
 
146
#define NETSNMP_DS_LIB_HAVE_READ_PREMIB_CONFIG 26 have the pre-mib parsing config tokens been processed
 
147
.IP "\(bu" 2
 
148
#define NETSNMP_DS_LIB_HAVE_READ_CONFIG 27 have the config tokens been processed
 
149
.IP "\(bu" 2
 
150
#define NETSNMP_DS_LIB_QUICKE_PRINT 28
 
151
.IP "\(bu" 2
 
152
#define NETSNMP_DS_LIB_DONT_PRINT_UNITS 29 don't print UNITS suffix
 
153
.IP "\(bu" 2
 
154
#define NETSNMP_DS_LIB_NO_DISPLAY_HINT 30 don't apply DISPLAY-HINTs
 
155
.IP "\(bu" 2
 
156
#define NETSNMP_DS_LIB_16BIT_IDS 31 restrict requestIDs, etc to 16-bit values
 
157
.IP "\(bu" 2
 
158
#define NETSNMP_DS_LIB_DONT_PERSIST_STATE 32 don't save/load any persistant state
 
159
.IP "\(bu" 2
 
160
#define NETSNMP_DS_LIB_2DIGIT_HEX_OUTPUT 33 print a leading 0 on hex values <= 'f'
161
161
.PP
162
162
.PP
163
163
library integers
164
164
.PP
165
165
.IP "\(bu" 2
166
 
define NETSNMP_DS_LIB_MIB_WARNINGS 0
167
 
.IP "\(bu" 2
168
 
define NETSNMP_DS_LIB_SECLEVEL 1
169
 
.IP "\(bu" 2
170
 
define NETSNMP_DS_LIB_SNMPVERSION 2
171
 
.IP "\(bu" 2
172
 
define NETSNMP_DS_LIB_DEFAULT_PORT 3
173
 
.IP "\(bu" 2
174
 
define NETSNMP_DS_LIB_OID_OUTPUT_FORMAT 4
175
 
.IP "\(bu" 2
176
 
define NETSNMP_DS_LIB_STRING_OUTPUT_FORMAT 5
 
166
#define NETSNMP_DS_LIB_MIB_WARNINGS 0
 
167
.IP "\(bu" 2
 
168
#define NETSNMP_DS_LIB_SECLEVEL 1
 
169
.IP "\(bu" 2
 
170
#define NETSNMP_DS_LIB_SNMPVERSION 2
 
171
.IP "\(bu" 2
 
172
#define NETSNMP_DS_LIB_DEFAULT_PORT 3
 
173
.IP "\(bu" 2
 
174
#define NETSNMP_DS_LIB_OID_OUTPUT_FORMAT 4
 
175
.IP "\(bu" 2
 
176
#define NETSNMP_DS_LIB_STRING_OUTPUT_FORMAT 5
177
177
.PP
178
178
.PP
179
179
library strings
180
180
.PP
181
181
.IP "\(bu" 2
182
 
define NETSNMP_DS_LIB_SECNAME 0
183
 
.IP "\(bu" 2
184
 
define NETSNMP_DS_LIB_CONTEXT 1
185
 
.IP "\(bu" 2
186
 
define NETSNMP_DS_LIB_PASSPHRASE 2
187
 
.IP "\(bu" 2
188
 
define NETSNMP_DS_LIB_AUTHPASSPHRASE 3
189
 
.IP "\(bu" 2
190
 
define NETSNMP_DS_LIB_PRIVPASSPHRASE 4
191
 
.IP "\(bu" 2
192
 
define NETSNMP_DS_LIB_OPTIONALCONFIG 5
193
 
.IP "\(bu" 2
194
 
define NETSNMP_DS_LIB_APPTYPE 6
195
 
.IP "\(bu" 2
196
 
define NETSNMP_DS_LIB_COMMUNITY 7
197
 
.IP "\(bu" 2
198
 
define NETSNMP_DS_LIB_PERSISTENT_DIR 8
199
 
.IP "\(bu" 2
200
 
define NETSNMP_DS_LIB_CONFIGURATION_DIR 9
201
 
.IP "\(bu" 2
202
 
define NETSNMP_DS_LIB_SECMODEL 10
203
 
.IP "\(bu" 2
204
 
define NETSNMP_DS_LIB_MIBDIRS 11
205
 
.IP "\(bu" 2
206
 
define NETSNMP_DS_LIB_OIDSUFFIX 12
207
 
.IP "\(bu" 2
208
 
define NETSNMP_DS_LIB_OIDPREFIX 13
209
 
.IP "\(bu" 2
210
 
define NETSNMP_DS_LIB_CLIENT_ADDR 14
211
 
.IP "\(bu" 2
212
 
define NETSNMP_DS_LIB_TEMP_FILE_PATTERN 15
213
 
.IP "\(bu" 2
214
 
define NETSNMP_DS_LIB_AUTHMASTERKEY 16
215
 
.IP "\(bu" 2
216
 
define NETSNMP_DS_LIB_PRIVMASTERKEY 17
217
 
.IP "\(bu" 2
218
 
define NETSNMP_DS_LIB_AUTHLOCALIZEDKEY 18
219
 
.IP "\(bu" 2
220
 
define NETSNMP_DS_LIB_PRIVLOCALIZEDKEY 19
 
182
#define NETSNMP_DS_LIB_SECNAME 0
 
183
.IP "\(bu" 2
 
184
#define NETSNMP_DS_LIB_CONTEXT 1
 
185
.IP "\(bu" 2
 
186
#define NETSNMP_DS_LIB_PASSPHRASE 2
 
187
.IP "\(bu" 2
 
188
#define NETSNMP_DS_LIB_AUTHPASSPHRASE 3
 
189
.IP "\(bu" 2
 
190
#define NETSNMP_DS_LIB_PRIVPASSPHRASE 4
 
191
.IP "\(bu" 2
 
192
#define NETSNMP_DS_LIB_OPTIONALCONFIG 5
 
193
.IP "\(bu" 2
 
194
#define NETSNMP_DS_LIB_APPTYPE 6
 
195
.IP "\(bu" 2
 
196
#define NETSNMP_DS_LIB_COMMUNITY 7
 
197
.IP "\(bu" 2
 
198
#define NETSNMP_DS_LIB_PERSISTENT_DIR 8
 
199
.IP "\(bu" 2
 
200
#define NETSNMP_DS_LIB_CONFIGURATION_DIR 9
 
201
.IP "\(bu" 2
 
202
#define NETSNMP_DS_LIB_SECMODEL 10
 
203
.IP "\(bu" 2
 
204
#define NETSNMP_DS_LIB_MIBDIRS 11
 
205
.IP "\(bu" 2
 
206
#define NETSNMP_DS_LIB_OIDSUFFIX 12
 
207
.IP "\(bu" 2
 
208
#define NETSNMP_DS_LIB_OIDPREFIX 13
 
209
.IP "\(bu" 2
 
210
#define NETSNMP_DS_LIB_CLIENT_ADDR 14
 
211
.IP "\(bu" 2
 
212
#define NETSNMP_DS_LIB_TEMP_FILE_PATTERN 15
 
213
.IP "\(bu" 2
 
214
#define NETSNMP_DS_LIB_AUTHMASTERKEY 16
 
215
.IP "\(bu" 2
 
216
#define NETSNMP_DS_LIB_PRIVMASTERKEY 17
 
217
.IP "\(bu" 2
 
218
#define NETSNMP_DS_LIB_AUTHLOCALIZEDKEY 18
 
219
.IP "\(bu" 2
 
220
#define NETSNMP_DS_LIB_PRIVLOCALIZEDKEY 19 
221
221
.PP
222
222
 
223
223
.SH "Function Documentation"
237
237
.PP
238
238
\fBReturns:\fP
239
239
.RS 4
240
 
Returns SNMPPERR_GENERR if the storeid and which parameters do not correspond to a valid slot, or SNMPERR_SUCCESS otherwise.
 
240
Returns SNMPPERR_GENERR if the storeid and which parameters do not correspond to a valid slot, or SNMPERR_SUCCESS otherwise. 
241
241
.RE
242
242
.PP
243
243