Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.6.0.3
Functions
Configuration Status [OPENAPI_CONFIG]

Functions

open_error_t openapiConfigChangeTrackerGet (openapiClientHandle_t *client_handle, uint32_t *configChangeTracker)
 Gets the value of a tracking variable whose value changes when there is a change to the switch's running configuration. More...
 
open_error_t openapiConfigClearTrackerGet (openapiClientHandle_t *client_handle, uint32_t *configClearTracker)
 Gets the value of a tracking variable whose value changes when the switch's running configuration is cleared. More...
 
open_error_t openapiConfigSaveTrackerGet (openapiClientHandle_t *client_handle, uint32_t *configSaveTracker)
 Gets the value of a tracking variable whose value changes when the switch's running configuration is saved to startup configuration. More...
 

Detailed Description

Function Documentation

open_error_t openapiConfigChangeTrackerGet ( openapiClientHandle_t client_handle,
uint32_t *  configChangeTracker 
)

Gets the value of a tracking variable whose value changes when there is a change to the switch's running configuration.

Parameters
[in]client_handleclient handle from registration API
[out]configChangeTrackerinteger value allowing detection of configuration saved event
Return values
OPEN_E_NONETracking value returned.
OPEN_E_PARAMError in parameter passed.
Note
In order to detect that a running configuration change has occurred since the caller last retrieved the tracking value, a simple check for equality is performed. If the values are different, one or more running configuration changes have occurred. Other than equality, the caller must not draw any conclusions about the tracker value.

OpEN API Version: 1.14

open_error_t openapiConfigClearTrackerGet ( openapiClientHandle_t client_handle,
uint32_t *  configClearTracker 
)

Gets the value of a tracking variable whose value changes when the switch's running configuration is cleared.

Parameters
[in]client_handleclient handle from registration API
[out]configClearTrackerinteger value allowing detection of configuration cleared event
Return values
OPEN_E_NONETracking value returned.
OPEN_E_PARAMError in parameter passed.
Note
In order to detect that running configuration change has been cleared since the caller last retrieved the tracking value, a simple check for equality is performed. If the values are different, one or more running configuration clear commands have occurred. Other than equality, the caller must not draw any conclusions about the tracker value.

OpEN API Version: 1.14

open_error_t openapiConfigSaveTrackerGet ( openapiClientHandle_t client_handle,
uint32_t *  configSaveTracker 
)

Gets the value of a tracking variable whose value changes when the switch's running configuration is saved to startup configuration.

Parameters
[in]client_handleclient handle from registration API
[out]configSaveTrackerinteger value allowing detection of configuration saved event
Return values
OPEN_E_NONETracking value returned.
OPEN_E_PARAMError in parameter passed.
Note
In order to detect that running configuration change has been saved since the caller last retrieved the tracking value, a simple check for equality is performed. If the values are different, one or more running configuration saves have occurred. Other than equality, the caller must not draw any conclusions about the tracker value.

OpEN API Version: 1.14