SSH Client Library

Functions
int	ssh_client_start (struct ssh_client *ssh, const char *user_name, const struct net_sockaddr *addr, int host_key_index, ssh_transport_event_callback_t callback, void *user_data)
	Start an SSH client connection.
int	ssh_client_stop (struct ssh_client *ssh)
	Stop an SSH client connection.

Detailed Description

Since

4.5

Version

0.1.0

Function Documentation

ssh_client_start()

int ssh_client_start	(	struct ssh_client *	ssh,
		const char *	user_name,
		const struct net_sockaddr *	addr,
		int	host_key_index,
		ssh_transport_event_callback_t	callback,
		void *	user_data )

#include <zephyr/net/ssh/client.h>

Start an SSH client connection.

Parameters

ssh	SSH client instance
user_name	Username to use for authentication
addr	Address of the SSH server to connect to
host_key_index	Index of the host key to use for verifying the server's identity
callback	Callback to be called on SSH transport events
user_data	User data to be passed to the callback

Returns

0 on success, negative error code on failure

ssh_client_stop()

int ssh_client_stop

(

struct ssh_client *

ssh

)

#include <zephyr/net/ssh/client.h>

Stop an SSH client connection.

Parameters

ssh	SSH client instance

Returns

0 on success, negative error code on failure