Package org.ovirt.engine.sdk4.services

Interface VmService.StartRequest

All Superinterfaces:

Request<VmService.StartRequest,VmService.StartResponse>

Enclosing interface:

VmService

public static interface VmService.StartRequest
extends Request<VmService.StartRequest,VmService.StartResponse>

Starts the virtual machine. If the virtual environment is complete and the virtual machine contains all necessary components to function, it can be started. This example starts the virtual machine: [source] ---- POST /ovirt-engine/api/vms/123/start ---- With a request body: [source,xml] ---- ----

Method Summary

Modifier and Type	Method	Description
VmService.StartRequest	async(Boolean async)	Indicates if the start action should be performed asynchronously.
VmService.StartRequest	authorizedKey(AuthorizedKeyBuilder authorizedKey)
VmService.StartRequest	authorizedKey(AuthorizedKey authorizedKey)
VmService.StartRequest	filter(Boolean filter)	Indicates if the results should be filtered according to the permissions of the user.
VmService.StartRequest	pause(Boolean pause)	If set to `true`, start the virtual machine in paused mode.
VmService.StartRequest	useCloudInit(Boolean useCloudInit)	If set to `true`, the initialization type is set to _cloud-init_.
VmService.StartRequest	useIgnition(Boolean useIgnition)	If set to `true`, the initialization type is set to _Ignition_.
VmService.StartRequest	useInitialization(Boolean useInitialization)	If set to `true`, the initialization type is set by the VM's OS.
VmService.StartRequest	useSysprep(Boolean useSysprep)	If set to `true`, the initialization type is set to _Sysprep_.
VmService.StartRequest	vm(VmBuilder vm)	The definition of the virtual machine for this specific run.
VmService.StartRequest	vm(Vm vm)
VmService.StartRequest	volatile_(Boolean volatile_)	Indicates that this run configuration will be discarded even in the case of guest-initiated reboot.

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

header, query, send

Method Detail

async

VmService.StartRequest async(Boolean async)

Indicates if the start action should be performed asynchronously.

authorizedKey

VmService.StartRequest authorizedKey(AuthorizedKey authorizedKey)

authorizedKey

VmService.StartRequest authorizedKey(AuthorizedKeyBuilder authorizedKey)

filter

VmService.StartRequest filter(Boolean filter)

Indicates if the results should be filtered according to the permissions of the user.

pause

VmService.StartRequest pause(Boolean pause)

If set to `true`, start the virtual machine in paused mode. The default is `false`.

useCloudInit

VmService.StartRequest useCloudInit(Boolean useCloudInit)

If set to `true`, the initialization type is set to _cloud-init_. The default value is `false`. See https://cloudinit.readthedocs.io/en/latest[this] for details.

useIgnition

VmService.StartRequest useIgnition(Boolean useIgnition)

If set to `true`, the initialization type is set to _Ignition_. The default value is `false`. See https://coreos.com/ignition/docs/latest/[this] for details.

useInitialization

VmService.StartRequest useInitialization(Boolean useInitialization)

If set to `true`, the initialization type is set by the VM's OS. Windows will set to _Sysprep_, Linux to _cloud-init_ and RedHat CoreOS to _Ignition_. If any of the initialization-types are explicitly set (useCloudInit, useSysprep or useIgnition), they will be prioritized and this flag will be ignored. The default value is `false`.

useSysprep

VmService.StartRequest useSysprep(Boolean useSysprep)

If set to `true`, the initialization type is set to _Sysprep_. The default value is `false`. See https://en.wikipedia.org/wiki/Sysprep[this] for details.

vm

VmService.StartRequest vm(Vm vm)

vm

VmService.StartRequest vm(VmBuilder vm)

The definition of the virtual machine for this specific run. For example: [source,xml] ---- cdrom ---- This will set the boot device to the CDROM only for this specific start. After the virtual machine is powered off, this definition will be reverted.

volatile_

VmService.StartRequest volatile_(Boolean volatile_)

Indicates that this run configuration will be discarded even in the case of guest-initiated reboot. The default value is `false`.