1Net::CLI::Interact::TraUnsseprorCto:n:tSrSiHb(u3t)ed PerNletD:o:cCuLmIe:n:tIanttieornact::Transport::SSH(3)
2
3
4
6 Net::CLI::Interact::Transport::SSH - SSH based CLI connection
7
9 This module provides a wrapped instance of an SSH client for use by
10 Net::CLI::Interact.
11
13 app
14 On Windows platforms you must download the "plink.exe" program, and
15 pass its location to the library in this parameter. On other platforms,
16 this defaults to "ssh" (openssh).
17
18 runtime_options
19 Based on the "connect_options" hash provided to Net::CLI::Interact on
20 construction, selects and formats parameters to provide to "app" on the
21 command line. Supported attributes:
22
23 host (required)
24 Host name or IP address of the host to which the SSH application is
25 to connect. Alternatively you can pass a value of the form
26 "user@host", but it's probably better to use the separate
27 "username" parameter instead.
28
29 username
30 Optionally pass in the username for the SSH connection, otherwise
31 the SSH client defaults to the current user's username. When using
32 this option, you should obviously only pass the host name to
33 "host".
34
35 ignore_host_checks
36 Under normal interactive use "openssh" tracks the identity of
37 connected hosts and verifies these identities upon each connection.
38 In automation this behaviour can be irritating because it is
39 interactive.
40
41 This option, enabled by default, causes "openssh" to skip or ignore
42 this host identity verification. This means the default setting is
43 less secure, but also less likely to trip you up. It is equivalent
44 to the following:
45
46 StrictHostKeyChecking=no
47 UserKnownHostsFile=/dev/null
48 CheckHostIP=no
49
50 Pass a false value to this option to disable the above and return
51 "openssh" to its default configured settings.
52
53 opts
54 If you want to pass any other options to openssh on its command
55 line, then use this option, which should be an array reference.
56 Each item in the list will be passed to "openssh", separated by a
57 single space character. For example:
58
59 $s->new({
60 # ...other parameters to new()...
61 connect_options => {
62 opts => [
63 '-p', '222', # connect to non-standard port on remote host
64 '-o', 'CheckHostIP=no', # don't check host IP in known_hosts file
65 ],
66 },
67 });
68
69 reap
70 Only used on Unix platforms, this installs a signal handler which
71 attempts to reap the "ssh" child process. Pass a true value to
72 enable this feature only if you notice zombie processes are being
73 left behind after use.
74
76 See the following for further interface details:
77
78 ยท Net::CLI::Interact::Transport::Base
79
80
81
82perl v5.30.0 2019-07-N2e6t::CLI::Interact::Transport::SSH(3)