.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" 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
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" 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 "App::ClusterSSH::Host 3pm"
.TH App::ClusterSSH::Host 3pm "2021-02-02" "perl v5.32.0" "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 "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    use ClusterSSH::Host;
\&
\&    my $host = ClusterSSH::Host\->new({
\&        hostname => \*(Aqhostname\*(Aq,
\&    });
\&    my $host = ClusterSSH::Host\->parse_host_string(\*(Aqusername@hostname:1234\*(Aq);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Object representing a host.  Include details to contact the host such as
hostname/ipaddress, username and port.
.SH "METHODS"
.IX Header "METHODS"
.ie n .IP "$host=ClusterSSH::Host\->new ({ hostname => 'hostname' })" 4
.el .IP "\f(CW$host\fR=ClusterSSH::Host\->new ({ hostname => 'hostname' })" 4
.IX Item "$host=ClusterSSH::Host->new ({ hostname => 'hostname' })"
Create a new host object.  'hostname' is a required arg, 'username' and 
\&'port' are optional.  Raises exception if an error occurs.
.ie n .IP "$host\->get_hostname" 4
.el .IP "\f(CW$host\fR\->get_hostname" 4
.IX Item "$host->get_hostname"
.PD 0
.ie n .IP "$host\->get_username" 4
.el .IP "\f(CW$host\fR\->get_username" 4
.IX Item "$host->get_username"
.ie n .IP "$host\->get_port" 4
.el .IP "\f(CW$host\fR\->get_port" 4
.IX Item "$host->get_port"
.ie n .IP "$host\->get_master" 4
.el .IP "\f(CW$host\fR\->get_master" 4
.IX Item "$host->get_master"
.ie n .IP "$host\->get_geometry" 4
.el .IP "\f(CW$host\fR\->get_geometry" 4
.IX Item "$host->get_geometry"
.ie n .IP "$host\->get_type" 4
.el .IP "\f(CW$host\fR\->get_type" 4
.IX Item "$host->get_type"
.PD
Return specific details about the host
.ie n .IP "$host\->set_username" 4
.el .IP "\f(CW$host\fR\->set_username" 4
.IX Item "$host->set_username"
.PD 0
.ie n .IP "$host\->set_port" 4
.el .IP "\f(CW$host\fR\->set_port" 4
.IX Item "$host->set_port"
.ie n .IP "$host\->set_master" 4
.el .IP "\f(CW$host\fR\->set_master" 4
.IX Item "$host->set_master"
.ie n .IP "$host\->set_geometry" 4
.el .IP "\f(CW$host\fR\->set_geometry" 4
.IX Item "$host->set_geometry"
.ie n .IP "$host\->set_type" 4
.el .IP "\f(CW$host\fR\->set_type" 4
.IX Item "$host->set_type"
.PD
Set specific details about the host after its been created.
.IP "get_realname" 4
.IX Item "get_realname"
If the server name provided is not an \s-1IP\s0 address (either IPv4 or IPv6) 
attempt to resolve it and return the discovered names.
.IP "get_givenname" 4
.IX Item "get_givenname"
Alias to get_hostname, for use when \f(CW\*(C` get_realname \*(C'\fR might return something
different
.IP "parse_host_string" 4
.IX Item "parse_host_string"
Given a host string, returns a host object.  Parses hosts such as
.IP "check_ssh_hostname" 4
.IX Item "check_ssh_hostname"
Check the objects hostname to see whether or not it may be configured within 
the users \fI \f(CI$HOME\fI/.ssh/config \fR configuration file
.IP "read_ssh_file" 4
.IX Item "read_ssh_file"
Method to ease reading in ssh configuration files.  Used for grabbing
hostnames for validation when used in clusters
.RS 4
.IP "host" 4
.IX Item "host"
.PD 0
.IP "192.168.0.1" 4
.IX Item "192.168.0.1"
.IP "user@host" 4
.IX Item "user@host"
.IP "user@192.168.0.1" 4
.IX Item "user@192.168.0.1"
.IP "host:port" 4
.IX Item "host:port"
.IP "[1234:1234:1234::4567]:port" 4
.IX Item "[1234:1234:1234::4567]:port"
.IP "1234:1234:1234::4567" 4
.IX Item "1234:1234:1234::4567"
.RE
.RS 4
.PD
.Sp
and so on.  Cope with IPv4 and IPv6 addresses \- raises a warning if the
IPv6 address is ambiguous (i.e. in the last example, is the 4567 part of
the IPv6 address or a port definition?) and assumes it is part of address.
Use brackets to avoid seeing warning.
.RE