This Code Implements The OpEN Telnet Management API [OPENAPI_MGMTTELNET]

Functions
open_error_t	openapiAgentTelnetAdminModeGet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t *pMode)
	Gets admin mode of telnet session. More...
open_error_t	openapiAgentTelnetAdminModeSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t mode)
	Sets admin mode of telnet Session. More...
open_error_t	openapiAgentTelnetCurrentNumSessionsGet (openapiClientHandle_t *client_handle, uint32_t *pSession)
	Gets current active number of telnet sessions. More...
open_error_t	openapiAgentTelnetNewSessionsGet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t *pState)
	Gets new telnet session acceptance state. More...
open_error_t	openapiAgentTelnetNewSessionsSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t state)
	Sets new telnet sessions acceptance state. More...
open_error_t	openapiAgentTelnetNumSessionsGet (openapiClientHandle_t *client_handle, uint32_t *pSession)
	Gets maximum number of telnet sessions. More...
open_error_t	openapiAgentTelnetNumSessionsSet (openapiClientHandle_t *client_handle, uint32_t maxSession)
	Sets maximum number of telnet sessions. More...
open_error_t	openapiAgentTelnetTimeoutGet (openapiClientHandle_t *client_handle, uint32_t *pTimeout)
	Gets telnet session timeout information. More...
open_error_t	openapiAgentTelnetTimeoutSet (openapiClientHandle_t *client_handle, uint32_t timeout)
	Sets telnet session timeout (in minutes). More...
open_error_t	openapiSwDevCtrlTelnetMgmtPortNumGet (openapiClientHandle_t *client_handle, uint32_t *pPort)
	Gets telnet access port number. More...
open_error_t	openapiSwDevCtrlTelnetMgmtPortNumSet (openapiClientHandle_t *client_handle, uint32_t port, OPEN_BOOL_t flag)
	Sets the port-number for Telnet Access. More...

Detailed Description

Function Documentation

open_error_t openapiAgentTelnetAdminModeGet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t *	pMode
	)

Gets admin mode of telnet session.

Parameters

[in]	client_handle	client handle from registration API
[out]	pMode	Telnet 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 telnet Session access admin mode state

OpEN API Version: 1.25

Examples:

telnet_example.c.

open_error_t openapiAgentTelnetAdminModeSet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t	mode
	)

Sets admin mode of telnet Session.

Parameters

[in]	client_handle	client handle from registration API
[in]	mode	Telnet 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 telnet access mode to enable/disable

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

OpEN API Version: 1.25

Examples:

telnet_example.c.

open_error_t openapiAgentTelnetCurrentNumSessionsGet	(	openapiClientHandle_t *	client_handle,
		uint32_t *	pSession
	)

Gets current active number of telnet sessions.

Parameters

[in]	client_handle	client handle from registration API
[out]	pSession	current active telnet sessions count

Return values

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

Note

This API fetches current active number of telnet sessions

OpEN API Version: 1.25

Examples:

telnet_example.c.

open_error_t openapiAgentTelnetNewSessionsGet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t *	pState
	)

Gets new telnet session acceptance state.

Parameters

[in]	client_handle	client handle from registration API
[out]	pState	Telnet 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 new telnet Session acceptance state

OpEN API Version: 1.25

Examples:

telnet_example.c.

open_error_t openapiAgentTelnetNewSessionsSet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t	state
	)

Sets new telnet sessions acceptance state.

Parameters

[in]	client_handle	client handle from registration API
[in]	state	Acceptance state of new telnet sessions[Enable/Disable]

Return values

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

Note

This API sets new telnet acceptance state to enable/disable

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

OpEN API Version: 1.25

Examples:

telnet_example.c.

open_error_t openapiAgentTelnetNumSessionsGet	(	openapiClientHandle_t *	client_handle,
		uint32_t *	pSession
	)

Gets maximum number of telnet sessions.

Parameters

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

Return values

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

Note

This API fetches maximum number of telnet sessions configured

OpEN API Version: 1.25

Examples:

telnet_example.c.

open_error_t openapiAgentTelnetNumSessionsSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	maxSession
	)

Sets maximum number of telnet sessions.

Parameters

[in]	client_handle	client handle from registration API
[in]	maxSession	maximum allowable number of telnet 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 telnet sessions

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

OpEN API Version: 1.25

Examples:

telnet_example.c.

open_error_t openapiAgentTelnetTimeoutGet	(	openapiClientHandle_t *	client_handle,
		uint32_t *	pTimeout
	)

Gets telnet session timeout information.

Parameters

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

Return values

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

Note

This API fetches information of telnet session timeout

OpEN API Version: 1.25

Examples:

telnet_example.c.

open_error_t openapiAgentTelnetTimeoutSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	timeout
	)

Sets telnet session timeout (in minutes).

Parameters

[in]	client_handle	client handle from registration API
[in]	timeout	telnet session timeout

Return values

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

Note

This API sets telnet session timeout

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

OpEN API Version: 1.25

Examples:

telnet_example.c.

open_error_t openapiSwDevCtrlTelnetMgmtPortNumGet	(	openapiClientHandle_t *	client_handle,
		uint32_t *	pPort
	)

Gets telnet access port number.

Parameters

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

Return values

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

Note

This API fetches telnet access port number

OpEN API Version: 1.25

Examples:

telnet_example.c.

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

Sets the port-number for Telnet Access.

Parameters

[in]	client_handle	client handle from registration API
[in]	port	Telnet 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 Telnet Access

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

OpEN API Version: 1.25

Examples:

telnet_example.c.