VmService.ShutdownRequest (oVirt Java SDK 4.4.6 API)

All Superinterfaces:

Request<VmService.ShutdownRequest,VmService.ShutdownResponse>

Enclosing interface:

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

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`VmService.ShutdownRequest`	`async(Boolean async)`	Indicates if the shutdown should be performed asynchronously.
`VmService.ShutdownRequest`	`force(Boolean force)`	Indicates if the VM should be forcibly shutdown even if a backup is running for it.
`VmService.ShutdownRequest`	`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.ShutdownRequest async(Boolean async)
```
    Indicates if the shutdown should be performed asynchronously.
  - force
```
VmService.ShutdownRequest force(Boolean force)
```
    Indicates if the VM should be forcibly shutdown even if a backup is running for it.
  - reason
```
VmService.ShutdownRequest reason(String reason)
```
    The reason the virtual machine was stopped. Optionally set by user when shutting down the virtual machine.