pmc(8) - f34

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

NAME

6       pmc - PTP management client
7
8

SYNOPSIS

10       pmc  [ -f config-file ] [ -2 | -4 | -6 | -u ] [ -b boundary-hops ] [ -d
11       domain-number ] [ -i interface ] [ -s uds-address ] [ -t transport-spe‐
12       cific-field ] [ long-options ] [ -v ] [ -z ] [ command ] ...
13
14

DESCRIPTION

16       pmc  is a program which implements a PTP management client according to
17       IEEE standard 1588. The program reads from the standard input  or  from
18       the  command  line  actions  specified by name and management ID, sends
19       them over the selected transport and prints any received replies. There
20       are  three  actions supported: GET retrieves the specified information,
21       SET updates the specified information and CMD  (or  COMMAND)  initiates
22       the specified event.
23
24       By default the management commands are addressed to all ports. The TAR‐
25       GET command can be used to select a particular clock and port  for  the
26       subsequent messages.
27
28       Command help can be used to get a list of supported actions and manage‐
29       ment IDs.
30
31

OPTIONS

33       -f config-file
34              Read configuration from the  specified  file.  No  configuration
35              file is read by default.
36
37       -2     Select the IEEE 802.3 network transport.
38
39       -4     Select  the  UDP  IPv4  network  transport.  This is the default
40              transport.
41
42       -6     Select the UDP IPv6 network transport.
43
44       -u     Select the Unix Domain Socket transport.
45
46       -b boundary-hops
47              Specify the boundary hops value in sent messages. The default is
48              1.
49
50       -d domain-number
51              Specify the domain number in sent messages. The default is 0.
52
53       -i interface
54              Specify  the network interface. The default is /var/run/pmc.$pid
55              for the Unix Domain Socket transport  and  eth0  for  the  other
56              transports.
57
58       -s uds-address
59              Specifies  the  address of the server's UNIX domain socket.  The
60              default is /var/run/ptp4l.
61
62       -t transport-specific-field
63              Specify the transport specific field in sent messages as a hexa‐
64              decimal number.  The default is 0x0.
65
66       -h     Display a help message.
67
68       -v     Prints the software version and exits.
69
70       -z     The  official interpretation of the 1588 standard mandates send‐
71              ing GET actions with valid (but meaningless) TLV values.  There‐
72              fore  the  pmc program normally sends GET requests with properly
73              formed TLV values. This option  enables  the  legacy  option  of
74              sending zero length TLV values instead.
75
76

LONG OPTIONS

78       Each  and  every  configuration file option (see below in sections PRO‐
79       GRAM OPTIONS and PORT OPTIONS) may also appear as a "long"  style  com‐
80       mand  line  argument.  For example, the transportSpecific option may be
81       set using either of these two forms:
82
83              --transportSpecific 1   --transportSpecific=1
84
85       Option values given on the command line override values in  the  global
86       section  of  the  configuration file (which, in turn, overrides default
87       values).
88
89

CONFIGURATION FILE

91       The configuration file is divided into sections.  Each  section  starts
92       with  a  line  containing  its name enclosed in brackets and it follows
93       with settings.  Each setting is placed on a separate line, it  contains
94       the  name  of  the option and the value separated by whitespace charac‐
95       ters. Empty lines and lines starting with # are ignored.
96
97       The global section (indicated as  [global])  sets  the  global  program
98       options  as  well as the default port specific options.  Other sections
99       are port specific sections and they override the default port  options.
100       The  name  of  the  section  is  the  name of the configured port (e.g.
101       [eth0] ).
102
103

PROGRAM OPTIONS

105       domainNumber
106              The domain attribute of the local clock. The default is 0.
107
108

PORT OPTIONS

110       transportSpecific
111              The transport specific field. Must be in the  range  0  to  255.
112              The default is 0.
113
114
115       network_transport
116              Select  the  network transport. Possible values are UDPv4, UDPv6
117              and L2. The default is UDPv4.
118
119
120       ptp_dst_mac
121              The MAC address to which PTP management messages should be sent.
122              Relevant    only    with    L2   transport.   The   default   is
123              01:1B:19:00:00:00.
124
125
126

MANAGEMENT IDS

128       ANNOUNCE_RECEIPT_TIMEOUT
129
130       CLOCK_ACCURACY
131
132       CLOCK_DESCRIPTION
133
134       CURRENT_DATA_SET
135
136       DEFAULT_DATA_SET
137
138       DELAY_MECHANISM
139
140       DOMAIN
141
142       GRANDMASTER_SETTINGS_NP
143
144       LOG_ANNOUNCE_INTERVAL
145
146       LOG_MIN_PDELAY_REQ_INTERVAL
147
148       LOG_SYNC_INTERVAL
149
150       NULL_MANAGEMENT
151
152       PARENT_DATA_SET
153
154       PORT_DATA_SET
155
156       PORT_DATA_SET_NP
157
158       PORT_PROPERTIES_NP
159
160       PORT_STATS_NP
161
162       PRIORITY1
163
164       PRIORITY2
165
166       SLAVE_ONLY
167
168       TIMESCALE_PROPERTIES
169
170       TIME_PROPERTIES_DATA_SET
171
172       TIME_STATUS_NP
173
174       TRACEABILITY_PROPERTIES
175
176       USER_DESCRIPTION
177
178       VERSION_NUMBER
179
180

WARNING

182       Be cautious when the same configuration file is used for both ptp4l and
183       pmc.  Keep in mind that values specified in the configuration file take
184       precedence over their default values. If a certain option which is com‐
185       mon to ptp4l and pmc is specified to a non-default value in the config‐
186       uration file (e.g. for ptp4l), then this non-default value applies also
187       for pmc. This might be not what is expected.
188
189       To  avoid  securely these unexpected behaviour, different configuration
190       files for ptp4l and pmc are recommended.
191
192