snmp4lptp man page

snmp4lptp ā€” SNMP sub agent

Synopsis

snmp4lptp [ -f config-file ] [ -m ] [ -q ] [ long-options ]

Description

snmp4lptp is an implementation of a sub agent for handling SNMP requests on the device running ptp4l. Via the UDS port, the sub agent retrieves management information from ptp4l and translates the information to or from an SNMP-specific form.

Options

-f file

Specify the path to the snmp4lptp configuration file.

-h

Display a help message.

-m

Print messages to the standard output.

-q

Don't send messages to the system logger.

Long Options

Each and every configuration file option (see below in sections Program Options and Port Options) may also appear as a "long" style command line argument. For example, the transportSpecific option may be set using either of these two forms:

--transportSpecific 1 Ā  --transportSpecific=1

Option values given on the command line override values in the global section of the configuration file (which, in turn, overrides default values).

Configuration File

The configuration file is divided into sections. Each section starts with a line containing its name enclosed in brackets and it follows with settings. Each setting is placed on a separate line, it contains the name of the option and the value separated by whitespace characters. Empty lines and lines starting with # are ignored.

The global section (indicated as [global]) sets the global program options as well as the default port specific options. Other sections are port specific sections and they override the default port options. The name of the section is the name of the configured port (e.g. [eth0] ). Currently no port specific options other than default are considered.

Program Options

domainNumber

The domain attribute of the local clock. The default is 0.

logging_level

The maximum logging level of messages which should be printed. The default is 6 (LOG_INFO).

message_tag

The tag which is added to all messages printed to the standard output or system log. The default is an empty string (which cannot be set in the configuration file as the option requires an argument).

use_syslog

Print messages to the system log if enabled. The default is 1 (enabled).

verbose

Print messages to the standard output if enabled. The default is 0 (disabled).

uds_address

Specifies the address of the server's UNIX domain socket. The default is /var/run/ptp4l.

Port Options

transportSpecific

The transport specific field. Must be in the range 0 to 255. The default is 0.

Warning

Be cautious when the same configuration file is used for both ptp4l and snmp4lptp. Keep in mind that values specified in the configuration file take precedence over their default values. If a certain option which is common to ptp4l and snmp4lptp is specified to a non-default value in the configuration file (e.g. for ptp4l), then this non-default value applies also for snmp4lptp. This might be not what is expected.

To avoid securely these unexpected behaviour, different configuration files for ptp4l and snmp4lptp are recommended.

See Also

ptp4l(8)

Info

September 2018 linuxptp