Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.12.0.1
Macros | Enumerations | Functions
openapi_ntp.h File Reference
#include "openapi_common.h"
#include "openapi_routing.h"

Go to the source code of this file.

Macros

#define OPEN_NTP_BUFFER_SIZE   256
 
#define OPEN_NTP_DATE_STRING_SIZE   21
 
#define OPEN_NTP_MAX_ASSOC_ID   65535
 NTP association ID maximum value.
 
#define OPEN_NTP_MAX_KEY_LENGTH   129
 NTP maximum key length.
 
#define OPEN_NTP_MAX_KEY_NUM   65535
 NTP maximum key number.
 
#define OPEN_NTP_MAX_SERVERS   8
 
#define OPEN_NTP_MIN_ASSOC_ID   0
 NTP association ID minimum value.
 
#define OPEN_NTP_MIN_KEY_LENGTH   1
 NTP minimum key length.
 
#define OPEN_NTP_MIN_KEY_NUM   1
 NTP minimum key number.
 
#define OPEN_SECS_PER_MIN   60
 
#define OPEN_VRF_MAX_NAME   15
 

Enumerations

enum  OPEN_NTP_ADDRESS_TYPE_t { OPEN_NTP_ADDRESS_UNKNOWN = 0, OPEN_NTP_ADDRESS_IPV4 = 1, OPEN_NTP_ADDRESS_IPV6 = 2, OPEN_NTP_ADDRESS_DNS = 3 }
 OpEN uses this enumeration to define NTP address types. More...
 
enum  OPEN_NTP_MODE_t { OPEN_NTP_DISABLED = 0, OPEN_NTP_UNICAST = 1, OPEN_NTP_BROADCAST = 2 }
 OpEN uses this enumeration to define NTP client modes. More...
 
enum  OPEN_NTP_MSG_AUTH_ALG_t { OPEN_NTP_MSG_AUTH_ALG_NONE = 0, OPEN_NTP_MSG_AUTH_ALG_MD5, OPEN_NTP_MSG_AUTH_ALG_SHA1, OPEN_NTP_MSG_AUTH_ALG_SHA256 }
 
enum  OPEN_NTP_PACKET_STATUS_t {
  OPEN_NTP_STATUS_OTHER = 1, OPEN_NTP_STATUS_SUCCESS = 2, OPEN_NTP_STATUS_REQUEST_TIMED_OUT = 3, OPEN_NTP_STATUS_BAD_DATE_ENCODED = 4,
  OPEN_NTP_STATUS_VERSION_NOT_SUPPORTED = 5, OPEN_NTP_STATUS_SERVER_UNSYNCHRONIZED = 6, OPEN_NTP_STATUS_KISS_OF_DEATH = 7, OPEN_NTP_STATUS_KOD_RATE_EXCEEDED = 8
}
 
enum  OPEN_NTP_SERVER_MODE_t {
  OPEN_NTP_SERVER_MODE_RESERVED = 0, OPEN_NTP_SERVER_MODE_SYMMETRIC_ACTIVE = 1, OPEN_NTP_SERVER_MODE_SYMMETRIC_PASSIVE = 2, OPEN_NTP_SERVER_MODE_CLIENT = 3,
  OPEN_NTP_SERVER_MODE_SERVER = 4, OPEN_NTP_SERVER_MODE_BROADCAST = 5, OPEN_NTP_SERVER_MODE_RESERVED_CONTROL = 6, OPEN_NTP_SERVER_MODE_RESERVED_PRIVATE = 7
}
 OpEN uses this enumeration to define NTP server modes. More...
 
enum  OPEN_NTP_SUPPORTED_MODE_t { OPEN_NTP_SUPPORTED_DISABLED = 0, OPEN_NTP_SUPPORTED_UNICAST = 1, OPEN_NTP_SUPPORTED_BROADCAST = 2, OPEN_NTP_SUPPORTED_UNICAST_AND_BROADCAST = 3 }
 OpEN uses this enumeration to define NTP supported client modes. More...
 

Functions

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. More...
 
open_error_t openapiActiveNtpServerIpAddressGet (openapiClientHandle_t *client_handle, open_buffdesc *ntpServer)
 Get the active NTP server from which last packet is received. More...
 
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. More...
 
open_error_t openapiActiveNtpServerReferenceIdGet (openapiClientHandle_t *client_handle, open_buffdesc *reference)
 Get the NTP server reference identifier from which last packet is received. More...
 
open_error_t openapiActiveNtpServerStratumGet (openapiClientHandle_t *client_handle, uint32_t *stratum)
 Get the stratum of the NTP server from which last packet is received. More...
 
open_error_t openapiNtpAssocAddressGet (openapiClientHandle_t *client_handle, uint32_t assocId, open_buffdesc *assocAddr)
 Get the address (IPv4 or IPv6) of the association. More...
 
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. More...
 
open_error_t openapiNtpAssocIdGet (openapiClientHandle_t *client_handle, uint32_t assocID)
 Check whether the given association ID exists or not. More...
 
open_error_t openapiNtpAssocIdNextGet (openapiClientHandle_t *client_handle, uint32_t *nextAssocID)
 Get the next association ID. More...
 
open_error_t openapiNtpAssocNameGet (openapiClientHandle_t *client_handle, uint32_t assocId, open_buffdesc *assocName)
 Get the hostname or other descriptive name for the association. More...
 
open_error_t openapiNtpAssocOffsetGet (openapiClientHandle_t *client_handle, uint32_t assocId, open_buffdesc *assocOffset)
 Get the time offset of the association. More...
 
open_error_t openapiNtpAssocRefIdGet (openapiClientHandle_t *client_handle, uint32_t assocId, open_buffdesc *assocRefId)
 Get the reference clock driver ID. More...
 
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. More...
 
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 association. More...
 
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 this entity was not able to process due to an NTP protocol error. More...
 
open_error_t openapiNtpAssocStatusDelayGet (openapiClientHandle_t *client_handle, uint32_t assocId, open_buffdesc *assocDelay)
 Get the association network delay. More...
 
open_error_t openapiNtpAssocStatusDispersionGet (openapiClientHandle_t *client_handle, uint32_t assocId, open_buffdesc *assocDispersion)
 Get the root dispersion of the association. More...
 
open_error_t openapiNtpAssocStatusJitterGet (openapiClientHandle_t *client_handle, uint32_t assocId, open_buffdesc *assocJitter)
 Get the association jitter. More...
 
open_error_t openapiNtpAssocStratumGet (openapiClientHandle_t *client_handle, uint32_t assocId, uint32_t *assocStratum)
 Get the association stratum value. More...
 
open_error_t openapiNtpAuthenticationModeGet (openapiClientHandle_t *client_handle, OPEN_BOOL_t *mode)
 Get the current authentication mode for this application. More...
 
open_error_t openapiNtpAuthenticationModeSet (openapiClientHandle_t *client_handle, OPEN_BOOL_t mode)
 Set the current authentication mode for this application. More...
 
open_error_t openapiNtpAuthTableEntryFirstGet (openapiClientHandle_t *client_handle, uint32_t *keyNumber)
 Get the first NTP auth table entry. More...
 
open_error_t openapiNtpAuthTableEntryGetNext (openapiClientHandle_t *client_handle, uint32_t *keyNum, uint32_t *nextKeyNum)
 Get the next NTP auth table entry. More...
 
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. More...
 
open_error_t openapiNtpAuthTableKeyDelete (openapiClientHandle_t *client_handle, uint32_t keyNumber)
 Delete an authentication table entry specified by key number. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
open_error_t openapiNtpAuthTableKeyValueGet (openapiClientHandle_t *client_handle, uint32_t keyNumber, open_buffdesc *keyValue)
 Get the key number of the authenticate table entry. More...
 
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. More...
 
open_error_t openapiNtpBroadcastClientModeGet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t *ntpMode)
 Get the NTP broadcast client mode. More...
 
open_error_t openapiNtpBroadcastClientModeSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t mode)
 Set the ntp broadcast client mode of the NTP application. More...
 
open_error_t openapiNtpBroadcastDelayGet (openapiClientHandle_t *client_handle, uint32_t *delay)
 Get the Broadcast delay for the NTP application. More...
 
open_error_t openapiNtpBroadcastDelaySet (openapiClientHandle_t *client_handle, uint32_t delay)
 Set the Broadcast delay for the NTP application. More...
 
open_error_t openapiNtpEntSoftwareNameGet (openapiClientHandle_t *client_handle, open_buffdesc *swName)
 Get the software name of the running NTP version. More...
 
open_error_t openapiNtpEntSoftwareVersionGet (openapiClientHandle_t *client_handle, open_buffdesc *swVersion)
 Get the software version of the installed NTP implementation. More...
 
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 unsupported NTP version. More...
 
open_error_t openapiNtpEntStatusInPktsGet (openapiClientHandle_t *client_handle, uint32_t *inPkts)
 Get the total number of NTP messages delivered to the NTP entity. More...
 
open_error_t openapiNtpEntStatusOutPktsGet (openapiClientHandle_t *client_handle, uint32_t *outPkts)
 Get the total number of NTP messages delivered from the NTP entity. More...
 
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 able to process due to an NTP protocol error. More...
 
open_error_t openapiNtpEntSystemTypeGet (openapiClientHandle_t *client_handle, open_buffdesc *systemType)
 Get the general hardware/os platform information. More...
 
open_error_t openapiNtpModeGet (openapiClientHandle_t *client_handle, OPEN_NTP_MODE_t *ntpMode)
 Get the NTP mode. More...
 
open_error_t openapiNtpModeSet (openapiClientHandle_t *client_handle, OPEN_NTP_MODE_t mode)
 Set the NTP mode. More...
 
open_error_t openapiNtpServerAdd (openapiClientHandle_t *client_handle, open_buffdesc *ipAddr)
 Add an NTP server. More...
 
open_error_t openapiNtpServerAddressTypeGet (openapiClientHandle_t *client_handle, open_buffdesc *ntpServer, OPEN_NTP_ADDRESS_TYPE_t *ntpServerAddrType)
 Get the NTP server address type. More...
 
open_error_t openapiNtpServerCurrentEntriesGet (openapiClientHandle_t *client_handle, uint32_t *currEntries)
 Get number of NTP servers configured. More...
 
open_error_t openapiNtpServerDelete (openapiClientHandle_t *client_handle, open_buffdesc *ipAddr)
 Delete an NTP server. More...
 
open_error_t openapiNtpServerFirstGet (openapiClientHandle_t *client_handle, open_buffdesc *ntpServer)
 Get the first NTP server. More...
 
open_error_t openapiNtpServerMaxAddrLenGet (openapiClientHandle_t *client_handle, uint32_t *ntpServerAddrLen)
 Get the maximum length of NTP server address. More...
 
open_error_t openapiNtpServerNextGet (openapiClientHandle_t *client_handle, open_buffdesc *ntpServer, open_buffdesc *nextNtpServer)
 Get the next NTP server. More...
 
open_error_t openapiNtpServerReferenceStringLengthGet (openapiClientHandle_t *client_handle, uint32_t *refStrLen)
 Get the maximum length of the NTP reference ID string. More...
 
open_error_t openapiNtpServersMaxSupportedGet (openapiClientHandle_t *client_handle, uint32_t *maxNtpServers)
 Get the maximum number of NTP servers supported. More...
 
open_error_t openapiNtpServerTableAuthKeyGet (openapiClientHandle_t *client_handle, open_buffdesc *ntpServer, uint32_t *keyIndex)
 Get the authentication key for an NTP server table entry. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
open_error_t openapiNtpServerTableVersionGet (openapiClientHandle_t *client_handle, open_buffdesc *ntpServer, uint16_t *version)
 Get the NTP version of the server table entry. More...
 
open_error_t openapiNtpServerTableVersionSet (openapiClientHandle_t *client_handle, open_buffdesc *ntpServer, uint16_t version)
 Set the NTP version of the server table entry. More...
 
open_error_t openapiNtpSourceInterfaceGet (openapiClientHandle_t *client_handle, uint32_t *intIfNum)
 Get the Source Interface of the NTP application. More...
 
open_error_t openapiNtpSourceInterfaceSet (openapiClientHandle_t *client_handle, uint32_t intIfNum)
 Set the Source Interface of the NTP application. More...
 
open_error_t openapiNtpSupportedModeGet (openapiClientHandle_t *client_handle, OPEN_NTP_SUPPORTED_MODE_t *ntpSupportedMode)
 Get the NTP supported mode. More...
 
open_error_t openapiNtpVersionGet (openapiClientHandle_t *client_handle, uint32_t *version)
 Get the highest NTP version the application supports. More...
 
open_error_t openapiNtpVrfNameGet (openapiClientHandle_t *client_handle, open_buffdesc *vrfName)
 Get the VRF name of the NTP server. More...
 
open_error_t openapiNtpVrfNameSet (openapiClientHandle_t *client_handle, open_buffdesc *vrfName)
 Set the VRF name of the NTP server. More...