Ssh2Connections::Ssh2ClientConnection Class Reference

class for SSH2 client session connections; returns an object of class Qore::SSH2::SSH2Client More...

#include <Ssh2Connections.qm.dox.h>

Inheritance diagram for Ssh2Connections::Ssh2ClientConnection:

Public Member Methods
	constructor (string name, string description, string url, hash< auto > attributes={}, hash< auto > options={})
	creates the Ssh2ClientConnection object
	constructor (hash< auto > config, *hash< auto > attr)
	Creates the Ssh2ClientConnection object.
string	getType ()
	returns "ssh2"
Public Member Methods inherited from Ssh2Connections::AbstractSsh2Connection
	constructor (string name, string description, string url, hash< auto > attributes={}, hash< auto > options={})
	creates the AbstractSsh2Connection object
	constructor (hash< auto > config, *hash< auto > attr)
	Creates the AbstractSsh2Connection object.

Public Attributes
const	ConnectionScheme = ...
	Connection entry info.

Private Member Methods
Qore::SSH2::SSH2Client	getImpl (bool connect=True, *hash< auto > rtopts)
	returns a Qore::SSH2::SSH2Client object
hash< ConnectionSchemeInfo >	getConnectionSchemeInfoImpl ()
	Returns the ConnectionSchemeInfo hash for this object.

Detailed Description

class for SSH2 client session connections; returns an object of class Qore::SSH2::SSH2Client

supports the following option:

• "keyfile": a path to a private key file in PEM format to use for key-based authentication (environment variables can be prefixed with "$" in the path (or optionally enclosed in curly brackets as in "${var}") and will be substituted with the value of the environment variable)

Member Function Documentation

constructor() [1/2]

Ssh2Connections::Ssh2ClientConnection::constructor	(	hash< auto >	config,
		*hash< auto >	attr
	)

Creates the Ssh2ClientConnection object.

Parameters

config

with the following keys: name (required string): the connection name display_name (optional string): the display name short_desc (optional string): a short description in plain text desc (optional string): a long description with markdown formatting url (required string): the connection URL opts (optional hash): connection options logger (optional LoggerInterface object): logger for the connection

attr

optional connection attributes monitor (optional bool): should the connection be monitored? Default: True enabled (optional bool): is the connection enabled? Default: True locked (optional bool): is the connection locked? Default: False debug_data (optional bool): debug data? Default: False tags (optional hash): tags for the connection; no default value

Exceptions

CONNECTION-OPTION-ERROR

missing or invalid connection option or attribute

constructor() [2/2]

Ssh2Connections::Ssh2ClientConnection::constructor	(	string	name,
		string	description,
		string	url,
		hash< auto >	attributes = {},
		hash< auto >	options = {}
	)

creates the Ssh2ClientConnection object

Parameters

name	the name of the connection
description	connection description
url	connection URL (potentially with password info)
attributes	various attributes. See below
options	connection options

See AbstractConnection::constructor() for attributes and options reference.

getImpl()

Qore::SSH2::SSH2Client Ssh2Connections::Ssh2ClientConnection::getImpl ( bool  connect = True, *hash< auto >  rtopts  )

private

returns a Qore::SSH2::SSH2Client object

Parameters

connect	if True, then Qore::SSH2::SSH2Client::connect() is called
rtopts	this connection type does not accept any runtime options, so this parameter is ignored

Returns

a Qore::SSH2::SSH2Client object

---

The documentation for this class was generated from the following file:

• doxygen/qlib/Ssh2Connections/Ssh2Connections.qm.dox.h