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

=head1 Name

B<rmigrate> - Execute migration of a guest VM between hosts/hypervisors

=head1 B<Synopsis>

B<rmigrate> I<noderange> I<target_host>

=head2 For zVM:

B<rmigrate> I<noderange> [B<destination=>I<target_host>] [B<action=>I<action>] [B<force=>I<force>] [B<immediate=>I<yes_no>] [B<max_total=>I<total>] [B<max_quiesce=>I<quiesce>]

=head1 B<Description>

B<rmigrate> requests that a guest VM be moved from the current entity hosting it to another.  It requests a live migration be done, if possible.

=head2 For zVM:

B<rmigrate> migrates a VM from one z/VM member to another in an SSI cluster (only in z/VM 6.2).

=head1 OPTIONS

=head2 zVM specific:

=over 4

=item B<destination=>
The name of the destination z/VM system to which the specified virtual machine will be relocated.

=item B<action=>
It can be: (MOVE) initiate a VMRELOCATE MOVE of the VM, (TEST) determine if VM is eligible to be relocated, or (CANCEL) stop the relocation of VM.

=item B<force=>
It can be: (ARCHITECTURE) attempt relocation even though hardware architecture facilities or CP features are not available on destination system, (DOMAIN) attempt relocation even though VM would be moved outside of its domain, or (STORAGE) relocation should proceed even if CP determines that there are insufficient storage resources on destination system.

=item B<immediate=>
It can be: (YES) VMRELOCATE command will do one early pass through virtual machine storage and then go directly to the quiesce stage, or (NO) specifies immediate processing.

=item B<max_total=>
The maximum wait time for relocation to complete.

=item B<max_quiesce=>
The maximum quiesce time a VM may be stopped during a relocation attempt.

=back

=head1 B<Files>

B<vm> table -
Table governing VM paramaters.  See L<vm(5)|vm.5> for further details.
This is used to determine the current host to migrate from.

=head1 B<Examples>

B<rmigrate> I<v1> I<n2>

=head2 zVM specific:

=over 4

B<rmigrate> I<ihost123> destination=I<pokdev62>

=back