GSP
Quick Navigator

Search Site

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

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  NET::SSH::MECHANIZE::CONNECTPARAMS (3)

.ds Aq ’

NAME

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

CONTENTS

VERSION

version 0.1.3

SYNOPSIS

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 somewhere.com sh:



    my $minimal_params = Net::SSH::Mechanize::ConnectParams->new(
        host => somewhere.com,
    );



This equates to /usr/bin/ssh -l someone -p 999 -t somewhere.com sh:



    my $all_params = Net::SSH::Mechanize::ConnectParams->new(
        host => somewhere.com,
        user => someone,
        port => 999,
        password => secret,
    );



CLASS METHODS

CW$obj = $class->new(%parameters)

Creates a new instance. Parameters is a hash or a list of key-value parameters. Valid parameter keys are:
host The hostname to connect to (a scalar string). Either this or connection_params must be supplied.
user 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).
port The port to connect to (a positive scalar integer; ssh will default to 22 if this is not specificed).
password The password to connect with (a scalar string). This is only required if authentication will be performed, either on log-in or when sudoing.

INSTANCE ATTRIBUTES

CW$obj->host =head2 CW$obj->user =head2 CW$obj->password =head2 CW$obj->port

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

INSTANCE METHODS

CW$cmd = $obj->ssh_cmd

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().

AUTHOR

Nick Stokoe <wulee@cpan.org>

LICENCE AND COPYRIGHT

Copyright (c) 2011, Nick Stokoe <wulee@cpan.org>. 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.

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


perl v5.20.3 NET::SSH::MECHANIZE::CONNECTPARAMS (3) 2016-04-03

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