.\" -*- 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::Cluster 3pm" .TH App::ClusterSSH::Cluster 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" .SH DESCRIPTION .IX Header "DESCRIPTION" Object representing application configuration .SH METHODS .IX Header "METHODS" .ie n .IP $cluster=ClusterSSH::Cluster\->\fBnew()\fR; 4 .el .IP \f(CW$cluster\fR=ClusterSSH::Cluster\->\fBnew()\fR; 4 .IX Item "$cluster=ClusterSSH::Cluster->new();" Create a new object. Object should be common across all invocations. .ie n .IP $cluster\->get_cluster_entries($filename); 4 .el .IP \f(CW$cluster\fR\->get_cluster_entries($filename); 4 .IX Item "$cluster->get_cluster_entries($filename);" Read in /etc/clusters, \f(CW$HOME\fR/.clusterssh/clusters and any other given file name and register the tags found. .ie n .IP @external_tags=\fBlist_external_clusters()\fR 4 .el .IP \f(CW@external_tags\fR=\fBlist_external_clusters()\fR 4 .IX Item "@external_tags=list_external_clusters()" Call an external script suing \f(CW\*(C`\-L\*(C'\fR to list available tags .ie n .IP @resolved_tags=get_external_clusters(@tags) 4 .el .IP \f(CW@resolved_tags\fR=get_external_clusters(@tags) 4 .IX Item "@resolved_tags=get_external_clusters(@tags)" Use an external script to resolve \f(CW@tags\fR into hostnames. .ie n .IP $cluster\->get_tag_entries($filename); 4 .el .IP \f(CW$cluster\fR\->get_tag_entries($filename); 4 .IX Item "$cluster->get_tag_entries($filename);" Read in /etc/tags, \f(CW$HOME\fR/.clusterssh/tags and any other given file name and register the tags found. .ie n .IP $cluster\->read_cluster_file($filename); 4 .el .IP \f(CW$cluster\fR\->read_cluster_file($filename); 4 .IX Item "$cluster->read_cluster_file($filename);" Read in the given cluster file and register the tags found .ie n .IP $cluster\->expand_filename($filename); 4 .el .IP \f(CW$cluster\fR\->expand_filename($filename); 4 .IX Item "$cluster->expand_filename($filename);" Expand ~ or \f(CW$HOME\fR in a filename .ie n .IP $cluster\->read_tag_file($filename); 4 .el .IP \f(CW$cluster\fR\->read_tag_file($filename); 4 .IX Item "$cluster->read_tag_file($filename);" Read in the given tag file and register the tags found .ie n .IP $cluster\->register_tag($tag,@hosts); 4 .el .IP \f(CW$cluster\fR\->register_tag($tag,@hosts); 4 .IX Item "$cluster->register_tag($tag,@hosts);" Register the given tag name with the given host names. .ie n .IP $cluster\->register_host($host,@tags); 4 .el .IP \f(CW$cluster\fR\->register_host($host,@tags); 4 .IX Item "$cluster->register_host($host,@tags);" Register the given host on the provided tags. .ie n .IP "@entries = $cluster\->get_tag('tag');" 4 .el .IP "\f(CW@entries\fR = \f(CW$cluster\fR\->get_tag('tag');" 4 .IX Item "@entries = $cluster->get_tag('tag');" .PD 0 .ie n .IP "$entries = $cluster\->get_tag('tag');" 4 .el .IP "\f(CW$entries\fR = \f(CW$cluster\fR\->get_tag('tag');" 4 .IX Item "$entries = $cluster->get_tag('tag');" .PD Retrieve all entries for the given tag. Returns an array of hosts or the number of hosts in the array depending on context. .ie n .IP "@tags = $cluster\->\fBlist_tags()\fR;" 4 .el .IP "\f(CW@tags\fR = \f(CW$cluster\fR\->\fBlist_tags()\fR;" 4 .IX Item "@tags = $cluster->list_tags();" Return an array of all available tag names .ie n .IP "%tags = $cluster\->\fBdump_tags()\fR;" 4 .el .IP "\f(CW%tags\fR = \f(CW$cluster\fR\->\fBdump_tags()\fR;" 4 .IX Item "%tags = $cluster->dump_tags();" Returns a hash of all tag data. .ie n .IP "@tags = $cluster\->expand_glob( $type, $name, @items );" 4 .el .IP "\f(CW@tags\fR = \f(CW$cluster\fR\->expand_glob( \f(CW$type\fR, \f(CW$name\fR, \f(CW@items\fR );" 4 .IX Item "@tags = $cluster->expand_glob( $type, $name, @items );" Use shell expansion against each item in \f(CW@items\fR, where \f(CW$type\fR is either 'node', or 'tag' and \f(CW$name\fR is the node or tag name. These attributes are presented to the user in the event of an issue with the expanion to track down the source.