- CLASS METHODS
- INSTANCE ATTRIBUTES
- INSTANCE METHODS
- LICENCE AND COPYRIGHT
Net::SSH::Mechanize::ConnectParams - encapsulates information about an ssh connection
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', );
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_paramsmust 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;
sshwill 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
Copyright (c) 2011, Nick Stokoe
<email@example.com>. 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.