PTP Management Messages

Enhanced PTP User Guide (UG1602)

Document ID
UG1602
Release Date
2022-10-18
Revision
1.0 English

PTP Management ‘GET’ messages are supported from sfptpd v2.2.1. These messages allow a network management node to retrieve PTP clock data from other PTP nodes in the network. The following table includes all supported managementId types.

Table 1. Management Messages
managementId Value
MGMT_ID_NULL 0x0000
MGMT_ID_CLOCK_DESCRIPTION 0x0001
MGMT_ID_USER_DESCRIPTION 0x0002
MGMT_ID_DEFAULT_DATA_SET 0x2000
MGMT_ID_CURRENT_DATA_SET 0x2001
MGMT_ID_PARENT_DATA_SET 0x2002
MGMT_ID_TIME_PROPERTIES_DATA_SET 0x2003
MGMT_ID_PORT_DATA_SET 0x2004
MGMT_ID_PRIORITY1 0x2005
MGMT_ID_PRIORITY2 0x2006
MGMT_ID_DOMAIN 0x2007
MGMT_ID_SLAVE_ONLY 0x2008
MGMT_ID_LOG_ANNOUNCE_INTERVAL 0x2009
MGMT_ID_ANNOUNCE_RECEIPT_TIMEOUT 0x200a
MGMT_ID_LOG_SYNC_INTERVAL 0x200b
MGMT_ID_VERSION_NUMBER 0x200c
MGMT_ID_TIME 0x200f
MGMT_ID_CLOCK_ACCURACY 0x2010
MGMT_ID_UTC_PROPERTIES 0x2011
MGMT_ID_TRACEABILITY_PROPERTIES 0x2012
MGMT_ID_DELAY_MECHANISM 0x6000
MGMT_ID_LOG_MIN_PDELAY_REQ_INTERVAL 0x6001

Management messages are disabled by default. To enable sfptpd support for GET messages, set the following option in the PTP configuration file.

ptp_mgmt_msgs read-only

For a detailed description of Management Messages and the managementId values, refer to the Std 1588-2008, IEEE Standard for a Precision Clock Synchronization Protocol for Networked Measurement and Control Systems.