.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" 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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    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
.\" ========================================================================
.\"
.IX Title "App::ClusterSSH::Host 3pm"
.TH App::ClusterSSH::Host 3pm 2024-07-12 "perl v5.38.2" "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 IP address (either IPv4 or IPv6) 
attempt to resolve it and retun 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 \fR\f(CI$HOME\fR\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