NAME

sinv - Checks the software configuration of the nodes in the cluster.


SYNOPSIS

sinv [-o output] [-p template path] [-t template count] [-s seed node] [-i] [-e] [-r] [-V] [[-f command file] | [-c command]]

sinv [-h | -v]


DESCRIPTION

The 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 xdsh command, designated to be run by the -c or -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 -o flag, or to stdout.

sinv supports checking the output from the rinv or xdsh command.


The B<sinv> command is an xCAT Distributed Shell Utility.

COMMAND SPECIFICATION:

The xdsh or rinv command to execute on the remote targets is specified by the -c flag, or by the -f flag which is followed by the fully qualified path to a file containing the command.

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 -c sinv parameter is as follows:

``command[; command]...''

where 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.

The sinv command does not work with any interactive commands, including those that read from standard input.

REMOTE SHELL COMMAND:

For xdsh, support is explicitly provided for AIX Remote Shell and OpenSSH, but any secure remote command that conforms to the IETF (Internet Engineering Task Force) Secure Remote Command Protocol can be used. See man xdsh for more details.


OPTIONS

-o|--output 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.

-p|--tp template path

This is the path to the template file. The template contains the output of xdsh 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 xdsh command on the seed node, pipe to xdshcoll ( required) and store the output in the template path. See examples.

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 [-s seed node] parameter, which will automatically build the template for you from the seed node named.

If a template path file does not exist, and a seed node is not input, then sinv will automatically use the first node in the noderange as the seed node and build the template.

-t|--tc template count

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 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.  
If there is no match, and we are not over the template count,
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. 
If no template count is specified,  0 is the default, and all nodes will
be compared against the first template.
-s|--seed seed node

This is the node that will be used to build the first template that is stored in template path. You can use this parameter instead of running the command yourself to build the template.

Note: If the template path file does not exists, and no seed node is supplied, the seed node automatically is the first node in the noderange.

-i|--ignorefirst

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.

-e|--exactmatch

This requires the check of node output against template to be an exact match. If this flag is not set, 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 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 set, if the node containes 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.

-c|--command

The xdsh or rinv command that will be run. The command should be enclosed in double quotes to insure correct shell interpretation.

Note: do not add the | xdshcoll to the command, it is automatically added by sinv.

-f|--file

The file containing the xdsh or rinv command that will be run. This should be the fully qualified name of the file.

Note: do not add the | xdshcoll to the command in the file, it is automatically added by sinv.

-r|--remove

This flag indicates that generated templates should be removed at the at the end of the sinv command execution.

If the flag is input, then all templates that are generated by the sinv command, will be removed. If the first template is created by the admin, it will not be removed.

If the flag is not input, no templates will be removed. It is up to the admin to cleanup templates.

-h|--help

Displays usage information.

-v|--version

Displays xCAT release version.

-V|--Verbose

Verbose mode.


Examples


Files

/opt/xcat/bin/sinv/

Location of the sinv command.


SEE ALSO

L <xdsh(1)|xdsh.1>, noderange(3)