Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.11.1.2
Data Fields

Data Fields

uint32_t family
 IP address family type of associated IPSLA operation (OPEN_AF_INET or OPEN_AF_INET6). More...
 
uint32_t ipSlaId
 IP SLA operation number Range {1-128}.
 
uint32_t ipSlaVrfId
 VRF-ID of the VRF to which the IPSLA ID is associated.
 
OPEN_BOOL_t isIpSlaEntryActive
 OPEN_TRUE,OPEN_FALSE}. More...
 
OPEN_BOOL_t isSrcIntfV4RoutingEnabled
 OPEN_TRUE if IPv4 routing is enabled on the interface. More...
 
OPEN_BOOL_t isSrcIntfV6RoutingEnabled
 OPEN_TRUE if IPv6 routing is enabled on the interface. More...
 
uint32_t lastProbeRTTvalue
 in millisecs [Default: 0 ms]
 
uint32_t latestOperationStartUpTime
 Up time since lastest probe start time.
 
uint32_t numFailures
 Count of Failed Probes (Return Code is not 'OK'). More...
 
uint32_t numSuccesses
 Count of Successful Probes (Return Code is 'OK'). More...
 
OPEN_BOOL_t overThresholdsOccurred
 {OPEN_TRUE, OPEN_FALSE}. More...
 
uint32_t probeReturnCode
 {OK, Timeout, overThreshold} [Default: OK]
 
open_inet_addr_t srcIpAddr
 SrcIP to be used for Probes in case SrcIntf configured for this IPSLA operation.
 

Detailed Description

Examples:
ipsla_example.c.

Definition at line 88 of file openapi_ipsla.h.

Field Documentation

uint32_t openIpSlaOperData_s::family

IP address family type of associated IPSLA operation (OPEN_AF_INET or OPEN_AF_INET6).

Default value is OPEN_AF_NONE.

Examples:
ipsla_example.c.

Definition at line 91 of file openapi_ipsla.h.

OPEN_BOOL_t openIpSlaOperData_s::isIpSlaEntryActive

OPEN_TRUE,OPEN_FALSE}.

[Default: OPEN_FALSE]

Examples:
ipsla_example.c.

Definition at line 93 of file openapi_ipsla.h.

OPEN_BOOL_t openIpSlaOperData_s::isSrcIntfV4RoutingEnabled

OPEN_TRUE if IPv4 routing is enabled on the interface.

Examples:
ipsla_example.c.

Definition at line 94 of file openapi_ipsla.h.

OPEN_BOOL_t openIpSlaOperData_s::isSrcIntfV6RoutingEnabled

OPEN_TRUE if IPv6 routing is enabled on the interface.

Examples:
ipsla_example.c.

Definition at line 95 of file openapi_ipsla.h.

uint32_t openIpSlaOperData_s::numFailures

Count of Failed Probes (Return Code is not 'OK').

[Default: 0]

Examples:
ipsla_example.c.

Definition at line 100 of file openapi_ipsla.h.

uint32_t openIpSlaOperData_s::numSuccesses

Count of Successful Probes (Return Code is 'OK').

[Default: 0]

Examples:
ipsla_example.c.

Definition at line 99 of file openapi_ipsla.h.

OPEN_BOOL_t openIpSlaOperData_s::overThresholdsOccurred

{OPEN_TRUE, OPEN_FALSE}.

[Default: OPEN_FALSE]

Examples:
ipsla_example.c.

Definition at line 101 of file openapi_ipsla.h.


The documentation for this struct was generated from the following file: