:orphan:

.. index:: pair: struct; tapi_ssh_client_opt
.. _doxid-structtapi__ssh__client__opt:

struct tapi_ssh_client_opt
==========================

.. toctree::
	:hidden:

Overview
~~~~~~~~

OpenSSH client specific options :ref:`More...<details-structtapi__ssh__client__opt>`


.. ref-code-block:: cpp
	:class: doxyrest-overview-code-block

	#include <tapi_ssh.h>
	
	struct tapi_ssh_client_opt {
		// fields
	
		char* :ref:`path<doxid-structtapi__ssh__client__opt_1aaf969a440ebf2c225c262a53723bdae7>`;
		bool :ref:`gateway_ports<doxid-structtapi__ssh__client__opt_1ad29a084558fd25044f1be0a459976bdc>`;
		char* :ref:`local_port_forwarding<doxid-structtapi__ssh__client__opt_1a26b4e27530acd5d50f6dc3d8789f9595>`;
		bool :ref:`forbid_remote_commands_execution<doxid-structtapi__ssh__client__opt_1a8c022b60a8597f907293aeb93f7f16f0>`;
		char* :ref:`identity_file<doxid-structtapi__ssh__client__opt_1a6ef069d32787fec927e80f1c25ece0cc>`;
		char* :ref:`login_name<doxid-structtapi__ssh__client__opt_1a60ef9a32d9f738a64c196811d76f1609>`;
		:ref:`tapi_ssh_strict_host_key_checking_t<doxid-group__tapi__ssh_1gad459d1324e1194aceef763a4ff67920e>` :ref:`strict_host_key_checking<doxid-structtapi__ssh__client__opt_1af38cb3dda101c4e92fc0ae4998c2d88c>`;
		char* :ref:`user_known_hosts_file<doxid-structtapi__ssh__client__opt_1a5f29a50c99fc3e2aaca5c2705e8744f6>`;
		unsigned int :ref:`port<doxid-structtapi__ssh__client__opt_1a4b1180ad089c3e3afc9d356e43db46e4>`;
		char* :ref:`remote_port_forwarding<doxid-structtapi__ssh__client__opt_1a81a9dfef93412e00efbde0abe08c6733>`;
		char* :ref:`destination<doxid-structtapi__ssh__client__opt_1a77200b2bc348fa360d3786bd070aac3f>`;
		char* :ref:`command<doxid-structtapi__ssh__client__opt_1a2f0f72d62ce13aaf9c3317eca3a73d74>`;
	};
.. _details-structtapi__ssh__client__opt:

Detailed Documentation
~~~~~~~~~~~~~~~~~~~~~~

OpenSSH client specific options

Fields
------

.. index:: pair: variable; path
.. _doxid-structtapi__ssh__client__opt_1aaf969a440ebf2c225c262a53723bdae7:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	char* path

Path to ssh binary

.. index:: pair: variable; gateway_ports
.. _doxid-structtapi__ssh__client__opt_1ad29a084558fd25044f1be0a459976bdc:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	bool gateway_ports

Allow remote hosts to connect to local forwarded ports.

.. ref-code-block:: cpp

	ssh -g

.. index:: pair: variable; local_port_forwarding
.. _doxid-structtapi__ssh__client__opt_1a26b4e27530acd5d50f6dc3d8789f9595:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	char* local_port_forwarding

String representation of connection to the given TCP port or Unix socket on the local (client) host has to be forwarded to the given host and port, or Unix socket, on the remote side.

.. ref-code-block:: cpp

	ssh -L <local_port_forwarding>

.. index:: pair: variable; forbid_remote_commands_execution
.. _doxid-structtapi__ssh__client__opt_1a8c022b60a8597f907293aeb93f7f16f0:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	bool forbid_remote_commands_execution

Do not execute a remote command. This is useful for just forwarding ports.



.. ref-code-block:: cpp

	ssh -N

.. index:: pair: variable; identity_file
.. _doxid-structtapi__ssh__client__opt_1a6ef069d32787fec927e80f1c25ece0cc:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	char* identity_file

File with identity (private key) for public key authentication

.. ref-code-block:: cpp

	ssh -i <identity_file>

.. index:: pair: variable; login_name
.. _doxid-structtapi__ssh__client__opt_1a60ef9a32d9f738a64c196811d76f1609:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	char* login_name

The user to log in on the remote machine

.. ref-code-block:: cpp

	ssh -l <login_name>

.. index:: pair: variable; strict_host_key_checking
.. _doxid-structtapi__ssh__client__opt_1af38cb3dda101c4e92fc0ae4998c2d88c:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`tapi_ssh_strict_host_key_checking_t<doxid-group__tapi__ssh_1gad459d1324e1194aceef763a4ff67920e>` strict_host_key_checking

Sets up extra confirmation during connection to unknown host

If StrictHostKeyChecking=yes and host to connect is unknown, the user is required to explicitly confirm connection to the host by answering the question: "Are you sure you want to continue connecting
(yes/no/[fingerprint])?"



.. ref-code-block:: cpp

	ssh -o StrictHostKeyChecking=<:ref:`strict_host_key_checking <doxid-structtapi__ssh__client__opt_1af38cb3dda101c4e92fc0ae4998c2d88c>`>

May be ``yes``, ``no``, ``accept-new``

.. index:: pair: variable; user_known_hosts_file
.. _doxid-structtapi__ssh__client__opt_1a5f29a50c99fc3e2aaca5c2705e8744f6:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	char* user_known_hosts_file

File to store known hosts keys

.. ref-code-block:: cpp

	ssh -o UserKnownHostsFile=<:ref:`user_known_hosts_file <doxid-structtapi__ssh__client__opt_1a5f29a50c99fc3e2aaca5c2705e8744f6>`>

.. index:: pair: variable; port
.. _doxid-structtapi__ssh__client__opt_1a4b1180ad089c3e3afc9d356e43db46e4:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	unsigned int port

Remote host port to connect

.. ref-code-block:: cpp

	ssh -p <port>

.. index:: pair: variable; remote_port_forwarding
.. _doxid-structtapi__ssh__client__opt_1a81a9dfef93412e00efbde0abe08c6733:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	char* remote_port_forwarding

String representation of connection to the given TCP port or Unix socket on the remote (server) host has to be forwarded to the local side.

.. ref-code-block:: cpp

	ssh -R <remote_port_forwarding>

.. index:: pair: variable; destination
.. _doxid-structtapi__ssh__client__opt_1a77200b2bc348fa360d3786bd070aac3f:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	char* destination

Server to connect to

.. index:: pair: variable; command
.. _doxid-structtapi__ssh__client__opt_1a2f0f72d62ce13aaf9c3317eca3a73d74:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	char* command

Command to be executed on the server