SSH shell backend

Shell access over an SSH connection. More...

Files
file	shell_ssh.h
	Header file for the SSH shell backend.

Data Structures
struct	shell_ssh_passwd
	SSH password storage. More...
struct	shell_ssh_context
	SSH transport user data. More...
struct	shell_ssh
	SSH transport API. More...

Macros
#define	SHELL_SSH_MAX_PASSWORD_LEN   32
	Maximum password length supported by the shell SSH transport.
#define	SHELL_SSH_GET_NAME(_name)
	Helper macro to construct internal symbol names for a shell SSH transport instance.
#define	SHELL_SSH_DEFINE(_name)
	Define a shell SSH transport instance.

Detailed Description

Shell access over an SSH connection.

Macro Definition Documentation

SHELL_SSH_DEFINE

#define SHELL_SSH_DEFINE

(

_name

)

#include <zephyr/shell/shell_ssh.h>

Value:

static struct shell_ssh SHELL_SSH_GET_NAME(_name);      \
static struct shell_transport _name = {                 \
        .api = &shell_ssh_transport_api,                \
        .ctx = &_name##_shell_ssh,                      \
}

Define a shell SSH transport instance.

This macro defines a shell transport backed by SSH. Use it together with SHELL_DEFINE() to create a shell instance that is accessible over SSH.

Parameters

_name

Name of the transport instance. This token is used to construct the internal symbol names.

SHELL_SSH_GET_NAME

#define SHELL_SSH_GET_NAME

(

_name

)

#include <zephyr/shell/shell_ssh.h>

Value:

_name##_shell_ssh

Helper macro to construct internal symbol names for a shell SSH transport instance.

SHELL_SSH_MAX_PASSWORD_LEN

#define SHELL_SSH_MAX_PASSWORD_LEN   32

#include <zephyr/shell/shell_ssh.h>

Maximum password length supported by the shell SSH transport.