Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
DEFAULT_STORE(3)		   Net-SNMP		      DEFAULT_STORE(3)

NAME
       default_store - generic storage of global data.

SYNOPSIS
       #include	<net-snmp/net-snmp-config.h>
       #include	<net-snmp/config_api.h>

       int netsnmp_ds_set_boolean(int store, int which,	int val);
       int netsnmp_ds_get_boolean(int store, int which);
       int netsnmp_ds_set_int(int store, int which, int	val);
       int netsnmp_ds_get_int(int store, int which);
       int netsnmp_ds_set_string(int store, int	which,
				 const char *val);
       char *netsnmp_ds_get_string(int store, int which);
       int netsnmp_ds_register_config(u_char type,
				      const char *ftype,
				      const char *token,
				      int store, int which);
       int netsnmp_ds_register_premib(u_char type,
				      const char *ftype,
				      const char *token,
				      int store, int which);
       void netsnmp_ds_shutdown(void);

DESCRIPTION
       The purpose of the default storage is three-fold:

       1)     To  create a global storage space	without	creating a whole bunch
	      of globally accessible variables or  a  whole  bunch  of	access
	      functions	to work	with more privately restricted variables.

       2)     To  provide  a single location where the thread locking needs to
	      be implemented. At the time of  this  writing,  however,	thread
	      locking is not yet in place.

       3)     To  reduce  the number of	cross dependencies between code	pieces
	      that may or may not be linked together in	 the  long  run.  This
	      provides	for a single location in which configuration data, for
	      example, can be stored for a separate section of code  that  may
	      not be linked in to the application in question.

       The functions defined here implement these goals.

       Currently,  three  data	types  are  supported: booleans, integers, and
       strings.	Each of	these data types have separate storage spaces. In  ad-
       dition,	the storage space for each data	type is	divided	further	by the
       application level.   Currently, there are two storage spaces. The first
       is reserved for the SNMP	library	itself.	The second is intended for use
       in applications and is not modified or checked  by  the	library,  and,
       therefore, this is the space usable by you.

       You can think of	these storage spaces as	being 3	arrays,	something like
       bool_storage[storeid][which],	 int_storage[storeid][which],	   and
       string_storage[storeid][which].	 The data is then accessed through the
       functions defined below.	 For data you wish to store, you should	use  a
       store parameter of NETSNMP_DS_APPLICATION_ID.

       The storage space used by the library (for which	the store parameter is
       NETSNMP_DS_LIBRARY_ID) is defined in the	 default_store.h  file,	 which
       currently contains the following	defines:

	    */
       /**
	* @def NETSNMP_DS_LIBRARY_ID
	* These	definitions correspond with the	"storid" argument to the API.
	*/
       #define NETSNMP_DS_LIBRARY_ID	 0
       #define NETSNMP_DS_APPLICATION_ID 1
       #define NETSNMP_DS_TOKEN_ID	 2

	   /*
	    * These definitions	correspond with	the "which" argument to	the API,
	    * when the storeid argument	is NETSNMP_DS_LIBRARY_ID
	    */
	   /*
	    * library booleans
	    */
       #define NETSNMP_DS_LIB_MIB_ERRORS	  0
       #define NETSNMP_DS_LIB_SAVE_MIB_DESCRS	  1
       #define NETSNMP_DS_LIB_MIB_COMMENT_TERM	  2
       #define NETSNMP_DS_LIB_MIB_PARSE_LABEL	  3
       #define NETSNMP_DS_LIB_DUMP_PACKET	  4
       #define NETSNMP_DS_LIB_LOG_TIMESTAMP	  5
       #define NETSNMP_DS_LIB_DONT_READ_CONFIGS	  6    /* don't	read normal config files */
       #define NETSNMP_DS_LIB_DISABLE_CONFIG_LOAD      NETSNMP_DS_LIB_DONT_READ_CONFIGS
       #define NETSNMP_DS_LIB_MIB_REPLACE	  7    /* replace objects from latest module */
       #define NETSNMP_DS_LIB_PRINT_NUMERIC_ENUM  8    /* print	only numeric enum values */
       #define NETSNMP_DS_LIB_PRINT_NUMERIC_OIDS  9    /* print	only numeric enum values */
       #define NETSNMP_DS_LIB_DONT_BREAKDOWN_OIDS 10   /* dont print oid indexes specially */
       #define NETSNMP_DS_LIB_ALARM_DONT_USE_SIG  11   /* don't	use the	alarm()	signal */
       #define NETSNMP_DS_LIB_PRINT_FULL_OID	  12   /* print	fully qualified	oids */
       #define NETSNMP_DS_LIB_QUICK_PRINT	  13   /* print	very brief output for parsing */
       #define NETSNMP_DS_LIB_RANDOM_ACCESS	  14   /* random access	to oid labels */
       #define NETSNMP_DS_LIB_REGEX_ACCESS	  15   /* regex	matching to oid	labels */
       #define NETSNMP_DS_LIB_DONT_CHECK_RANGE	  16   /* don't	check values for ranges	on send	*/
       #define NETSNMP_DS_LIB_NO_TOKEN_WARNINGS	  17   /* no warn about	unknown	config tokens */
       #define NETSNMP_DS_LIB_NUMERIC_TIMETICKS	  18   /* print	timeticks as a number */
       #define NETSNMP_DS_LIB_ESCAPE_QUOTES	  19   /* shell	escape quote marks in oids */
       #define NETSNMP_DS_LIB_REVERSE_ENCODE	  20   /* encode packets from back to front */
       #define NETSNMP_DS_LIB_PRINT_BARE_VALUE	  21   /* just print value (not	OID = value) */
       #define NETSNMP_DS_LIB_EXTENDED_INDEX	  22   /* print	extended index format [x1][x2] */
       #define NETSNMP_DS_LIB_PRINT_HEX_TEXT	  23   /* print	ASCII text along with hex strings */
       #define NETSNMP_DS_LIB_PRINT_UCD_STYLE_OID 24   /* print	OID's using the	UCD-style prefix suppression */
       #define NETSNMP_DS_LIB_READ_UCD_STYLE_OID  25   /* require top-level OIDs to be prefixed	with a dot */
       #define NETSNMP_DS_LIB_HAVE_READ_PREMIB_CONFIG 26       /* have the pre-mib parsing config tokens been processed	*/
       #define NETSNMP_DS_LIB_HAVE_READ_CONFIG	  27   /* have the config tokens been processed	*/
       #define NETSNMP_DS_LIB_QUICKE_PRINT	  28
       #define NETSNMP_DS_LIB_DONT_PRINT_UNITS	  29 /*	don't print UNITS suffix */
       #define NETSNMP_DS_LIB_NO_DISPLAY_HINT	  30 /*	don't apply DISPLAY-HINTs */
       #define NETSNMP_DS_LIB_16BIT_IDS		  31   /* restrict requestIDs, etc to 16-bit values */
       #define NETSNMP_DS_LIB_DONT_PERSIST_STATE  32	 /* don't load config and don't	load/save persistent file */
       #define NETSNMP_DS_LIB_2DIGIT_HEX_OUTPUT	  33	 /* print a leading 0 on hex values <= 'f' */
       #define NETSNMP_DS_LIB_IGNORE_NO_COMMUNITY 34	 /* don't complain if no community is specified	in the command arguments */
       #define NETSNMP_DS_LIB_DISABLE_PERSISTENT_LOAD  35 /* don't load	persistent file	*/
       #define NETSNMP_DS_LIB_DISABLE_PERSISTENT_SAVE  36 /* don't save	persistent file	*/
       #define NETSNMP_DS_LIB_APPEND_LOGFILES	  37 /*	append,	don't overwrite, log files */
       #define NETSNMP_DS_LIB_NO_DISCOVERY	  38 /*	don't support RFC5343 contextEngineID discovery	*/
       #define NETSNMP_DS_LIB_TSM_USE_PREFIX	  39 /*	TSM's simple security name mapping */
       #define NETSNMP_DS_LIB_DONT_LOAD_HOST_FILES 40 /* don't read host.conf files */
       #define NETSNMP_DS_LIB_DNSSEC_WARN_ONLY	   41 /* tread DNSSEC errors as	warnings */
       #define NETSNMP_DS_LIB_MAX_BOOL_ID	   48 /* match NETSNMP_DS_MAX_SUBIDS */

	   /*
	    * library integers
	    */
       #define NETSNMP_DS_LIB_MIB_WARNINGS	   0
       #define NETSNMP_DS_LIB_SECLEVEL		   1
       #define NETSNMP_DS_LIB_SNMPVERSION	   2
       #define NETSNMP_DS_LIB_DEFAULT_PORT	   3
       #define NETSNMP_DS_LIB_OID_OUTPUT_FORMAT	   4
       #define NETSNMP_DS_LIB_PRINT_SUFFIX_ONLY	   NETSNMP_DS_LIB_OID_OUTPUT_FORMAT
       #define NETSNMP_DS_LIB_STRING_OUTPUT_FORMAT 5
       #define NETSNMP_DS_LIB_HEX_OUTPUT_LENGTH	   6
       #define NETSNMP_DS_LIB_SERVERSENDBUF	   7 /*	send buffer (server) */
       #define NETSNMP_DS_LIB_SERVERRECVBUF	   8 /*	receive	buffer (server)	*/
       #define NETSNMP_DS_LIB_CLIENTSENDBUF	   9 /*	send buffer (client) */
       #define NETSNMP_DS_LIB_CLIENTRECVBUF	  10 /*	receive	buffer (client)	*/
       #define NETSNMP_DS_SSHDOMAIN_SOCK_PERM	  11
       #define NETSNMP_DS_SSHDOMAIN_DIR_PERM	  12
       #define NETSNMP_DS_SSHDOMAIN_SOCK_USER	  12
       #define NETSNMP_DS_SSHDOMAIN_SOCK_GROUP	  13
       #define NETSNMP_DS_LIB_TIMEOUT		  14
       #define NETSNMP_DS_LIB_RETRIES		  15
       #define NETSNMP_DS_LIB_MAX_INT_ID	  48 /*	match NETSNMP_DS_MAX_SUBIDS */

	   /*
	    * special meanings for the default SNMP version slot (NETSNMP_DS_LIB_SNMPVERSION)
	    */
       #ifndef NETSNMP_DISABLE_SNMPV1
       #define NETSNMP_DS_SNMP_VERSION_1    128	       /* bogus	*/
       #endif
       #ifndef NETSNMP_DISABLE_SNMPV2C
       #define NETSNMP_DS_SNMP_VERSION_2c   1  /* real */
       #endif
       #define NETSNMP_DS_SNMP_VERSION_3    3  /* real */

	   /*
	    * library strings
	    */
       #define NETSNMP_DS_LIB_SECNAME		0
       #define NETSNMP_DS_LIB_CONTEXT		1
       #define NETSNMP_DS_LIB_PASSPHRASE	2
       #define NETSNMP_DS_LIB_AUTHPASSPHRASE	3
       #define NETSNMP_DS_LIB_PRIVPASSPHRASE	4
       #define NETSNMP_DS_LIB_OPTIONALCONFIG	5
       #define NETSNMP_DS_LIB_APPTYPE		6
       #define NETSNMP_DS_LIB_COMMUNITY		7
       #define NETSNMP_DS_LIB_PERSISTENT_DIR	8
       #define NETSNMP_DS_LIB_CONFIGURATION_DIR	9
       #define NETSNMP_DS_LIB_SECMODEL		10
       #define NETSNMP_DS_LIB_MIBDIRS		11
       #define NETSNMP_DS_LIB_OIDSUFFIX		12
       #define NETSNMP_DS_LIB_OIDPREFIX		13
       #define NETSNMP_DS_LIB_CLIENT_ADDR	14
       #define NETSNMP_DS_LIB_TEMP_FILE_PATTERN	15
       #define NETSNMP_DS_LIB_AUTHMASTERKEY	16
       #define NETSNMP_DS_LIB_PRIVMASTERKEY	17
       #define NETSNMP_DS_LIB_AUTHLOCALIZEDKEY	18
       #define NETSNMP_DS_LIB_PRIVLOCALIZEDKEY	19
       #define NETSNMP_DS_LIB_APPTYPES		20
       #define NETSNMP_DS_LIB_KSM_KEYTAB	21
       #define NETSNMP_DS_LIB_KSM_SERVICE_NAME	22
       #define NETSNMP_DS_LIB_X509_CLIENT_PUB	23
       #define NETSNMP_DS_LIB_X509_SERVER_PUB	24
       #define NETSNMP_DS_LIB_SSHTOSNMP_SOCKET	25
       #define NETSNMP_DS_LIB_CERT_EXTRA_SUBDIR	26
       #define NETSNMP_DS_LIB_HOSTNAME		27
       #define NETSNMP_DS_LIB_X509_CRL_FILE	28
       #define NETSNMP_DS_LIB_TLS_ALGORITMS	29
       #define NETSNMP_DS_LIB_TLS_LOCAL_CERT	30
       #define NETSNMP_DS_LIB_TLS_PEER_CERT	31
       #define NETSNMP_DS_LIB_SSH_USERNAME	32
       #define NETSNMP_DS_LIB_SSH_PUBKEY	33
       #define NETSNMP_DS_LIB_SSH_PRIVKEY	34
       #define NETSNMP_DS_LIB_MAX_STR_ID	48 /* match NETSNMP_DS_MAX_SUBIDS */

	   /*

FUNCTIONS
       int netsnmp_ds_set_boolean(int store, int which,	int val);
	      Stores  TRUE  if	val  !=	 0  or	else FALSE into	the bool_stor-
	      age[store][which]	slot.  Returns SNMPERR_GENERR if the store and
	      which  parameters	 do  not  correspond  to a valid slot, or SNM-
	      PERR_SUCCESS otherwise.

       int netsnmp_ds_get_boolean(int store, int which);
	      Returns 1	if bool_storage[store][which] is TRUE  or  0  if  not.
	      May also return SNMPERR_GENERR if	the store and which parameters
	      do not correspond	to a valid slot.

       int netsnmp_ds_set_string(int store, int	which, const char *val);
	      Stores val into the string_storage[store][which] slot.   Returns
	      SNMPERR_SUCCESS  normally,  or  SNMPERR_GENERR  if the store and
	      which parameters do not correspond to a valid slot.

       char *netsnmp_ds_get_string(int store, int which);
	      Returns the string which has been	 stored	 in  the  string_stor-
	      age[store][which]	 slot,	or NULL	if the store and which parame-
	      ters do not correspond to	a valid	slot.

       netsnmp_ds_set_int(int store, int which,	int val);
	      Stores val into the int_storage[store][which] slot.  Returns SN-
	      MPERR_GENERR if the store	and which parameters do	not correspond
	      to a valid slot, or SNMPERR_SUCCESS otherwise.

       int netsnmp_ds_get_int(int store, int which);
	      Returns the integer which	 has  been  stored  in	the  int_stor-
	      age[store][which]	slot, or SNMPERR_GENERR	if the store and which
	      parameters do not	correspond to a	valid slot.

       void netsnmp_ds_shutdown(void);
	      Reclaims memory  used  to	 hold  information  gathered  by  net-
	      snmp_ds_register_config and netsnmp_ds_register_premib.

       int  netsnmp_ds_register_config(u_char  type,  const char *ftype, const
       char *token, int	store, int which);
	      Registers	a configuration	file directive token and  attaches  it
	      to  a  default  storage  type and	slot.  Specifically, store and
	      which indicate the storage slot in the data  type	 indicated  by
	      type, where type is one of the following constants: ASN_BOOLEAN,
	      ASN_INTEGER, or ASN_OCTET_STR.  The ftype	variable indicates the
	      file name	base string searched for the token keyword.  For exam-
	      ple, the following call:

		     netsnmp_ds_register_config(ASN_INTEGER, "snmp",  "testto-
		     ken", DS_APPLICATION_ID, 5)

	      would  indicate  that  when the snmp.conf	file(s)	were found and
	      parsed, that any line beginning with the word "testtoken"	should
	      be  read	and  the value after "testtoken" should	be stored into
	      the int_storage[DS_APPLICATION_ID][5]  slot.   For  example  the
	      following	line in	the configuration file:

		     testtoken 502

	      would  set  int_storage[DS_APPLICATION_ID][5] = 502.  This func-
	      tion returns SNMPERR_SUCCESS if the registration was  made  suc-
	      cessfully,  or  SNMPERR_GENERR  if the registration was not made
	      (perhaps because the store and which parameters  do  not	corre-
	      spond  to	 a valid slot, or because of a memory allocation fail-
	      ure).

       int netsnmp_ds_register_premib(u_char type, const  char	*ftype,	 const
       char *token, int	store, int which);
	      Analogous	 to the	preceding function, but	the token is processed
	      before MIBs are read (this is therefore useful  for  controlling
	      MIB processing options).

SEE ALSO
       snmp_config(5), netsnmp_config_api(3)

V5.7.3				  25 Jun 2002		      DEFAULT_STORE(3)

NAME | SYNOPSIS | DESCRIPTION | FUNCTIONS | SEE ALSO

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=default_store&sektion=3&manpath=FreeBSD+12.1-RELEASE+and+Ports>

home | help