Here's my proposed documentation:

       trapsink  [-profile  p]  [-name  n]  [-tag  t] [-s src] HOST
[COMMUNITY

       [PORT]]


       trap2sink [-profile p] [-name n] [-tag  t]  [-s  src]  HOST
[COMMUNITY

       [PORT]]


       informsink  [-profile  p]  [-name  n] [-tag t] [-s src] HOST
[COMMUNITY

       [PORT]]

              define the address of a notification  receiver  that  should
be

              sent  SNMPv1  TRAPs,  SNMPv2c TRAP2s, or SNMPv2 INFORM
notifica-

              tions respectively.  See the section *LISTENING ADDRESSES *in
the

              snmpd(8)  manual  page  for more information about the format
of

              listening addresses.  If COMMUNITY is not  specified,  the
most

              recent trapcommunity string will be used.


              If the transport address does not include an explicit port
spec-

              ification, then PORT will be used.  If this  is  not
specified,

              the well known SNMP trap port (162) will be used.


              Note:  This  mechanism  is  being  deprecated, and the
listening

                     port should be specified via the transport
specification

                     HOST instead.


              The  optional  name and tag parameters specifies the name or
tag

              that will be used for SNMP-NOTIFICATION-MIB table  entries.
The

              profile  specifies  which notification filter profile entry
will

              be used for filtering outgoing notifications. (See
notification-

              Filter)


              The  optional  src  parameter  specifies the source address
that

              will be used when sending the trap packet to this sink.   It
is

              specified  as  a <transport-address>, using the same
<transport-

              specifier> as the destination HOST.  See the  section
*LISTENING*

              *ADDRESSES *in the snmpd(8) manual page for more information
about

              the format.


              If several sink directives are  specified,  multiple  copies
of

              each  notification  (in  the appropriate formats) will be
gener-

              ated.


              Note:  It is *not *normally appropriate to list two (or all
three)

                     sink directives with the same destination.


       trapsess [-profile p] [-name n] [-tag t] [-s src] [SNMPCMD_ARGS] HOST

              provides a more generic mechanism for defining notification
des-

              tinations.  SNMPCMD_ARGS  should  be  the  command-line
options
...

- Added [ -s src ] to all of trapsink, trap2sink, informsink, and trapsess

- Added the paragraph about the src parameter.  I duplicated the reference
to the LISTENING ADDRESS from snmpd(8), which also appears a few paragraphs
above, but I think it's worth doing since if you search for "src" you may
gloss over the above reference.

What do you think?

Thanks,
  Bill


On Mon, Aug 26, 2019 at 11:57 AM Bill Fenner <fen...@gmail.com> wrote:

> Hi Bart,
>
> I'm afraid I deferred to the documentation for
> df26f8f2d51409827a3ce131c1b9de67d01ee6e5 which added "-s" for trapsink.
> (i.e., nowhere.)  I acknowledge that was lazy, and I will write
> documentation for both commits in snmpd.conf.5.def.
>
>   Bill
>
>
> On Fri, Jul 26, 2019 at 9:28 PM Bart Van Assche <bvanass...@acm.org>
> wrote:
>
>> Hi Bill,
>>
>> Commit e56699f5e2ef added the ability to set the source address with
>> "-s" for trapsess, which is great. Do you remember in which man page
>> that option has been documented?
>>
>> Thanks,
>>
>> Bart.
>>
>
_______________________________________________
Net-snmp-coders mailing list
Net-snmp-coders@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/net-snmp-coders

Reply via email to