VmService.StopRequest (oVirt Java SDK 4.4.6 API)

All Superinterfaces:

Request<VmService.StopRequest,VmService.StopResponse>

Enclosing interface:

VmService
```
public static interface VmService.StopRequest
extends Request<VmService.StopRequest,VmService.StopResponse>
```
This operation forces a virtual machine to power-off. For example: [source] ---- POST /ovirt-engine/api/vms/123/stop ---- The stop action does not take any action specific parameters; therefore, the request body should contain an empty `action`: [source,xml] ---- ---- To stop the VM even if a backup is running for it, the action should include the 'force' element. For example, to force stop virtual machine `123`: ---- POST /ovirt-engine/api/vms/123/stop ---- [source,xml] ---- true ----

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`VmService.StopRequest`	`async(Boolean async)`	Indicates if the stop action should be performed asynchronously.
`VmService.StopRequest`	`force(Boolean force)`	Indicates if the VM should be forcibly stop even if a backup is running for it.
`VmService.StopRequest`	`reason(String reason)`	The reason the virtual machine was stopped.

Methods inherited from interface org.ovirt.engine.sdk4.Request
header, query, send

- Method Detail
  - async
```
VmService.StopRequest async(Boolean async)
```
    Indicates if the stop action should be performed asynchronously.
  - force
```
VmService.StopRequest force(Boolean force)
```
    Indicates if the VM should be forcibly stop even if a backup is running for it.
  - reason
```
VmService.StopRequest reason(String reason)
```
    The reason the virtual machine was stopped. Optionally set by user when shutting down the virtual machine.