xCAT/xcat-core
2
0
Fork 0
mirror of https://github.com/xcat2/xcat-core.git synced 2025-06-24 15:05:36 +00:00
Code Issues Releases Wiki Activity

Remove trailing spaces in file xCAT-client/pods/man1/sinv.1.pod

Browse Source
This commit is contained in:
GONG Jie
2017-12-31 23:59:59 +00:00
parent 491eb897ef
commit 04f4245385
1 changed files with 32 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files

64
xCAT-client/pods/man1/sinv.1.pod
View File

@ -1,6 +1,6 @@
=head1 B<NAME>
B<sinv> - Checks the software configuration of the nodes in the cluster.
B<sinv> - Checks the software configuration of the nodes in the cluster.
=head1 B<SYNOPSIS>
@ -12,12 +12,12 @@ B<sinv> [B<-h> | B<-v>]
=head1 B<DESCRIPTION>
The B<sinv> command is designed to check the configuration of the nodes in a cluster.
The command takes as input command line flags, and one or more templates which will be compared against the output of the B<xdsh> command, designated to be run by the B<-c> or B<-f> flag, on the nodes in the noderange.
The command takes as input command line flags, and one or more templates which will be compared against the output of the B<xdsh> command, designated to be run by the B<-c> or B<-f> flag, on the nodes in the noderange.
The nodes will then be grouped according to the template they match and a report returned to the administrator in the output file designated by the B<-o> flag, or to stdout.
The nodes will then be grouped according to the template they match and a report returned to the administrator in the output file designated by the B<-o> flag, or to stdout.
B<sinv> supports checking the output from the B<rinv> or B<xdsh> command.
B<sinv> supports checking the output from the B<rinv> or B<xdsh> command.
The B<sinv> command is an xCAT Distributed Shell Utility.
@ -38,7 +38,7 @@ The syntax for the B<-c> parameter is as follows:
where I<command> is the command to run on the remote
target. Quotation marks are required to ensure that all commands in the
list are executed remotely, and that any special characters are interpreted
correctly on the remote target.
correctly on the remote target.
The B<sinv> command does not work with any interactive commands, including
those that read from standard input.
@ -56,22 +56,22 @@ Command Protocol can be used. See man B<xdsh> for more details.
=item B<-o>|B<--output> I<report output file>
Optional output file. This is the location of the file that will contain the report of the nodes that match, and do not match, the input templates. If the flag is not used, the output will go to stdout.
Optional output file. This is the location of the file that will contain the report of the nodes that match, and do not match, the input templates. If the flag is not used, the output will go to stdout.
=item B<-p>|B<--tp> I<template path>
This is the path to the template file. The template contains the output
of B<xdsh> or B<rinv> command, that has been run against a "seed" node, a node
that contains the configuration that you would like all nodes in your noderange to match.
of B<xdsh> or B<rinv> command, that has been run against a "seed" node, a node
that contains the configuration that you would like all nodes in your noderange to match.
The admin can create the template by running the B<xdsh> or B<rinv> command on
the seed node, pipe to B<xdshcoll> (required) and store the output
in the template path. See examples.
B<Note:> The admin can also edit the template to remove any lines that they do not want checked.
B<Note:> The admin can also edit the template to remove any lines that they do not want checked.
An alternative method is to use the [B<-s> I<seed node>] parameter,
which will automatically build the template for you from the
An alternative method is to use the [B<-s> I<seed node>] parameter,
which will automatically build the template for you from the
seed node named.
If a a seed node is not provided, then command will automatically use the first node in the noderange as
@ -82,15 +82,15 @@ the seed node.
This count is the number of templates that the command will use
to check for nodes matches. If the template in the template path does not
match a node, the B<sinv> will check additional templates up
match a node, the B<sinv> will check additional templates up
to the template count.
For each node, it will compare the node against each template to see if
there is a match.
For each node, it will compare the node against each template to see if
there is a match.
If there is no match, and we are not over the template count,
then a new template will be created from the node output.
then a new template will be created from the node output.
This will result in having all nodes that match a given template reported in
their group at the end of the run in the output file.
their group at the end of the run in the output file.
If no template count is specified, 0 is the default, and all nodes will
be compared against the first template.
@ -109,22 +109,22 @@ selected as a seed node.
This flag suppresses the reporting of the nodes matching the first
template. In very large systems, you may not want to show the nodes that
have the correct configuration, since the list could contain thousands of nodes.
This allows you to only report the nodes that do not match the required
configuration.
This allows you to only report the nodes that do not match the required
configuration.
=item B<-e>|B<--exactmatch>
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
B<xdsh> or B<rinv> command to the nodes contain a match for each line in the input
If this flag is not set, B<sinv> checks to see if the return from the
B<xdsh> or B<rinv> command to the nodes contain a match for each line in the input
template (except for xdshcoll header and comments). If not in exactmatch mode,
there can be more lines in the B<xdsh> or B<rinv> return from the nodes.
For example, if running a "rpm -qa | grep xCAT" command, without exactmatch
For example, if running a "rpm -qa | grep xCAT" command, without exactmatch
set, if the node contains more xCAT rpms that listed in the template,
it would be considered a match, as long as all rpms listed in the template
were on the node. With exactmatch set, the output must be identical
to the template.
were on the node. With exactmatch set, the output must be identical
to the template.
=item B<--devicetype> I<type_of_device>
@ -148,16 +148,16 @@ Specifies a remote user name to use for remote command execution.
=item B<-c>|B<--command>
The B<xdsh> or B<rinv> command that will be run. The command should be enclosed in
The B<xdsh> or B<rinv> command that will be run. The command should be enclosed in
double quotes to insure correct shell interpretation. This parameter must only contain, the node range or the image path (Linux) or spot name for AIX. It cannot be used to set additional input flags to B<xdsh> or B<rinv> (for example B<-s>,B<-T>,B<-e>). See examples below.
B<Note:> do not add the B<| xdshcoll> to the command,
it is automatically added by B<sinv>. B<sinv> also automatically sets the B<-v> flag for B<xdsh>.
it is automatically added by B<sinv>. B<sinv> also automatically sets the B<-v> flag for B<xdsh>.
=item B<-f>|B<--file>
The file containing the B<xdsh> or B<rinv> command that will be run.
This should be the fully qualified name of the file.
The file containing the B<xdsh> or B<rinv> command that will be run.
This should be the fully qualified name of the file.
B<Note:> do not add the B<| xdshcoll> to the command in the file,
it is automatically added by B<sinv>.
@ -165,7 +165,7 @@ it is automatically added by B<sinv>.
=item B<-r>|B<--remove>
This flag indicates that generated templates should be removed at the
at the end of the B<sinv> command execution.
at the end of the B<sinv> command execution.
If the flag is specified, then all templates that are generated by the B<sinv>
command, will be removed. If the first template is created by the admin,
@ -233,7 +233,7 @@ possibly generating up to two additional
templates and removing any generated templates at the end, enter:
sinv -c "rinv node1-node4 serial" -s node8 -p /tmp/sinv.template -t 2 -r -o /tmp/rinv.output
=item 6.
To execute B<sinv> on noderange, I<node1-node4>, using I<node1> as
the seed node, to generate the sinv.template from the B<xdsh> command (B<-c>),
@ -245,7 +245,7 @@ Note: the /tmp/sinv.template file must be empty, otherwise it will be used
as an admin generated template.
=item 7.
To execute B<sinv> on the Linux osimage defined for cn1. First build a template from the /etc/hosts on the node. Then run B<sinv> to compare.
To execute B<sinv> on the Linux osimage defined for cn1. First build a template from the /etc/hosts on the node. Then run B<sinv> to compare.
xdsh cn1 "cat /etc/hosts" | xdshcoll > /tmp/sinv2/template"