2
0
mirror of https://github.com/xcat2/xcat-core.git synced 2025-05-22 03:32:04 +00:00
xcat-core/xCAT-client/pods/man1/clonevm.1.pod

95 lines
2.1 KiB
Plaintext

=head1 NAME
B<clonevm> - Create masters from virtual machines and virtual machines from masters.
=head1 SYNOPSIS
B<clonevm> I<noderange> [ B<-t> I<master_to_be_made> | B<-b> I<master_to_base_vms_upon> ] [ B<-d|--detached>] [B<-f|--force>]
=head1 DESCRIPTION
Command to promote a VM's current configuration and storage to a master as well as
performing the converse operation of creating VMs based on a master.
By default, attempting to create a master from a running VM will produce an error.
The B<--force> argument will request that a master be made of the VM anyway.
Also, by default a VM that is used to create a master will be rebased as a thin
clone of that master. If the B<--force> argument is used to create a master of a powered
on vm, this will not be done. Additionally, the B<--detached> option can be used to
explicitly request that a clone not be tethered to a master image, allowing the
clones to not be tied to the health of a master, at the cost of additional storage.
When promoting a VM's current state to master, all related virtual disks will be
copied and merged with any prerequisite images. A master will not be tethered to
other masters.
=head1 OPTIONS
=over 4
=item B<-h|--help>
Display usage message.
=item B<-b> I<master_to_base_vms_upon>
The master to base the clones upon
=item B<-t> I<master_to_be_made>
The target master to copy a single VM's state to
=item B<-d|--detached>
Explicitly request that the noderange be untethered from any masters.
=item B<-f|--force>
Force cloning of a powered on VM. Implies B<-d> if the VM is on.
=item B<-v|--version>
Command Version.
=item B<-V|--verbose>
Verbose output.
=back
=head1 RETURN VALUE
0: The command completed successfully.
Any other value: An error has occurred.
=head1 EXAMPLES
=over 3
=item 1.
Creating a master named I<appserver> from a node called I<vm1>:
clonevm vm1 -t appserver
=item 2.
Cleating 30 VMs from a master named I<appserver>:
clonevm vm1-vm30 -b appserver
=back
=head1 FILES
/opt/xcat/bin/clonevm
=head1 SEE ALSO
L<chvm(1)|chvm.1>, L<lsvm(1)|lsvm.1>, L<rmvm(1)|rmvm.1>, L<mkvm(1)|mkvm.1>, L<vmmaster(5)|vmmaster.5>