pmc(8) - c8

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

LONG OPTIONS

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

CONFIGURATION FILE

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

PROGRAM OPTIONS

101       domainNumber
102              The domain attribute of the local clock. The default is 0.
103
104

PORT OPTIONS

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

MANAGEMENT IDS

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

WARNING

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