This Code Implements The OpEN IPSLA API [OPENAPI_IPSLA]

Data Structures
struct	openIpSlaCfg_s
struct	openIpSlaIcmpEchoCfg_s
struct	openIpSlaOperData_s
struct	openIpSlaTrackCfg_s
struct	openIpSlaTrackOperData_s

Typedefs
typedef struct openIpSlaCfg_s	openIpSlaCfg_t
	IPSLA Tracking types.
typedef struct openIpSlaIcmpEchoCfg_s	openIpSlaIcmpEchoCfg_t
	IP SLA Config Entry Structure.
typedef struct openIpSlaOperData_s	openIpSlaOperData_t
	IPSLA Track object configuration.
typedef enum openIpSlaOperTypes_s	openIpSlaOperTypes_t
	< IPSLA operation types More...
typedef struct openIpSlaTrackCfg_s	openIpSlaTrackCfg_t
	IPSLA Tracking return codes.
typedef struct openIpSlaTrackOperData_s	openIpSlaTrackOperData_t
typedef enum openIpSlaTrackTypes_s	openIpSlaTrackTypes_t
	Data structure for Operational Data of IP-SLA-Table Element.
typedef enum openTrackRC_s	openTrackRC_t
	Data structure for Operational data of Track-Table Element.

Enumerations
enum	openIpSlaOperTypes_s { OPEN_IPSLA_OPERATION_TYPE_NONE = 0, OPEN_IPSLA_OPERATION_TYPE_ICMP_ECHO = 1 }
	< IPSLA operation types
enum	openIpSlaTrackTypes_s { OPEN_IPSLA_TRACKING_TYPE_REACHABILITY = 0, OPEN_IPSLA_TRACKING_TYPE_STATE = 1 }
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 }

Functions
open_error_t	openapiIpSlaIpSlaIdCfgNodeFirstGet (openapiClientHandle_t *client_handle, OPEN_BOOL_t isShowRunningCfg, uint32_t *ipSlaId)
	To get the IPSLA ID of the first IPSLA probe operational. More...
open_error_t	openapiIpSlaIpSlaIdCfgNodeNextGet (openapiClientHandle_t *client_handle, uint32_t ipSlaId, OPEN_BOOL_t isShowRunningCfg, uint32_t *nextIpSlaId)
	To get the ipSla id of the next IPSLA probe operational entry from the IPSLA Table. More...
open_error_t	openapiIpSlaIpSlaIdCreate (openapiClientHandle_t *client_handle, uint32_t ipSlaId)
	Create an IP SLA operation for the given IP SLA number. More...
open_error_t	openapiIpSlaIpSlaIdDelete (openapiClientHandle_t *client_handle, uint32_t ipSlaId)
	Delete an IP SLA operation for the given IP SLA number. More...
open_error_t	openapiIpSlaIpSlaIdNodeCfgInfoGet (openapiClientHandle_t *client_handle, uint32_t ipSlaId, openIpSlaCfg_t *ipSlaCfgInfo)
	Get the config information of the given IP SLA number. More...
open_error_t	openapiIpSlaIpSlaIdNodeOperInfoGet (openapiClientHandle_t *client_handle, uint32_t ipSlaId, openIpSlaOperData_t *ipSlaOperInfo)
	Get the operational info of the given IP SLA number. More...
open_error_t	openapiIpSlaIpSlaIdOperStatusGet (openapiClientHandle_t *client_handle, uint32_t ipSlaId, OPEN_BOOL_t *isIpSlaEntryActive)
	Get the operational status of the given IP SLA number. More...
open_error_t	openapiIpSlaIpSlaProbesIcmpEchoTypeSet (openapiClientHandle_t *client_handle, uint32_t ipSlaId, open_inet_addr_t destIpAddress, uint32_t srcIntIfNum)
	Set the given IP SLA Operation's ICMP-ECHO Type params. More...
open_error_t	openapiIpSlaIpSlaSchedule (openapiClientHandle_t *client_handle, uint32_t ipSlaId, OPEN_BOOL_t toSchedule)
	Schedule an IP SLA operation to start or stop probing. More...
open_error_t	openapiIpSlaIpSlaStatisticsClear (openapiClientHandle_t *client_handle, uint32_t ipSlaId)
	Clear IP SLA statistical information for given IP SLA operation or all IP SLAs. More...
open_error_t	openapiIpSlaSetIpSlaProbesFrequency (openapiClientHandle_t *client_handle, uint32_t ipSlaId, uint32_t frequency)
	Set the given IP SLA Operation's ICMP-ECHO Frequency value. More...
open_error_t	openapiIpSlaSetIpSlaProbesThreshold (openapiClientHandle_t *client_handle, uint32_t ipSlaId, uint32_t threshold)
	Set the given IP SLA Operation's ICMP-ECHO Threshold value. More...
open_error_t	openapiIpSlaSetIpSlaProbesTimeout (openapiClientHandle_t *client_handle, uint32_t ipSlaId, uint32_t timeout)
	Set the given IP SLA Operation's ICMP-ECHO Timeout value. More...
open_error_t	openapiIpSlaSetIpSlaProbesVrfName (openapiClientHandle_t *client_handle, uint32_t ipSlaId, open_buffdesc *vrfName)
	Set the given IP SLA Operation's ICMP-ECHO VRF Name value. More...
open_error_t	openapiIpSlaSetTrackOjectsDelayDownTime (openapiClientHandle_t *client_handle, uint32_t trackId, uint32_t downDelayTime)
	Set the given Track object's Down delay time value. More...
open_error_t	openapiIpSlaSetTrackOjectsDelayUpTime (openapiClientHandle_t *client_handle, uint32_t trackId, uint32_t upDelayTime)
	Set the given Track object's Up delay time value. More...
open_error_t	openapiIpSlaTrackIdCfgNodeFirstGet (openapiClientHandle_t *client_handle, uint32_t *trackId)
	To get the track Id of the first track object's operational entry from the Track Table. More...
open_error_t	openapiIpSlaTrackIdCfgNodeNextGet (openapiClientHandle_t *client_handle, uint32_t trackId, uint32_t *nextTrackId)
	To get the track Id of the next track object's operational entry from the TrackTable. More...
open_error_t	openapiIpSlaTrackIdCreate (openapiClientHandle_t *client_handle, uint32_t trackId, uint32_t ipSlaId, openIpSlaTrackTypes_t trackingType)
	Create a Track object for the given track number. More...
open_error_t	openapiIpSlaTrackIdDelete (openapiClientHandle_t *client_handle, uint32_t trackId)
	Delete the Track object for the given track number. More...
open_error_t	openapiIpSlaTrackIdNodeCfgInfoGet (openapiClientHandle_t *client_handle, uint32_t trackId, openIpSlaTrackCfg_t *trackCfgInfo)
	Get the config information of the given track number. More...
open_error_t	openapiIpSlaTrackIdNodeOperInfoGet (openapiClientHandle_t *client_handle, uint32_t trackId, openIpSlaTrackOperData_t *trackOperInfo)
	Get the operational info of the given track number. More...
open_error_t	openapiIpSlaTrackIdTrackingStateGet (openapiClientHandle_t *client_handle, uint32_t trackId, OPEN_BOOL_t *isTrackStatusUp)
	Get the tracking status of the given Track number. More...

Detailed Description

Typedef Documentation

typedef enum openIpSlaOperTypes_s openIpSlaOperTypes_t

< IPSLA operation types

IP SLA ICMP Echo Operation Config Params IPSLA ICMP Echo configuration

Function Documentation

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

To get the IPSLA ID of the first IPSLA probe operational.

Entry from the IPSLA Table.

Parameters

[in]	client_handle	Client handle from registration API
[in]	isShowRunningCfg	Is for show running-config output (OPEN_TRUE/OPEN_FALSE)
[out]	ipSlaId	IPSLA operation number

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.25

Examples:

ipsla_example.c.

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

To get the ipSla id of the next IPSLA probe operational entry from the IPSLA Table.

Parameters

[in]	client_handle	Client handle from registration API
[in]	ipSlaId	Current IPSLA operation number
[in]	isShowRunningCfg	Is for show running-config output (OPEN_TRUE/OPEN_FALSE)
[out]	nextIpSlaId	Next IPSLA operation number

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.25

Examples:

ipsla_example.c.

open_error_t openapiIpSlaIpSlaIdCreate	(	openapiClientHandle_t *	client_handle,
		uint32_t	ipSlaId
	)

Create an IP SLA operation for the given IP SLA number.

Parameters

[in]	client_handle	Client handle from registration API
[in]	ipSlaId	IPSLA operation number

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.25

Examples:

ipsla_example.c.

open_error_t openapiIpSlaIpSlaIdDelete	(	openapiClientHandle_t *	client_handle,
		uint32_t	ipSlaId
	)

Delete an IP SLA operation for the given IP SLA number.

Parameters

[in]	client_handle	Client handle from registration API
[in]	ipSlaId	IPSLA operation number

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.25

Examples:

ipsla_example.c.

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

Get the config information of the given IP SLA number.

Parameters

[in]	client_handle	Client handle from registration API
[in]	ipSlaId	IPSLA operation number
[out]	ipSlaCfgInfo	Pointer to an IPSLA's config info

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.25

Examples:

ipsla_example.c.

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

Get the operational info of the given IP SLA number.

Parameters

[in]	client_handle	Client handle from registration API
[in]	ipSlaId	IPSLA operation number
[out]	ipSlaOperInfo	Pointer to an IPSLA's oper info

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.25

Examples:

ipsla_example.c.

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

Get the operational status of the given IP SLA number.

Parameters

[in]	client_handle	Client handle from registration API
[in]	ipSlaId	Current IPSLA operation number
[out]	isIpSlaEntryActive	Pointer to an IPSLA's oper status(OPEN_TRUE/OPEN_FALSE)

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.25

Examples:

ipsla_example.c.

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

Set the given IP SLA Operation's ICMP-ECHO Type params.

Parameters

[in]	client_handle	Client handle from registration API
[in]	ipSlaId	IPSLA operation number
[in]	destIpAddress	Destination Host's IP address
[in]	srcIntIfNum	Source interface's internal interface number

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.25

Examples:

ipsla_example.c.

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

Schedule an IP SLA operation to start or stop probing.

Parameters

[in]	client_handle	Client handle from registration API
[in]	ipSlaId	IPSLA operation number
[in]	toSchedule	Schedule mode (OPEN_TRUE/OPEN_FALSE)

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.25

Examples:

ipsla_example.c.

open_error_t openapiIpSlaIpSlaStatisticsClear	(	openapiClientHandle_t *	client_handle,
		uint32_t	ipSlaId
	)

Clear IP SLA statistical information for given IP SLA operation or all IP SLAs.

Parameters

[in]	client_handle	Client handle from registration API
[in]	ipSlaId	IPSLA operation number incase a specific probe's stats need to be cleared or else zero incase for all IPSLA's.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.25

Examples:

ipsla_example.c.

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

Set the given IP SLA Operation's ICMP-ECHO Frequency value.

Parameters

[in]	client_handle	Client handle from registration API
[in]	ipSlaId	IPSLA operation number
[in]	frequency	Frequency value

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.25

Examples:

ipsla_example.c.

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

Set the given IP SLA Operation's ICMP-ECHO Threshold value.

Parameters

[in]	client_handle	Client handle from registration API
[in]	ipSlaId	IPSLA operation number
[in]	threshold	Threshold value

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.25

Examples:

ipsla_example.c.

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

Set the given IP SLA Operation's ICMP-ECHO Timeout value.

Parameters

[in]	client_handle	Client handle from registration API
[in]	ipSlaId	IPSLA operation number
[in]	timeout	Timeout value

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.25

Examples:

ipsla_example.c.

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

Set the given IP SLA Operation's ICMP-ECHO VRF Name value.

Parameters

[in]	client_handle	Client handle from registration API
[in]	ipSlaId	IPSLA operation number
[in]	vrfName	VRF name of VRF in which the IP SLA probe is to run

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.25

Examples:

ipsla_example.c.

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

Set the given Track object's Down delay time value.

Parameters

[in]	client_handle	Client handle from registration API
[in]	trackId	Track object number
[in]	downDelayTime	Down delay time in seconds

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.25

Examples:

ipsla_example.c.

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

Set the given Track object's Up delay time value.

Parameters

[in]	client_handle	Client handle from registration API
[in]	trackId	Track object number
[in]	upDelayTime	Up delay time in seconds

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.25

Examples:

ipsla_example.c.

open_error_t openapiIpSlaTrackIdCfgNodeFirstGet	(	openapiClientHandle_t *	client_handle,
		uint32_t *	trackId
	)

To get the track Id of the first track object's operational entry from the Track Table.

Parameters

[in]	client_handle	Client handle from registration API
[out]	trackId	Track object number

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.25

Examples:

ipsla_example.c.

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

To get the track Id of the next track object's operational entry from the TrackTable.

Parameters

[in]	client_handle	Client handle from registration API
[in]	trackId	Current track object number
[out]	nextTrackId	Next track object number

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.25

Examples:

ipsla_example.c.

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

Create a Track object for the given track number.

Parameters

[in]	client_handle	Client handle from registration API
[in]	trackId	Track object number
[in]	ipSlaId	IPSLA operation number
[in]	trackingType	Tracking-type value

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.25

Examples:

ipsla_example.c.

open_error_t openapiIpSlaTrackIdDelete	(	openapiClientHandle_t *	client_handle,
		uint32_t	trackId
	)

Delete the Track object for the given track number.

Parameters

[in]	client_handle	Client handle from registration API
[in]	trackId	Track object number

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.25

Examples:

ipsla_example.c.

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

Get the config information of the given track number.

Parameters

[in]	client_handle	Client handle from registration API
[in]	trackId	Track object number
[out]	trackCfgInfo	Pointer to a track's config info

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.25

Examples:

ipsla_example.c.

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

Get the operational info of the given track number.

Parameters

[in]	client_handle	Client handle from registration API
[in]	trackId	Track object number
[out]	trackOperInfo	Pointer to a track's oper info

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.25

Examples:

ipsla_example.c.

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

Get the tracking status of the given Track number.

Parameters

[in]	client_handle	Client handle from registration API
[in]	trackId	Track object number
[out]	isTrackStatusUp	Pointer to an Track object' tracking status(OPEN_TRUE/OPEN_FALSE)

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.25

Examples:

ipsla_example.c.