xcat-core/xCAT-client/pods/man1/rmkitcomp.1.pod
2013-10-12 12:58:15 -04:00

87 lines
2.5 KiB
Plaintext

=head1 NAME
B<rmkitcomp> - Remove Kit components from an xCAT osimage.
=head1 SYNOPSIS
B<rmkitcomp> [B<-?>|B<-h>|B<--help>] [B<-v>|B<--version>]
B<rmkitcomp> [B<-V>|B<--verbose>] [B<-u>|B<--uninstall>] [B<-f>|B<--force>] B<-i> I<osimage> I<kitcompname_list>
=head1 DESCRIPTION
The B<rmkitcomp> command removes kit components from an xCAT osimage. All the kit component attribute values that are contained in the osimage will be removed, and the kit comoponent meta rpm and package rpm could be uninstalled by <-u|--uninstall> option.
Note: The xCAT support for Kits is only available for Linux operating systems.
=head1 OPTIONS
=over 10
=item B<-u|--uninstall>
All the kit component meta rpms and package rpms in otherpkglist will be uninstalled during genimage for stateless image and updatenode for stateful nodes.
=item B<-h|--help>
Display usage message.
=item B<-V|--verbose>
Verbose mode.
=item B<-v|--version>
Command version.
=item B<-f|--force>
Remove this kit component from osimage no matter it is a dependency of other kit components.
=item B<-i> I<osimage>
osimage name that include this kit component.
=item B<kitcompname_list>
A comma-delimited list of valid full kit component names or kit component basenames that are to be removed from the osimage.
=back
=head1 RETURN VALUE
0 The command completed successfully.
1 An error has occurred.
=head1 EXAMPLES
1. To remove a kit component from osimage
rmkitcomp -i rhels6.2-ppc64-netboot-compute comp-test1-1.0-1-rhels-6.2-ppc64
Output is similar to:
kitcomponents comp-test1-1.0-1-rhels-6.2-ppc64 were removed from osimage rhels6.2-ppc64-netboot-compute successfully
2. To remove a kit component even it is still used as a dependency of other kit component.
rmkitcomp -f -i rhels6.2-ppc64-netboot-compute comp-test1-1.0-1-rhels-6.2-ppc64
Output is similar to:
kitcomponents comp-test1-1.0-1-rhels-6.2-ppc64 were removed from osimage rhels6.2-ppc64-netboot-compute successfully
3. To remove a kit component from osimage and also remove the kit component meta RPM and package RPM. So in next genimage for statelss image and updatenode for statefull nodes, the kit component meta RPM and package RPM will be uninstalled.
rmkitcomp -u -i rhels6.2-ppc64-netboot-compute comp-test1-1.0-1-rhels-6.2-ppc64
Output is similar to:
kitcomponents comp-test1-1.0-1-rhels-6.2-ppc64 were removed from osimage rhels6.2-ppc64-netboot-compute successfully
=head1 SEE ALSO
L<lskit(1)|lskit.1>, L<addkit(1)|addkit.1>, L<rmkit(1)|rmkit.1>, L<addkitcomp(1)|addkitcomp.1>, L<chkkitcomp(1)|chkkitcomp.1>