Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Contact Us
Online Help
Domain Status
Man Pages

Virtual Servers

Topology Map

Server Agreement
Year 2038

USA Flag



Man Pages
Net::SSH::Mechanize::ConnectParams(3) User Contributed Perl Documentation Net::SSH::Mechanize::ConnectParams(3)

Net::SSH::Mechanize::ConnectParams - encapsulates information about an ssh connection

version 0.1.3

This class is just a container for log-in details with a method which constructs an approprate "ssh" command invocation.
This equates to "/usr/bin/ssh -t sh":
    my $minimal_params = Net::SSH::Mechanize::ConnectParams->new(
        host => '',
This equates to "/usr/bin/ssh -l someone -p 999 -t sh":
    my $all_params = Net::SSH::Mechanize::ConnectParams->new(
        host => '',
        user => 'someone',
        port => 999,
        password => 'secret',

Creates a new instance. Parameters is a hash or a list of key-value parameters. Valid parameter keys are:
The hostname to connect to (a scalar string). Either this or "connection_params" must be supplied.
The name of the user account to log into (a scalar string). If not given, no user will be supplied to "ssh" (this typically means it will use the current user as default).
The port to connect to (a positive scalar integer; "ssh" will default to 22 if this is not specificed).
The password to connect with (a scalar string). This is only required if authentication will be performed, either on log-in or when sudoing.

These are all read-write accessors for the attribute parameters accepted by the constructor.

This constructs the "ssh" command to invoke. If you need something different, you can create a subclass which overrides this method, and pass that via the "connection_params" parameter to "Net::SSH::Mechanize->new()".

Nick Stokoe "<>"

Copyright (c) 2011, Nick Stokoe "<>". All rights reserved.
This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perlartistic.
2019-01-02 perl v5.28.1

Search for    or go to Top of page |  Section 3 |  Main Index

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.