This Code Implements The OpEN Web Management API [OPENAPI_WEBMGMT]

Functions
open_error_t	openapiCliWebHttpNumSessionsGet (openapiClientHandle_t *client_handle, uint32_t *pSession)
	Gets maximum number of HTTP web sessions. More...
open_error_t	openapiCliWebHttpNumSessionsSet (openapiClientHandle_t *client_handle, uint32_t maxSession)
	Sets maximum number of HTTP web sessions. More...
open_error_t	openapiCliWebHttpSessionHardTimeOutGet (openapiClientHandle_t *client_handle, uint32_t *pTimeout)
	Gets HTTP session hard timeout information (in hours). More...
open_error_t	openapiCliWebHttpSessionHardTimeOutSet (openapiClientHandle_t *client_handle, uint32_t timeout)
	Sets HTTP session hard timeout (in hours). More...
open_error_t	openapiCliWebHttpSessionSoftTimeOutGet (openapiClientHandle_t *client_handle, uint32_t *pTimeout)
	Gets HTTP session soft timeout information. More...
open_error_t	openapiCliWebHttpSessionSoftTimeOutSet (openapiClientHandle_t *client_handle, uint32_t timeout)
	Sets HTTP session soft timeout (in minutes). More...
open_error_t	openapiSwDevCtrlWebMgmtModeGet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t *pMode)
	Gets admin mode of System Web. More...
open_error_t	openapiSwDevCtrlWebMgmtModeSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t mode)
	Sets System Web Mode. More...
open_error_t	openapiSwDevCtrlWebMgmtPortNumGet (openapiClientHandle_t *client_handle, uint32_t *pPort)
	Gets HTTP access port number. More...
open_error_t	openapiSwDevCtrlWebMgmtPortNumSet (openapiClientHandle_t *client_handle, uint32_t port, OPEN_BOOL_t flag)
	Sets the port-number for HTTP Access. More...

Detailed Description

Function Documentation

open_error_t openapiCliWebHttpNumSessionsGet	(	openapiClientHandle_t *	client_handle,
		uint32_t *	pSession
	)

Gets maximum number of HTTP web sessions.

Parameters

[in]	client_handle	client handle from registration API
[out]	pSession	maximum allowable number of web sessions configured

Return values

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

Note

This API fetches maximum number of HTTP web sessions configured

OpEN API Version: 1.25

Examples:

webmgmt_example.c.

open_error_t openapiCliWebHttpNumSessionsSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	maxSession
	)

Sets maximum number of HTTP web sessions.

Parameters

[in]	client_handle	client handle from registration API
[in]	maxSession	maximum allowable number of HTTP web sessions

Return values

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

Note

This API sets maximum number of HTTP web sessions

Calling this API will change the running configuration of the switch.

OpEN API Version: 1.25

Examples:

webmgmt_example.c.

open_error_t openapiCliWebHttpSessionHardTimeOutGet	(	openapiClientHandle_t *	client_handle,
		uint32_t *	pTimeout
	)

Gets HTTP session hard timeout information (in hours).

Parameters

[in]	client_handle	client handle from registration API
[out]	pTimeout	HTTP session hard timeout

Return values

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

Note

This API fetches information of HTTP session hard timeout

OpEN API Version: 1.25

Examples:

webmgmt_example.c.

open_error_t openapiCliWebHttpSessionHardTimeOutSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	timeout
	)

Sets HTTP session hard timeout (in hours).

Parameters

[in]	client_handle	client handle from registration API
[in]	timeout	HTTP session hard timeout

Return values

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

Note

This API sets HTTP session hard timeout

Calling this API will change the running configuration of the switch.

OpEN API Version: 1.25

Examples:

webmgmt_example.c.

open_error_t openapiCliWebHttpSessionSoftTimeOutGet	(	openapiClientHandle_t *	client_handle,
		uint32_t *	pTimeout
	)

Gets HTTP session soft timeout information.

Parameters

[in]	client_handle	client handle from registration API
[out]	pTimeout	HTTP session soft timeout

Return values

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

Note

This API fetches information of HTTP session soft timeout

OpEN API Version: 1.25

Examples:

webmgmt_example.c.

open_error_t openapiCliWebHttpSessionSoftTimeOutSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	timeout
	)

Sets HTTP session soft timeout (in minutes).

Parameters

[in]	client_handle	client handle from registration API
[in]	timeout	HTTP session soft timeout

Return values

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

Note

This API sets HTTP session soft timeout

Calling this API will change the running configuration of the switch.

OpEN API Version: 1.25

Examples:

webmgmt_example.c.

open_error_t openapiSwDevCtrlWebMgmtModeGet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t *	pMode
	)

Gets admin mode of System Web.

Parameters

[in]	client_handle	client handle from registration API
[out]	pMode	Web Access Mode [Enable/Disable]

Return values

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

Note

This API fetches HTTP device access admin mode state

OpEN API Version: 1.25

Examples:

webmgmt_example.c.

open_error_t openapiSwDevCtrlWebMgmtModeSet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t	mode
	)

Sets System Web Mode.

Parameters

[in]	client_handle	client handle from registration API
[in]	mode	Web Access Mode [Enable/Disable]

Return values

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

Note

This API sets HTTP access mode to enable/disable

Calling this API will change the running configuration of the switch.

OpEN API Version: 1.25

Examples:

webmgmt_example.c.

open_error_t openapiSwDevCtrlWebMgmtPortNumGet	(	openapiClientHandle_t *	client_handle,
		uint32_t *	pPort
	)

Gets HTTP access port number.

Parameters

[in]	client_handle	client handle from registration API
[out]	pPort	HTTP access port number

Return values

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

Note

This API fetches HTTP access port number

OpEN API Version: 1.25

Examples:

webmgmt_example.c.

open_error_t openapiSwDevCtrlWebMgmtPortNumSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	port,
		OPEN_BOOL_t	flag
	)

Sets the port-number for HTTP Access.

Parameters

[in]	client_handle	client handle from registration API
[in]	port	HTTP Access port-number
[in]	flag	Flag indicates if the port number needs to be applied immediately

Return values

OPEN_E_EXISTS	Operation failed due to port number already in use.
OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API sets port-number for HTTP Access

Calling this API will change the running configuration of the switch.

OpEN API Version: 1.25

Examples:

webmgmt_example.c.