Package org.ovirt.engine.sdk4.services
Interface StorageDomainService.RemoveRequest
-
- All Superinterfaces:
Request<StorageDomainService.RemoveRequest,StorageDomainService.RemoveResponse>
- Enclosing interface:
- StorageDomainService
public static interface StorageDomainService.RemoveRequest extends Request<StorageDomainService.RemoveRequest,StorageDomainService.RemoveResponse>
Removes the storage domain. Without any special parameters, the storage domain is detached from the system and removed from the database. The storage domain can then be imported to the same or to a different setup, with all the data on it. If the storage is not accessible the operation will fail. If the `destroy` parameter is `true` then the operation will always succeed, even if the storage is not accessible, the failure is just ignored and the storage domain is removed from the database anyway. If the `format` parameter is `true` then the actual storage is formatted, and the metadata is removed from the LUN or directory, so it can no longer be imported to the same or to a different setup.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description StorageDomainService.RemoveRequest
async(Boolean async)
Indicates if the remove should be performed asynchronously.StorageDomainService.RemoveRequest
destroy(Boolean destroy)
Indicates if the operation should succeed, and the storage domain removed from the database, even if the storage is not accessible.StorageDomainService.RemoveRequest
format(Boolean format)
Indicates if the actual storage should be formatted, removing all the metadata from the underlying LUN or directory: [source] ---- DELETE /ovirt-engine/api/storageDomains/123?format=true ---- This parameter is optional, and the default value is `false`.StorageDomainService.RemoveRequest
host(String host)
Indicates which host should be used to remove the storage domain.
-
-
-
Method Detail
-
async
StorageDomainService.RemoveRequest async(Boolean async)
Indicates if the remove should be performed asynchronously.
-
destroy
StorageDomainService.RemoveRequest destroy(Boolean destroy)
Indicates if the operation should succeed, and the storage domain removed from the database, even if the storage is not accessible. [source] ---- DELETE /ovirt-engine/api/storageDomains/123?destroy=true ---- This parameter is optional, and the default value is `false`. When the value of `destroy` is `true` the `host` parameter will be ignored.
-
format
StorageDomainService.RemoveRequest format(Boolean format)
Indicates if the actual storage should be formatted, removing all the metadata from the underlying LUN or directory: [source] ---- DELETE /ovirt-engine/api/storageDomains/123?format=true ---- This parameter is optional, and the default value is `false`.
-
host
StorageDomainService.RemoveRequest host(String host)
Indicates which host should be used to remove the storage domain. This parameter is mandatory, except if the `destroy` parameter is included and its value is `true`, in that case the `host` parameter will be ignored. The value should contain the name or the identifier of the host. For example, to use the host named `myhost` to remove the storage domain with identifier `123` send a request like this: [source] ---- DELETE /ovirt-engine/api/storageDomains/123?host=myhost ----
-
-