add manpage for xdshcoll, fix sinv manpage and fix xcoll manpage
git-svn-id: https://svn.code.sf.net/p/xcat/code/xcat-core/trunk@3225 8638fb3e-16cb-4fca-ae20-7b5d299a9bcd
This commit is contained in:
lissav
parent
a58f0df77b
commit
fd415df59c
@ -29,7 +29,7 @@ The xdsh or rinv command to execute on the remote targets is specified by the
|
||||
which is followed by the fully qualified path to a file containing the command.
|
||||
|
||||
|
||||
Note: do not add | xcoll to the command on the command line or in the
|
||||
Note: do not add | xdshcoll to the command on the command line or in the
|
||||
command file, it is automatically added by sinv.
|
||||
|
||||
The syntax for the B<-c> B<sinv> parameter is as follows:
|
||||
@ -68,7 +68,7 @@ that contains the configuration that you would like
|
||||
all nodes in your noderange to match.
|
||||
|
||||
The admin can create the template by running the xdsh command on
|
||||
the seed node, pipe to xcoll ( required) and store the output
|
||||
the seed node, pipe to xdshcoll ( required) and store the output
|
||||
in the template path. See examples.
|
||||
|
||||
B<Note:> The admin can also edit the
|
||||
@ -123,7 +123,7 @@ configuration.
|
||||
This requires the check of node output against template to be an exact match.
|
||||
If this flag is not set, B<sinv> checks to see if the return from the
|
||||
xdsh command to the nodes contain a match for each line in the input
|
||||
template (except for xcoll header and comments). If not in exactmatch mode,
|
||||
template (except for xdshcoll header and comments). If not in exactmatch mode,
|
||||
there can exist more lines in the xdsh return from the nodes.
|
||||
|
||||
For example, if running a "rpm -qa | grep xCAT" command, without exactmatch
|
||||
@ -137,7 +137,7 @@ to the template.
|
||||
The xdsh or rinv command that will be run. The command should be enclosed in
|
||||
double quotes to insure correct shell interpretation.
|
||||
|
||||
B<Note:> do not add the | xcoll to the command,
|
||||
B<Note:> do not add the | xdshcoll to the command,
|
||||
it is automatically added by sinv.
|
||||
|
||||
=item B<-f>|B<--file>
|
||||
@ -145,7 +145,7 @@ it is automatically added by sinv.
|
||||
The file containing the xdsh or rinv command that will be run.
|
||||
This should be the fully qualified name of the file.
|
||||
|
||||
B<Note:> do not add the | xcoll to the command in the file,
|
||||
B<Note:> do not add the | xdshcoll to the command in the file,
|
||||
it is automatically added by sinv.
|
||||
|
||||
=item B<-r>|B<--remove>
|
||||
@ -184,19 +184,19 @@ Verbose mode.
|
||||
|
||||
To setup sinv.template (name optional) for input to the B<sinv> command , enter:
|
||||
|
||||
B<xdsh> I<node1,node2 "rpm -qa | grep xCAT " | xcoll E<gt> /tmp/sinv.template>
|
||||
B<xdsh> I<node1,node2 "rpm -qa | grep xCAT " | xdshcoll E<gt> /tmp/sinv.template>
|
||||
|
||||
Note: when setting up the template the output of xdsh must be piped
|
||||
to xcoll, sinv processing depends on it.
|
||||
to xdshcoll, sinv processing depends on it.
|
||||
|
||||
=item *
|
||||
|
||||
To setup rinv.template for input to the B<sinv> command , enter:
|
||||
|
||||
B<rinv> I<node1-node2 serial | xcoll E<gt> /tmp/rinv.template>
|
||||
B<rinv> I<node1-node2 serial | xdshcoll E<gt> /tmp/rinv.template>
|
||||
|
||||
Note: when setting up the template the output of rinv must be piped
|
||||
to xcoll, sinv processing depends on it.
|
||||
to xdshcoll, sinv processing depends on it.
|
||||
|
||||
=item *
|
||||
|
||||
@ -207,7 +207,7 @@ output report to /tmp/sinv.output, enter:
|
||||
|
||||
B<sinv> I< -c "xdsh testnodes rpm -qa | grep xCAT" -p /tmp/sinv.template -t 2 -r -o /tmp/sinv.output>
|
||||
|
||||
Note: do not add the pipe to xcoll on the -c flag, it is automatically
|
||||
Note: do not add the pipe to xdshcoll on the -c flag, it is automatically
|
||||
added by the sinv routine.
|
||||
|
||||
=item *
|
||||
@ -251,4 +251,4 @@ Location of the sinv command.
|
||||
|
||||
=head1 B<SEE ALSO>
|
||||
|
||||
L <xdsh(1)|xdsh.1>, L<xcoll(1)|xcoll.1>, L<noderange(3)|noderange.3>
|
||||
L <xdsh(1)|xdsh.1>, L<noderange(3)|noderange.3>
|
||||
|
||||
@ -11,14 +11,14 @@ B<xcoll>
|
||||
The B<xcoll> command formats and consolidates output from the B<psh,rinv,sinv> command. The B<xcoll>
|
||||
command takes, as input, lines in the following format:
|
||||
|
||||
host_name: line of output from remote command
|
||||
groupname: line of output from remote command, will use group name, if defined
|
||||
|
||||
The B<xcoll> command formats the lines as follows and writes them to
|
||||
standard output. Assume that the output from node3 and node4
|
||||
is identical:
|
||||
|
||||
====================================
|
||||
node1
|
||||
node1 or nodegroup name
|
||||
====================================
|
||||
.
|
||||
.
|
||||
@ -27,7 +27,7 @@ is identical:
|
||||
.
|
||||
|
||||
====================================
|
||||
node2
|
||||
node2 or nodegroup name
|
||||
====================================
|
||||
.
|
||||
.
|
||||
@ -36,7 +36,7 @@ is identical:
|
||||
.
|
||||
|
||||
====================================
|
||||
node3, node4
|
||||
node3, node4 or nodegroup name
|
||||
====================================
|
||||
.
|
||||
.
|
||||
@ -60,4 +60,4 @@ B<psh> I<node1,node2,node3 cat /etc/passwd> | B<xcoll>
|
||||
|
||||
=head1 B<SEE ALSO>
|
||||
|
||||
L<psh(1)|psh.1>, L<xdshbak(1)|xdshbak.1>
|
||||
L<psh(1)|psh.1>, L<xdshbak(1)|xdshbak.1> ,L<xdshcoll(1)|xdshcoll.1>
|
||||
|
||||
63
xCAT-client/pods/man1/xdshcoll.1.pod
Normal file
63
xCAT-client/pods/man1/xdshcoll.1.pod
Normal file
@ -0,0 +1,63 @@
|
||||
=head1 B<NAME>
|
||||
|
||||
B<xdshcoll> - Formats and consolidates the output of the B<xdsh,sinv> commands.
|
||||
|
||||
=head1 B<SYNOPSIS>
|
||||
|
||||
B<xdshcoll>
|
||||
|
||||
=head1 B<DESCRIPTION>
|
||||
|
||||
The B<xdshcoll> command formats and consolidates output from the B<xdsh,sinv> command. The B<xdshcoll>
|
||||
command takes, as input, lines in the following format:
|
||||
|
||||
host_name: line of output from remote command
|
||||
|
||||
The B<xdshcoll> command formats the lines as follows and writes them to
|
||||
standard output. Assume that the output from node3 and node4
|
||||
is identical:
|
||||
|
||||
====================================
|
||||
node1
|
||||
====================================
|
||||
.
|
||||
.
|
||||
lines from psh for node1 with hostnames stripped off
|
||||
.
|
||||
.
|
||||
|
||||
====================================
|
||||
node2
|
||||
====================================
|
||||
.
|
||||
.
|
||||
lines from psh for node2 with hostnames stripped off
|
||||
.
|
||||
.
|
||||
|
||||
====================================
|
||||
node3, node4
|
||||
====================================
|
||||
.
|
||||
.
|
||||
lines from psh for node 3 with hostnames stripped off
|
||||
.
|
||||
.
|
||||
|
||||
|
||||
=head1 B<EXAMPLES>
|
||||
|
||||
=over 3
|
||||
|
||||
=item *
|
||||
|
||||
To display the results of a command issued on several nodes, in
|
||||
the format used in the Description, enter:
|
||||
|
||||
B<psh> I<node1,node2,node3 cat /etc/passwd> | B<xdshcoll>
|
||||
|
||||
=back
|
||||
|
||||
=head1 B<SEE ALSO>
|
||||
|
||||
L<xdshbak(1)|xdshbak.1>
|
||||
Loading…
Reference in New Issue
Block a user