Mellanox SwitchX SDK API Guide  4.3.2104
Functions
sx_api_issu.h File Reference

Go to the source code of this file.

Functions

sx_status_t sx_api_issu_log_verbosity_level_set (const sx_api_handle_t handle, const sx_log_verbosity_target_t verbosity_target, const sx_verbosity_level_t module_verbosity_level, const sx_verbosity_level_t api_verbosity_level)
 
sx_status_t sx_api_issu_start_set (const sx_api_handle_t handle)
 
sx_status_t sx_api_issu_end_set (const sx_api_handle_t handle)
 
sx_status_t sx_api_issu_pause_set (const sx_api_handle_t handle, const sx_issu_pause_t *pause_params_p)
 
sx_status_t sx_api_issu_resume_set (const sx_api_handle_t handle, const sx_issu_resume_t *resume_params_p)
 

Function Documentation

◆ sx_api_issu_log_verbosity_level_set()

sx_status_t sx_api_issu_log_verbosity_level_set ( const sx_api_handle_t  handle,
const sx_log_verbosity_target_t  verbosity_target,
const sx_verbosity_level_t  module_verbosity_level,
const sx_verbosity_level_t  api_verbosity_level 
)

This function sets the log verbosity level of ISSU MODULE. Supported devices: SwitchX, SwitchX2, Spectrum.

Parameters
[in]handle- SX-API handle
[in]verbosity_target- set verbosity of : API / MODULE / BOTH
[in]module_verbosity_level- ISSU module verbosity level
[in]api_verbosity_level- ISSU API verbosity level
Returns
SX_STATUS_SUCCESS if operation completes successfully
SX_STATUS_PARAM_ERROR if an input parameter is invalid
SX_STATUS_ERROR for a general error

◆ sx_api_issu_start_set()

sx_status_t sx_api_issu_start_set ( const sx_api_handle_t  handle)

Used for "fast-fast" boot mode to trigger the preparation for ISSU before SDK shut down. This API also switches the active FW to the new one in case such exists. Supported devices: Spectrum.

Parameters
[in]handle- SX-API handle
Returns
SX_STATUS_SUCCESS if operation completes successfully
SX_STATUS_ERROR for a general error

◆ sx_api_issu_end_set()

sx_status_t sx_api_issu_end_set ( const sx_api_handle_t  handle)

Used for "fast-fast" boot mode to notify the SDK that the configuration stage of the ISSU process has ended. Supported devices: Spectrum.

Parameters
[in]handle- SX-API handle
Returns
SX_STATUS_SUCCESS if operation completes successfully
SX_STATUS_ERROR for a general error

◆ sx_api_issu_pause_set()

sx_status_t sx_api_issu_pause_set ( const sx_api_handle_t  handle,
const sx_issu_pause_t *  pause_params_p 
)

Used for "Warm" boot mode to prepare the SDK for CRIU hibernation Supported devices: Spectrum.

Parameters
[in]handle- SX-API handle.
[in]pause_params_p- pause params.
Returns
sx_status_t:
SX_STATUS_SUCCESS - Operation completes successfully
SX_STATUS_PARAM_ERROR - Input parameters error - NULL handle
SX_STATUS_COMM_ERROR - Input parameters error - Invalid handle

◆ sx_api_issu_resume_set()

sx_status_t sx_api_issu_resume_set ( const sx_api_handle_t  handle,
const sx_issu_resume_t *  resume_params_p 
)

Used for "Warm" boot mode to "resume" the SDK from CRIU hibernation Supported devices: Spectrum.

Parameters
[in]handle- SX-API handle.
[in]resume_params_p- resume params.
Returns
sx_status_t:
SX_STATUS_SUCCESS - Operation completes successfully
SX_STATUS_PARAM_ERROR - Input parameters error - NULL handle
SX_STATUS_COMM_ERROR - Input parameters error - Invalid handle