xcat-core/xCAT-client/pods/man1/rmimage.1.pod
ligc 138b9ec928 rmimage code drop
git-svn-id: https://svn.code.sf.net/p/xcat/code/xcat-core/trunk@7444 8638fb3e-16cb-4fca-ae20-7b5d299a9bcd
2010-09-14 08:22:36 +00:00

90 lines
2.3 KiB
Plaintext

=head1 NAME
B<rmimage> - Removes the Linux stateless or statelite image from the file system.
=head1 SYNOPSIS
I<rmimage [-h | --help]>
I<rmimage [-V | --verbose]> I<-o <OS>> I<-a <architecture>> I<-p <profile>>
I<rmimage [-V | --verbose] imagename [--xcatdef]>
=head1 DESCRIPTION
Removes the Linux stateless or statelite image from the file system.
The install dir is setup by using "installdir" attribute set in the site table.
If I<imagename> is specified, this command uses the information in the I<imagename>
to calculate the image root directory; otherwise, this command uses the operating system name,
architecture and profile name to calculate the image root directory.
The osimage definition will not be removed from the xCAT tables by default,
specifying the flag --xcatdef will remove the osimage definition,
or you can use rmdef -t osimage to remove the osimage definition.
The statelite image files on the diskful service nodes will not be removed,
remove the image files on the service nodes manually if necessary,
for example, use command "rsync -az --delete /install <sn>:/" to remove the image files on the service nodes,
where the <sn> is the hostname of the service node.
=head1 Parameters
I<imagename> specifies the name of an os image definition to be used. The specification for the image is stored in the I<osimage> table and I<linuximage> table.
=head1 OPTIONS
B<-h | --help> Display usage message.
B<-V | --verbose> Verbose mode.
B<-o> Operating system (fedora9,rhels5.5,sles11,etc)
B<-p> Profile (compute,service,etc)
B<-a> Architecture (ppc64,x86_64,etc)
B<--xcatdef> Remove the xCAT osimage definition
=head1 RETURN VALUE
0 The command completed successfully.
1 An error has occurred.
=head1 EXAMPLES
1. To remove a fedora9 stateless image for a compute node architecture x86_64, enter:
I<rmimage fedora9-x86_64-netboot-compute>
or
I<rmimage -o fedora9 -p compute -a x86_64>
2. To remove a rhels5.5 statelite image for a compute node architecture ppc64 and the osimage definition, enter:
I<rmimage rhels5.5-ppc64-statelite-compute --xcatdef>
or
I<rmimage -o rhels5.5 -p compute -a ppc64 --xcatdef>
=head1 FILES
/opt/xcat/sbin/rmimage
=head1 NOTES
This command is part of the xCAT software product.
=head1 SEE ALSO
L<genimage(1)|genimage.1>, L<packimage(1)|packimage.1>