.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Net::CLI::Interact::Transport::SSH 3pm"
.TH Net::CLI::Interact::Transport::SSH 3pm "2017-11-08" "perl v5.26.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Net::CLI::Interact::Transport::SSH \- SSH based CLI connection
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module provides a wrapped instance of an \s-1SSH\s0 client for use by
Net::CLI::Interact.
.SH "INTERFACE"
.IX Header "INTERFACE"
.SS "app"
.IX Subsection "app"
On Windows platforms you \fBmust\fR download the \f(CW\*(C`plink.exe\*(C'\fR program, and pass its
location to the library in this parameter. On other platforms, this defaults to
\&\f(CW\*(C`ssh\*(C'\fR (openssh).
.SS "runtime_options"
.IX Subsection "runtime_options"
Based on the \f(CW\*(C`connect_options\*(C'\fR hash provided to Net::CLI::Interact on
construction, selects and formats parameters to provide to \f(CW\*(C`app\*(C'\fR on the
command line. Supported attributes:
.IP "host (required)" 4
.IX Item "host (required)"
Host name or \s-1IP\s0 address of the host to which the \s-1SSH\s0 application is to
connect. Alternatively you can pass a value of the form \f(CW\*(C`user@host\*(C'\fR, but it's
probably better to use the separate \f(CW\*(C`username\*(C'\fR parameter instead.
.IP "username" 4
.IX Item "username"
Optionally pass in the username for the \s-1SSH\s0 connection, otherwise the \s-1SSH\s0
client defaults to the current user's username. When using this option, you
should obviously \fIonly\fR pass the host name to \f(CW\*(C`host\*(C'\fR.
.IP "ignore_host_checks" 4
.IX Item "ignore_host_checks"
Under normal interactive use \f(CW\*(C`openssh\*(C'\fR tracks the identity of connected hosts
and verifies these identities upon each connection. In automation this behaviour
can be irritating because it is interactive.
.Sp
This option, enabled by default, causes \f(CW\*(C`openssh\*(C'\fR to skip or ignore this host
identity verification. This means the default setting is less secure, but also
less likely to trip you up. It is equivalent to the following:
.Sp
.Vb 3
\& StrictHostKeyChecking=no
\& UserKnownHostsFile=/dev/null
\& CheckHostIP=no
.Ve
.Sp
Pass a false value to this option to disable the above and return \f(CW\*(C`openssh\*(C'\fR to
its default configured settings.
.IP "opts" 4
.IX Item "opts"
If you want to pass any other options to openssh on its command line, then use
this option, which should be an array reference. Each item in the list will be
passed to \f(CW\*(C`openssh\*(C'\fR, separated by a single space character. For example:
.Sp
.Vb 9
\& $s\->new({
\&     # ...other parameters to new()...
\&     connect_options => {
\&         opts => [
\&             \*(Aq\-p\*(Aq, \*(Aq222\*(Aq,            # connect to non\-standard port on remote host
\&             \*(Aq\-o\*(Aq, \*(AqCheckHostIP=no\*(Aq, # don\*(Aqt check host IP in known_hosts file
\&         ],
\&     },
\& });
.Ve
.IP "reap" 4
.IX Item "reap"
Only used on Unix platforms, this installs a signal handler which attempts to
reap the \f(CW\*(C`ssh\*(C'\fR child process. Pass a true value to enable this feature only
if you notice zombie processes are being left behind after use.
.SH "COMPOSITION"
.IX Header "COMPOSITION"
See the following for further interface details:
.IP "\(bu" 4
Net::CLI::Interact::Transport::Base