1Net::CLI::Interact::TraUnsseprorCto:n:tNreitbN_ueOttpe:ed:nCSPLSeIHr:(l:3I)Dnotceurmaecntt:a:tTiroannsport::Net_OpenSSH(3)
2
3
4

NAME

6       Net::CLI::Interact::Transport::Net_OpenSSH - Net::OpenSSH based CLI
7       connection
8

DESCRIPTION

10       This module provides a wrapped instance of a Net::OpenSSH SSH client
11       object for use by Net::CLI::Interact.
12
13       This allows one to combine the capability of Net::CLI::Interact to talk
14       to remote servers for which Net::OpenSSH one-command-per-session
15       approach is not well suited (i.e. network equipment running custom
16       administration shells) and still use the capability of Net::OpenSSH to
17       run several sessions over one single SSH connection, including
18       accessing SCP and SFTP services.
19
20       Note that this transport is not supported on Windows as Net::OpenSSH is
21       not supported there either.
22

INTERFACE

24   app_and_runtime_options
25       Based on the "connect_options" hash provided to Net::CLI::Interact on
26       construction, selects and formats the command and arguments required to
27       run the SSH session over the Net::OpenSSH connection.
28
29       Under the hood, this method just wraps Net::OpenSSH
30       "make_remote_command" method.
31
32       Supported attributes:
33
34       master
35           Reference to the Net::OpenSSH object wrapping the SSH master
36           connection.
37
38       opts
39           Optional hash of extra options to be forwarded to Net::OpenSSH
40           "make_remote_command" method.
41
42       shell_cmd
43           Remote command to start the shell. Can be a single string or an
44           array reference.
45
46           The default is to pass nothing which on conforming SSH
47           implementations starts the shell configured for the user.
48
49           Examples:
50
51             # interact with default user shell:
52             $s->new({
53                # ...other parameters to new()...
54                connect_options => { master => $ssh },
55             });
56
57             # interact with csh:
58             $s->new({
59                # ...other parameters to new()...
60                connect_options => {
61                    master => $ssh,
62                    shell_cmd => ['csh', '-i'],
63                },
64             });
65
66       reap
67           Only used on Unix platforms, this installs a signal handler which
68           attempts to reap the "ssh" child process. Pass a true value to
69           enable this feature only if you notice zombie processes are being
70           left behind after use.
71

COMPOSITION

73       See the following for further interface details:
74
75       •   Net::CLI::Interact::Transport::Base
76

AUTHORS

78       Oliver Gorwits <oliver@cpan.org> Salvador Fandin~o <sfandino@yahoo.com>
79

81       This software is copyright (c) 2014 by Oliver Gorwits.  This software
82       is copyright (c) 2014 by Salvador Fandin~o.
83
84       This is free software; you can redistribute it and/or modify it under
85       the same terms as the Perl 5 programming language system itself.
86
87
88
89perl v5.34.0                     N2e0t2:2:-C0L1I-:2:1Interact::Transport::Net_OpenSSH(3)
Impressum