libssh2_session_banner_set
(3ssh2)
Name
libssh2_session_banner_set - set the SSH protocol banner for the local
client
Synopsis
#include <libssh2.h>
int libssh2_session_banner_set(LIBSSH2_SESSION *session, const char
*banner);
Description
libssh2 manual libssh2_session_banner_set(3ssh2)
NAME
libssh2_session_banner_set - set the SSH protocol banner for the local
client
SYNOPSIS
#include <libssh2.h>
int libssh2_session_banner_set(LIBSSH2_SESSION *session, const char
*banner);
DESCRIPTION
session - Session instance as returned by libssh2_session_init_ex(3)
banner - A pointer to a zero-terminated string holding the user defined
banner
Set the banner that will be sent to the remote host when the SSH ses-
sion is started with libssh2_session_handshake(3) This is optional; a
banner corresponding to the protocol and libssh2 version will be sent
by default.
RETURN VALUE
Returns 0 on success or negative on failure. It returns LIB-
SSH2_ERROR_EAGAIN when it would otherwise block. While LIB-
SSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per
se.
ERRORS
LIBSSH2_ERROR_ALLOC - An internal memory allocation call failed.
AVAILABILITY
Added in 1.4.0.
Before 1.4.0 this function was known as libssh2_banner_set(3)
ATTRIBUTES
See attributes(7) for descriptions of the following attributes:
+---------------+------------------+
|ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+---------------+------------------+
|Availability | library/libssh2 |
+---------------+------------------+
|Stability | Uncommitted |
+---------------+------------------+
SEE ALSO
libssh2_session_handshake(3), libssh2_session_banner_get(3)
NOTES
Source code for open source software components in Oracle Solaris can
be found at https://www.oracle.com/downloads/opensource/solaris-source-
code-downloads.html.
This software was built from source available at
https://github.com/oracle/solaris-userland. The original community
source was downloaded from https://www.libssh2.org/download/lib-
ssh2-1.10.0.tar.gz.
Further information about this software can be found on the open source
community website at https://www.libssh2.org/.
libssh2 1.4.0 9 Sep 2011
libssh2_session_banner_set(3ssh2)