Ssh2Connections::AbstractSsh2Connection Class Reference

abstract base class for ssh module connections More...

#include <Ssh2Connections.qm.dox.h>

Inheritance diagram for Ssh2Connections::AbstractSsh2Connection:

Public Member Methods
void	constructor (string url, hash< auto > attributes, string name, string description, hash< auto > options)
	creates the AbstractSsh2Connection object
void	constructor (hash< auto > config, soft< hash< auto > > attr)
	Creates the AbstractSsh2Connection object.

Detailed Description

abstract base class for ssh module connections

supports the following option:

• "keyfile": a path to a private key file in PEM format to use for key-based authentication

Member Function Documentation

constructor() [1/2]

void Ssh2Connections::AbstractSsh2Connection::constructor	(	hash< auto >	config,
		soft< hash< auto > >	attr
	)

Creates the AbstractSsh2Connection 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]

void Ssh2Connections::AbstractSsh2Connection::constructor	(	string	url,
		hash< auto >	attributes,
		string	name,
		string	description,
		hash< auto >	options
	)

creates the AbstractSsh2Connection 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.

---

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

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