Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.11.1.2
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 
55 typedef enum
56 {
57  OPEN_NTP_DISABLED = 0,
58  OPEN_NTP_UNICAST = 1,
59  OPEN_NTP_BROADCAST = 2
60 } OPEN_NTP_MODE_t;
61 
62 
64 typedef enum
65 {
66  OPEN_NTP_SUPPORTED_DISABLED = 0,
67  OPEN_NTP_SUPPORTED_UNICAST = 1,
68  OPEN_NTP_SUPPORTED_BROADCAST = 2,
69  OPEN_NTP_SUPPORTED_UNICAST_AND_BROADCAST = 3
70 }OPEN_NTP_SUPPORTED_MODE_t;
71 
73 typedef enum
74 {
75  OPEN_NTP_ADDRESS_UNKNOWN = 0,
76  OPEN_NTP_ADDRESS_IPV4 = 1,
77  OPEN_NTP_ADDRESS_IPV6 = 2,
78  OPEN_NTP_ADDRESS_DNS = 3
79 } OPEN_NTP_ADDRESS_TYPE_t;
80 
82 typedef enum
83 {
84  OPEN_NTP_SERVER_MODE_RESERVED = 0,
85  OPEN_NTP_SERVER_MODE_SYMMETRIC_ACTIVE = 1,
86  OPEN_NTP_SERVER_MODE_SYMMETRIC_PASSIVE = 2,
87  OPEN_NTP_SERVER_MODE_CLIENT = 3,
88  OPEN_NTP_SERVER_MODE_SERVER = 4,
89  OPEN_NTP_SERVER_MODE_BROADCAST = 5,
90  OPEN_NTP_SERVER_MODE_RESERVED_CONTROL = 6,
91  OPEN_NTP_SERVER_MODE_RESERVED_PRIVATE = 7
92 } OPEN_NTP_SERVER_MODE_t;
93 
94 typedef enum
95 {
96  OPEN_NTP_STATUS_OTHER = 1,
97  OPEN_NTP_STATUS_SUCCESS = 2,
98  OPEN_NTP_STATUS_REQUEST_TIMED_OUT = 3,
99  OPEN_NTP_STATUS_BAD_DATE_ENCODED = 4,
100  OPEN_NTP_STATUS_VERSION_NOT_SUPPORTED = 5,
101  OPEN_NTP_STATUS_SERVER_UNSYNCHRONIZED = 6,
102  OPEN_NTP_STATUS_KISS_OF_DEATH = 7,
103  OPEN_NTP_STATUS_KOD_RATE_EXCEEDED = 8
104 } OPEN_NTP_PACKET_STATUS_t;
105 
106 /* NTP Message Authentication Algorithms supported. */
107 typedef enum
108 {
109  OPEN_NTP_MSG_AUTH_ALG_NONE = 0,
110  OPEN_NTP_MSG_AUTH_ALG_MD5,
111  OPEN_NTP_MSG_AUTH_ALG_SHA1,
112  OPEN_NTP_MSG_AUTH_ALG_SHA256
113 } OPEN_NTP_MSG_AUTH_ALG_t;
114 
115 /*****************************************************************/
130 open_error_t openapiNtpTimeSet(openapiClientHandle_t *client_handle,
131  uint32_t offset);
132 
133 /*****************************************************************/
156 open_error_t openapiNtpServerAdd(openapiClientHandle_t *client_handle,
157  open_buffdesc *ipAddr);
158 
159 /*****************************************************************/
175 open_error_t openapiNtpServersMaxSupportedGet(openapiClientHandle_t *client_handle,
176  uint32_t *maxNtpServers);
177 
178 /*****************************************************************/
199 open_error_t openapiNtpServerDelete(openapiClientHandle_t *client_handle,
200  open_buffdesc *ipAddr);
201 
202 /*****************************************************************/
216 open_error_t openapiNtpServerMaxAddrLenGet(openapiClientHandle_t *client_handle,
217  uint32_t *ntpServerAddrLen);
218 
219 /*****************************************************************/
236 open_error_t openapiNtpServerFirstGet(openapiClientHandle_t *client_handle,
237  open_buffdesc *ntpServer);
238 
239 /*****************************************************************/
258 open_error_t openapiNtpServerNextGet(openapiClientHandle_t *client_handle,
259  open_buffdesc *ntpServer,
260  open_buffdesc *nextNtpServer);
261 
262 /*****************************************************************/
278 open_error_t openapiNtpServerAddressTypeGet(openapiClientHandle_t *client_handle,
279  open_buffdesc *ntpServer,
280  OPEN_NTP_ADDRESS_TYPE_t *ntpServerAddrType);
281 
282 /*****************************************************************/
301 open_error_t openapiNtpModeSet(openapiClientHandle_t *client_handle,
302  OPEN_NTP_MODE_t mode);
303 
304 /*****************************************************************/
318 open_error_t openapiNtpModeGet(openapiClientHandle_t *client_handle,
319  OPEN_NTP_MODE_t *ntpMode);
320 
321 /*****************************************************************/
335 open_error_t openapiNtpSupportedModeGet(openapiClientHandle_t *client_handle,
336  OPEN_NTP_SUPPORTED_MODE_t *ntpSupportedMode);
337 
338 
339 /*****************************************************************/
354 open_error_t openapiActiveNtpServerAddressTypeGet(openapiClientHandle_t *client_handle,
355  OPEN_NTP_ADDRESS_TYPE_t *type);
356 
357 /*****************************************************************/
376 open_error_t openapiActiveNtpServerIpAddressGet(openapiClientHandle_t *client_handle,
377  open_buffdesc *ntpServer);
378 
379 /*****************************************************************/
394 open_error_t openapiActiveNtpServerStratumGet(openapiClientHandle_t *client_handle,
395  uint32_t *stratum);
396 
397 /*****************************************************************/
412 open_error_t openapiActiveNtpServerReferenceIdGet(openapiClientHandle_t *client_handle,
413  open_buffdesc *reference);
414 
415 /*****************************************************************/
428 open_error_t openapiNtpServerReferenceStringLengthGet(openapiClientHandle_t *client_handle,
429  uint32_t *refStrLen);
430 
431 /*****************************************************************/
445 open_error_t openapiActiveNtpServerModeGet(openapiClientHandle_t *client_handle,
446  OPEN_NTP_SERVER_MODE_t *serverMode);
447 
448 /*****************************************************************/
462 open_error_t openapiNtpServerCurrentEntriesGet(openapiClientHandle_t *client_handle,
463  uint32_t *currEntries);
464 
465 /*****************************************************************/
482 open_error_t openapiNtpAuthenticationModeSet(openapiClientHandle_t *client_handle,
483  OPEN_BOOL_t mode);
484 
485 /*****************************************************************/
501 open_error_t openapiNtpAuthenticationModeGet(openapiClientHandle_t *client_handle,
502  OPEN_BOOL_t *mode);
503 
504 /*****************************************************************/
519 open_error_t openapiNtpBroadcastDelaySet(openapiClientHandle_t *client_handle,
520  uint32_t delay);
521 
522 /*****************************************************************/
537 open_error_t openapiNtpBroadcastDelayGet(openapiClientHandle_t *client_handle,
538  uint32_t *delay);
539 
540 /******************************************************************/
555 open_error_t openapiNtpSourceInterfaceSet(openapiClientHandle_t *client_handle,
556  uint32_t intIfNum);
557 
558 /******************************************************************/
573 open_error_t openapiNtpSourceInterfaceGet(openapiClientHandle_t *client_handle,
574  uint32_t *intIfNum);
575 
576 /******************************************************************/
591 open_error_t openapiNtpVrfNameSet(openapiClientHandle_t *client_handle,
592  open_buffdesc *vrfName);
593 
594 /******************************************************************/
609 open_error_t openapiNtpVrfNameGet(openapiClientHandle_t *client_handle,
610  open_buffdesc *vrfName);
611 
612 /*****************************************************************/
630 open_error_t openapiNtpServerTableAuthKeySet(openapiClientHandle_t *client_handle,
631  open_buffdesc *ntpServer, uint32_t keyIndex);
632 
633 /*****************************************************************/
650 open_error_t openapiNtpServerTableAuthKeyGet(openapiClientHandle_t *client_handle,
651  open_buffdesc *ntpServer, uint32_t *keyIndex);
652 
653 /*****************************************************************/
670 open_error_t openapiNtpServerTableMaxPollSet(openapiClientHandle_t *client_handle,
671  open_buffdesc *ntpServer, uint16_t interval);
672 
673 /*****************************************************************/
690 open_error_t openapiNtpServerTableMaxPollGet(openapiClientHandle_t *client_handle,
691  open_buffdesc *ntpServer, uint16_t *interval);
692 
693 /*****************************************************************/
710 open_error_t openapiNtpServerTableMinPollSet(openapiClientHandle_t *client_handle,
711  open_buffdesc *ntpServer, uint16_t interval);
712 
713 /*****************************************************************/
730 open_error_t openapiNtpServerTableMinPollGet(openapiClientHandle_t *client_handle,
731  open_buffdesc *ntpServer, uint16_t *interval);
732 
733 /*****************************************************************/
750 open_error_t openapiNtpServerTablePreferSet(openapiClientHandle_t *client_handle,
751  open_buffdesc *ntpServer, OPEN_BOOL_t prefer);
752 
753 /*****************************************************************/
770 open_error_t openapiNtpServerTablePreferGet(openapiClientHandle_t *client_handle,
771  open_buffdesc *ntpServer, OPEN_BOOL_t *prefer);
772 
773 /*****************************************************************/
790 open_error_t openapiNtpServerTableBurstSet(openapiClientHandle_t *client_handle,
791  open_buffdesc *ntpServer, OPEN_BOOL_t burst);
792 
793 /*****************************************************************/
810 open_error_t openapiNtpServerTableBurstGet(openapiClientHandle_t *client_handle,
811  open_buffdesc *ntpServer, OPEN_BOOL_t *burst);
812 
813 /*****************************************************************/
830 open_error_t openapiNtpServerTableIBurstSet(openapiClientHandle_t *client_handle,
831  open_buffdesc *ntpServer, OPEN_BOOL_t iburst);
832 
833 /*****************************************************************/
850 open_error_t openapiNtpServerTableIBurstGet(openapiClientHandle_t *client_handle,
851  open_buffdesc *ntpServer, OPEN_BOOL_t *iburst);
852 
853 /*****************************************************************/
870 open_error_t openapiNtpServerTableVersionSet(openapiClientHandle_t *client_handle,
871  open_buffdesc *ntpServer, uint16_t version);
872 
873 /*****************************************************************/
890 open_error_t openapiNtpServerTableVersionGet(openapiClientHandle_t *client_handle,
891  open_buffdesc *ntpServer, uint16_t *version);
892 
893 /*****************************************************************/
917 open_error_t openapiNtpAuthTableKeyAdd(openapiClientHandle_t *client_handle,
918  uint32_t keyNumber, open_buffdesc *keyValue,
919  OPEN_BOOL_t isEncrypted, OPEN_NTP_MSG_AUTH_ALG_t msgAuthAlg);
920 
921 /*****************************************************************/
939 open_error_t openapiNtpAuthTableKeyDelete(openapiClientHandle_t *client_handle,
940  uint32_t keyNumber);
941 
942 /*****************************************************************/
962 open_error_t openapiNtpAuthTableKeyValueSet(openapiClientHandle_t *client_handle,
963  uint32_t keyNumber,
964  open_buffdesc *keyValue,
965  OPEN_BOOL_t isEncrypted);
966 
967 /*****************************************************************/
986 open_error_t openapiNtpAuthTableKeyValueGet(openapiClientHandle_t *client_handle,
987  uint32_t keyNumber,
988  open_buffdesc *keyValue);
989 
990 /*****************************************************************/
1010 open_error_t openapiNtpAuthTableKeyMsgAuthAlgSet(openapiClientHandle_t *client_handle,
1011  uint32_t keyNumber,
1012  OPEN_NTP_MSG_AUTH_ALG_t msgAlg);
1013 
1014 /*****************************************************************/
1033 open_error_t openapiNtpAuthTableKeyMsgAuthAlgGet(openapiClientHandle_t *client_handle,
1034  uint32_t keyNumber,
1035  OPEN_NTP_MSG_AUTH_ALG_t *msgAlg);
1036 
1037 /*****************************************************************/
1056 open_error_t openapiNtpAuthTableKeyTrustedSet(openapiClientHandle_t *client_handle,
1057  uint32_t keyNumber,
1058  OPEN_BOOL_t trustedStatus);
1059 
1060 /*****************************************************************/
1079 open_error_t openapiNtpAuthTableKeyTrustedGet(openapiClientHandle_t *client_handle,
1080  uint32_t keyNumber,
1081  OPEN_BOOL_t *trustedStatus);
1082 
1083 /*****************************************************************/
1098 open_error_t openapiNtpAuthTableEntryFirstGet(openapiClientHandle_t *client_handle,
1099  uint32_t *keyNumber);
1100 
1101 /*****************************************************************/
1117 open_error_t openapiNtpAuthTableEntryGetNext(openapiClientHandle_t *client_handle,
1118  uint32_t *keyNum,
1119  uint32_t *nextKeyNum);
1120 
1121 /*****************************************************************/
1135 open_error_t openapiNtpNotifyPeerList(openapiClientHandle_t *client_handle,
1136  open_buffdesc *assocList);
1137 
1138 #endif
1139 
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:97
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.
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:98
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.
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.
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.
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:99
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:76
open_error_t
open_error_t
OPEN uses these enumerators to indicate the error codes.
Definition: openapi_common.h:64
OPEN_NTP_SERVER_MODE_RESERVED_CONTROL
Reserved Control Mode.
Definition: openapi_ntp.h:90
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:57
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.
open_buffdesc
Definition: openapi_common.h:137
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:130
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:91
OPEN_NTP_STATUS_OTHER
Other.
Definition: openapi_ntp.h:96
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.
openapiNtpTimeSet
open_error_t openapiNtpTimeSet(openapiClientHandle_t *client_handle, uint32_t offset)
Update the local clock with the correction.
openapiNtpAuthTableKeyMsgAuthAlgGet
open_error_t openapiNtpAuthTableKeyMsgAuthAlgGet(openapiClientHandle_t *client_handle, uint32_t keyNumber, OPEN_NTP_MSG_AUTH_ALG_t *msgAlg)
Get the message authentication algorithm for the specified authentication key table entry index...
openapiNtpServerTableVersionGet
open_error_t openapiNtpServerTableVersionGet(openapiClientHandle_t *client_handle, open_buffdesc *ntpServer, uint16_t *version)
Get the NTP version of the server table entry.
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:100
OPEN_NTP_STATUS_KISS_OF_DEATH
Server Kiss Of Death.
Definition: openapi_ntp.h:102
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:55
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:59
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.
OPEN_NTP_SERVER_MODE_t
OPEN_NTP_SERVER_MODE_t
OpEN uses this enumeration to define NTP server modes.
Definition: openapi_ntp.h:82
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_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:178
OPEN_NTP_STATUS_KOD_RATE_EXCEEDED
Kiss of Death as Rate Exceeded.
Definition: openapi_ntp.h:103
OPEN_NTP_UNICAST
NTP client unicast mode.
Definition: openapi_ntp.h:58
OPEN_NTP_SERVER_MODE_RESERVED
Reserved Mode.
Definition: openapi_ntp.h:84
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.
OPEN_NTP_SUPPORTED_UNICAST
NTP client unicast mode.
Definition: openapi_ntp.h:67
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:87
OPEN_NTP_ADDRESS_IPV6
Address type IPv6.
Definition: openapi_ntp.h:77
OPEN_NTP_SERVER_MODE_SYMMETRIC_PASSIVE
Symmetric Passive Mode.
Definition: openapi_ntp.h:86
openapiNtpNotifyPeerList
open_error_t openapiNtpNotifyPeerList(openapiClientHandle_t *client_handle, open_buffdesc *assocList)
Notify NTP application to update the peer list.
OPEN_NTP_ADDRESS_TYPE_t
OPEN_NTP_ADDRESS_TYPE_t
OpEN uses this enumeration to define NTP address types.
Definition: openapi_ntp.h:73
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:88
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:64
openapiNtpSupportedModeGet
open_error_t openapiNtpSupportedModeGet(openapiClientHandle_t *client_handle, OPEN_NTP_SUPPORTED_MODE_t *ntpSupportedMode)
Get the NTP supported mode.
openapiNtpAuthTableKeyMsgAuthAlgSet
open_error_t openapiNtpAuthTableKeyMsgAuthAlgSet(openapiClientHandle_t *client_handle, uint32_t keyNumber, OPEN_NTP_MSG_AUTH_ALG_t msgAlg)
Set the message authentication algorithm for the specified authentication key table entry index...
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:75
OPEN_NTP_SUPPORTED_UNICAST_AND_BROADCAST
NTP client unicast and broadcast modes.
Definition: openapi_ntp.h:69
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:68
OPEN_NTP_SERVER_MODE_BROADCAST
Broadcast Mode.
Definition: openapi_ntp.h:89
OPEN_NTP_STATUS_SERVER_UNSYNCHRONIZED
Server Unsynchronized.
Definition: openapi_ntp.h:101
OPEN_NTP_SUPPORTED_DISABLED
NTP client mode disabled.
Definition: openapi_ntp.h:66
OPEN_NTP_PACKET_STATUS_t
OPEN_NTP_PACKET_STATUS_t
Definition: openapi_ntp.h:94
OPEN_NTP_ADDRESS_DNS
Address type DNS.
Definition: openapi_ntp.h:78
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.
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.
OPEN_NTP_SERVER_MODE_SYMMETRIC_ACTIVE
Symmetric Active Mode.
Definition: openapi_ntp.h:85