snmp4lptp(8)

1SNMP4LPTP(8)                System Manager's Manual               SNMP4LPTP(8)
2
3
4

NAME

6       snmp4lptp - SNMP sub agent
7
8

SYNOPSIS

10       snmp4lptp [ -f config-file ] [ -m ] [ -q ] [ long-options ]
11
12

DESCRIPTION

14       snmp4lptp  is  an  implementation  of  a  sub  agent  for handling SNMP
15       requests on the device running ptp4l. Via the UDS port, the  sub  agent
16       retrieves management information from ptp4l and translates the informa‐
17       tion to or from an SNMP-specific form.
18
19

OPTIONS

21       -f file
22              Specify the path to the snmp4lptp configuration file.
23
24       -h     Display a help message.
25
26       -m     Print messages to the standard output.
27
28       -q     Don't send messages to the system logger.
29
30

LONG OPTIONS

32       Each and every configuration file option (see below  in  sections  PRO‐
33       GRAM OPTIONS  and  PORT OPTIONS) may also appear as a "long" style com‐
34       mand line argument. For example, the transportSpecific  option  may  be
35       set using either of these two forms:
36
37              --transportSpecific 1   --transportSpecific=1
38
39       Option  values  given on the command line override values in the global
40       section of the configuration file (which, in  turn,  overrides  default
41       values).
42
43

CONFIGURATION FILE

45       The  configuration  file  is divided into sections. Each section starts
46       with a line containing its name enclosed in  brackets  and  it  follows
47       with  settings.  Each setting is placed on a separate line, it contains
48       the name of the option and the value separated  by  whitespace  charac‐
49       ters. Empty lines and lines starting with # are ignored.
50
51       The  global  section  (indicated  as  [global]) sets the global program
52       options as well as the default port specific options.   Other  sections
53       are  port specific sections and they override the default port options.
54       The name of the section is  the  name  of  the  configured  port  (e.g.
55       [eth0]  ).  Currently  no  port specific options other than default are
56       considered.
57
58

PROGRAM OPTIONS

60       domainNumber
61              The domain attribute of the local clock.  The default is 0.
62
63       logging_level
64              The maximum logging level of messages which should  be  printed.
65              The default is 6 (LOG_INFO).
66
67       message_tag
68              The  tag  which is added to all messages printed to the standard
69              output or system log.  The default is  an  empty  string  (which
70              cannot  be  set in the configuration file as the option requires
71              an argument).
72
73       use_syslog
74              Print messages to the system log if enabled.  The default  is  1
75              (enabled).
76
77       verbose
78              Print  messages  to the standard output if enabled.  The default
79              is 0 (disabled).
80
81       uds_address
82              Specifies the address of the server's UNIX domain  socket.   The
83              default is /var/run/ptp4l.
84
85

PORT OPTIONS

87       transportSpecific
88              The  transport  specific  field.  Must be in the range 0 to 255.
89              The default is 0.
90
91

WARNING

93       Be cautious when the same configuration file is used for both ptp4l and
94       snmp4lptp. Keep in mind that values specified in the configuration file
95       take precedence over their default values. If a certain option which is
96       common  to  ptp4l  and snmp4lptp is specified to a non-default value in
97       the configuration file (e.g. for ptp4l), then  this  non-default  value
98       applies also for snmp4lptp. This might be not what is expected.
99
100       To  avoid  securely these unexpected behaviour, different configuration
101       files for ptp4l and snmp4lptp are recommended.
102
103