Enumerations
enum	OPEN_SSH_KEY_TYPE_t { OPEN_SSH_KEY_TYPE_RSA = 0, OPEN_SSH_KEY_TYPE_DSA = 1 }
	OpEN uses this enumeration to define SSH key types. More...

enum	OPEN_SSH_PROTO_VERSION_t { OPEN_SSH_PROTO_VERSION_1 = 0, OPEN_SSH_PROTO_VERSION_2 = 1, OPEN_SSH_PROTO_VERSION_BOTH = 2 }
	OpEN uses this enumeration to define SSH protocol versions. More...

Functions
open_error_t	openapiScpRemoteTransferComplete (openapiClientHandle_t *client_handle)
	To update application about the completion of scp remote file transfer.

open_error_t	openapiScpRemoteTransferStart (openapiClientHandle_t client_handle, int32_t scpClientPID, open_buffdesc fileParams)
	To get the download file complete path and initiate transfer process.

open_error_t	openapiScpServerAdminModeGet (openapiClientHandle_t client_handle, OPEN_CONTROL_t scpServerAdminMode)
	Get the SCP server admin mode.

open_error_t	openapiScpServerAdminModeSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t scpServerAdminMode)
	Set the SCP server admin mode to initiate file transfer.

open_error_t	openapiSSHActiveSessionsGet (openapiClientHandle_t client_handle, uint32_t sshActiveSessions)
	Get the active number of SSH sessions.

open_error_t	openapiSSHAdminModeGet (openapiClientHandle_t client_handle, OPEN_CONTROL_t sshAdminMode)
	Get the admin mode of SSH.

open_error_t	openapiSSHAdminModeSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t sshAdminMode)
	Set the admin mode of SSH.

open_error_t	openapiSSHKeyDelete (openapiClientHandle_t *client_handle, OPEN_SSH_KEY_TYPE_t sshKeyType)
	Delete the generated SSH key pairs.

open_error_t	openapiSSHKeyGenerate (openapiClientHandle_t *client_handle, OPEN_SSH_KEY_TYPE_t sshKeyType)
	Generate SSH key pairs.

open_error_t	openapiSSHKeyStatusGet (openapiClientHandle_t *client_handle, OPEN_SSH_KEY_TYPE_t sshKeyType)
	Check the status of SSH key.

open_error_t	openapiSSHLogMessage (openapiClientHandle_t client_handle, OPEN_LOG_SEVERITY_t severity, open_buffdesc fileName, uint32_t lineNum, open_buffdesc *msgBuf)
	Log an SSH message in the log server.

open_error_t	openapiSSHMaxSessionsDefaultSet (openapiClientHandle_t *client_handle)
	Set the maximum number of allowed SSH sessions to the default.

open_error_t	openapiSSHMaxSessionsGet (openapiClientHandle_t client_handle, uint32_t sshMaxSessions)
	Get the maximum number of SSH sessions allowed.

open_error_t	openapiSSHMaxSessionsSet (openapiClientHandle_t *client_handle, uint32_t sshMaxSessions)
	Set the maximum number of allowed SSH sessions.

open_error_t	openapiSSHProtocolVersionGet (openapiClientHandle_t client_handle, OPEN_SSH_PROTO_VERSION_t protoVersion)
	Get the SSH protocol version.

open_error_t	openapiSSHProtocolVersionSet (openapiClientHandle_t *client_handle, OPEN_SSH_PROTO_VERSION_t protoVersion)
	Set the SSH protocol version.

open_error_t	openapiSSHPubKeyAuthModeGet (openapiClientHandle_t client_handle, OPEN_CONTROL_t sshdPubKeyAuthMode)
	Get the admin mode of SSH public key.

open_error_t	openapiSSHPubKeyGet (openapiClientHandle_t client_handle, OPEN_SSH_KEY_TYPE_t sshKeyType, open_buffdesc userName, open_buffdesc *pubKey)
	Get the SSH public key for specified user.

open_error_t	openapiSSHPublicUserAuthenticate (openapiClientHandle_t client_handle, open_buffdesc userName, open_buffdesc *ipAddr, uint32_t sshClientID)
	Authenticate SSH User.

open_error_t	openapiSSHSessionTimeoutGet (openapiClientHandle_t client_handle, uint32_t sshSessionTimeout)
	Get the SSH session idle timeout value.

open_error_t	openapiSSHSessionTimeoutSet (openapiClientHandle_t *client_handle, uint32_t sshSessionTimeout)
	Set the SSH session idle timeout.

open_error_t	openapiSSHSocketInfoClear (openapiClientHandle_t *client_handle, uint32_t sshClientID)
	Clear socket info entry.

open_error_t	openapiSSHTransferRemotePasswordFromUserGet (openapiClientHandle_t client_handle, open_buffdesc userName, open_buffdesc *password)
	Get the remote password for the matching remote username used for transfer.

open_error_t	openapiSSHUserAuthenticate (openapiClientHandle_t client_handle, open_buffdesc userName, open_buffdesc password, open_buffdesc ipAddr, uint32_t sshClientID)
	Authenticate SSH User.

Detailed Description

Enumeration Type Documentation

enum OPEN_SSH_KEY_TYPE_t

OpEN uses this enumeration to define SSH key types.

Enumerator:

OPEN_SSH_KEY_TYPE_RSA	SSH Key Type RSA.
OPEN_SSH_KEY_TYPE_DSA	SSH Key Type DSA.

Definition at line 45 of file openapi_ssh.h.

enum OPEN_SSH_PROTO_VERSION_t

OpEN uses this enumeration to define SSH protocol versions.

Enumerator:

OPEN_SSH_PROTO_VERSION_2	SSH Protocol Version 2.
OPEN_SSH_PROTO_VERSION_BOTH	SSH Protocol Version Both (1 and 2) option not supported.

Definition at line 52 of file openapi_ssh.h.

Function Documentation

open_error_t openapiScpRemoteTransferComplete ( openapiClientHandle_t * client_handle )

To update application about the completion of scp remote file transfer.

Parameters

[in] client_handle Client handle from registration API.

Return values

OPEN_E_NONE	if successfully updated status.
OPEN_E_FAIL	if failed to update status.
OPEN_E_PARAM	if invalid input parameters is passed.

OpEN API Version: 1.14

Examples:: ssh_example.c.

open_error_t openapiScpRemoteTransferStart	(	openapiClientHandle_t *	client_handle,
		int32_t	scpClientPID,
		open_buffdesc *	fileParams
	)

To get the download file complete path and initiate transfer process.

Parameters

[in]	client_handle	Client handle from registration API
[in]	scpClientPID	Process identifier of client
[in,out]	fileParams	file download path.

Return values

OPEN_E_NONE	if file path updated and scp file transfer was successfully initiated.
OPEN_E_FAIL	if failed to start the scp remote file transfer.
OPEN_E_PARAM	if invalid input parameters is passed.

Note: SCP remote file transfer supported for specific files via scp command. Example scp push commands executed on a PC host for configuration and firmware images. scp <config file> user\<scp server ip>:startup-config scp <config file> user\<scp server ip>:backup-config scp <config file> user\<scp server ip>:factory-defaults scp <config file> user\<scp server ip>:<scriptfile.scr> scp <image file> user\<scp server ip>:active scp <image file> user\<scp server ip>:backup; Caller provided fileName should be less than supported length. OPENAPI_FILENAME_LEN_MAX bytes.; Caller must provide a buffer for filename of at least OPENAPI_FILEPATH_LEN_MAX+1 bytes.; Caller must provide a PID of calling process. This identifier shall be used to monitor liveliness of scp client.

OpEN API Version: 1.15

Examples:: ssh_example.c.

open_error_t openapiScpServerAdminModeGet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t *	scpServerAdminMode
	)

Get the SCP server admin mode.

Parameters

[in]	client_handle	Client handle from registration API
[out]	mode	SCP Remote server mode enabled or disabled. Must be one of the following: OPEN_DISABLE or OPEN_ENABLE

Return values

OPEN_E_NONE	if get SCP remote server admin mode status.
OPEN_E_FAIL	if failed to get SCP server admin mode.
OPEN_E_PARAM	if invalid input parameters is passed.

OpEN API Version: 1.14

Examples:: ssh_example.c.

open_error_t openapiScpServerAdminModeSet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t	scpServerAdminMode
	)

Set the SCP server admin mode to initiate file transfer.

Parameters

[in]	client_handle	Client handle from registration API
[in]	scpServerAdminMode	SCP Remote server mode enabled or disabled. Must be one of the following: OPEN_DISABLE or OPEN_ENABLE

Return values

OPEN_E_NONE	if SCP remote server mode status set.
OPEN_E_FAIL	if failed to get SCP server admin mode.
OPEN_E_PARAM	if invalid input parameters is passed.

OpEN API Version: 1.14

Examples:: ssh_example.c.

open_error_t openapiSSHActiveSessionsGet	(	openapiClientHandle_t *	client_handle,
		uint32_t *	sshActiveSessions
	)

Get the active number of SSH sessions.

Parameters

[in]	client_handle	Client handle from registration API
[out]	sshActiveSessions	Active SSH sessions

Return values

OPEN_E_NONE	if the number of active SSH sessions is returned.
OPEN_E_FAIL	if failed to get number of active SSH sessions.
OPEN_E_PARAM	if invalid parameter is passed.

OpEN API Version: 1.1

Examples:: ssh_example.c.

open_error_t openapiSSHAdminModeGet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t *	sshAdminMode
	)

Get the admin mode of SSH.

Parameters

[in]	client_handle	Client handle from registration API
[in]	sshAdminMode	SSH admin mode. Must be one of the following: OPEN_DISABLE or OPEN_ENABLE

Return values

OPEN_E_NONE	if SSH admin mode is returned.
OPEN_E_FAIL	if failed to return SSH admin mode.
OPEN_E_PARAM	if invalid parameter is passed.

OpEN API Version: 1.1

Examples:: ssh_example.c.

open_error_t openapiSSHAdminModeSet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t	sshAdminMode
	)

Set the admin mode of SSH.

Parameters

[in]	client_handle	Client handle from registration API
[in]	sshAdminMode	SSH admin mode. Must be one of the following: OPEN_DISABLE or OPEN_ENABLE

Return values

OPEN_E_NONE	if SSH admin mode is set.
OPEN_E_FAIL	if the RSA and DSA keys are not present.
OPEN_E_PARAM	if invalid parameter is passed.

Note: Calling this API will change the running configuration of the switch.; The API returns OPEN_E_FAIL only for OPEN_ENABLE mode if RSA and DSA keys are not found.

OpEN API Version: 1.1

Examples:: ssh_example.c.

open_error_t openapiSSHKeyDelete	(	openapiClientHandle_t *	client_handle,
		OPEN_SSH_KEY_TYPE_t	sshKeyType
	)

Delete the generated SSH key pairs.

Parameters

[in]	client_handle	Client handle from registration API
[in]	sshKeyType	SSH key type. Must be one of the following: OPEN_SSH_KEY_TYPE_RSA or OPEN_SSH_KEY_TYPE_DSA

Return values

OPEN_E_NONE	if the generated key is deleted.
OPEN_E_FAIL	if SSH admin mode is enabled.
OPEN_E_PARAM	if invalid parameter is passed.

Note: SSH admin mode must be disabled to delete the keys.

OpEN API Version: 1.1

Examples:: ssh_example.c.

open_error_t openapiSSHKeyGenerate	(	openapiClientHandle_t *	client_handle,
		OPEN_SSH_KEY_TYPE_t	sshKeyType
	)

Generate SSH key pairs.

Parameters

[in]	client_handle	Client handle from registration API
[in]	sshKeyType	SSH key type. Must be one of the following: OPEN_SSH_KEY_TYPE_RSA or OPEN_SSH_KEY_TYPE_DSA

Return values

OPEN_E_NONE	if SSH key is generated.
OPEN_E_FAIL	if SSH admin mode is enabled or if key generation is in progress or if failed to generate SSH key.
OPEN_E_PARAM	if invalid parameter is passed.

Note: SSH admin mode must be disabled to regenerate the keys.

OpEN API Version: 1.1

Examples:: ssh_example.c.

open_error_t openapiSSHKeyStatusGet	(	openapiClientHandle_t *	client_handle,
		OPEN_SSH_KEY_TYPE_t	sshKeyType
	)

Check the status of SSH key.

Parameters

[in]	client_handle	Client handle from registration API
[in]	sshKeyType	SSH key type. Must be one of the following: OPEN_SSH_KEY_TYPE_RSA or OPEN_SSH_KEY_TYPE_DSA

Return values

OPEN_E_NONE	if SSH key exists.
OPEN_E_FAIL	if SSH key generation is in progress.
OPEN_E_NOT_FOUND	if SSH key does not exist.
OPEN_E_INTERNAL	if internal error has occurred.
OPEN_E_PARAM	if invalid parameter is passed.

OpEN API Version: 1.1

Examples:: ssh_example.c.

open_error_t openapiSSHLogMessage	(	openapiClientHandle_t *	client_handle,
		OPEN_LOG_SEVERITY_t	severity,
		open_buffdesc *	fileName,
		uint32_t	lineNum,
		open_buffdesc *	msgBuf
	)

Log an SSH message in the log server.

Parameters

[in]	client_handle	Client handle from registration API
[in]	severity	Severity of the log message
[in]	fileName	File name from which the log is generated
[in]	lineNum	Line number in the file generating the log
[in]	msgBuf	Log message buffer

Return values

OPEN_E_NONE	if message is logged.
OPEN_E_PARAM	if invalid parameter is passed.

OpEN API Version: 1.1

open_error_t openapiSSHMaxSessionsDefaultSet ( openapiClientHandle_t * client_handle )

Set the maximum number of allowed SSH sessions to the default.

Parameters

[in] client_handle Client handle from registration API

Return values

OPEN_E_NONE	if maximum number SSH sessions is set to default.
OPEN_E_FAIL	if failed to set maximum SSH sessions to default.
OPEN_E_PARAM	if invalid parameter is passed.

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

OpEN API Version: 1.1

Examples:: ssh_example.c.

open_error_t openapiSSHMaxSessionsGet	(	openapiClientHandle_t *	client_handle,
		uint32_t *	sshMaxSessions
	)

Get the maximum number of SSH sessions allowed.

Parameters

[in]	client_handle	Client handle from registration API
[out]	sshMaxSessions	Maximum number of SSH sessions

Return values

OPEN_E_NONE	if maximum number of SSH sessions is returned.
OPEN_E_PARAM	if invalid parameter is passed.

OpEN API Version: 1.1

Examples:: ssh_example.c.

open_error_t openapiSSHMaxSessionsSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	sshMaxSessions
	)

Set the maximum number of allowed SSH sessions.

Parameters

[in]	client_handle	Client handle from registration API
[in]	sshMaxSessions	Maximum number of SSH sessions

Return values

OPEN_E_NONE	if maximum number of SSH sessions is set.
OPEN_E_FAIL	if failed to set maximum SSH sessions.
OPEN_E_PARAM	if invalid parameter is passed.

Note: The maximum number of sessions can be obtained by using the OpEN API openapiSSHMaxSessionsGet() function.; Calling this API will change the running configuration of the switch.

OpEN API Version: 1.1

Examples:: ssh_example.c.

open_error_t openapiSSHProtocolVersionGet	(	openapiClientHandle_t *	client_handle,
		OPEN_SSH_PROTO_VERSION_t *	protoVersion
	)

Get the SSH protocol version.

Parameters

[in]	client_handle	Client handle from registration API
[out]	protoVersion	SSH protocol version

Return values

OPEN_E_NONE	if SSH protocol version is returned successfully.
OPEN_E_PARAM	if invalid parameter is passed.

OpEN API Version: 1.1

Examples:: ssh_example.c.

open_error_t openapiSSHProtocolVersionSet	(	openapiClientHandle_t *	client_handle,
		OPEN_SSH_PROTO_VERSION_t	protoVersion
	)

Set the SSH protocol version.

Parameters

[in]	client_handle	Client handle from registration API
[in]	protoVersion	SSH protocol version. Must be set to OPEN_SSH_PROTO_VERSION_2

Return values

OPEN_E_NONE	if SSH protocol version is set.
OPEN_E_FAIL	if failed to set SSH protocol version.
OPEN_E_UNAVAIL	SSH protocol version 1 not supported.
OPEN_E_PARAM	if invalid parameter is passed.

Note: Calling this API will change the running configuration of the switch. Only SSH protocol vesion 2 supported. SSH protocol vesion 1 deprecated by OpenSSH7.5p1 version.

OpEN API Version: 1.1

Examples:: ssh_example.c.

open_error_t openapiSSHPubKeyAuthModeGet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t *	sshdPubKeyAuthMode
	)

Get the admin mode of SSH public key.

Parameters

[in]	client_handle	Client handle from registration API
[in]	sshAdminMode	SSH admin mode. Must be one of the following: OPEN_DISABLE or OPEN_ENABLE

Return values

OPEN_E_NONE	if SSH public key mode is returned.
OPEN_E_FAIL	if failed to return SSH public key mode.
OPEN_E_PARAM	if invalid parameter is passed.

OpEN API Version: 1.1

open_error_t openapiSSHPubKeyGet	(	openapiClientHandle_t *	client_handle,
		OPEN_SSH_KEY_TYPE_t	sshKeyType,
		open_buffdesc *	userName,
		open_buffdesc *	pubKey
	)

Get the SSH public key for specified user.

Parameters

[in]	client_handle	Client handle from registration API
[in]	sshKeyType	SSH key type. Must be one of the following: OPEN_SSH_KEY_TYPE_RSA or OPEN_SSH_KEY_TYPE_DSA
[in]	userName	SSH user name supplied by SSH client
[out]	pubKey	SSH public key

Return values

OPEN_E_NONE	if SSH public key is returned.
OPEN_E_FAIL	if failed to return SSH public key.
OPEN_E_PARAM	if invalid parameter is passed.

OpEN API Version: 1.1

open_error_t openapiSSHPublicUserAuthenticate	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	userName,
		open_buffdesc *	ipAddr,
		uint32_t	sshClientID
	)

Authenticate SSH User.

Parameters

[in]	client_handle	Client handle from registration API
[in]	userName	SSH user name supplied by SSH client
[in]	ipAddr	IP address of SSH client
[in]	sshClientID	openSSH client ID

Return values

OPEN_E_NONE	if SSH user exists.
OPEN_E_FAIL	if failed to get the user authenticated session.
OPEN_E_NOT_FOUND	if SSH user does not exist.
OPEN_E_INTERNAL	if internal error has occured.
OPEN_E_PARAM	if invalid parameter is passed.

OpEN API Version: 1.1

open_error_t openapiSSHSessionTimeoutGet	(	openapiClientHandle_t *	client_handle,
		uint32_t *	sshSessionTimeout
	)

Get the SSH session idle timeout value.

Parameters

[in]	client_handle	Client handle from registration API
[out]	sshSessionTimeout	SSH session idle timeout

Return values

OPEN_E_NONE	if SSH idle session timeout is returned successfully.
OPEN_E_FAIL	if failed to get SSH session idle timeout value.
OPEN_E_PARAM	if invalid parameter is passed.

OpEN API Version: 1.1

Examples:: ssh_example.c.

open_error_t openapiSSHSessionTimeoutSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	sshSessionTimeout
	)

Set the SSH session idle timeout.

Parameters

[in]	client_handle	Client handle from registration API
[in]	sshSessionTimeout	SSH session idle timeout
	-	Maximum value OPENAPI_SSHD_MAX_TIMEOUT

Return values

OPEN_E_NONE	if SSH session idle timeout is set.
OPEN_E_FAIL	if failed to set SSH session idle timeout value.
OPEN_E_PARAM	if invalid parameter is passed.

Note: Setting sshSessionTimeout to 0 indicates the default timeout value.; Calling this API will change the running configuration of the switch.

OpEN API Version: 1.1

Examples:: ssh_example.c.

open_error_t openapiSSHSocketInfoClear	(	openapiClientHandle_t *	client_handle,
		uint32_t	sshClientID
	)

Clear socket info entry.

Parameters

[in]	client_handle	Client handle from registration API
[in]	sshClientID	openSSH client ID

Return values

OPEN_E_NONE	if request socket info entry was cleared properly.
OPEN_E_FAIL	if failed to clear requested socket info entry.
OPEN_E_PARAM	if invalid parameter is passed.

OpEN API Version: 1.1

open_error_t openapiSSHTransferRemotePasswordFromUserGet	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	userName,
		open_buffdesc *	password
	)

Get the remote password for the matching remote username used for transfer.

Parameters

[in]	client_handle	Client handle from registration API
[in]	userName	User name for which password is requested
[out]	password	Password of the input User name

Return values

OPEN_E_NONE	if message is logged.
OPEN_E_PARAM	if invalid parameter is passed.

OpEN API Version: 1.1

open_error_t openapiSSHUserAuthenticate	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	userName,
		open_buffdesc *	password,
		open_buffdesc *	ipAddr,
		uint32_t	sshClientID
	)

Authenticate SSH User.

Parameters

[in]	client_handle	Client handle from registration API
[in]	userName	SSH user name supplied by SSH client
[in]	password	SSH user password supplied by SSH client
[in]	ipAddr	IP address of SSH client
[in]	sshClientID	openSSH client ID

Return values

OPEN_E_NONE	if SSH user exists.
OPEN_E_FAIL	if failed to get the user authenticated session.
OPEN_E_NOT_FOUND	if SSH user does not exist.
OPEN_E_INTERNAL	if internal error has occurred.
OPEN_E_PARAM	if invalid parameter is passed.

OpEN API Version: 1.1

Enumerations

Functions

Detailed Description

Enumeration Type Documentation

Function Documentation