xcat-core/xCAT-client/pods/man8/rmosdistro.8.pod

78 lines
1.2 KiB
Plaintext

=head1 NAME
B<rmosdistro> - remove OS Distro
=head1 SYNOPSIS
B<rmosdistro> [B<-a>|B<--all>] [B<-f|--force>] B<osdistroname> [B<osdistroname2 ...>]
B<rmosdistro> [B<-h>|B<--help>]
=head1 DESCRIPTION
The B<rmosdistro> command removes the specified OS Distro that was created by B<copycds>. To delete all OS Distro entries, please specify B<[-a|--all]>. If the specified OS Distro is referenced by some osimage, B<[-f|force]> can be used to remove it.
=head1 ARGUMENTS
The OS Distro names to delete, delimited by blank space.
=head1 OPTIONS
=over 6
=item {B<-a|--all>}
If specified, try to delete all the OS Distros.
=item {B<-f|--force>}
Remove referenced OS Distros, never prompt.
=item {B<-h|--help>}
Show info of rmosdistro usage.
=back
=head1 RETURN VALUE
Zero:
The command completed successfully.
Nonzero:
An Error has occurred.
=head1 EXAMPLES
=over 2
=item *
To remove OS Distro "rhels6.2-ppc64" and "sles11.2-ppc64":
B<rmosdistro rhels6.2-ppc64 sles11.2-ppc64>
=item *
To remove OS Distro "rhels6.2-ppc64", regardless of whether is referenced by any osimage:
B<rmosdistro -f rhels6.2-ppc64>
=item *
To remove all OS Distros:
B<rmosdistro -a>
=back