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 different setup, with all the data on it. If the storage isn’t accessible the operation will fail.

If the destroy parameter is true then the operation will always succeed, even if the storage isn’t 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 a different setup.

Method Summary

Modifier and Type	Method and 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 isn’t accessible.
StorageDomainService.RemoveRequest	format(Boolean format) Indicates if the actual storage should be formatted, removing all the metadata from the underlying LUN or directory.
StorageDomainService.RemoveRequest	host(String host) Indicates what host should be used to remove the storage domain.

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

send

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 isn’t accessible.

This parameter is optional, and the default value is false.

format

StorageDomainService.RemoveRequest format(Boolean format)

Indicates if the actual storage should be formatted, removing all the metadata from the underlying LUN or directory.

This parameter is optional, and the default value is false.

host

StorageDomainService.RemoveRequest host(String host)

Indicates what host should be used to remove the storage domain.

This parameter is mandatory, and it can 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:

DELETE /ovirt-engine/api/storagedomains/123?host=myhost