Lines Matching +full:target +full:- +full:module

2 .\" Copyright (c) 2004-2005
5 .\" Copyright (c) 2001-2003
135 .Nd "SNMP daemon loadable module interface"
138 .Pq libbsnmp, -lbsnmp
320 UDP port table, a community table, a module table, a statistics group and
326 .Ss MODULE LOADING AND UNLOADING
327 Modules are loaded by writing to the module table.
328 This table is indexed by a string, that identifies the module to the daemon.
331 to identify resources allocated to this module.
332 A row in the module table is
333 created by writing a string of non-zero length to the
336 This string must be the complete path to the file containing the module.
337 A module can be unloaded by writing a zero length string to the path column
343 Upon loading a module the SNMP daemon expects the module file to a export
348 .Bd -literal -offset indent
371 .Bl -tag -width ".It Va tree_size"
373 This is a string that will be visible in the module table.
374 It should give some hint about the function of this module.
376 This function is called upon loading the module.
377 The module pointer should
378 be stored by the module because it is needed in other calls and the
379 argument vector will contain the arguments to this module from the daemons
385 function is called when the module is unloaded.
387 The module is unloaded.
388 This gives the module a chance to free resources that
409 it is called by the daemon to dump the state of the module.
413 signal it re-reads its configuration file.
418 it is called after reading the configuration file to give the module a chance
423 this function is called after successful loading and initializing the module
427 community was registered by this module and
433 This is a pointer to the node array for the MIB tree implemented by this module.
440 it is called whenever another module was loaded or unloaded.
442 pointer to that module and a flag that is 0 for unloading and 1 for loading.
445 When everything is ok, the daemon merges the module's MIB tree into its current
450 the global one and the module is unloaded.
458 When the module is unloaded, its MIB tree is removed from the global one,
462 function is called, the module file is unloaded and the
485 .Bd -literal -offset indent
524 .Bl -tag -width "INDEX"
561 .Bd -literal -offset indent
562 get_ticks() - start_tick
567 .Bd -literal -offset indent
587 .Bd -literal -offset indent
601 when the community strings for the read-write or read-only community are found
607 another link) or to implement non-UDP access points to SNMP.
611 .Bl -tag -width ".It Fa descr"
613 This is an integer identifying the community to the module.
614 Each module has its own namespace with regard to this parameter.
615 The community table is indexed with the module name and this identifier.
620 This is the module defining the community.
634 All communities defined by a module are automatically released when the module
636 .Ss THE USER-BASED SECURITY GROUP
639 .Bd -literal -offset indent
655 .Bd -literal -offset indent
674 to external loadable module(s) to manage the list.
697 .Ss THE MANAGEMENT TARGET GROUP
698 The Management Target group holds target address information used when sending
701 The scalar statistics of the Management Target group are held in the global
704 .Bd -literal -offset indent
713 Three global lists of configured management target addresses, parameters and
715 .Bd -literal -offset indent
729 This structure represents a SNMPv3 Management Target address. Each time a SNMP
730 TRAP is send the daemon will send the Trap to all active Management Target
732 .Bd -literal -offset indent
745 associated SNMPv3 Management Target addresses.
746 .Bd -literal -offset indent
756 This structure represents Notification Tag entries - SNMP notifications are sent
757 to the Target address for each entry in the Management Target Address list that
760 The daemon does not create or remove entries in the Management Target group
761 lists, it gives an interface to external loadable module(s) to manage the lists.
763 adds a target address entry, and
765 deletes an existing entry from the target address list.
767 creates a socket associated with the target address entry so that SNMP
768 notifications may actually be send to that target address.
770 will return a pointer to the first target address entry in the list, while
772 will return a pointer to the next target address of a given entry if one exists.
774 adds a target parameters' entry, and
776 deletes an existing entry from the target parameters list.
778 will return a pointer to the first target parameters' entry in the list, while
780 will return a pointer to the next target parameters of a given entry if one
783 adds a notification target entry, and
785 deletes an existing entry from the notification target list.
787 will return a pointer to the first notification target entry in the list, while
789 will return a pointer to the next notification target of a given entry if one
792 is used to remove all configured data from the three global Management Target
806 easier routing of responses to the correct sub-system.
808 provide a way to acquire globally non-overlapping sub-ranges of the entire
809 31-bit id range.
813 The arguments are: the size of the range and the module allocating the range.
815 .Bd -literal -offset indent
816 id = reqid_allocate(1000, module);
855 is the module that starts the timer.
856 These timers are one-shot, they are not restarted.
870 If a module is unloaded all timers started by the module that have not expired
873 A module may need to get input from socket file descriptors without blocking
888 non-blocking mode, it is set to non-blocking mode.
893 All file descriptors selected by a module are automatically deselected when
894 the module is unloaded.
909 A module may create an entry in this table by calling
915 and a pointer to the module
919 All registrations of a module are automatically removed if the module is
939 .Bl -tag -width ".It Er SNMPD_INPUT_VALBADLEN"
991 identifying the trap and a NULL-terminated list of
997  should be granted or denied, according to the configured View-Based Access
1008 .Bl -tag -width "XXXXXXXXX"
1018 should be -1 if any size of the string is acceptable or a number larger or
1024 allocates a new string, copies over the new value, NUL-terminates it and
1039 is -1, the length is computed via
1048 The following functions are used to process scalars of type IP-address:
1049 .Bl -tag -width "XXXXXXXXX"
1061 The following functions handle OID-typed variables:
1062 .Bl -tag -width "XXXXXXXXX"
1079 .Bl -tag -width "XXXXXXXXX"
1101 .Bl -tag -width ".It Li OCTET STRING"
1137 .Fa value->var
1143 The function returns -1, 0, +1 when the
1181 This implementation conforms to the applicable IETF RFCs and ITU-T