Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.12.0.1
openapi_ntp.h
Go to the documentation of this file.
1 
9 /*********************************************************************
10 *
11 * Copyright 2021-2023 Broadcom.
12 *
13 * Licensed under the Apache License, Version 2.0 (the "License");
14 * you may not use this file except in compliance with the License.
15 * You may obtain a copy of the License at
16 *
17 * http://www.apache.org/licenses/LICENSE-2.0
18 *
19 * Unless required by applicable law or agreed to in writing, software
20 * distributed under the License is distributed on an "AS IS" BASIS,
21 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
22 * See the License for the specific language governing permissions and
23 * limitations under the License.
24 *
25 **********************************************************************
26 *
27 * @filename openapi_ntp.h
28 *
29 * @purpose NTP Configuration and Status
30 *
31 * @component OpEN
32 *
33 * @create 23/09/2021
34 *
35 * @end
36 *
37 **********************************************************************/
38 #ifndef OPENAPI_NTP_H_INCLUDED
39 #define OPENAPI_NTP_H_INCLUDED
40 
41 #include "openapi_common.h"
42 #include "openapi_routing.h"
43 
44 #define OPEN_NTP_BUFFER_SIZE 256
45 #define OPEN_SECS_PER_MIN 60
46 #define OPEN_NTP_DATE_STRING_SIZE 21
47 #define OPEN_NTP_MIN_KEY_LENGTH 1
48 #define OPEN_NTP_MAX_KEY_LENGTH 129
49 #define OPEN_NTP_MIN_KEY_NUM 1
50 #define OPEN_NTP_MAX_KEY_NUM 65535
51 #define OPEN_VRF_MAX_NAME 15
52 #define OPEN_NTP_MAX_SERVERS 8
53 #define OPEN_NTP_MIN_ASSOC_ID 0
54 #define OPEN_NTP_MAX_ASSOC_ID 65535
57 typedef enum
58 {
59  OPEN_NTP_DISABLED = 0,
60  OPEN_NTP_UNICAST = 1,
61  OPEN_NTP_BROADCAST = 2
62 } OPEN_NTP_MODE_t;
63 
64 
66 typedef enum
67 {
68  OPEN_NTP_SUPPORTED_DISABLED = 0,
69  OPEN_NTP_SUPPORTED_UNICAST = 1,
70  OPEN_NTP_SUPPORTED_BROADCAST = 2,
71  OPEN_NTP_SUPPORTED_UNICAST_AND_BROADCAST = 3
72 }OPEN_NTP_SUPPORTED_MODE_t;
73 
75 typedef enum
76 {
77  OPEN_NTP_ADDRESS_UNKNOWN = 0,
78  OPEN_NTP_ADDRESS_IPV4 = 1,
79  OPEN_NTP_ADDRESS_IPV6 = 2,
80  OPEN_NTP_ADDRESS_DNS = 3
81 } OPEN_NTP_ADDRESS_TYPE_t;
82 
84 typedef enum
85 {
86  OPEN_NTP_SERVER_MODE_RESERVED = 0,
87  OPEN_NTP_SERVER_MODE_SYMMETRIC_ACTIVE = 1,
88  OPEN_NTP_SERVER_MODE_SYMMETRIC_PASSIVE = 2,
89  OPEN_NTP_SERVER_MODE_CLIENT = 3,
90  OPEN_NTP_SERVER_MODE_SERVER = 4,
91  OPEN_NTP_SERVER_MODE_BROADCAST = 5,
92  OPEN_NTP_SERVER_MODE_RESERVED_CONTROL = 6,
93  OPEN_NTP_SERVER_MODE_RESERVED_PRIVATE = 7
94 } OPEN_NTP_SERVER_MODE_t;
95 
96 typedef enum
97 {
98  OPEN_NTP_STATUS_OTHER = 1,
99  OPEN_NTP_STATUS_SUCCESS = 2,
100  OPEN_NTP_STATUS_REQUEST_TIMED_OUT = 3,
101  OPEN_NTP_STATUS_BAD_DATE_ENCODED = 4,
102  OPEN_NTP_STATUS_VERSION_NOT_SUPPORTED = 5,
103  OPEN_NTP_STATUS_SERVER_UNSYNCHRONIZED = 6,
104  OPEN_NTP_STATUS_KISS_OF_DEATH = 7,
105  OPEN_NTP_STATUS_KOD_RATE_EXCEEDED = 8
106 } OPEN_NTP_PACKET_STATUS_t;
107 
108 /* NTP Message Authentication Algorithms supported. */
109 typedef enum
110 {
111  OPEN_NTP_MSG_AUTH_ALG_NONE = 0,
112  OPEN_NTP_MSG_AUTH_ALG_MD5,
113  OPEN_NTP_MSG_AUTH_ALG_SHA1,
114  OPEN_NTP_MSG_AUTH_ALG_SHA256
115 } OPEN_NTP_MSG_AUTH_ALG_t;
116 
117 #ifndef DOXYGEN_SHOULD_SKIP_THIS
118 /*****************************************************************/
133 open_error_t openapiNtpTimeSet(openapiClientHandle_t *client_handle,
134  uint32_t offset);
135 #endif /* DOXYGEN_SHOULD_SKIP_THIS */
136 
137 /*****************************************************************/
160 open_error_t openapiNtpServerAdd(openapiClientHandle_t *client_handle,
161  open_buffdesc *ipAddr);
162 
163 /*****************************************************************/
179 open_error_t openapiNtpServersMaxSupportedGet(openapiClientHandle_t *client_handle,
180  uint32_t *maxNtpServers);
181 
182 /*****************************************************************/
203 open_error_t openapiNtpServerDelete(openapiClientHandle_t *client_handle,
204  open_buffdesc *ipAddr);
205 
206 /*****************************************************************/
220 open_error_t openapiNtpServerMaxAddrLenGet(openapiClientHandle_t *client_handle,
221  uint32_t *ntpServerAddrLen);
222 
223 /*****************************************************************/
240 open_error_t openapiNtpServerFirstGet(openapiClientHandle_t *client_handle,
241  open_buffdesc *ntpServer);
242 
243 /*****************************************************************/
262 open_error_t openapiNtpServerNextGet(openapiClientHandle_t *client_handle,
263  open_buffdesc *ntpServer,
264  open_buffdesc *nextNtpServer);
265 
266 /*****************************************************************/
282 open_error_t openapiNtpServerAddressTypeGet(openapiClientHandle_t *client_handle,
283  open_buffdesc *ntpServer,
284  OPEN_NTP_ADDRESS_TYPE_t *ntpServerAddrType);
285 
286 /*****************************************************************/
311 open_error_t openapiNtpModeSet(openapiClientHandle_t *client_handle,
312  OPEN_NTP_MODE_t mode);
313 
314 /*****************************************************************/
334 open_error_t openapiNtpModeGet(openapiClientHandle_t *client_handle,
335  OPEN_NTP_MODE_t *ntpMode);
336 
337 /*****************************************************************/
351 open_error_t openapiNtpSupportedModeGet(openapiClientHandle_t *client_handle,
352  OPEN_NTP_SUPPORTED_MODE_t *ntpSupportedMode);
353 
354 
355 /*****************************************************************/
370 open_error_t openapiActiveNtpServerAddressTypeGet(openapiClientHandle_t *client_handle,
371  OPEN_NTP_ADDRESS_TYPE_t *type);
372 
373 /*****************************************************************/
392 open_error_t openapiActiveNtpServerIpAddressGet(openapiClientHandle_t *client_handle,
393  open_buffdesc *ntpServer);
394 
395 /*****************************************************************/
410 open_error_t openapiActiveNtpServerStratumGet(openapiClientHandle_t *client_handle,
411  uint32_t *stratum);
412 
413 /*****************************************************************/
428 open_error_t openapiActiveNtpServerReferenceIdGet(openapiClientHandle_t *client_handle,
429  open_buffdesc *reference);
430 
431 /*****************************************************************/
444 open_error_t openapiNtpServerReferenceStringLengthGet(openapiClientHandle_t *client_handle,
445  uint32_t *refStrLen);
446 
447 /*****************************************************************/
461 open_error_t openapiActiveNtpServerModeGet(openapiClientHandle_t *client_handle,
462  OPEN_NTP_SERVER_MODE_t *serverMode);
463 
464 /*****************************************************************/
478 open_error_t openapiNtpServerCurrentEntriesGet(openapiClientHandle_t *client_handle,
479  uint32_t *currEntries);
480 
481 /*****************************************************************/
498 open_error_t openapiNtpAuthenticationModeSet(openapiClientHandle_t *client_handle,
499  OPEN_BOOL_t mode);
500 
501 /*****************************************************************/
517 open_error_t openapiNtpAuthenticationModeGet(openapiClientHandle_t *client_handle,
518  OPEN_BOOL_t *mode);
519 
520 /*****************************************************************/
535 open_error_t openapiNtpBroadcastDelaySet(openapiClientHandle_t *client_handle,
536  uint32_t delay);
537 
538 /*****************************************************************/
553 open_error_t openapiNtpBroadcastDelayGet(openapiClientHandle_t *client_handle,
554  uint32_t *delay);
555 
556 /******************************************************************/
573 open_error_t openapiNtpSourceInterfaceSet(openapiClientHandle_t *client_handle,
574  uint32_t intIfNum);
575 
576 /******************************************************************/
591 open_error_t openapiNtpSourceInterfaceGet(openapiClientHandle_t *client_handle,
592  uint32_t *intIfNum);
593 
594 /******************************************************************/
609 open_error_t openapiNtpVrfNameSet(openapiClientHandle_t *client_handle,
610  open_buffdesc *vrfName);
611 
612 /******************************************************************/
627 open_error_t openapiNtpVrfNameGet(openapiClientHandle_t *client_handle,
628  open_buffdesc *vrfName);
629 
630 /*****************************************************************/
648 open_error_t openapiNtpServerTableAuthKeySet(openapiClientHandle_t *client_handle,
649  open_buffdesc *ntpServer, uint32_t keyIndex);
650 
651 /*****************************************************************/
668 open_error_t openapiNtpServerTableAuthKeyGet(openapiClientHandle_t *client_handle,
669  open_buffdesc *ntpServer, uint32_t *keyIndex);
670 
671 /*****************************************************************/
688 open_error_t openapiNtpServerTableMaxPollSet(openapiClientHandle_t *client_handle,
689  open_buffdesc *ntpServer, uint16_t interval);
690 
691 /*****************************************************************/
708 open_error_t openapiNtpServerTableMaxPollGet(openapiClientHandle_t *client_handle,
709  open_buffdesc *ntpServer, uint16_t *interval);
710 
711 /*****************************************************************/
728 open_error_t openapiNtpServerTableMinPollSet(openapiClientHandle_t *client_handle,
729  open_buffdesc *ntpServer, uint16_t interval);
730 
731 /*****************************************************************/
748 open_error_t openapiNtpServerTableMinPollGet(openapiClientHandle_t *client_handle,
749  open_buffdesc *ntpServer, uint16_t *interval);
750 
751 /*****************************************************************/
768 open_error_t openapiNtpServerTablePreferSet(openapiClientHandle_t *client_handle,
769  open_buffdesc *ntpServer, OPEN_BOOL_t prefer);
770 
771 /*****************************************************************/
788 open_error_t openapiNtpServerTablePreferGet(openapiClientHandle_t *client_handle,
789  open_buffdesc *ntpServer, OPEN_BOOL_t *prefer);
790 
791 /*****************************************************************/
808 open_error_t openapiNtpServerTableBurstSet(openapiClientHandle_t *client_handle,
809  open_buffdesc *ntpServer, OPEN_BOOL_t burst);
810 
811 /*****************************************************************/
828 open_error_t openapiNtpServerTableBurstGet(openapiClientHandle_t *client_handle,
829  open_buffdesc *ntpServer, OPEN_BOOL_t *burst);
830 
831 /*****************************************************************/
848 open_error_t openapiNtpServerTableIBurstSet(openapiClientHandle_t *client_handle,
849  open_buffdesc *ntpServer, OPEN_BOOL_t iburst);
850 
851 /*****************************************************************/
868 open_error_t openapiNtpServerTableIBurstGet(openapiClientHandle_t *client_handle,
869  open_buffdesc *ntpServer, OPEN_BOOL_t *iburst);
870 
871 /*****************************************************************/
888 open_error_t openapiNtpServerTableVersionSet(openapiClientHandle_t *client_handle,
889  open_buffdesc *ntpServer, uint16_t version);
890 
891 /*****************************************************************/
908 open_error_t openapiNtpServerTableVersionGet(openapiClientHandle_t *client_handle,
909  open_buffdesc *ntpServer, uint16_t *version);
910 
911 /*****************************************************************/
935 open_error_t openapiNtpAuthTableKeyAdd(openapiClientHandle_t *client_handle,
936  uint32_t keyNumber, open_buffdesc *keyValue,
937  OPEN_BOOL_t isEncrypted, OPEN_NTP_MSG_AUTH_ALG_t msgAuthAlg);
938 
939 /*****************************************************************/
957 open_error_t openapiNtpAuthTableKeyDelete(openapiClientHandle_t *client_handle,
958  uint32_t keyNumber);
959 
960 /*****************************************************************/
980 open_error_t openapiNtpAuthTableKeyValueSet(openapiClientHandle_t *client_handle,
981  uint32_t keyNumber,
982  open_buffdesc *keyValue,
983  OPEN_BOOL_t isEncrypted);
984 
985 /*****************************************************************/
1004 open_error_t openapiNtpAuthTableKeyValueGet(openapiClientHandle_t *client_handle,
1005  uint32_t keyNumber,
1006  open_buffdesc *keyValue);
1007 
1008 /*****************************************************************/
1028 open_error_t openapiNtpAuthTableKeyMsgAuthAlgSet(openapiClientHandle_t *client_handle,
1029  uint32_t keyNumber,
1030  OPEN_NTP_MSG_AUTH_ALG_t msgAuthAlg);
1031 
1032 /*****************************************************************/
1051 open_error_t openapiNtpAuthTableKeyMsgAuthAlgGet(openapiClientHandle_t *client_handle,
1052  uint32_t keyNumber,
1053  OPEN_NTP_MSG_AUTH_ALG_t *msgAuthAlg);
1054 
1055 /*****************************************************************/
1074 open_error_t openapiNtpAuthTableKeyTrustedSet(openapiClientHandle_t *client_handle,
1075  uint32_t keyNumber,
1076  OPEN_BOOL_t trustedStatus);
1077 
1078 /*****************************************************************/
1097 open_error_t openapiNtpAuthTableKeyTrustedGet(openapiClientHandle_t *client_handle,
1098  uint32_t keyNumber,
1099  OPEN_BOOL_t *trustedStatus);
1100 
1101 /*****************************************************************/
1116 open_error_t openapiNtpAuthTableEntryFirstGet(openapiClientHandle_t *client_handle,
1117  uint32_t *keyNumber);
1118 
1119 /*****************************************************************/
1135 open_error_t openapiNtpAuthTableEntryGetNext(openapiClientHandle_t *client_handle,
1136  uint32_t *keyNum,
1137  uint32_t *nextKeyNum);
1138 
1139 #ifndef DOXYGEN_SHOULD_SKIP_THIS
1140 /*****************************************************************/
1154 open_error_t openapiNtpNotifyPeerList(openapiClientHandle_t *client_handle,
1155  open_buffdesc *assocList);
1156 #endif /* DOXYGEN_SHOULD_SKIP_THIS */
1157 
1158 /*****************************************************************/
1176 open_error_t openapiNtpBroadcastClientModeSet(openapiClientHandle_t *client_handle,
1177  OPEN_CONTROL_t mode);
1178 
1179 /*****************************************************************/
1193 open_error_t openapiNtpBroadcastClientModeGet(openapiClientHandle_t *client_handle,
1194  OPEN_CONTROL_t *ntpMode);
1195 
1196 /*****************************************************************/
1211 open_error_t openapiNtpVersionGet(openapiClientHandle_t *client_handle,
1212  uint32_t *version);
1213 
1214 /*******************************************************************/
1229 open_error_t openapiNtpEntSoftwareNameGet(openapiClientHandle_t *client_handle,
1230  open_buffdesc *swName);
1231 
1232 /*******************************************************************/
1247 open_error_t openapiNtpEntSoftwareVersionGet(openapiClientHandle_t *client_handle,
1248  open_buffdesc *swVersion);
1249 
1250 /*******************************************************************/
1265 open_error_t openapiNtpEntSystemTypeGet(openapiClientHandle_t *client_handle,
1266  open_buffdesc *systemType);
1267 
1268 /*******************************************************************/
1284 open_error_t openapiNtpEntStatusInPktsGet(openapiClientHandle_t *client_handle,
1285  uint32_t *inPkts);
1286 
1287 /*******************************************************************/
1303 open_error_t openapiNtpEntStatusOutPktsGet(openapiClientHandle_t *client_handle,
1304  uint32_t *outPkts);
1305 
1306 /*******************************************************************/
1323 open_error_t openapiNtpEntStatusBadVersionGet(openapiClientHandle_t *client_handle,
1324  uint32_t *badVerPkts);
1325 
1326 /*******************************************************************/
1343 open_error_t openapiNtpEntStatusProtocolErrorGet(openapiClientHandle_t *client_handle,
1344  uint32_t *pErrPkts);
1345 
1346 /*******************************************************************/
1362 open_error_t openapiNtpAssocIdGet(openapiClientHandle_t *client_handle,
1363  uint32_t assocID);
1364 
1365 /*******************************************************************/
1381 open_error_t openapiNtpAssocIdNextGet(openapiClientHandle_t *client_handle,
1382  uint32_t *nextAssocID);
1383 
1384 /*******************************************************************/
1401 open_error_t openapiNtpAssocNameGet(openapiClientHandle_t *client_handle,
1402  uint32_t assocId, open_buffdesc *assocName);
1403 
1404 /*******************************************************************/
1421 open_error_t openapiNtpAssocRefIdGet(openapiClientHandle_t *client_handle,
1422  uint32_t assocId, open_buffdesc *assocRefId);
1423 
1424 /*******************************************************************/
1441 open_error_t openapiNtpAssocAddressTypeGet(openapiClientHandle_t *client_handle,
1442  uint32_t assocId, OPEN_NTP_ADDRESS_TYPE_t *assocAddrType);
1443 
1444 /*******************************************************************/
1461 open_error_t openapiNtpAssocAddressGet(openapiClientHandle_t *client_handle,
1462  uint32_t assocId, open_buffdesc *assocAddr);
1463 
1464 /*******************************************************************/
1481 open_error_t openapiNtpAssocOffsetGet(openapiClientHandle_t *client_handle,
1482  uint32_t assocId, open_buffdesc *assocOffset);
1483 
1484 /*******************************************************************/
1501 open_error_t openapiNtpAssocStratumGet(openapiClientHandle_t *client_handle,
1502  uint32_t assocId, uint32_t *assocStratum);
1503 
1504 /*******************************************************************/
1521 open_error_t openapiNtpAssocStatusJitterGet(openapiClientHandle_t *client_handle,
1522  uint32_t assocId, open_buffdesc *assocJitter);
1523 
1524 /*******************************************************************/
1541 open_error_t openapiNtpAssocStatusDelayGet(openapiClientHandle_t *client_handle,
1542  uint32_t assocId, open_buffdesc *assocDelay);
1543 
1544 /*******************************************************************/
1561 open_error_t openapiNtpAssocStatusDispersionGet(openapiClientHandle_t *client_handle,
1562  uint32_t assocId, open_buffdesc *assocDispersion);
1563 
1564 /*******************************************************************/
1582 open_error_t openapiNtpAssocStatInPktsGet(openapiClientHandle_t *client_handle,
1583  uint32_t assocId, uint32_t *assocInPkts);
1584 
1585 /*******************************************************************/
1604 open_error_t openapiNtpAssocStatOutPktsGet(openapiClientHandle_t *client_handle,
1605  uint32_t assocId, uint32_t *assocOutPkts);
1606 
1607 /*******************************************************************/
1626 open_error_t openapiNtpAssocStatProtocolErrorGet(openapiClientHandle_t *client_handle,
1627  uint32_t assocId, uint32_t *assocProtErrPkts);
1628 #endif
1629 
openapiNtpBroadcastDelaySet
open_error_t openapiNtpBroadcastDelaySet(openapiClientHandle_t *client_handle, uint32_t delay)
Set the Broadcast delay for the NTP application.
openapiActiveNtpServerIpAddressGet
open_error_t openapiActiveNtpServerIpAddressGet(openapiClientHandle_t *client_handle, open_buffdesc *ntpServer)
Get the active NTP server from which last packet is received.
OPEN_NTP_STATUS_SUCCESS
Success.
Definition: openapi_ntp.h:99
openapiNtpServerTableBurstGet
open_error_t openapiNtpServerTableBurstGet(openapiClientHandle_t *client_handle, open_buffdesc *ntpServer, OPEN_BOOL_t *burst)
Get the NTP burst status of the server table entry.
openapiNtpEntStatusOutPktsGet
open_error_t openapiNtpEntStatusOutPktsGet(openapiClientHandle_t *client_handle, uint32_t *outPkts)
Get the total number of NTP messages delivered from the NTP entity.
OPEN_NTP_MSG_AUTH_ALG_NONE
NTP Authentication Algorithm None.
Definition: openapi_ntp.h:111
openapiNtpAuthenticationModeGet
open_error_t openapiNtpAuthenticationModeGet(openapiClientHandle_t *client_handle, OPEN_BOOL_t *mode)
Get the current authentication mode for this application.
OPEN_NTP_STATUS_REQUEST_TIMED_OUT
Request Timed Out.
Definition: openapi_ntp.h:100
openapiNtpAuthTableKeyTrustedSet
open_error_t openapiNtpAuthTableKeyTrustedSet(openapiClientHandle_t *client_handle, uint32_t keyNumber, OPEN_BOOL_t trustedStatus)
Set a key as trusted or untrusted specified by the authenticate table entry index.
openapiNtpEntSystemTypeGet
open_error_t openapiNtpEntSystemTypeGet(openapiClientHandle_t *client_handle, open_buffdesc *systemType)
Get the general hardware/os platform information.
openapiNtpServerTableMinPollSet
open_error_t openapiNtpServerTableMinPollSet(openapiClientHandle_t *client_handle, open_buffdesc *ntpServer, uint16_t interval)
Set the server minimum poll interval in seconds as a power of two.
OPEN_NTP_MSG_AUTH_ALG_SHA256
NTP Authentication Algorithm SHA256.
Definition: openapi_ntp.h:114
openapiActiveNtpServerModeGet
open_error_t openapiActiveNtpServerModeGet(openapiClientHandle_t *client_handle, OPEN_NTP_SERVER_MODE_t *serverMode)
Get the mode of the NTP server from which last packet is received.
openapiActiveNtpServerStratumGet
open_error_t openapiActiveNtpServerStratumGet(openapiClientHandle_t *client_handle, uint32_t *stratum)
Get the stratum of the NTP server from which last packet is received.
openapiNtpBroadcastDelayGet
open_error_t openapiNtpBroadcastDelayGet(openapiClientHandle_t *client_handle, uint32_t *delay)
Get the Broadcast delay for the NTP application.
openapiNtpServerTableVersionSet
open_error_t openapiNtpServerTableVersionSet(openapiClientHandle_t *client_handle, open_buffdesc *ntpServer, uint16_t version)
Set the NTP version of the server table entry.
openapiNtpServerReferenceStringLengthGet
open_error_t openapiNtpServerReferenceStringLengthGet(openapiClientHandle_t *client_handle, uint32_t *refStrLen)
Get the maximum length of the NTP reference ID string.
openapiNtpAuthTableEntryFirstGet
open_error_t openapiNtpAuthTableEntryFirstGet(openapiClientHandle_t *client_handle, uint32_t *keyNumber)
Get the first NTP auth table entry.
OPEN_NTP_MSG_AUTH_ALG_t
OPEN_NTP_MSG_AUTH_ALG_t
Definition: openapi_ntp.h:109
openapiNtpServerAdd
open_error_t openapiNtpServerAdd(openapiClientHandle_t *client_handle, open_buffdesc *ipAddr)
Add an NTP server.
OPEN_NTP_STATUS_BAD_DATE_ENCODED
Bad Date Encoded.
Definition: openapi_ntp.h:101
openapiNtpVrfNameSet
open_error_t openapiNtpVrfNameSet(openapiClientHandle_t *client_handle, open_buffdesc *vrfName)
Set the VRF name of the NTP server.
OPEN_NTP_ADDRESS_IPV4
Address type IPv4.
Definition: openapi_ntp.h:78
open_error_t
open_error_t
OPEN uses these enumerators to indicate the error codes.
Definition: openapi_common.h:64
openapiNtpAssocStatOutPktsGet
open_error_t openapiNtpAssocStatOutPktsGet(openapiClientHandle_t *client_handle, uint32_t assocId, uint32_t *assocOutPkts)
Get the total number of NTP messages delivered to the transport service by this NTP entity for this a...
openapiNtpAssocIdGet
open_error_t openapiNtpAssocIdGet(openapiClientHandle_t *client_handle, uint32_t assocID)
Check whether the given association ID exists or not.
OPEN_NTP_SERVER_MODE_RESERVED_CONTROL
Reserved Control Mode.
Definition: openapi_ntp.h:92
openapiNtpServerCurrentEntriesGet
open_error_t openapiNtpServerCurrentEntriesGet(openapiClientHandle_t *client_handle, uint32_t *currEntries)
Get number of NTP servers configured.
openapiNtpServerTableMaxPollGet
open_error_t openapiNtpServerTableMaxPollGet(openapiClientHandle_t *client_handle, open_buffdesc *ntpServer, uint16_t *interval)
Get the server maximum poll interval in seconds as a power of two.
OPEN_NTP_DISABLED
NTP client mode disabled.
Definition: openapi_ntp.h:59
openapiNtpServerNextGet
open_error_t openapiNtpServerNextGet(openapiClientHandle_t *client_handle, open_buffdesc *ntpServer, open_buffdesc *nextNtpServer)
Get the next NTP server.
openapiNtpServerMaxAddrLenGet
open_error_t openapiNtpServerMaxAddrLenGet(openapiClientHandle_t *client_handle, uint32_t *ntpServerAddrLen)
Get the maximum length of NTP server address.
openapiNtpBroadcastClientModeGet
open_error_t openapiNtpBroadcastClientModeGet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t *ntpMode)
Get the NTP broadcast client mode.
openapiNtpAssocRefIdGet
open_error_t openapiNtpAssocRefIdGet(openapiClientHandle_t *client_handle, uint32_t assocId, open_buffdesc *assocRefId)
Get the reference clock driver ID.
open_buffdesc
Definition: openapi_common.h:138
openapiActiveNtpServerAddressTypeGet
open_error_t openapiActiveNtpServerAddressTypeGet(openapiClientHandle_t *client_handle, OPEN_NTP_ADDRESS_TYPE_t *type)
Get the active NTP server address type from which last packet is received.
openapiClientHandle_s
Definition: openapi_common.h:131
openapiActiveNtpServerReferenceIdGet
open_error_t openapiActiveNtpServerReferenceIdGet(openapiClientHandle_t *client_handle, open_buffdesc *reference)
Get the NTP server reference identifier from which last packet is received.
OPEN_NTP_SERVER_MODE_RESERVED_PRIVATE
Reserved Private Mode.
Definition: openapi_ntp.h:93
openapiNtpEntSoftwareVersionGet
open_error_t openapiNtpEntSoftwareVersionGet(openapiClientHandle_t *client_handle, open_buffdesc *swVersion)
Get the software version of the installed NTP implementation.
OPEN_NTP_STATUS_OTHER
Other.
Definition: openapi_ntp.h:98
openapiNtpAuthTableEntryGetNext
open_error_t openapiNtpAuthTableEntryGetNext(openapiClientHandle_t *client_handle, uint32_t *keyNum, uint32_t *nextKeyNum)
Get the next NTP auth table entry.
openapiNtpServerTableMinPollGet
open_error_t openapiNtpServerTableMinPollGet(openapiClientHandle_t *client_handle, open_buffdesc *ntpServer, uint16_t *interval)
Get the server minimum poll interval in seconds as a power of two.
openapiNtpEntStatusProtocolErrorGet
open_error_t openapiNtpEntStatusProtocolErrorGet(openapiClientHandle_t *client_handle, uint32_t *pErrPkts)
Get the total number of NTP messages that were delivered to this NTP entity and this entity was not a...
openapiNtpServerTableVersionGet
open_error_t openapiNtpServerTableVersionGet(openapiClientHandle_t *client_handle, open_buffdesc *ntpServer, uint16_t *version)
Get the NTP version of the server table entry.
openapiNtpAssocStratumGet
open_error_t openapiNtpAssocStratumGet(openapiClientHandle_t *client_handle, uint32_t assocId, uint32_t *assocStratum)
Get the association stratum value.
openapiNtpAuthTableKeyDelete
open_error_t openapiNtpAuthTableKeyDelete(openapiClientHandle_t *client_handle, uint32_t keyNumber)
Delete an authentication table entry specified by key number.
openapiNtpServerTableIBurstGet
open_error_t openapiNtpServerTableIBurstGet(openapiClientHandle_t *client_handle, open_buffdesc *ntpServer, OPEN_BOOL_t *iburst)
Get the NTP iburst status of the server table entry.
OPEN_NTP_STATUS_VERSION_NOT_SUPPORTED
Version Not Supported.
Definition: openapi_ntp.h:102
openapiNtpAssocAddressGet
open_error_t openapiNtpAssocAddressGet(openapiClientHandle_t *client_handle, uint32_t assocId, open_buffdesc *assocAddr)
Get the address (IPv4 or IPv6) of the association.
OPEN_NTP_STATUS_KISS_OF_DEATH
Server Kiss Of Death.
Definition: openapi_ntp.h:104
openapiNtpServerTableBurstSet
open_error_t openapiNtpServerTableBurstSet(openapiClientHandle_t *client_handle, open_buffdesc *ntpServer, OPEN_BOOL_t burst)
Set the NTP burst status of the server table entry.
openapi_routing.h
OPEN_NTP_MODE_t
OPEN_NTP_MODE_t
OpEN uses this enumeration to define NTP client modes.
Definition: openapi_ntp.h:57
OPEN_NTP_MSG_AUTH_ALG_SHA1
NTP Authentication Algorithm SHA1.
Definition: openapi_ntp.h:113
openapiNtpServerAddressTypeGet
open_error_t openapiNtpServerAddressTypeGet(openapiClientHandle_t *client_handle, open_buffdesc *ntpServer, OPEN_NTP_ADDRESS_TYPE_t *ntpServerAddrType)
Get the NTP server address type.
OPEN_NTP_BROADCAST
NTP client broadcast mode.
Definition: openapi_ntp.h:61
openapiNtpServerTableMaxPollSet
open_error_t openapiNtpServerTableMaxPollSet(openapiClientHandle_t *client_handle, open_buffdesc *ntpServer, uint16_t interval)
Set the server maximum poll interval in seconds as a power of two.
openapiNtpAuthenticationModeSet
open_error_t openapiNtpAuthenticationModeSet(openapiClientHandle_t *client_handle, OPEN_BOOL_t mode)
Set the current authentication mode for this application.
openapiNtpServerTablePreferGet
open_error_t openapiNtpServerTablePreferGet(openapiClientHandle_t *client_handle, open_buffdesc *ntpServer, OPEN_BOOL_t *prefer)
Get the NTP prefer status of the server table entry.
openapiNtpAssocStatProtocolErrorGet
open_error_t openapiNtpAssocStatProtocolErrorGet(openapiClientHandle_t *client_handle, uint32_t assocId, uint32_t *assocProtErrPkts)
Get the total number of NTP messages that were delivered to this NTP entity from this association and...
OPEN_NTP_SERVER_MODE_t
OPEN_NTP_SERVER_MODE_t
OpEN uses this enumeration to define NTP server modes.
Definition: openapi_ntp.h:84
OPEN_CONTROL_t
OPEN_CONTROL_t
OPEN uses these enumerators to indicate enable or disable for a given config or status parameter...
Definition: openapi_common.h:163
openapiNtpAssocStatusJitterGet
open_error_t openapiNtpAssocStatusJitterGet(openapiClientHandle_t *client_handle, uint32_t assocId, open_buffdesc *assocJitter)
Get the association jitter.
openapiNtpAuthTableKeyAdd
open_error_t openapiNtpAuthTableKeyAdd(openapiClientHandle_t *client_handle, uint32_t keyNumber, open_buffdesc *keyValue, OPEN_BOOL_t isEncrypted, OPEN_NTP_MSG_AUTH_ALG_t msgAuthAlg)
Add a new authentication table entry specified by key number.
OPEN_NTP_MSG_AUTH_ALG_MD5
NTP Authentication Algorithm MD5.
Definition: openapi_ntp.h:112
openapiNtpAssocOffsetGet
open_error_t openapiNtpAssocOffsetGet(openapiClientHandle_t *client_handle, uint32_t assocId, open_buffdesc *assocOffset)
Get the time offset of the association.
OPEN_BOOL_t
OPEN_BOOL_t
OPEN uses these enumerators to indicate true or false for a given config or status parameter...
Definition: openapi_common.h:179
openapiNtpAssocIdNextGet
open_error_t openapiNtpAssocIdNextGet(openapiClientHandle_t *client_handle, uint32_t *nextAssocID)
Get the next association ID.
OPEN_NTP_STATUS_KOD_RATE_EXCEEDED
Kiss of Death as Rate Exceeded.
Definition: openapi_ntp.h:105
openapiNtpEntSoftwareNameGet
open_error_t openapiNtpEntSoftwareNameGet(openapiClientHandle_t *client_handle, open_buffdesc *swName)
Get the software name of the running NTP version.
openapiNtpAssocNameGet
open_error_t openapiNtpAssocNameGet(openapiClientHandle_t *client_handle, uint32_t assocId, open_buffdesc *assocName)
Get the hostname or other descriptive name for the association.
OPEN_NTP_UNICAST
NTP client unicast mode.
Definition: openapi_ntp.h:60
OPEN_NTP_SERVER_MODE_RESERVED
Reserved Mode.
Definition: openapi_ntp.h:86
openapiNtpServerTableAuthKeySet
open_error_t openapiNtpServerTableAuthKeySet(openapiClientHandle_t *client_handle, open_buffdesc *ntpServer, uint32_t keyIndex)
Set the authentication key for the specified NTP server table entry.
openapiNtpModeSet
open_error_t openapiNtpModeSet(openapiClientHandle_t *client_handle, OPEN_NTP_MODE_t mode)
Set the NTP mode.
openapiNtpAssocAddressTypeGet
open_error_t openapiNtpAssocAddressTypeGet(openapiClientHandle_t *client_handle, uint32_t assocId, OPEN_NTP_ADDRESS_TYPE_t *assocAddrType)
Get the type of address of the association.
OPEN_NTP_SUPPORTED_UNICAST
NTP client unicast mode.
Definition: openapi_ntp.h:69
openapiNtpServersMaxSupportedGet
open_error_t openapiNtpServersMaxSupportedGet(openapiClientHandle_t *client_handle, uint32_t *maxNtpServers)
Get the maximum number of NTP servers supported.
openapiNtpServerTableAuthKeyGet
open_error_t openapiNtpServerTableAuthKeyGet(openapiClientHandle_t *client_handle, open_buffdesc *ntpServer, uint32_t *keyIndex)
Get the authentication key for an NTP server table entry.
OPEN_NTP_SERVER_MODE_CLIENT
Client Mode.
Definition: openapi_ntp.h:89
OPEN_NTP_ADDRESS_IPV6
Address type IPv6.
Definition: openapi_ntp.h:79
OPEN_NTP_SERVER_MODE_SYMMETRIC_PASSIVE
Symmetric Passive Mode.
Definition: openapi_ntp.h:88
OPEN_NTP_ADDRESS_TYPE_t
OPEN_NTP_ADDRESS_TYPE_t
OpEN uses this enumeration to define NTP address types.
Definition: openapi_ntp.h:75
openapiNtpAuthTableKeyMsgAuthAlgGet
open_error_t openapiNtpAuthTableKeyMsgAuthAlgGet(openapiClientHandle_t *client_handle, uint32_t keyNumber, OPEN_NTP_MSG_AUTH_ALG_t *msgAuthAlg)
Get the message authentication algorithm for the specified authentication key table entry index...
openapiNtpAuthTableKeyValueSet
open_error_t openapiNtpAuthTableKeyValueSet(openapiClientHandle_t *client_handle, uint32_t keyNumber, open_buffdesc *keyValue, OPEN_BOOL_t isEncrypted)
Set the key value of the authenticate table entry.
openapiNtpVrfNameGet
open_error_t openapiNtpVrfNameGet(openapiClientHandle_t *client_handle, open_buffdesc *vrfName)
Get the VRF name of the NTP server.
OPEN_NTP_SERVER_MODE_SERVER
Server Mode.
Definition: openapi_ntp.h:90
openapiNtpServerTableIBurstSet
open_error_t openapiNtpServerTableIBurstSet(openapiClientHandle_t *client_handle, open_buffdesc *ntpServer, OPEN_BOOL_t iburst)
Set the NTP iburst status of the server table entry.
openapiNtpModeGet
open_error_t openapiNtpModeGet(openapiClientHandle_t *client_handle, OPEN_NTP_MODE_t *ntpMode)
Get the NTP mode.
OPEN_NTP_SUPPORTED_MODE_t
OPEN_NTP_SUPPORTED_MODE_t
OpEN uses this enumeration to define NTP supported client modes.
Definition: openapi_ntp.h:66
openapiNtpSupportedModeGet
open_error_t openapiNtpSupportedModeGet(openapiClientHandle_t *client_handle, OPEN_NTP_SUPPORTED_MODE_t *ntpSupportedMode)
Get the NTP supported mode.
openapiNtpBroadcastClientModeSet
open_error_t openapiNtpBroadcastClientModeSet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t mode)
Set the ntp broadcast client mode of the NTP application.
openapiNtpAuthTableKeyValueGet
open_error_t openapiNtpAuthTableKeyValueGet(openapiClientHandle_t *client_handle, uint32_t keyNumber, open_buffdesc *keyValue)
Get the key number of the authenticate table entry.
OPEN_NTP_ADDRESS_UNKNOWN
Address type unknown.
Definition: openapi_ntp.h:77
OPEN_NTP_SUPPORTED_UNICAST_AND_BROADCAST
NTP client unicast and broadcast modes.
Definition: openapi_ntp.h:71
openapi_common.h
openapiNtpSourceInterfaceSet
open_error_t openapiNtpSourceInterfaceSet(openapiClientHandle_t *client_handle, uint32_t intIfNum)
Set the Source Interface of the NTP application.
OPEN_NTP_SUPPORTED_BROADCAST
NTP client broadcast mode.
Definition: openapi_ntp.h:70
OPEN_NTP_SERVER_MODE_BROADCAST
Broadcast Mode.
Definition: openapi_ntp.h:91
OPEN_NTP_STATUS_SERVER_UNSYNCHRONIZED
Server Unsynchronized.
Definition: openapi_ntp.h:103
openapiNtpEntStatusBadVersionGet
open_error_t openapiNtpEntStatusBadVersionGet(openapiClientHandle_t *client_handle, uint32_t *badVerPkts)
Get the total number of NTP messages that were delivered to this NTP entity and were for an unsupport...
OPEN_NTP_SUPPORTED_DISABLED
NTP client mode disabled.
Definition: openapi_ntp.h:68
OPEN_NTP_PACKET_STATUS_t
OPEN_NTP_PACKET_STATUS_t
Definition: openapi_ntp.h:96
openapiNtpVersionGet
open_error_t openapiNtpVersionGet(openapiClientHandle_t *client_handle, uint32_t *version)
Get the highest NTP version the application supports.
OPEN_NTP_ADDRESS_DNS
Address type DNS.
Definition: openapi_ntp.h:80
openapiNtpServerTablePreferSet
open_error_t openapiNtpServerTablePreferSet(openapiClientHandle_t *client_handle, open_buffdesc *ntpServer, OPEN_BOOL_t prefer)
Set the NTP prefer status of the server table entry.
openapiNtpServerFirstGet
open_error_t openapiNtpServerFirstGet(openapiClientHandle_t *client_handle, open_buffdesc *ntpServer)
Get the first NTP server.
openapiNtpSourceInterfaceGet
open_error_t openapiNtpSourceInterfaceGet(openapiClientHandle_t *client_handle, uint32_t *intIfNum)
Get the Source Interface of the NTP application.
openapiNtpAssocStatusDispersionGet
open_error_t openapiNtpAssocStatusDispersionGet(openapiClientHandle_t *client_handle, uint32_t assocId, open_buffdesc *assocDispersion)
Get the root dispersion of the association.
openapiNtpAssocStatusDelayGet
open_error_t openapiNtpAssocStatusDelayGet(openapiClientHandle_t *client_handle, uint32_t assocId, open_buffdesc *assocDelay)
Get the association network delay.
openapiNtpServerDelete
open_error_t openapiNtpServerDelete(openapiClientHandle_t *client_handle, open_buffdesc *ipAddr)
Delete an NTP server.
openapiNtpAuthTableKeyTrustedGet
open_error_t openapiNtpAuthTableKeyTrustedGet(openapiClientHandle_t *client_handle, uint32_t keyNumber, OPEN_BOOL_t *trustedStatus)
Get a key as trusted or untrusted specified by the authenticate table entry index.
openapiNtpEntStatusInPktsGet
open_error_t openapiNtpEntStatusInPktsGet(openapiClientHandle_t *client_handle, uint32_t *inPkts)
Get the total number of NTP messages delivered to the NTP entity.
openapiNtpAuthTableKeyMsgAuthAlgSet
open_error_t openapiNtpAuthTableKeyMsgAuthAlgSet(openapiClientHandle_t *client_handle, uint32_t keyNumber, OPEN_NTP_MSG_AUTH_ALG_t msgAuthAlg)
Set the message authentication algorithm for the specified authentication key table entry index...
OPEN_NTP_SERVER_MODE_SYMMETRIC_ACTIVE
Symmetric Active Mode.
Definition: openapi_ntp.h:87
openapiNtpAssocStatInPktsGet
open_error_t openapiNtpAssocStatInPktsGet(openapiClientHandle_t *client_handle, uint32_t assocId, uint32_t *assocInPkts)
Get the total number of NTP messages delivered to the NTP entity from this association.