xcat-core/xCAT-client/pods/man1/addkit.1.pod

=head1 NAME

B<addkit> - Install a kit on the xCAT management node

=head1 SYNOPSIS

B<addkit> [B<-?>|B<-h>|B<--help>] [B<-v>|B<--version>]

B<addkit> [B<-i>|B<--inspection>] I<kitlist>

B<addkit> [B<-V>|B<--verbose>] [B<-p>|B<--path> I<path>] I<kitlist>

=head1 DESCRIPTION

The B<addkit> command install a kit on the xCAT management node from a kit tarfile or directory, creating xCAT database definitions for kit, kitrepo, kitcomponent.

Note: The xCAT support for Kits is only available for Linux operating systems.

=head1 OPTIONS

=over 10

=item B<-h|--help>

Display usage message.

=item B<-V|--verbose>

Verbose mode.

=item B<-v|--version>

Command version.

=item B<-i|--inspection>

Show the summary of the given kits

=item B<-p|--path <path>>

The destination directory to which the contents of the kit tarfiles and/or kit deploy dirs will be copied.  When this option is not specified, the default destination directory will be formed from the installdir site attribute with ./kits subdirectory.

=item B<kitlist>

a comma delimited list of kit_tarball_files and kit_deploy_dirs that are to be added to the xCAT cluster.  Each entry can be an absolute or relative path.  For kit_tarball_files, these must be valid kits tarfiles added.  For kit_deploy_dirs, these must be fully populated directory structures that are identical to the contents of an expanded kit_tarball_file.

=back

=head1 RETURN VALUE

0  The command completed successfully.

1  An error has occurred.

=head1 EXAMPLES

1. To add two kits from tarball files.

addkit kit-test1.tar.bz2,kit-test2.tar.bz2

Output is similar to:

Kit /kit/kit-test1.tar.bz2,/kit/kit-test2.tar.bz2 was successfully added.

2. To add two kits from directories.

addkit kit-test1,kit-test2

Output is similar to:

Kit /kit/kit-test1,/kit/kit-test2 was successfully added.

3. To add a kit from tarball file to /install/test directory.

addkit -p /install/test kit-test1.tar.bz2

Output is similar to:

Kit /kit/kit-test1.tar.bz2 was successfully added.

4. To read the general infomration of the kit, without adding the kits to xCAT DB

addkit -i kit-test1.tar.bz2

Output is similar to:

kitname=xlc-12.1.0.0-Linux
description=XLC12 for Linux
version=12.1.0.0
ostype=Linux

=head1 SEE ALSO

L<lskit(1)|lskit.1>, L<rmkit(1)|rmkit.1>, L<addkitcomp(1)|addkitcomp.1>, L<rmkitcomp(1)|rmkitcomp.1>, L<chkkitcomp(1)|chkkitcomp.1>