openapi_ipsla.h

Go to the documentation of this file.

/**********************************************************************
*
*  Copyright 2022-2023 Broadcom.
*
*  Licensed under the Apache License, Version 2.0 (the "License");
*  you may not use this file except in compliance with the License.
*  You may obtain a copy of the License at
*
*      http://www.apache.org/licenses/LICENSE-2.0
*
*  Unless required by applicable law or agreed to in writing, software
*  distributed under the License is distributed on an "AS IS" BASIS,
*  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
*  See the License for the specific language governing permissions and
*  limitations under the License.
*
***********************************************************************
*
* @filename  openapi_ipsla.h
*
* @purpose   This code implements the OpEN IPSLA API
*
* @component OPEN
*
* @create    12/27/2022
*
* @end
*
*********************************************************************/
#ifndef OPENAPI_IPSLA_H_INCLUDED
#define OPENAPI_IPSLA_H_INCLUDED

#include "openapi_common.h" 
#include "openapi_routing_config.h"


/*** Data structures for Configuration data of IP-SLA-Table ***/

typedef enum openIpSlaOperTypes_s
{
  OPEN_IPSLA_OPERATION_TYPE_NONE      = 0,
  OPEN_IPSLA_OPERATION_TYPE_ICMP_ECHO = 1
} openIpSlaOperTypes_t;

typedef struct openIpSlaIcmpEchoCfg_s
{
  open_inet_addr_t destIpAddr;    
  uint32_t         srcIntIfNum;   
  uint32_t         frequency;     
  uint32_t         threshold;     
  uint32_t         timeout;       
  char             vrfName[OPEN_VRF_MAX_NAME_LEN + 1]; 
} openIpSlaIcmpEchoCfg_t;

typedef struct openIpSlaCfg_s
{
  OPEN_BOOL_t          inUse;       
  uint32_t             ipSlaId;     
  openIpSlaOperTypes_t ipSlaType;   
  OPEN_BOOL_t          isScheduled; 
  union
  {
    openIpSlaIcmpEchoCfg_t ipSlaEchoCfgParams;
  } u;
} openIpSlaCfg_t;

typedef enum openIpSlaTrackTypes_s
{
  OPEN_IPSLA_TRACKING_TYPE_REACHABILITY = 0,
  OPEN_IPSLA_TRACKING_TYPE_STATE        = 1
} openIpSlaTrackTypes_t;

typedef struct openIpSlaOperData_s
{
  uint32_t         ipSlaId;            
  uint32_t         family;             
  uint32_t         ipSlaVrfId;         
  OPEN_BOOL_t      isIpSlaEntryActive; 
  OPEN_BOOL_t      isSrcIntfV4RoutingEnabled; 
  OPEN_BOOL_t      isSrcIntfV6RoutingEnabled; 
  open_inet_addr_t srcIpAddr;          
  uint32_t         probeReturnCode;    
  uint32_t         lastProbeRTTvalue;  
  uint32_t         numSuccesses;       
  uint32_t         numFailures;        
  OPEN_BOOL_t      overThresholdsOccurred;      
  uint32_t         latestOperationStartUpTime;  
} openIpSlaOperData_t;

typedef struct openIpSlaTrackCfg_s
{
  OPEN_BOOL_t    inUse;          
  uint32_t       trackId;        
  uint32_t       trackedIpSlaId; 
  openIpSlaTrackTypes_t trackingType;   
  uint32_t       delayUp;        
  uint32_t       delayDown;      
} openIpSlaTrackCfg_t;

typedef enum openTrackRC_s
{
  OPEN_IPSLA_TRACK_RC_UNKNOWN = 0,
  OPEN_IPSLA_TRACK_RC_OK = 1,
  OPEN_IPSLA_TRACK_RC_TIMEOUT = 2,
  OPEN_IPSLA_TRACK_RC_OVERTHRESHOLD = 3,
} openTrackRC_t;

typedef struct openIpSlaTrackOperData_s
{
  uint32_t      trackId;              /*Track object number. Range {1-128}*/
  uint32_t      family;               /*IP address family type of associated IPSLA operation (OPEN_AF_INET or OPEN_AF_INET6)*/
  OPEN_BOOL_t   isTrackEntryActive;   /*{OPEN_TRUE, OPEN_FALSE}. [Default: OPEN_FALSE]**If IpSlaId associated but IpSlaId not created/defined then also OPEN_FALSE.*/
  OPEN_BOOL_t   trackingStatus;       /*{OPEN_TRUE, OPEN_FALSE}. [Default: OPEN_TRUE]*/
  OPEN_BOOL_t   prevTrackingStatus;   /*{OPEN_TRUE, OPEN_FALSE}. [Default: OPEN_TRUE]. Store the previous TrackStatus value for delayTimerCheck*/
  OPEN_BOOL_t   ignoreDelayConfig;    /*{OPEN_TRUE, OPEN_FALSE}. [Default: OPEN_FALSE]. Flag to indicate whether to ignore delay config or not*/
  uint32_t      delayStartTime;       /*Time in seconds since the last reachability status change update arrived with
                                        different value. If not value is zero. It is reset to zero when delay up or
                                        delay down timer expiry happens and Reachability Status is changed. */
  uint32_t      lastStatusChangeUpdateTime;  /*Time in seconds since the last reachability status change*/
  uint32_t      numStatusChangeUpdates;      /*Count of Status Change Updates received since TrackEntryActive. [Default: 0]*/
  uint32_t      latestOperationReturnCode;   /*ReturnCode when the last TrackingStatus was changed.{Unknown, OK, Timeout, overThreshold} [Default: Unknown]*/

} openIpSlaTrackOperData_t;


/*************************************************************************/
open_error_t openapiIpSlaIpSlaIdCreate(openapiClientHandle_t *client_handle, uint32_t ipSlaId);

/*************************************************************************/
open_error_t openapiIpSlaIpSlaIdDelete(openapiClientHandle_t *client_handle, uint32_t ipSlaId);

/*************************************************************************/
open_error_t openapiIpSlaIpSlaSchedule(openapiClientHandle_t *client_handle, uint32_t ipSlaId, OPEN_BOOL_t toSchedule);

/*************************************************************************/
open_error_t openapiIpSlaIpSlaIdNodeCfgInfoGet(openapiClientHandle_t *client_handle, uint32_t ipSlaId, openIpSlaCfg_t *ipSlaCfgInfo);

/*************************************************************************/
open_error_t openapiIpSlaIpSlaIdNodeOperInfoGet(openapiClientHandle_t *client_handle,uint32_t ipSlaId, openIpSlaOperData_t *ipSlaOperInfo);

/*************************************************************************/
open_error_t openapiIpSlaIpSlaIdCfgNodeFirstGet(openapiClientHandle_t *client_handle, OPEN_BOOL_t isShowRunningCfg, uint32_t *ipSlaId);

/*************************************************************************/
open_error_t openapiIpSlaIpSlaIdCfgNodeNextGet(openapiClientHandle_t *client_handle, uint32_t ipSlaId, OPEN_BOOL_t isShowRunningCfg, uint32_t *nextIpSlaId);

/*************************************************************************/
open_error_t openapiIpSlaIpSlaIdOperStatusGet(openapiClientHandle_t *client_handle, uint32_t ipSlaId, OPEN_BOOL_t *isIpSlaEntryActive);

/*************************************************************************/
open_error_t openapiIpSlaTrackIdTrackingStateGet(openapiClientHandle_t *client_handle, uint32_t trackId, OPEN_BOOL_t *isTrackStatusUp);

/*************************************************************************/
open_error_t openapiIpSlaTrackIdNodeCfgInfoGet(openapiClientHandle_t *client_handle, uint32_t trackId, openIpSlaTrackCfg_t *trackCfgInfo);

/*************************************************************************/
open_error_t openapiIpSlaTrackIdNodeOperInfoGet(openapiClientHandle_t *client_handle, uint32_t trackId, openIpSlaTrackOperData_t *trackOperInfo);

/*************************************************************************/
open_error_t openapiIpSlaTrackIdCfgNodeFirstGet(openapiClientHandle_t *client_handle, uint32_t *trackId);

/*************************************************************************/
open_error_t openapiIpSlaTrackIdCfgNodeNextGet(openapiClientHandle_t *client_handle, uint32_t trackId, uint32_t *nextTrackId);

/*************************************************************************/
open_error_t openapiIpSlaTrackIdCreate(openapiClientHandle_t *client_handle, uint32_t trackId, uint32_t ipSlaId, openIpSlaTrackTypes_t trackingType);

/*************************************************************************/
open_error_t openapiIpSlaTrackIdDelete(openapiClientHandle_t *client_handle, uint32_t trackId);

/*************************************************************************/
open_error_t openapiIpSlaSetTrackOjectsDelayUpTime(openapiClientHandle_t *client_handle, uint32_t trackId, uint32_t upDelayTime);

/*************************************************************************/
open_error_t openapiIpSlaSetTrackOjectsDelayDownTime(openapiClientHandle_t *client_handle, uint32_t trackId, uint32_t downDelayTime);

/*************************************************************************/
open_error_t openapiIpSlaIpSlaProbesIcmpEchoTypeSet(openapiClientHandle_t *client_handle, uint32_t ipSlaId, open_inet_addr_t destIpAddress, uint32_t srcIntIfNum);

/*************************************************************************/
open_error_t openapiIpSlaSetIpSlaProbesFrequency(openapiClientHandle_t *client_handle, uint32_t ipSlaId, uint32_t frequency);

/*************************************************************************/
open_error_t openapiIpSlaSetIpSlaProbesTimeout(openapiClientHandle_t *client_handle, uint32_t ipSlaId, uint32_t timeout);

/*************************************************************************/
open_error_t openapiIpSlaSetIpSlaProbesThreshold(openapiClientHandle_t *client_handle, uint32_t ipSlaId, uint32_t threshold);

/*************************************************************************/
open_error_t openapiIpSlaSetIpSlaProbesVrfName(openapiClientHandle_t *client_handle, uint32_t ipSlaId, open_buffdesc *vrfName);

/*************************************************************************/
open_error_t openapiIpSlaIpSlaStatisticsClear(openapiClientHandle_t *client_handle, uint32_t ipSlaId);


#endif /* OPENAPI_IPSLA_H_INCLUDED */