Package org.ovirt.engine.sdk4.services

Interface VmService.MigrateRequest

All Superinterfaces:

Request<VmService.MigrateRequest,VmService.MigrateResponse>

Enclosing interface:

VmService

public static interface VmService.MigrateRequest
extends Request<VmService.MigrateRequest,VmService.MigrateResponse>

Migrates a virtual machine to another physical host. Example: [source] ---- POST /ovirt-engine/api/vms/123/migrate ---- To specify a specific host to migrate the virtual machine to: [source,xml] ---- ----

Method Summary

Modifier and Type	Method	Description
VmService.MigrateRequest	async(Boolean async)	Indicates if the migration should be performed asynchronously.
VmService.MigrateRequest	cluster(ClusterBuilder cluster)	Specifies the cluster the virtual machine should migrate to.
VmService.MigrateRequest	cluster(Cluster cluster)
VmService.MigrateRequest	force(Boolean force)	Specifies that the virtual machine should migrate even if the virtual machine is defined as non-migratable.
VmService.MigrateRequest	host(HostBuilder host)	Specifies a specific host that the virtual machine should migrate to.
VmService.MigrateRequest	host(Host host)
VmService.MigrateRequest	migrateVmsInAffinityClosure(Boolean migrateVmsInAffinityClosure)	Migrate also all other virtual machines in positive enforcing affinity groups with this virtual machine, that are running on the same host.

Methods inherited from interface org.ovirt.engine.sdk4.Request

header, query, send

Method Detail

async

VmService.MigrateRequest async(Boolean async)

Indicates if the migration should be performed asynchronously.

cluster

VmService.MigrateRequest cluster(Cluster cluster)

cluster

VmService.MigrateRequest cluster(ClusterBuilder cluster)

Specifies the cluster the virtual machine should migrate to. This is an optional parameter. By default, the virtual machine is migrated to another host within the same cluster. WARNING: Live migration to another cluster is not supported. Strongly consider the target cluster's hardware architecture and network architecture before attempting a migration.

force

VmService.MigrateRequest force(Boolean force)

Specifies that the virtual machine should migrate even if the virtual machine is defined as non-migratable. This is an optional parameter. By default, it is set to `false`.

host

VmService.MigrateRequest host(Host host)

host

VmService.MigrateRequest host(HostBuilder host)

Specifies a specific host that the virtual machine should migrate to. This is an optional parameter. By default, the {engine-name} automatically selects a default host for migration within the same cluster. If an API user requires a specific host, the user can specify the host with either an `id` or `name` parameter.

migrateVmsInAffinityClosure

VmService.MigrateRequest migrateVmsInAffinityClosure(Boolean migrateVmsInAffinityClosure)

Migrate also all other virtual machines in positive enforcing affinity groups with this virtual machine, that are running on the same host. The default value is `false`.