Package org.ovirt.engine.sdk4.services
Interface VmService.StopRequest
-
- 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] --------
-
-
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
reason(String reason)
The reason the virtual machine was stopped.
-
-
-
Method Detail
-
async
VmService.StopRequest async(Boolean async)
Indicates if the stop action should be performed asynchronously.
-
reason
VmService.StopRequest reason(String reason)
The reason the virtual machine was stopped. Optionally set by user when shutting down the virtual machine.
-
-